Skip to content

Commit

Permalink
Merge pull request #30 from hron/standart_cmd_args
Browse files Browse the repository at this point in the history 
Standardize command line args
  • Loading branch information
@e2
e2 committed Nov 10, 2015
2 parents c509f4e + f15bb56 commit e64ca5c
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 202 deletions.
67 changes: 30 additions & 37 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,57 +53,49 @@ Please read the [Guard documentation](http://github.com/guard/guard#readme) for

## Options

You can pass any of the standard Cucumber CLI options using the :cli option:
You can pass any of the standard Cucumber CLI options using the :cmd_additional_args option:

```ruby
guard 'cucumber', :cli => '-c --drb --port 1234 --profile guard'
guard 'cucumber', :cmd_additional_args => '-c --drb --port 1234 --profile guard'
```

Former `:color`, `:drb`, `:port` and `:profile` options are thus deprecated and have no effect anymore.
Former `:color`, `:drb`, `:port`, `:profile` and `:cli` options are thus deprecated and have no effect anymore.

### List of available options
You can specify custom cucumber command to run using the :cmd option:

```ruby
:cli => '--profile guard -c' # Pass arbitrary Cucumber CLI arguments,
# default: '--no-profile --color --format progress --strict'
guard 'cucumber', :cmd => 'spring cucumber'
```

:feature_sets => # Use non-default feature directory/ies
['set_a', 'set_b'] # default: ['features']
Former `:bundler`, `:bin_stubs`, `:change_format`, `:rvm` and `:command_prefix` options are thus deprecated and have no effect anymore.

:bundler => false # Don't use "bundle exec" to run the Cucumber command
# default: true

:binstubs => true # use "bin/cucumber" to run the Cucumber command (implies :bundler => true)
# default: false
### List of available options

:rvm => ['1.8.7', '1.9.2'] # Directly run your features on multiple ruby versions
# default: nil
```ruby
cmd: 'spring cucumber' # Specify custom cucumber command to run, default: 'cucumber'
cmd_additional_args: # Pass arbitrary Cucumber CLI arguments,
'--profile guard -c' # default: '--no-profile --color --format progress --strict'

:notification => false # Don't display Growl (or Libnotify) notification
feature_sets: # Use non-default feature directory/ies
['set_a', 'set_b'] # default: ['features']

notification: false # Don't display Growl (or Libnotify) notification
# default: true

:all_after_pass => false # Don't run all features after changed features pass
all_after_pass: false # Don't run all features after changed features pass
# default: true

:all_on_start => false # Don't run all the features at startup
all_on_start: false # Don't run all the features at startup
# default: true

:keep_failed => false # Keep failed features until they pass
keep_failed: false # Keep failed features until they pass
# default: true

:run_all => { :cli => "-p" } # Override any option when running all specs
run_all: {cmd: "-p"} # Override any option when running all specs
# default: {}

:change_format => 'pretty' # Use a different cucumber format when running individual features
# This replaces the Cucumber --format option within the :cli option
# default: nil

:command_prefix => 'xvfb-run' # Add a prefix to the cucumber command such as 'xvfb-run' or any
# other shell script.
# The example generates: 'xvfb-run bundle exec cucumber ...'
# default: nil

:focus_on => 'dev' # Focus on scenarios tagged with '@dev'
focus_on: 'dev' # Focus on scenarios tagged with '@dev'
# If '@dev' is on line 6 in 'foo.feature',
# this example runs: 'bundle exec cucumber foo.feature:6'
# default: nil
Expand All @@ -125,14 +117,14 @@ then the default profile forces guard-cucumber to always run all features, becau

If you want to configure Cucumber from Guard solely, then you should pass `--no-profile` to the `:cli` option.

Since guard-cucumber version 0.3.2, the default `:cli` options are:
Since guard-cucumber version 0.3.2, the default `:cmd_additional_args` options are:

```ruby
:cli => '--no-profile --color --format progress --strict'
cmd_additional_args: '--no-profile --color --format progress --strict'
```

This default configuration has been chosen to avoid strange behavior when mixing configurations from
the cucumber.yml default profile with the guard-cucumber `:cli` option.
the cucumber.yml default profile with the guard-cucumber `:cmd_additional_args` option.

You can safely remove `config/cucumber.yml`, since all configuration is done in the `Guardfile`.

Expand Down Expand Up @@ -161,7 +153,7 @@ guard 'spork' do
watch('spec/spec_helper.rb')
end

guard 'cucumber', :cli => '--drb --format progress --no-profile' do
guard 'cucumber', :cmd_additional_args => '--drb --format progress --no-profile' do
watch(%r{^features/.+\.feature$})
watch(%r{^features/support/.+$}) { 'features' }
watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
Expand All @@ -174,23 +166,24 @@ There is a section with alternative configurations on the [Wiki](https://github.

To use Guard::Cucumber with [Zeus](https://github.com/burke/zeus), just set the command prefix:
```
guard 'cucumber', :command_prefix => 'zeus', :bundler => false do
guard 'cucumber', :cmd => 'zeus cucumber' do
...
end
```

You need to set `:bundler => false` to avoid using Bundler, as recommended in the Zeus documenation.
Don't use `cmd: 'bundle exec zeus cucumber'` because Zeus recommends to avoid a bundler call.

## Cucumber with Spring

To use Guard::Cucumber with [Spring](https://github.com/jonleighton/spring), just set the command prefix:
```
guard 'cucumber', :command_prefix => 'spring', :bundler => false do
guard 'cucumber', :cmd => 'spring cucumber' do
...
end
```

You need to set `:bundler => false` to avoid using Bundler, as recommended in the Spring documenation.
Don't use `cmd: 'bundle exec zeus cucumber'` because Spring recommends to avoid a bundler call.


Issues
------
Expand Down
38 changes: 2 additions & 36 deletions lib/guard/cucumber/runner.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,33 +59,12 @@ def run(paths, options = {})
#
def cucumber_command(paths, options)
cmd = []
_add_cmd_prefix(cmd, options[:command_prefix])
_add_rvm_options(cmd, options[:rvm])
_add_bundler_options(cmd, options[:bundler])
cmd << cucumber_exec(options)
_add_cli_options(cmd, options[:cli])
_add_cli_options(cmd, options[:cmd] || "cucumber")
_add_notification(cmd, options)

_add_cli_options(cmd, options[:cmd_additional_args])
(cmd + paths).join(" ")
end

# Simple test if binstubs prefix should be used.
#
# @return [String] Cucumber executable
#
def cucumber_exec(options = {})
options[:binstubs] == true ? "bin/cucumber" : "cucumber"
end

# Simple test if bundler should be used. it just checks for the
# `Gemfile`.
#
# @return [Boolean] bundler exists
#
def bundler?
@bundler ||= File.exist?("#{ Dir.pwd }/Gemfile")
end

# Returns a null device for all OS.
#
# @return [String] the name of the null device
Expand All @@ -111,22 +90,9 @@ def _add_notification(cmd, options)
end.join(" ")
end

def _add_rvm_options(cmd, rvm_args)
return unless rvm_args.is_a?(Array)
cmd << "rvm #{ rvm_args.join(',') } exec"
end

def _add_bundler_options(cmd, bundler)
cmd << "bundle exec" if bundler? && bundler != false
end

def _add_cli_options(cmd, cli)
cmd << cli if cli
end

def _add_cmd_prefix(cmd, prefix)
cmd << prefix if prefix
end
end
end
end
Expand Down
147 changes: 18 additions & 129 deletions spec/guard/cucumber/runner_spec.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,48 +36,18 @@
end
end

context "with a :rvm option" do
it "executes cucumber through the rvm versions" do
req = @lib_path.join("guard/cucumber/notification_formatter.rb")
expect(runner).to receive(:system).with(
"rvm 1.8.7,1.9.2 exec bundle exec cucumber"\
" --require #{ req }"\
" --format Guard::Cucumber::NotificationFormatter"\
" --out #{ null_device }"\
" --require features features"
)
runner.run(["features"], rvm: ["1.8.7", "1.9.2"])
end
end

context "with a :command_prefix option" do
it "executes cucumber with the command_prefix option" do
req = @lib_path.join("guard/cucumber/notification_formatter.rb")
expect(runner).to receive(:system).with(
"xvfb-run bundle exec cucumber "\
"--require #{ req } "\
"--format Guard::Cucumber::NotificationFormatter "\
"--out #{ null_device } "\
"--require features features"
)
runner.run(["features"], command_prefix: "xvfb-run")
end
it "runs cucumber according to passed cmd option" do
req = @lib_path.join("guard/cucumber/notification_formatter.rb")
expect(runner).to receive(:system).with(
"xvfb-run bundle exec cucumber "\
"--require #{ req } "\
"--format Guard::Cucumber::NotificationFormatter "\
"--out #{ null_device } "\
"--require features features"
)
runner.run(["features"], cmd: "xvfb-run bundle exec cucumber")
end

context "with a :bundler option" do
it "runs without bundler when false" do
req = @lib_path.join("guard/cucumber/notification_formatter.rb")
expect(runner).to receive(:system).with(
"cucumber"\
" --require #{ req }"\
" --format Guard::Cucumber::NotificationFormatter"\
" --out #{ null_device }"\
" --require features features"
)
runner.run(["features"], bundler: false)
end
end


context "with a :focus_on option" do
it "passes the value in :focus_on to the Focuser" do
paths = ["features"]
Expand All @@ -93,104 +63,23 @@
end
end

describe ":binstubs" do
it "runs without Bundler with binstubs option to true and "\
"bundler option to false" do
req = @lib_path.join("guard/cucumber/notification_formatter.rb")
expect(subject).to receive(:system).with(
"bin/cucumber"\
" --require #{ req }"\
" --format Guard::Cucumber::NotificationFormatter"\
" --out #{ null_device }"\
" --require features features"
).and_return(true)
subject.run(["features"], bundler: false, binstubs: true)
end

it "runs with Bundler and binstubs with bundler option to true "\
"and binstubs option to true" do
req = @lib_path.join("guard/cucumber/notification_formatter.rb")
expect(subject).to receive(:system).with(
"bundle exec bin/cucumber"\
" --require #{ req }"\
" --format Guard::Cucumber::NotificationFormatter"\
" --out #{ null_device }"\
" --require features features"
).and_return(true)
subject.run(["features"], bundler: true, binstubs: true)
end

it "runs with Bundler and binstubs with bundler option unset "\
"and binstubs option to true" do
req = @lib_path.join("guard/cucumber/notification_formatter.rb")
expect(subject).to receive(:system).with(
"bundle exec bin/cucumber"\
" --require #{ req } "\
"--format Guard::Cucumber::NotificationFormatter "\
"--out #{ null_device }"\
" --require features features"
).and_return(true)
subject.run(["features"], binstubs: true)
end

it "runs with Bundler and binstubs with bundler option unset, "\
"binstubs option to true and all_after_pass option to true" do
req = @lib_path.join("guard/cucumber/notification_formatter.rb")
expect(subject).to receive(:system).with(
"bundle exec bin/cucumber"\
" --require #{ req } "\
"--format Guard::Cucumber::NotificationFormatter"\
" --out #{ null_device }"\
" --require features features"
).and_return(true)
subject.run(["features"], binstubs: true, all_after_pass: true)
end

it "runs with Bundler and binstubs with bundler option unset, "\
"binstubs option to true and all_on_start option to true" do
req = @lib_path.join("guard/cucumber/notification_formatter.rb")
expect(subject).to receive(:system).with(
"bundle exec bin/cucumber --require #{ req } "\
"--format Guard::Cucumber::NotificationFormatter "\
"--out #{ null_device } --require features features"
).and_return(true)
subject.run(["features"], binstubs: true, all_on_start: true)
end

it "runs with Bundler and binstubs with bundler option unset, "\
"binstubs option to true, all_on_start option to true and "\
"all_after_pass option to true" do
req = @lib_path.join("guard/cucumber/notification_formatter.rb")

expect(subject).to receive(:system).with(
"bundle exec bin/cucumber --require #{ req } "\
"--format Guard::Cucumber::NotificationFormatter "\
"--out #{ null_device } --require features features"
).and_return(true)

subject.run(
["features"],
binstubs: true,
all_after_pass: true,
all_on_start: true)
end
end

context "with a :cli option" do
context "with a :cmd_additional_args option" do
it "appends the cli arguments when calling cucumber" do
req = @lib_path.join("guard/cucumber/notification_formatter.rb")
expect(runner).to receive(:system).with(
"bundle exec cucumber --custom command --require #{req} "\
"cucumber --require #{req} "\
"--format Guard::Cucumber::NotificationFormatter "\
"--out #{ null_device } --require features features")
runner.run(["features"], cli: "--custom command")
"--out #{ null_device } --require features "\
"--custom command "\
"features")
runner.run(["features"], cmd_additional_args: "--custom command")
end
end

context "with a :notification option" do
it "does not add the guard notification listener" do
expect(runner).to receive(:system).with(
"bundle exec cucumber features"
"cucumber features"
)
runner.run(["features"], notification: false)
end
Expand Down

0 comments on commit e64ca5c

Please sign in to comment.