Class: Cucumber::Rake::Task

Inherits:
Object show all
Includes:
Gherkin::Formatter::AnsiEscapes, Rake::DSL
Defined in:
lib/cucumber/rake/task.rb

Overview

Defines a Rake task for running features.

The simplest use of it goes something like:

Cucumber::Rake::Task.new

This will define a task named cucumber described as 'Run Cucumber features'. It will use steps from 'features/*/.rb' and features in 'features/*/.feature'.

To further configure the task, you can pass a block:

Cucumber::Rake::Task.new do |t|
  t.cucumber_opts = %w{--format progress}
end

See the attributes for additional configuration possibilities.

Defined Under Namespace

Classes: ForkedCucumberRunner, InProcessCucumberRunner

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Task) initialize(task_name = "cucumber", desc = "Run Cucumber features") {|_self| ... }

Define Cucumber Rake task

Yields:

  • (_self)

Yield Parameters:



130
131
132
133
134
135
136
137
138
# File 'lib/cucumber/rake/task.rb', line 130

def initialize(task_name = "cucumber", desc = "Run Cucumber features")
  @task_name, @desc = task_name, desc
  @fork = true
  @libs = ['lib']
  @rcov_opts = %w{--rails --exclude osx\/objc,gems\/}
  yield self if block_given?
  @binary = binary.nil? ? Cucumber::BINARY : File.expand_path(binary)
  define_task
end

Instance Attribute Details

- (Object) binary

Name of the cucumber binary to use for running features. Defaults to Cucumber::BINARY



104
105
106
# File 'lib/cucumber/rake/task.rb', line 104

def binary
  @binary
end

- (Object) bundler

Whether or not to run with bundler (bundle exec). Setting this to false may speed up the execution. The default value is true if Bundler is installed and you have a Gemfile, false otherwise.

Note that this attribute has no effect if you don't run in forked mode.



127
128
129
# File 'lib/cucumber/rake/task.rb', line 127

def bundler
  @bundler
end

- (Object) cucumber_opts

Extra options to pass to the cucumber binary. Can be overridden by the CUCUMBER_OPTS environment variable. It's recommended to pass an Array, but if it's a String it will be #split by ' '.



108
109
110
# File 'lib/cucumber/rake/task.rb', line 108

def cucumber_opts
  @cucumber_opts
end

- (Object) fork

Whether or not to fork a new ruby interpreter. Defaults to true. You may gain some startup speed if you set it to false, but this may also cause issues with your load path and gems.



116
117
118
# File 'lib/cucumber/rake/task.rb', line 116

def fork
  @fork
end

- (Object) libs

Directories to add to the Ruby $LOAD_PATH



101
102
103
# File 'lib/cucumber/rake/task.rb', line 101

def libs
  @libs
end

- (Object) profile

Define what profile to be used. When used with cucumber_opts it is simply appended to it. Will be ignored when CUCUMBER_OPTS is used.



120
121
122
# File 'lib/cucumber/rake/task.rb', line 120

def profile
  @profile
end

Instance Method Details

- (Object) cucumber_opts_with_profile

:nodoc:



155
156
157
# File 'lib/cucumber/rake/task.rb', line 155

def cucumber_opts_with_profile #:nodoc:
  @profile ? [cucumber_opts, '--profile', @profile] : cucumber_opts
end

- (Object) define_task

:nodoc:



140
141
142
143
144
145
# File 'lib/cucumber/rake/task.rb', line 140

def define_task #:nodoc:
  desc @desc
  task @task_name do
    runner.run
  end
end

- (Object) feature_files

:nodoc:



159
160
161
# File 'lib/cucumber/rake/task.rb', line 159

def feature_files #:nodoc:
  make_command_line_safe(FileList[ ENV['FEATURE'] || [] ])
end

- (Object) make_command_line_safe(list)



163
164
165
# File 'lib/cucumber/rake/task.rb', line 163

def make_command_line_safe(list)
  list.map{|string| string.gsub(' ', '\ ')}
end

- (Object) runner(task_args = nil)

:nodoc:



147
148
149
150
151
152
153
# File 'lib/cucumber/rake/task.rb', line 147

def runner(task_args = nil) #:nodoc:
  cucumber_opts = [(ENV['CUCUMBER_OPTS'] ? ENV['CUCUMBER_OPTS'].split(/\s+/) : nil) || cucumber_opts_with_profile]
  if(@fork)
    return ForkedCucumberRunner.new(libs, binary, cucumber_opts, bundler, feature_files)
  end
  InProcessCucumberRunner.new(libs, cucumber_opts, feature_files)
end