Class: Cucumber::Rake::Task

Inherits:
Object
  • 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

Constant Summary

Constants included from Gherkin::Formatter::AnsiEscapes

Gherkin::Formatter::AnsiEscapes::ALIASES, Gherkin::Formatter::AnsiEscapes::COLORS

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Gherkin::Formatter::AnsiEscapes

#reset, #up

Constructor Details

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

Define Cucumber Rake task

Yields:

  • (_self)

Yield Parameters:


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

def initialize(task_name = 'cucumber', desc = 'Run Cucumber features')
  @task_name = task_name
  @desc = 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

#binaryObject

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


110
111
112
# File 'lib/cucumber/rake/task.rb', line 110

def binary
  @binary
end

#bundlerObject

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.


133
134
135
# File 'lib/cucumber/rake/task.rb', line 133

def bundler
  @bundler
end

#cucumber_optsObject

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 ' '.


114
115
116
# File 'lib/cucumber/rake/task.rb', line 114

def cucumber_opts
  @cucumber_opts
end

#forkObject

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.


122
123
124
# File 'lib/cucumber/rake/task.rb', line 122

def fork
  @fork
end

#libsObject

Directories to add to the Ruby $LOAD_PATH


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

def libs
  @libs
end

#profileObject

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.


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

def profile
  @profile
end

Instance Method Details

#cucumber_opts_with_profileObject

:nodoc:


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

def cucumber_opts_with_profile #:nodoc:
  Array(cucumber_opts).concat(Array(@profile).flat_map { |p| ['--profile', p] })
end

#define_taskObject

:nodoc:


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

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

#feature_filesObject

:nodoc:


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

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

#make_command_line_safe(list) ⇒ Object


168
169
170
# File 'lib/cucumber/rake/task.rb', line 168

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

#runner(_task_args = nil) ⇒ Object

:nodoc:


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

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