Skip to content
Browse files

Updated README.

  • Loading branch information...
1 parent 42d37c8 commit 9623fb6583ccd057e90f089e8e41b29b6dea16ed @apeiros apeiros committed Mar 18, 2010
Showing with 52 additions and 40 deletions.
  1. +52 −40 README.rdoc
View
92 README.rdoc
@@ -87,48 +87,44 @@ right one: `rake gem:install GEM=gem1.9`
Usage:
- baretest [options] [glob, ...]
-
- Glob defaults to 'test/**/*.rb'
- Providing a directory as glob is equivalent to dir/**/*.rb
- Options:
- -f, --format FORMAT use FORMAT for output
- -F, --formats show available formats
- -d, --debug set debugging flags (set $DEBUG to true)
- -i, --interactive drop into IRB on error or failure
- -s, --setup FILE specify setup file
- -v, --version print the version and exit
- -w, --warn turn warnings on for your script
-
-
-
-== Planned Features
-
-* Word-wrapping for CLI runner
-* baretest --init \[LAYOUT], to create the necessary directory structure
-* Detect whether baretest is run from an interactive terminal or not and adjust
- defaults (no-color e.g.)
-* Alternative CLI runner with status implicit via colored/bg-colored descriptions
-* Alternative CLI runner which prints the name of the test prior the label and rewrites
- the line when the test has executed to add status & coloring.
-* Simple stubbing with automatic cleanup at teardown. Example:
-
- assert "Should require a single file listed in :requires option." do |a|
- file = 'foo/bar'
- stub(Kernel, :require) do |file, *args| a.touch(file) end
- ::Test::Suite.create(nil, nil, :requires => file)
+ baretest [command] [options] *(selector | -selector)
+ command: The command to run. See `baretest commands`
+ options: The flags and options, see in the "Options" section.
+ selector: The tests to run. Example:
+ baretest -- test/suite/a -test/suite/a/x @tag -@other %failure -%pending
+ Defaults to 'test/{suite,unit,integration,system}
+ See `baretest selectors` to get more information
- touched file
- end
-
-* A redmine plugin
-* --fail-all flag, to test/review diagnostics of tests (no idea how to do that yet)
-
-
-
-== Rejected Features
+ Default command is 'run', which runs the testsuite or the provided testfiles.
+
+ Options:
+
+ --commands overview over the commands
+ -d, --debug set debugging flags (set $DEBUG to true)
+ -i, --interactive drop into IRB on error or failure. Use 'help!' in the irb session for more information
+ -f, --format FORMAT use FORMAT for output, see `baretest formats`
+ -s, --setup FILE specify setup file
+ -w, --warn turn warnings on for your script
+ -h, --help help for usage and flags
+ -v, --version print the version and exit
+ --init Deprecated form for `baretest --init`
+
+ Options for 'CLI' formatter:
+
+ -c, --[no-]color Enable/disable output coloring
+ -p, --[no-]profile Enable/disable profiling assertions
+
+ Environment variables for 'CLI' formatter:
+
+ * COLOR Enable/disable output coloring
+ * PROFILE Enable/disable profiling assertions
+
+ Environment variables:
+
+ * FORMAT use FORMAT for output, see `baretest formats`
+ * VERBOSE turn warnings on for your script
+ * INTERACTIVE drop into IRB on error or failure. Use 'help!' in the irb session for more information
-* Currently none
== A Bit of Background
@@ -251,13 +247,29 @@ From examples/test.rb:
* Tass
* adding rr integration
* reporting bugs
+* robgleeson
+ * Introducing me to rack-test
+ * Feedback
+
+
== Known bugs
Currently none.
+== Known issues
+
+* A setup that raises an exception will cause all teardowns to not be executed.
+ This will change in a future release as follows: a setup that raises an
+ exception will only cause teardowns defined on the same suite not to be
+ executed.
+* --interactive can't be used to investigate problems in setup or teardown
+* Inherited skip reasons are not reported
+
+
+
== Foot Notes
<sup>1</sup>:: The abbreviated form without support code and output formatters.
The normal code is expanded to more lines for readability.

0 comments on commit 9623fb6

Please sign in to comment.
Something went wrong with that request. Please try again.