Class: Cucumber::CLI

Inherits:
Object show all
Defined in:
lib/cucumber/cli.rb

Constant Summary collapse

FORMATS =
%w{pretty profile progress rerun}
DEFAULT_FORMAT =
'pretty'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(out_stream = STDOUT, error_stream = STDERR) ⇒ CLI

Returns a new instance of CLI.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# File 'lib/cucumber/cli.rb', line 33

def initialize(out_stream = STDOUT, error_stream = STDERR)
  @out_stream = out_stream

  @error_stream = error_stream
  @paths = []
  @options = {
    :strict   => false,
    :require  => nil,
    :lang     => 'en',
    :dry_run  => false,
    :formats  => {},
    :excludes => [],
    :tags     => [],
    :scenario_names => []
  }
  @active_format = DEFAULT_FORMAT
end

Instance Attribute Details

#optionsObject (readonly)

Returns the value of attribute options.



29
30
31
# File 'lib/cucumber/cli.rb', line 29

def options
  @options
end

#pathsObject (readonly)

Returns the value of attribute paths.



29
30
31
# File 'lib/cucumber/cli.rb', line 29

def paths
  @paths
end

Class Method Details

.execute(args) ⇒ Object



18
19
20
# File 'lib/cucumber/cli.rb', line 18

def execute(args)
  parse(args).execute!(@step_mother)
end

.parse(args) ⇒ Object



22
23
24
25
26
# File 'lib/cucumber/cli.rb', line 22

def parse(args)
  cli = new
  cli.parse_options!(args)
  cli
end

.step_mother=(step_mother) ⇒ Object



12
13
14
15
16
# File 'lib/cucumber/cli.rb', line 12

def step_mother=(step_mother)
  @step_mother = step_mother
  @step_mother.extend(StepMother)
  @step_mother.snippet_generator = StepDefinition
end

Instance Method Details

#execute!(step_mother) ⇒ Object



181
182
183
184
185
186
187
188
189
190
191
192
193
# File 'lib/cucumber/cli.rb', line 181

def execute!(step_mother)
  Cucumber.load_language(@options[:lang])
  require_files
  enable_diffing
  features = load_plain_text_features

  visitor = build_formatter_broadcaster(step_mother)
  visitor.options = @options
  visitor.visit_features(features)
  
  failure = features.steps[:failed].any? || (@options[:strict] && features.steps[:undefined].length)
  Kernel.exit(failure ? 1 : 0)
end

#parse_options!(args) ⇒ Object



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'lib/cucumber/cli.rb', line 51

def parse_options!(args)
  @args = args
  return parse_args_from_profile('default') if args.empty?
  args.extend(OptionParser::Arguable)

  args.options do |opts|
    opts.banner = ["Usage: cucumber [options] [[FILE[:LINE[:LINE]*]] | [FILES|DIRS]]", "",
      "Examples:",
      "cucumber examples/i18n/en/features",
      "cucumber --language it examples/i18n/it/features/somma.feature:6:98:113", "", ""
    ].join("\n")
    opts.on("-r LIBRARY|DIR", "--require LIBRARY|DIR", 
      "Require files before executing the features. If this",
      "option is not specified, all *.rb files that are",
      "siblings or below the features will be loaded auto-",
      "matically. Automatic loading is disabled when this",
      "option is specified, and all loading becomes explicit.",
      "Files under directories named \"support\" are always",
      "loaded first.",
      "This option can be specified multiple times.") do |v|
      @options[:require] ||= []
      @options[:require] << v
    end
    opts.on("-l LANG", "--language LANG", 
      "Specify language for features (Default: #{@options[:lang]})",
      %{Run with "--language help" to see all languages},
      %{Run with "--language LANG help" to list keywords for LANG}) do |v|
      if v == 'help'
        list_languages
      elsif args==['help']
        list_keywords(v)
      else
        @options[:lang] = v
      end
    end
    opts.on("-f FORMAT", "--format FORMAT", 
      "How to format features (Default: #{DEFAULT_FORMAT})",
      "Available formats: #{FORMATS.join(", ")}",
      "You can also provide your own formatter classes as long",
      "as they have been previously required using --require or",
      "if they are in the folder structure such that cucumber",
      "will require them automatically.", 
      "This option can be specified multiple times.") do |v|
      @options[:formats][v] = @out_stream
      @active_format = v
    end
    opts.on("-o", "--out FILE", 
      "Write output to a file instead of STDOUT. This option",
      "applies to the previously specified --format, or the",
      "default format if no format is specified.") do |v|
      @options[:formats][@active_format] = v
    end
    opts.on("-t TAGS", "--tags TAGS", 
      "Only execute the features or scenarios with the specified tags.",
      "TAGS must be comma-separated without spaces.") do |v|
      @options[:tags] = v.split(",")
    end
    opts.on("-s SCENARIO", "--scenario SCENARIO", 
      "Only execute the scenario with the given name. If this option",
      "is given more than once, run all the specified scenarios.") do |v|
      @options[:scenario_names] << v
    end
    opts.on("-e", "--exclude PATTERN", "Don't run feature files matching PATTERN") do |v|
      @options[:excludes] << v
    end
    opts.on("-p", "--profile PROFILE", "Pull commandline arguments from cucumber.yml.") do |v|
      parse_args_from_profile(v)
    end
    opts.on("-c", "--[no-]color",
      "Whether or not to use ANSI color in the output. Cucumber decides",
      "based on your platform and the output destination if not specified.") do |v|
      Term::ANSIColor.coloring = v
    end
    opts.on("-d", "--dry-run", "Invokes formatters without executing the steps.",
      "Implies --quiet.") do
      @options[:dry_run] = true
      @quiet = true
    end
    opts.on("-a", "--autoformat DIRECTORY", 
      "Reformats (pretty prints) feature files and write them to DIRECTORY.",
      "Be careful if you choose to overwrite the originals.",
      "Implies --dry-run --formatter pretty.") do |directory|
      @options[:autoformat] = directory
      Term::ANSIColor.coloring = false
      @options[:dry_run] = true
      @quiet = true
    end
    opts.on("-m", "--[no-]multiline", 
      "Don't print multiline strings and tables under steps.") do |v|
      @options[:source] = v
    end
    opts.on("-n", "--[no-]source", 
      "Don't show the file and line of the step definition with the steps.") do |v|
      @options[:source] = v
    end
    opts.on("-i", "--[no-]snippets", "Don't show the snippets for pending steps.") do |v|
      @options[:snippets] = v
    end
    opts.on("-q", "--quiet", "Alias for --no-snippets --no-source.") do
      @quiet = true
    end
    opts.on("-b", "--backtrace", "Show full backtrace for all errors.") do
      Exception.cucumber_full_backtrace = true
    end
    opts.on("--strict", "Fail if there are any undefined steps.") do
      @options[:strict] = true
    end
    opts.on("-v", "--verbose", "Show the files and features loaded.") do
      @options[:verbose] = true
    end
    opts.on_tail("--version", "Show version.") do
      @out_stream.puts VERSION::STRING
      Kernel.exit
    end
    opts.on_tail("--help", "You're looking at it.") do
      @out_stream.puts opts.help
      Kernel.exit
    end
  end.parse!

  @options[:formats]['pretty'] = @out_stream if @options[:formats].empty?

  @options[:snippets] = true if !@quiet && @options[:snippets].nil?
  @options[:source]   = true if !@quiet && @options[:source].nil?

  # Whatever is left after option parsing is the FILE arguments
  @paths += args
end