Skip to content

Commit

Permalink
(BKR-1393) Update documentation on multiple arguments to subcommand e…
Browse files Browse the repository at this point in the history
…xec (#1528)

* (BKR-1393) Update exec help description

Clarify behavior to support passing multiple test files, directories, or suites as a comma-separated list, as long as that list is homogeneous.

* (BKR-1393) Update docs/tutorials/subcommands.md

Clarify that exec accepts comma-separated list of tests.
  • Loading branch information
Dakta authored and kevpl committed Jul 2, 2018
1 parent 11881cc commit dcee653
Showing 2 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/tutorials/subcommands.md
Original file line number Diff line number Diff line change
@@ -22,7 +22,7 @@ Provisions hosts defined in your `subcommand_options file`. You can pass the `--

### beaker exec

Run a single file, directory, or Beaker suite. If supplied a file or directory, that resource will be run in the context of the `tests` suite; if supplied a Beaker suite, then just that suite will run. If no resource is supplied, then this command executes the suites as they are defined in the configuration in the `subcommand_options.yaml`.
Run either files, directories, or beaker suites. If supplied a file or directory, that resource will be run in the context of the `tests` suite; If supplied a beaker suite, then just that suite will run. If no resource is supplied, then this command executes the suites as they are defined in the configuration. Accepts a comma-separated, homogeneous list. E.g. only files, only directories, or only suites, such as: `exec pre-suite,tests`

### beaker destroy

8 changes: 5 additions & 3 deletions lib/beaker/subcommand.rb
Original file line number Diff line number Diff line change
@@ -149,12 +149,14 @@ def provision()
end
end

desc 'exec FILE/BEAKER_SUITE', 'execute a directory, file, or beaker suite'
desc 'exec FILE(S)/BEAKER_SUITE', 'execute directories, files, or beaker suites'
long_desc <<-LONG_DESC
Run a single file, directory, or beaker suite. If supplied a file or directory,
Run either files, directories, or beaker suites. If supplied a file or directory,
that resource will be run in the context of the `tests` suite; If supplied a beaker
suite, then just that suite will run. If no resource is supplied, then this command
executes the suites as they are defined in the configuration.
executes the suites as they are defined in the configuration. Accepts a comma
-separated, homogeneous list. E.g. only files, only directories, or only suites,
such as: exec pre-suite,tests
LONG_DESC
option :help, :type => :boolean, :hide => true
def exec(resource=nil)

0 comments on commit dcee653

Please sign in to comment.