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

This task can also be configured to be run with RCov:

Cucumber::Rake::Task.new do |t|
  t.rcov = true
end

See the attributes for additional configuration possibilities.

Defined Under Namespace

Classes: ForkedCucumberRunner, InProcessCucumberRunner, RCovCucumberRunner

Constant Summary collapse

LIB =

:nodoc:

File.expand_path(File.dirname(__FILE__) + '/../..')

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Define Cucumber Rake task

Yields:

  • (_self)

Yield Parameters:



174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/cucumber/rake/task.rb', line 174

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)
  @libs.insert(0, LIB) if binary == Cucumber::BINARY

  define_task
end

Instance Attribute Details

#binary ⇒ Object

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



131
132
133
 
# File 'lib/cucumber/rake/task.rb', line 131

def binary
  @binary
end

#bundler ⇒ Object

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.



171
172
173
 
# File 'lib/cucumber/rake/task.rb', line 171

def bundler
  @bundler
end

#cucumber_opts ⇒ Object

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 ‘ ’.



135
136
137
 
# File 'lib/cucumber/rake/task.rb', line 135

def cucumber_opts
  @cucumber_opts
end

#fork ⇒ Object

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.



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

def fork
  @fork
end

#libs ⇒ Object

Directories to add to the Ruby $LOAD_PATH



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

def libs
  @libs
end

#profile ⇒ Object

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.



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

def profile
  @profile
end

#rcov ⇒ Object

Run cucumber with RCov? Defaults to false. If you set this to true, fork is implicit.



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

def rcov
  @rcov
end

#rcov_opts ⇒ Object

Extra options to pass to rcov. It’s recommended to pass an Array, but if it’s a String it will be #split by ‘ ’.



152
153
154
 
# File 'lib/cucumber/rake/task.rb', line 152

def rcov_opts
  @rcov_opts
end

Instance Method Details

#cucumber_opts_with_profile ⇒ Object

:nodoc:



206
207
208
 
# File 'lib/cucumber/rake/task.rb', line 206

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

#define_task ⇒ Object

:nodoc:



188
189
190
191
192
193
 
# File 'lib/cucumber/rake/task.rb', line 188

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

#feature_files ⇒ Object

:nodoc:



210
211
212
 
# File 'lib/cucumber/rake/task.rb', line 210

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

#make_command_line_safe(list) ⇒ Object 



214
215
216
 
# File 'lib/cucumber/rake/task.rb', line 214

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

#runner(task_args = nil) ⇒ Object

:nodoc:



195
196
197
198
199
200
201
202
203
204
 
# File 'lib/cucumber/rake/task.rb', line 195

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