Author: vborja
Date: Tue Sep 23 12:14:22 2008
New Revision: 698309
URL: http://svn.apache.org/viewvc?rev=698309&view=rev
Log:
More documentation on JtestR/RSpec options
Modified:
incubator/buildr/trunk/doc/pages/languages.textile
Modified: incubator/buildr/trunk/doc/pages/languages.textile
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/languages.textile?rev=698309&r1=698308&r2=698309&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/languages.textile (original)
+++ incubator/buildr/trunk/doc/pages/languages.textile Tue Sep 23 12:14:22 2008
@@ -353,8 +353,16 @@
Supports the following options:
|_. Option |_. Value |
+| @:gems@ | Hash of gems needed before running the tests.
+ Keys are gem names, values are the required gem version.
+ An example use of this option would be to require the
ci_reporter gem to generate xml reports |
+| @:requires@ | Array of ruby files to require before running the specs |
+| @:format@ | Array of valid RSpec @--format@ option values.
+ Defaults to html report on the @reports@ directory and
text progress |
+| @:output@ | File path to output dump. @false@ to supress output |
+| @:fork@ | Run the tests on a new java vm. (enabled unless running on
JRuby) |
| @:properties@ | Hash of system properties available to the test case. |
-| @:java_args@ | Arguments passed as is to the JVM. |
+| @:java_args@ | Arguments passed as is to the JVM. (only when fork is
enabled) |
h4. JtestR
@@ -375,13 +383,23 @@
| "TestNG":http://testng.org | Classes from @src/test/java@ annotated with
@org.testng.annotations.Test@ |
If you create a @src/spec/ruby/jtestr_config.rb@ file, it will be loaded by
JtestR, just after being configured
-by Buildr, this way you can add helpers or anything described on the "JtestR
guide":http://jtestr.codehaus.org/Configuration
+by Buildr, this way you can configure as described on "JtestR
guide":http://jtestr.codehaus.org/Configuration.
+
+p(tip). If you have a @jtestr_config.rb@ file, don't set @JtestR::[EMAIL
PROTECTED] Buildr uses its (@RSpecResultHandler@)
+so that it can know which tests succeeded/failed, this handler is capable of
using RSpec formatter classes, so that
+you can obtain an html report or use a custom rspec formatter with @[EMAIL
PROTECTED] See the @format@ option.
Supports the following options:
|_. Option |_. Value |
| @:config@ | The JtestR config file to be loaded after being configured
by Buildr. Defaults to @src/spec/ruby/[EMAIL PROTECTED] |
-| @:output@ | A file path where to store JtestR output. @false@ to
suppress output, @true@ to use standard output. |
-| @:properties@ | Hash of system properties available to the test case. |
-| @:java_args@ | Arguments passed as is to the JVM. |
-
+| @:gems@ | Hash of gems needed before running the tests.
+ Keys are gem names, values are the required gem version.
+ An example use of this option would be to require the
ci_reporter gem to generate xml reports |
+| @:requires@ | Array of ruby files to require before running the specs |
+| @:format@ | Array of valid RSpec @--format@ option values.
+ Defaults to html report on the @reports@ directory and
text progress |
+| @:output@ | File path to output dump. @false@ to supress output |
+| @:fork@ | Run the tests on a new java vm. (enabled unless running on
JRuby) |
+| @:properties@ | Hash of system properties available to the test case.
(only when fork is enabled) |
+| @:java_args@ | Arguments passed as is to the JVM. (only when fork is
enabled) |
