From 0db3f4c6502d95e4487ad6c181302c81e3687355 Mon Sep 17 00:00:00 2001
From: Jesse Luehrs
Date: Mon, 18 Mar 2013 18:22:58 -0500
Subject: update docs
---
com/iinteractive/test/ExternalTest.html | 2 +-
com/iinteractive/test/Test.html | 2 +-
com/iinteractive/test/TestMore.html | 87 ++++-
com/iinteractive/test/harness/SummarizedTests.html | 6 +-
com/iinteractive/test/harness/SummaryReporter.html | 6 +-
com/iinteractive/test/sbt/SBTReporter.html | 10 +-
com/iinteractive/test/tap/LineEvent.html | 398 +++++++++++++++++++++
com/iinteractive/test/tap/TAPEvent.html | 2 +-
com/iinteractive/test/tap/TestBuilder.html | 12 +-
com/iinteractive/test/tap/package.html | 13 +
index.html | 2 +-
index.js | 2 +-
index/index-d.html | 3 +
index/index-e.html | 3 +
index/index-l.html | 8 +-
index/index-t.html | 3 +
16 files changed, 529 insertions(+), 30 deletions(-)
create mode 100644 com/iinteractive/test/tap/LineEvent.html
diff --git a/com/iinteractive/test/ExternalTest.html b/com/iinteractive/test/ExternalTest.html
index 1187ab9..c1197c2 100644
--- a/com/iinteractive/test/ExternalTest.html
+++ b/com/iinteractive/test/ExternalTest.html
@@ -363,7 +363,7 @@ Console.err, so you can swap these out as required in order to parse it.
results are being summarized rather than directly displayed.
Runs the test just like run, but in a way that makes sense when test results are being summarized rather than directly displayed.
Summarizing test reporters tend to repeatedly update the same line on the terminal, so this method makes calls to - diag (which sends + diag (which sends messages to stderr, where they are typically displayed as-is) prefix the message with a newline, to ensure that the output starts on its own line. diff --git a/com/iinteractive/test/Test.html b/com/iinteractive/test/Test.html index 4a21978..56ff54d 100644 --- a/com/iinteractive/test/Test.html +++ b/com/iinteractive/test/Test.html @@ -362,7 +362,7 @@ Console.err, so you can swap these out as required in order to parse it. results are being summarized rather than directly displayed.
Runs the test just like run, but in a way that makes sense when test results are being summarized rather than directly displayed.
Summarizing test reporters tend to repeatedly update the same line on the terminal, so this method makes calls to - diag (which sends + diag (which sends messages to stderr, where they are typically displayed as-is) prefix the message with a newline, to ensure that the output starts on its own line. diff --git a/com/iinteractive/test/TestMore.html b/com/iinteractive/test/TestMore.html index 9d811bd..5d37abf 100644 --- a/com/iinteractive/test/TestMore.html +++ b/com/iinteractive/test/TestMore.html @@ -332,21 +332,38 @@ was called, not from the call to
ok
in thenotok
methodef - diag(message: String): Unit + diag(message: Any): Unit
Output a comment to
Console.err
.Output a comment to
Console.err
. This is intended to be visible to users even when running the test under a summarizing harness.
+diag("Testing with Scala " + util.Properties.versionString)
++ + + def + + + dies_ok[T <: Throwable](body: ⇒ Unit)(implicit arg0: ClassTag[T]): Boolean + +
+Assert that the given block of code throws an exception.
Assert that the given block of code throws an exception. +
dies_ok[MyException] { myObj.explode }
+ + + def + + + exception(body: ⇒ Unit): Option[Throwable] + +
+Runs a block of code, returning the exception that it throws, or None if +no exception was thrown.
Runs a block of code, returning the exception that it throws, or None if +no exception was thrown. Not an assertion on its own, but can be used to +create more complicated assertions about exceptions. +
+is(exception { myObj.explode }, None)
+Assert that a string matches a regular expression.
Assert that a string matches a regular expression.
+like(response.header("Content-Type"), """text/x?html""".r)
++ + + def + + + lives_ok(body: ⇒ Unit): Boolean + +
+Assert that the given block of code doesn't throw an exception.
Assert that the given block of code doesn't throw an exception. +
lives_ok { myObj.explode }
def - note(message: String): Unit + note(message: Any): Unit
Output a comment to
Console.out
.Output a comment to
Console.out
. This is intended to only be visible @@ -770,7 +824,7 @@ Console.err, so you can swap these out as required in order to parse it. results are being summarized rather than directly displayed.Runs the test just like run, but in a way that makes sense when test results are being summarized rather than directly displayed.
Summarizing test reporters tend to repeatedly update the same line on the terminal, so this method makes calls to - diag (which sends + diag (which sends messages to stderr, where they are typically displayed as-is) prefix the message with a newline, to ensure that the output starts on its own line. @@ -841,6 +895,25 @@ the single assertion that the overall test sees.
+ + + def + + + throws_ok(e: Throwable)(body: ⇒ Unit): Boolean + +
+Assert that the given block of code throws an exception, and that the +exception that it throws is equal to the passed exception.
Assert that the given block of code throws an exception, and that the +exception that it throws is equal to the passed exception. +
+throws_ok(new MyException("foo")) { myObj.explode }
+def - runOneTest(test: Test, cb: (TAPEvent) ⇒ Unit): TAPResult + runOneTest(test: Test, cb: (TAPEvent) ⇒ Unit, combine: Boolean = false): TAPResult
Runs a single test instance, calling
cb
diff --git a/com/iinteractive/test/harness/SummaryReporter.html b/com/iinteractive/test/harness/SummaryReporter.html index 71aa8b3..cd38118 100644 --- a/com/iinteractive/test/harness/SummaryReporter.html +++ b/com/iinteractive/test/harness/SummaryReporter.html @@ -354,15 +354,15 @@ namestestNames
.The exit code for the harness to use. Will be 0 on success.
def - runOneTest(test: Test, cb: (TAPEvent) ⇒ Unit): TAPResult + runOneTest(test: Test, cb: (TAPEvent) ⇒ Unit, combine: Boolean = false): TAPResult
Runs a single test instance, calling
cb
diff --git a/com/iinteractive/test/sbt/SBTReporter.html b/com/iinteractive/test/sbt/SBTReporter.html index 04e3db4..47f030d 100644 --- a/com/iinteractive/test/sbt/SBTReporter.html +++ b/com/iinteractive/test/sbt/SBTReporter.html @@ -85,7 +85,7 @@Instance Constructors
@@ -93,7 +93,7 @@ new - SBTReporter(loader: ClassLoader, loggers: Array[Logger], eventHandler: EventHandler) + SBTReporter(loader: ClassLoader, loggers: Array[Logger], eventHandler: EventHandler, verbose: Boolean)
@@ -338,15 +338,15 @@The exit code for the harness to use. Will be 0 on success.
def - runOneTest(test: Test, cb: (TAPEvent) ⇒ Unit): TAPResult + runOneTest(test: Test, cb: (TAPEvent) ⇒ Unit, combine: Boolean = false): TAPResult
Runs a single test instance, calling
+cb
diff --git a/com/iinteractive/test/tap/LineEvent.html b/com/iinteractive/test/tap/LineEvent.html new file mode 100644 index 0000000..28c742e --- /dev/null +++ b/com/iinteractive/test/tap/LineEvent.html @@ -0,0 +1,398 @@ + + + +com.iinteractive.test.tap
+LineEvent
++ + + case class + + + LineEvent extends TAPEvent with Product with Serializable + +
+ +A line was parsed.
+ +- Alphabetic
+ - By inheritance
+
++ +
+- LineEvent
- Serializable
- Serializable
- Product
- Equals
- TAPEvent
- AnyRef
- Any
+
++- Hide All
+ - Show all
+
+ Learn more about member selection +- Public
- All
+Value Members
+-
+
+
+
- Definition Classes
- AnyRef
+ -
+
+
+
- Definition Classes
- Any
+ -
+
+
+
- Definition Classes
- AnyRef → Any
+ -
+
+
+
- Definition Classes
- AnyRef
+ -
+
+
+
- Definition Classes
- Any
+ -
+
+
+
- Definition Classes
- Any
+ -
+
+
+
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
-
+ @throws()
+
+
+ -
+
+
+
- Definition Classes
- AnyRef
+ -
+
+
+
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
-
+ @throws()
+
+
+ -
+
+
+
- Definition Classes
- AnyRef → Any
+ -
+
+
+
- Definition Classes
- Any
+ -
+
+
+
-
+
+
+
- Definition Classes
- AnyRef
+ -
+
+
+
- Definition Classes
- AnyRef
+ -
+
+
+
- Definition Classes
- AnyRef
+ -
+
+
+
- Definition Classes
- AnyRef
+ -
+
+
+
- Definition Classes
- AnyRef
- Annotations
-
+ @throws()
+
+
+ -
+
+
+
- Definition Classes
- AnyRef
- Annotations
-
+ @throws()
+
+
+ -
+
+
+
- Definition Classes
- AnyRef
- Annotations
-
+ @throws()
+
+
+
++ + final + def + + + !=(arg0: AnyRef): Boolean + +
++ + final + def + + + !=(arg0: Any): Boolean + +
++ + final + def + + + ##(): Int + +
++ + final + def + + + ==(arg0: AnyRef): Boolean + +
++ + final + def + + + ==(arg0: Any): Boolean + +
++ + final + def + + + asInstanceOf[T0]: T0 + +
++ + + def + + + clone(): AnyRef + +
++ + final + def + + + eq(arg0: AnyRef): Boolean + +
++ + + def + + + finalize(): Unit + +
++ + final + def + + + getClass(): Class[_] + +
++ + final + def + + + isInstanceOf[T0]: Boolean + +
++ + + val + + + line: Line + +
+The Line that was + parsed.
++ + final + def + + + ne(arg0: AnyRef): Boolean + +
++ + final + def + + + notify(): Unit + +
++ + final + def + + + notifyAll(): Unit + +
++ + final + def + + + synchronized[T0](arg0: ⇒ T0): T0 + +
++ + final + def + + + wait(): Unit + +
++ + final + def + + + wait(arg0: Long, arg1: Int): Unit + +
++ + final + def + + + wait(arg0: Long): Unit + +
+Inherited from Serializable
+Inherited from Serializable
+Inherited from Product
+Inherited from Equals
+Inherited from TAPEvent
+Inherited from AnyRef
+Inherited from Any
+Ungrouped
+ +ok
.def - diag(message: String): Unit + diag(message: Any): Unit
Writes a comment line to
Console.err
.Writes a comment line to
Console.err
. This will allow it to be @@ -390,15 +390,15 @@ tests.def - note(message: String): Unit + note(message: Any): Unit
Write a comment line to
Console.out
.Write a comment line to
Console.out
. This will typically only be diff --git a/com/iinteractive/test/tap/package.html b/com/iinteractive/test/tap/package.html index a0a10d0..f02f03a 100644 --- a/com/iinteractive/test/tap/package.html +++ b/com/iinteractive/test/tap/package.html @@ -125,6 +125,19 @@The end of a TAP stream.
++ + + case class + + + LineEvent extends TAPEvent with Product with Serializable + +
+A line was parsed.
- (case class)CommentEvent
- (object)Consumer
- (trait)Directive
- (case class)EndEvent
- (case class)ParseException
- (class)Parser
- (case class)PlanEvent
- (object)Producer
- (case class)ResultEvent
- (case class)SkipDirective
- (object)StartEvent
- (case class)SubtestEndEvent
- (object)SubtestStartEvent
- (trait)TAPEvent
- (class)TAPResult
- (class)TestBuilder
- (class)TestResult
- (case class)TodoDirective
+