Guard::Cucumber

Guard::Cucumber allows you to automatically run Cucumber features when files are modified.

Supported Ruby versions are those tested on Travis CI. (NOTE: Any Ruby version earlier than 2.2.5 is outdated and likely insecure).

If you have any questions please join us on our Google group or on #guard (irc.freenode.net).

Install

The simplest way to install Guard is to use Bundler. Please make sure to have Guard installed before continue.

Add Guard::Cucumber to your Gemfile:

group :development do
  gem 'guard-cucumber'
end

Add the default Guard::Cucumber template to your Guardfile by running:

$ guard init cucumber

Usage

Please read the Guard usage documentation.

Guardfile

Guard::Cucumber can be adapted to all kind of projects and comes with a default template that looks like this:

guard 'cucumber' 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' }
end

Expressed in plain English, this configuration tells Guard::Cucumber:

1. When a file within the features directory that ends in feature is modified, just run that single feature.
2. When any file within features/support directory is modified, run all features.
3. When a file within the features/step_definitions directory that ends in _steps.rb is modified, run the first feature that matches the name (_steps.rb replaced by .feature) and when no feature is found, then run all features.

Please read the Guard documentation for more information about the Guardfile DSL.

Options

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

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

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

You can specify custom cucumber command to run using the :cmd option:

guard 'cucumber', :cmd => 'spring cucumber'

Former :bundler, :bin_stubs, :change_format, :rvm and :command_prefix options are thus deprecated and have no effect anymore.

List of available options

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'

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
                                  # default: true

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

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

run_all: {cmd_additional_args: "--format pretty"}              # Override any option when running all specs
                                  # default: {}

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

Cucumber configuration

It's very important that you understand how Cucumber gets configured, because it's often the origin of strange behavior of guard-cucumber.

Cucumber uses cucumber.yml for defining profiles of specific run configurations. When you pass configurations through the :cli option but don't include a specific profile with --profile, then the configurations from the default profile are also used.

For example, when you're using the default cucumber.yml generated by cucumber-rails, then the default profile forces guard-cucumber to always run all features, because it appends the features folder.

Configure Cucumber solely from Guard

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 :cmd_additional_args options are:

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 :cmd_additional_args option.

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

Use a separate Guard profile

If you're using different profiles with Cucumber then you should create a profile for Guard in cucumber.yml, something like this:

guard: --format progress --strict --tags ~@wip

Now you want to make guard-cucumber use that profile by passing --profile guard to the :cli.

Cucumber with Spork

To use Guard::Cucumber with Spork, you should install Guard::Spork and use the following configuration:

guard 'spork' do
  watch('config/application.rb')
  watch('config/environment.rb')
  watch(%r{^config/environments/.*\.rb$})
  watch(%r{^config/initializers/.*\.rb$})
  watch('spec/spec_helper.rb')
end

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' }
end

There is a section with alternative configurations on the Wiki.

Cucumber with Zeus

To use Guard::Cucumber with Zeus, just set the command prefix:

guard 'cucumber', :cmd => 'zeus cucumber' do
  ...
end

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, just set the command prefix:

guard 'cucumber', :cmd => 'spring cucumber' do
  ...
end

Don't use cmd: 'bundle exec zeus cucumber' because Spring recommends to avoid a bundler call.

Issues

You can report issues and feature requests to GitHub Issues. Try to figure out where the issue belongs to: Is it an issue with Guard itself or with Guard::Cucumber? Please don't ask question in the issue tracker, instead join us in our Google group or on #guard (irc.freenode.net).

When you file an issue, please try to follow to these simple rules if applicable:

• Make sure you run Guard with bundle exec first.
• Add debug information to the issue by running Guard with the --debug option.
• Add your Guardfile and Gemfile to the issue.
• Make sure that the issue is reproducible with your description.

Development

• Documentation hosted at RubyDoc.
• Source hosted at GitHub.

Pull requests are very welcome! Please try to follow these simple rules if applicable:

• Please create a topic branch for every separate change you make.
• Make sure your patches are well tested.
• Update the Yard documentation.
• Update the README.
• Update the CHANGELOG for noteworthy changes.
• Please do not change the version number.

For questions please join us in our Google group or on #guard (irc.freenode.net).

Author

Developed by Michael Kessler, sponsored by FlinkFinger.

If you like Guard::Cucumber, you can watch the repository at GitHub and follow @netzpirat on Twitter for project updates.

Contributors

See the GitHub list of contributors.

Since guard-cucumber is very close to guard-rspec, some contributions by the following authors have been incorporated into guard-cucumber:

• Andre Arko
• Thibaud Guillaume-Gentil

Acknowledgment

The Guard Team for giving us such a nice pice of software that is so easy to extend, one has to make a plugin for it!

All the authors of the numerous Guards available for making the Guard ecosystem so much growing and comprehensive.

License

(The MIT License)

Copyright (c) 2010-2013 Michael Kessler

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.