cucumber 6.1.0 → 7.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +256 -166
- data/CONTRIBUTING.md +217 -52
- data/README.md +133 -13
- data/lib/cucumber/cli/options.rb +1 -1
- data/lib/cucumber/events.rb +1 -1
- data/lib/cucumber/formatter/ansicolor.rb +0 -7
- data/lib/cucumber/formatter/console.rb +11 -3
- data/lib/cucumber/formatter/message.rb +2 -1
- data/lib/cucumber/formatter/message_builder.rb +8 -8
- data/lib/cucumber/formatter/pretty.rb +19 -18
- data/lib/cucumber/formatter/publish_banner_printer.rb +1 -1
- data/lib/cucumber/formatter/steps.rb +5 -2
- data/lib/cucumber/formatter/usage.rb +6 -4
- data/lib/cucumber/gherkin/data_table_parser.rb +1 -1
- data/lib/cucumber/gherkin/steps_parser.rb +1 -1
- data/lib/cucumber/glue/dsl.rb +19 -0
- data/lib/cucumber/glue/registry_and_more.rb +29 -0
- data/lib/cucumber/glue/registry_wrapper.rb +31 -0
- data/lib/cucumber/glue/step_definition.rb +3 -4
- data/lib/cucumber/runtime.rb +32 -2
- data/lib/cucumber/version +1 -1
- metadata +40 -40
- data/lib/cucumber/core_ext/string.rb +0 -11
data/CONTRIBUTING.md
CHANGED
@@ -1,85 +1,250 @@
|
|
1
|
-
|
1
|
+
# Contributing to Cucumber
|
2
2
|
|
3
|
-
|
3
|
+
Thank you for considering contributing to Cucumber!
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
- Reporting a bug? Please tell us:
|
8
|
-
- which version of Cucumber you're using
|
9
|
-
- which version of Ruby you're using.
|
10
|
-
- How to reproduce it. Bugs with a failing test in a [pull request](https://help.github.com/articles/using-pull-requests) get fixed much quicker. Some bugs may never be fixed.
|
11
|
-
- Want to paste some code or output? Put \`\`\` on a line above and below your code/output. See [GFM](https://help.github.com/articles/github-flavored-markdown)'s _Fenced Code Blocks_ for details.
|
12
|
-
- We love [pull requests](https://help.github.com/articles/using-pull-requests). But if you don't have a test to go with it we probably won't merge it.
|
5
|
+
This document will first introduce different ways to get involved before
|
6
|
+
focusing on how to contribute to the code.
|
13
7
|
|
14
|
-
|
8
|
+
## Code of Conduct
|
9
|
+
|
10
|
+
Everyone interacting in this codebase and issue tracker is expected to follow
|
11
|
+
the Cucumber [code of conduct](https://cucumber.io/conduct).
|
12
|
+
|
13
|
+
## How can I contribute?
|
14
|
+
|
15
|
+
If you're reading this, you are certainly looking to contribute to the code. Cucumber
|
16
|
+
is not this single repository. It is made up of several packages around several
|
17
|
+
repositories. So before going further with the code, you may consider the
|
18
|
+
following first, in order to get your bearings.
|
19
|
+
|
20
|
+
If you just want to know how to contribute to the code, go to
|
21
|
+
[Contribute to the code](#contribute-to-the-code).
|
22
|
+
|
23
|
+
If you want to report an issue, or suggest an enhancement, go to
|
24
|
+
[Report bugs and submit feature requests](#report-bugs-and-submit-feature-requests).
|
25
|
+
|
26
|
+
### Meet the community, the maintainers, and other Cucumber developers
|
27
|
+
|
28
|
+
Smartbear hosts a [community message board].
|
29
|
+
This is a good place to meet users, the community, and to ask questions.
|
30
|
+
|
31
|
+
You can also join the Cucumber Community Slack:
|
32
|
+
[register for an account][register-slack] then head over to [#intro][slack-intro].
|
33
|
+
This is the place to be to meet other contributors and find a mentor to help you
|
34
|
+
get started.
|
35
|
+
|
36
|
+
### Test Cucumber
|
37
|
+
|
38
|
+
Testing Cucumber, especially new features, is a great way to contribute. We
|
39
|
+
cannot put a price on (early) feedback.
|
40
|
+
|
41
|
+
Keep an eye on our CHANGELOGS to discover new features. Test and experiment, and
|
42
|
+
submit your feedback through [issues](#report-bugs-and-submit-feature-requests),
|
43
|
+
the [community message board], or [Slack][community-slack].
|
44
|
+
|
45
|
+
### Contribute to the documentation
|
46
|
+
|
47
|
+
[The documentation][cucumber-docs] is an important part of Cucumber. It is
|
48
|
+
essential that it remains simple and accurate. You can contribute to it via
|
49
|
+
[github.com/cucumber/docs](https://github.com/cucumber/docs).
|
50
|
+
|
51
|
+
### Promote Cucumber
|
52
|
+
|
53
|
+
You don't know how to contribute but would like to help? Telling other people
|
54
|
+
about Cucumber on the Internet - social media, reviews, blogs - but also in real
|
55
|
+
life is already a big help! Join us on [Slack][community-slack] to share your
|
56
|
+
publication and to discover new ones.
|
57
|
+
|
58
|
+
## Report bugs and submit feature requests
|
59
|
+
|
60
|
+
The short version is:
|
61
|
+
|
62
|
+
- Find the appropriate repository
|
63
|
+
- Try to check there is not already an issue or pull request that deals with
|
64
|
+
your bug or request
|
65
|
+
- Explain your issue and include as much details as possible to help other
|
66
|
+
people reproduce your problem or understand your request
|
67
|
+
- Consider submitting a pull request if you feel confident enough
|
68
|
+
|
69
|
+
You can find more details for each of these steps in the following sections.
|
70
|
+
|
71
|
+
### Find the appropriate repository
|
72
|
+
|
73
|
+
The current repository, `cucumber-ruby`, is actually the tip of the iceberg. It
|
74
|
+
provides a user interface through a CLI, some built-in formatters, and the
|
75
|
+
execution environment you may know as the `World` object.
|
76
|
+
|
77
|
+
An important repository is [cucumber/common]. It is a mono-repo
|
78
|
+
with a lot of libraries. You will find there what is related to:
|
79
|
+
|
80
|
+
- parsing Gherkin documents - aka `.feature` files
|
81
|
+
- parsing tag expressions - the options you use to filter an execution with tags
|
82
|
+
- parsing Cucumber expressions - the expressions that link a Gherkin step to a
|
83
|
+
step definition
|
84
|
+
- everyting related to the HTML formatter
|
85
|
+
|
86
|
+
`cucumber-ruby` is also composed of:
|
87
|
+
|
88
|
+
- [cucumber-ruby-core]: this is the engine that will execute the test cases
|
89
|
+
computed from a parsed Gherkin document
|
90
|
+
- [cucumber-ruby-wire]: everything related to the Cucumber's wire protocol
|
91
|
+
|
92
|
+
Last but not least, there is also a repository for [cucumber-rails], the gem
|
93
|
+
that brings Cucumber to Rails 5.x and 6.x.
|
15
94
|
|
16
|
-
|
95
|
+
In any case, if your are not sure, best places to open an issue are the current
|
96
|
+
repository - `cucumber-ruby` - and the mono-repo at [cucumber/common].
|
17
97
|
|
18
|
-
|
98
|
+
### Look for existing issues and pull requests
|
19
99
|
|
20
|
-
|
100
|
+
Search in [the current repository][cucumber-ruby-issues], in the
|
101
|
+
[mono-repo][cucumber/common-issues], but also in the
|
102
|
+
[whole cucumber organization][cucumber-issues] if the problem or feature has already
|
103
|
+
been reported. If you find an issue or pull request which is still open, add
|
104
|
+
comments to it instead of opening a new one.
|
21
105
|
|
22
|
-
|
106
|
+
If you're not sure, don't hesitate to just open a new issue. We can always merge
|
107
|
+
and de-duplicate later.
|
23
108
|
|
24
|
-
|
25
|
-
Execute `bundle config set --local gemfile Gemfile.local` to use it per default.
|
109
|
+
### Submitting a pull request
|
26
110
|
|
27
|
-
|
111
|
+
When submitting a pull request:
|
112
|
+
|
113
|
+
- create a [draft pull request][how-to-create-a-draft-pr]
|
114
|
+
- try to follow the instructions in the [template](.github/PULL_REQUEST_TEMPLATE.md)
|
115
|
+
- if possible, [sign your commits]
|
116
|
+
- update CHANGELOG.md with your changes
|
117
|
+
- once the PR is ready, request for reviews
|
118
|
+
|
119
|
+
More info on [how to contribute to the code](#contribute-to-the-code) can be
|
120
|
+
found below.
|
121
|
+
|
122
|
+
### Opening a new issue
|
123
|
+
|
124
|
+
To open a good issue, be clear and precise.
|
125
|
+
|
126
|
+
If you report a problem, the reader must be able to reproduce it easily.
|
127
|
+
Please do your best to create a [minimal, reproducible example][minimal-reproducible-example].
|
128
|
+
|
129
|
+
Consider submitting a pull request. Even if you think you cannot fix it by
|
130
|
+
yourself, a pull request with a failing test is always welcome.
|
131
|
+
|
132
|
+
If you request is for an enhancement - a new feature - try to be specific and
|
133
|
+
support your request with referenced facts and include examples to illustrate
|
134
|
+
your proposal.
|
135
|
+
|
136
|
+
## Contribute to the code
|
137
|
+
|
138
|
+
### Development environment
|
139
|
+
|
140
|
+
Development environment for `cucumber-ruby` is a simple Ruby environment with
|
141
|
+
Bundler. Use a [supported Ruby version](./README.md#supported-platforms), make
|
142
|
+
sure [Bundler] is set-up, and voilà!
|
143
|
+
|
144
|
+
You can then [fork][how-to-fork] and clone the repository. If your environment
|
145
|
+
is set-up properly, the following commands should install the dependencies and
|
146
|
+
execute all the tests successfully.
|
147
|
+
|
148
|
+
```shell
|
149
|
+
bundle install
|
150
|
+
bundle exec rake
|
151
|
+
```
|
152
|
+
|
153
|
+
You can now create a branch for your changes and [submit a pull request](#submitting-a-pull-request)!
|
154
|
+
|
155
|
+
If you want to check the code coverage during your development, execute
|
156
|
+
`bundle exec rake cov`.
|
157
|
+
|
158
|
+
### Cucumber-ruby-core
|
159
|
+
|
160
|
+
As seen here: [Find the appropriate repository](#find-the-appropriate-repository),
|
161
|
+
you may need to work with other repositories in order to accomplish your
|
162
|
+
development. Beside the mono-repo in [cucumber/common], [cucumber-ruby-core] is
|
163
|
+
also a big piece of `cucumber-ruby`.
|
164
|
+
|
165
|
+
### Using a local Gemfile
|
166
|
+
|
167
|
+
A local Gemfile allows you to use your prefer set of gems for your own
|
168
|
+
development workflow, like gems dedicated to debugging. Such gems are not part
|
169
|
+
of `cucumber-ruby` standard `Gemfile`.
|
170
|
+
|
171
|
+
`Gemfile.local`, `Gemfile.local.lock` and `.bundle` have been added to
|
172
|
+
`.gitignore` so local changes cannot be accidentaly commited and pushed to the
|
173
|
+
repository.
|
174
|
+
|
175
|
+
A `Gemfile.local` may look like this:
|
28
176
|
|
29
177
|
```ruby
|
178
|
+
# Gemfile.local
|
179
|
+
|
30
180
|
# Include the regular Gemfile
|
31
181
|
eval File.read('Gemfile')
|
32
182
|
|
183
|
+
# Include your favorites development gems
|
33
184
|
group :development do
|
34
185
|
gem 'byebug'
|
35
|
-
gem 'debase', require: false
|
36
|
-
gem 'ruby-debug-ide', require: false
|
37
186
|
gem 'pry'
|
38
187
|
gem 'pry-byebug'
|
188
|
+
|
189
|
+
gem 'debase', require: false
|
190
|
+
gem 'ruby-debug-ide', require: false
|
39
191
|
end
|
40
192
|
```
|
41
193
|
|
42
|
-
|
194
|
+
Then you can execute bundler with the `--gemfile` flag:
|
195
|
+
`bundle install --gemfile Gemfile.local`, or with an environment variable:
|
196
|
+
`BUNDLE_GEMFILE=Gemfile.local bundle [COMMAND]`.
|
197
|
+
|
198
|
+
To use your local Gemfile per default, you can also execute
|
199
|
+
`bundle config set --local gemfile Gemfile.local`.
|
43
200
|
|
44
|
-
|
45
|
-
[docs/vscode-example-launch-configuration.md](https://github.com/cucumber/cucumber-ruby/blob/main/docs/vscode-example-launch-configuration.md)
|
201
|
+
### First timer? Welcome!
|
46
202
|
|
47
|
-
|
203
|
+
Looking for something simple to begin with? Look at issues with the label
|
204
|
+
'[good first issue](https://github.com/cucumber/cucumber-ruby/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)'.
|
48
205
|
|
49
|
-
|
50
|
-
|
51
|
-
- Make sure your patch is well covered by tests. We don't accept changes to Cucumber that aren't tested.
|
52
|
-
- Please do not change the Rakefile, version, or history.
|
53
|
-
(if you want to have your own version, that is fine but
|
54
|
-
bump version in a commit by itself so we can ignore when we merge your change)
|
55
|
-
- Send us a pull request.
|
206
|
+
Remember: Cucumber is more than `cucumber-ruby`. You can look for good first
|
207
|
+
issues in [other cucumber reporistories](#find-the-appropriate-repository).
|
56
208
|
|
57
|
-
|
209
|
+
### Having trouble getting started with the code? We're here to help!
|
58
210
|
|
59
|
-
|
60
|
-
|
61
|
-
|
211
|
+
If you have trouble setting-up your development environment, or getting started
|
212
|
+
with the code, you can join us on [Slack][community-slack]. You will find there
|
213
|
+
a lot of contributors.
|
62
214
|
|
63
|
-
|
215
|
+
Full-time maintainers are also available. We would be please to have 1:1 pairing
|
216
|
+
sessions to help you getting started. Look for
|
217
|
+
[Matt Wynne](https://cucumberbdd.slack.com/team/U590XDLF3) or
|
218
|
+
[Aurélien Reeves](https://cucumberbdd.slack.com/team/U011BB95MC7) on
|
219
|
+
[Slack][community-slack].
|
64
220
|
|
65
|
-
|
221
|
+
### Additional documentation and notice
|
66
222
|
|
67
|
-
|
68
|
-
|
69
|
-
help us to correct style violations reported here:
|
70
|
-
[.rubocop_todo.yml](https://github.com/cucumber/cucumber-ruby/blob/main/.rubocop_todo.yml).
|
223
|
+
You can find additional documentation in the [docs](./docs) directory such as
|
224
|
+
(non-exhaustive list):
|
71
225
|
|
72
|
-
|
226
|
+
- [How to release cucumber-ruby](./docs/RELEASE_PROCESS.md) (for maintainers)
|
227
|
+
- [How to set-up a launch.json configuration for Visual Studio Code](./docs/vscode-example-launch-configuration.md)
|
73
228
|
|
74
|
-
- Upgrade gems with `scripts/update-gemspec`
|
75
|
-
- Bump the version number in `lib/cucumber/version`
|
76
|
-
- Update `CHANGELOG.md` with the upcoming version number and create a new `In Git` section
|
77
|
-
- Remove empty sections from `CHANGELOG.md`
|
78
|
-
- Now release it:
|
79
229
|
|
80
|
-
|
81
|
-
git commit -am "Release X.Y.Z"
|
82
|
-
make release
|
83
|
-
```
|
230
|
+
<!-- Links -->
|
84
231
|
|
85
|
-
|
232
|
+
[community message board]: https://community.smartbear.com/t5/Cucumber-Open/bd-p/CucumberOS
|
233
|
+
[register-slack]: https://cucumberbdd-slack-invite.herokuapp.com/
|
234
|
+
[slack-intro]: https://cucumberbdd.slack.com/messages/C5WD8SA21/
|
235
|
+
[community-slack]: https://cucumberbdd.slack.com/
|
236
|
+
[cucumber-docs]: https://cucumber.io/docs/cucumber
|
237
|
+
[cucumber/common]: https://github.com/cucumber/common
|
238
|
+
[cucumber-ruby-core]: https://github.com/cucumber/cucumber-ruby-core
|
239
|
+
[cucumber-ruby-wire]: https://github.com/cucumber/cucumber-ruby-wire
|
240
|
+
[cucumber-rails]: https://github.com/cucumber/cucumber-rails
|
241
|
+
[cucumber-ruby-issues]: https://github.com/cucumber/cucumber-ruby/search?q=is%3Aissue
|
242
|
+
[cucumber/common-issues]: https://github.com/cucumber/common/search?q=is%3Aissue
|
243
|
+
[cucumber-issues]: https://github.com/search?q=is%3Aissue+user%3Acucumber
|
244
|
+
[how-to-create-a-draft-pr]: https://docs.github.com/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests
|
245
|
+
[how-to-fork]: https://docs.github.com/github/collaborating-with-pull-requests/working-with-forks/about-forks
|
246
|
+
[sign your commits]: https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/signing-commits
|
247
|
+
[minimal-reproducible-example]: https://stackoverflow.com/help/minimal-reproducible-example
|
248
|
+
[RVM]: https://rvm.io/
|
249
|
+
[rbenv]: https://github.com/rbenv/rbenv
|
250
|
+
[Bundler]: https://bundler.io/
|
data/README.md
CHANGED
@@ -1,29 +1,54 @@
|
|
1
|
+
<p align="center">
|
2
|
+
<img src="./.github/img/cucumber-open-logo.png" alt="Cucumber Open - Supported by Smartbear" width="428" />
|
3
|
+
</p>
|
4
|
+
|
5
|
+
# Cucumber
|
6
|
+
|
1
7
|
[](https://opencollective.com/cucumber)
|
2
8
|
[](https://opencollective.com/cucumber)
|
3
9
|
[](https://oselvar.com/github/cucumber/oselvar-github-metrics/main/cucumber/cucumber-ruby)
|
4
10
|
[](https://oselvar.com/github/cucumber/oselvar-github-metrics/main/cucumber/cucumber-ruby)
|
5
|
-
[](https://github.com/cucumber/cucumber-ruby/actions/workflows/cucumber-ruby.yml)
|
6
12
|
[](https://codeclimate.com/github/cucumber/cucumber-ruby)
|
7
13
|
[](https://coveralls.io/r/cucumber/cucumber-ruby?branch=main)
|
8
14
|
|
9
|
-
# Cucumber
|
10
|
-
|
11
15
|
Cucumber is a tool for running automated tests written in plain language. Because they're
|
12
16
|
written in plain language, they can be read by anyone on your team. Because they can be
|
13
17
|
read by anyone, you can use them to help improve communication, collaboration and trust on
|
14
18
|
your team.
|
15
19
|
|
16
|
-
|
20
|
+
<p align="center">
|
21
|
+
<img src="./.github/img/gherkin-example.png" alt="Cucumber Gherkin Example" width="728" />
|
22
|
+
</p>
|
17
23
|
|
18
|
-
|
19
|
-
-
|
20
|
-
|
21
|
-
|
22
|
-
|
24
|
+
This is the Ruby implementation of Cucumber. Cucumber is also available for [JavaScript](https://github.com/cucumber/cucumber-js),
|
25
|
+
[Java](https://github.com/cucumber/cucumber-jvm), and a lot of other languages. You can find a list of implementations here: https://cucumber.io/docs/installation/.
|
26
|
+
|
27
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for info on contributing to Cucumber (issues, PRs, etc.).
|
28
|
+
|
29
|
+
Everyone interacting in this codebase and issue tracker is expected to follow the
|
30
|
+
Cucumber [code of conduct](https://cucumber.io/conduct).
|
31
|
+
|
32
|
+
## Installation
|
33
|
+
|
34
|
+
Cucumber for Ruby is a Ruby gem. Install it as you would install any gem: add
|
35
|
+
`cucumber` to your Gemfile:
|
36
|
+
|
37
|
+
gem 'cucumber'
|
38
|
+
|
39
|
+
then install it:
|
40
|
+
|
41
|
+
$ bundle
|
23
42
|
|
24
|
-
|
43
|
+
or install the gem directly:
|
25
44
|
|
26
|
-
|
45
|
+
$ gem install cucumber
|
46
|
+
|
47
|
+
Later in this document, bundler is considered being used so all commands are using
|
48
|
+
`bundle exec`. If this is not the case for you, execute `cucumber` directly, without
|
49
|
+
`bundle exec`.
|
50
|
+
|
51
|
+
### Supported platforms
|
27
52
|
|
28
53
|
- Ruby 3.0
|
29
54
|
- Ruby 2.7
|
@@ -33,9 +58,104 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for info on contributing to Cucumber.
|
|
33
58
|
- Ruby 2.3
|
34
59
|
- JRuby 9.2 (with [some limitations](https://github.com/cucumber/cucumber-ruby/blob/main/docs/jruby-limitations.md))
|
35
60
|
|
36
|
-
|
61
|
+
JRuby 9.3 is not supported yet due to a known issue. More info can
|
62
|
+
be found in the [PR#1571](https://github.com/cucumber/cucumber-ruby/pull/1571).
|
63
|
+
|
64
|
+
### Ruby on Rails
|
65
|
+
|
66
|
+
Using Ruby on Rails? You can use [cucumber-rails](https://github.com/cucumber/cucumber-rails)
|
67
|
+
to bring Cucumber into your Rails project.
|
68
|
+
|
69
|
+
## Usage
|
70
|
+
|
71
|
+
### Initialization
|
72
|
+
|
73
|
+
If you need to, initialize your `features` directory with
|
74
|
+
|
75
|
+
$ bundle exec cucumber --init
|
76
|
+
|
77
|
+
This will create the following directories and files if they do not exist already:
|
78
|
+
|
79
|
+
features
|
80
|
+
├── step_definitions
|
81
|
+
└── support
|
82
|
+
└── env.rb
|
83
|
+
|
84
|
+
### Create your specification
|
85
|
+
|
86
|
+
Create a file named `rule.feature` in the `features` directory with:
|
87
|
+
|
88
|
+
```gherkin
|
89
|
+
# features/rule.feature
|
37
90
|
|
38
|
-
|
91
|
+
Feature: Rule Sample
|
92
|
+
|
93
|
+
Rule: This is a rule
|
94
|
+
|
95
|
+
Example: A passing example
|
96
|
+
Given this will pass
|
97
|
+
When I do an action
|
98
|
+
Then some results should be there
|
99
|
+
|
100
|
+
Example: A failing example
|
101
|
+
Given this will fail
|
102
|
+
When I do an action
|
103
|
+
Then some results should be there
|
104
|
+
|
105
|
+
```
|
106
|
+
|
107
|
+
### Automate your specification
|
108
|
+
|
109
|
+
And a file named `steps.rb` in `features/step_definitions` with:
|
110
|
+
|
111
|
+
```ruby
|
112
|
+
# features/step_definitions/steps.rb
|
113
|
+
|
114
|
+
Given("this will pass") do
|
115
|
+
@this_will_pass = true
|
116
|
+
end
|
117
|
+
|
118
|
+
Given("this will fail") do
|
119
|
+
@this_will_pass = false
|
120
|
+
end
|
121
|
+
|
122
|
+
When("I do an action") do
|
123
|
+
end
|
124
|
+
|
125
|
+
Then("some results should be there") do
|
126
|
+
expect(@this_will_pass)
|
127
|
+
end
|
128
|
+
```
|
129
|
+
|
130
|
+
### Run Cucumber
|
131
|
+
|
132
|
+
$ bundle exec cucumber
|
133
|
+
|
134
|
+
To execute a single feature file:
|
135
|
+
|
136
|
+
$ bundle exec cucumber features/rule.feature
|
137
|
+
|
138
|
+
To execute a single example, indicates the line of the name of the example:
|
139
|
+
|
140
|
+
$ bundle exec cucumber features/rule.feature:7
|
141
|
+
|
142
|
+
To summarize the results on the standard output, and writte a HTML report on disk:
|
143
|
+
|
144
|
+
$ bundle exec cucumber --format summary --format html --out report.html
|
145
|
+
|
146
|
+
For more command line options
|
147
|
+
|
148
|
+
$ bundle exec cucumber --help
|
149
|
+
|
150
|
+
You can also find documentation on the command line possibilities in
|
151
|
+
[features/docs/cli](features/docs/cli).
|
152
|
+
|
153
|
+
## Documentation and support
|
154
|
+
|
155
|
+
- Getting started, writing features, step definitions, and more: https://cucumber.io/docs
|
156
|
+
- Ruby API Documentation: http://www.rubydoc.info/github/cucumber/cucumber-ruby/
|
157
|
+
- Community support forum: https://community.smartbear.com/t5/Cucumber-Open/bd-p/CucumberOS
|
158
|
+
- Slack: [register for an account](https://cucumberbdd-slack-invite.herokuapp.com/) then head over to [#intro](https://cucumberbdd.slack.com/messages/C5WD8SA21/)
|
39
159
|
|
40
160
|
## Copyright
|
41
161
|
|
data/lib/cucumber/cli/options.rb
CHANGED
@@ -29,7 +29,7 @@ module Cucumber
|
|
29
29
|
"#{INDENT}Please consider using the message formatter\n"\
|
30
30
|
"#{INDENT}with the standalone json-formatter\n" \
|
31
31
|
"#{INDENT}(https://github.com/cucumber/cucumber/tree/master/json-formatter)."],
|
32
|
-
'message' => ['Cucumber::Formatter::Message', '
|
32
|
+
'message' => ['Cucumber::Formatter::Message', 'Prints each message in NDJSON form, which can then be consumed by other tools.'],
|
33
33
|
'html' => ['Cucumber::Formatter::HTML', 'Outputs HTML report'],
|
34
34
|
'summary' => ['Cucumber::Formatter::Summary', 'Summary output of feature and scenarios']
|
35
35
|
}.freeze
|
data/lib/cucumber/events.rb
CHANGED
@@ -3,13 +3,6 @@
|
|
3
3
|
require 'cucumber/platform'
|
4
4
|
require 'cucumber/term/ansicolor'
|
5
5
|
|
6
|
-
if Cucumber::WINDOWS_MRI
|
7
|
-
unless ENV['ANSICON']
|
8
|
-
STDERR.puts %{*** WARNING: You must use ANSICON 1.31 or higher (https://github.com/adoxa/ansicon/) to get coloured output on Windows}
|
9
|
-
Cucumber::Term::ANSIColor.coloring = false
|
10
|
-
end
|
11
|
-
end
|
12
|
-
|
13
6
|
Cucumber::Term::ANSIColor.coloring = false if !STDOUT.tty? && !ENV.key?('AUTOTEST')
|
14
7
|
|
15
8
|
module Cucumber
|
@@ -34,7 +34,7 @@ module Cucumber
|
|
34
34
|
|
35
35
|
def format_step(keyword, step_match, status, source_indent)
|
36
36
|
comment = if source_indent
|
37
|
-
c = ('# ' + step_match.location.to_s)
|
37
|
+
c = indent(('# ' + step_match.location.to_s), source_indent)
|
38
38
|
format_string(c, :comment)
|
39
39
|
else
|
40
40
|
''
|
@@ -99,11 +99,11 @@ module Cucumber
|
|
99
99
|
@io.puts(format_string(string, status))
|
100
100
|
end
|
101
101
|
|
102
|
-
def exception_message_string(e,
|
102
|
+
def exception_message_string(e, indent_amount)
|
103
103
|
message = "#{e.message} (#{e.class})".dup.force_encoding('UTF-8')
|
104
104
|
message = linebreaks(message, ENV['CUCUMBER_TRUNCATE_OUTPUT'].to_i)
|
105
105
|
|
106
|
-
"#{message}\n#{e.backtrace.join("\n")}"
|
106
|
+
indent("#{message}\n#{e.backtrace.join("\n")}", indent_amount)
|
107
107
|
end
|
108
108
|
|
109
109
|
# http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/10655
|
@@ -208,6 +208,14 @@ module Cucumber
|
|
208
208
|
].join("\n")
|
209
209
|
end
|
210
210
|
|
211
|
+
def indent(string, padding)
|
212
|
+
if padding >= 0
|
213
|
+
string.gsub(/^/, ' ' * padding)
|
214
|
+
else
|
215
|
+
string.gsub(/^ {0,#{-padding}}/, '')
|
216
|
+
end
|
217
|
+
end
|
218
|
+
|
211
219
|
private
|
212
220
|
|
213
221
|
FORMATS = Hash.new { |hash, format| hash[format] = method(format).to_proc }
|
@@ -48,12 +48,12 @@ module Cucumber
|
|
48
48
|
}
|
49
49
|
|
50
50
|
if media_type.start_with?('text/')
|
51
|
-
attachment_data[:content_encoding] = Cucumber::Messages::
|
51
|
+
attachment_data[:content_encoding] = Cucumber::Messages::AttachmentContentEncoding::IDENTITY
|
52
52
|
attachment_data[:body] = src
|
53
53
|
else
|
54
54
|
body = src.respond_to?(:read) ? src.read : src
|
55
55
|
|
56
|
-
attachment_data[:content_encoding] = Cucumber::Messages::
|
56
|
+
attachment_data[:content_encoding] = Cucumber::Messages::AttachmentContentEncoding::BASE64
|
57
57
|
attachment_data[:body] = Base64.strict_encode64(body)
|
58
58
|
end
|
59
59
|
|
@@ -101,7 +101,7 @@ module Cucumber
|
|
101
101
|
def test_step_to_message(step)
|
102
102
|
return hook_step_to_message(step) if step.hook?
|
103
103
|
|
104
|
-
Cucumber::Messages::
|
104
|
+
Cucumber::Messages::TestStep.new(
|
105
105
|
id: step.id,
|
106
106
|
pickle_step_id: @pickle_step_by_test_step.pickle_step_id(step),
|
107
107
|
step_definition_ids: @step_definitions_by_test_step.step_definition_ids(step),
|
@@ -110,7 +110,7 @@ module Cucumber
|
|
110
110
|
end
|
111
111
|
|
112
112
|
def hook_step_to_message(step)
|
113
|
-
Cucumber::Messages::
|
113
|
+
Cucumber::Messages::TestStep.new(
|
114
114
|
id: step.id,
|
115
115
|
hook_id: @hook_by_test_step.hook_id(step)
|
116
116
|
)
|
@@ -118,7 +118,7 @@ module Cucumber
|
|
118
118
|
|
119
119
|
def step_match_arguments_lists(step)
|
120
120
|
match_arguments = step_match_arguments(step)
|
121
|
-
[Cucumber::Messages::
|
121
|
+
[Cucumber::Messages::StepMatchArgumentsList.new(
|
122
122
|
step_match_arguments: match_arguments
|
123
123
|
)]
|
124
124
|
rescue Cucumber::Formatter::TestStepUnknownError
|
@@ -127,7 +127,7 @@ module Cucumber
|
|
127
127
|
|
128
128
|
def step_match_arguments(step)
|
129
129
|
@step_definitions_by_test_step.step_match_arguments(step).map do |argument|
|
130
|
-
Cucumber::Messages::
|
130
|
+
Cucumber::Messages::StepMatchArgument.new(
|
131
131
|
group: argument_group_to_message(argument.group),
|
132
132
|
parameter_type_name: argument.parameter_type.name
|
133
133
|
)
|
@@ -135,7 +135,7 @@ module Cucumber
|
|
135
135
|
end
|
136
136
|
|
137
137
|
def argument_group_to_message(group)
|
138
|
-
Cucumber::Messages::
|
138
|
+
Cucumber::Messages::Group.new(
|
139
139
|
start: group.start,
|
140
140
|
value: group.value,
|
141
141
|
children: group.children.map { |child| argument_group_to_message(child) }
|
@@ -190,7 +190,7 @@ module Cucumber
|
|
190
190
|
|
191
191
|
result_message = result.to_message
|
192
192
|
if result.failed? || result.pending?
|
193
|
-
result_message = Cucumber::Messages::
|
193
|
+
result_message = Cucumber::Messages::TestStepResult.new(
|
194
194
|
status: result_message.status,
|
195
195
|
duration: result_message.duration,
|
196
196
|
message: create_error_message(result)
|