cucumber 3.1.2 → 7.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +1780 -1146
- data/CONTRIBUTING.md +224 -61
- data/README.md +144 -22
- data/bin/cucumber +1 -1
- data/lib/autotest/cucumber_mixin.rb +46 -53
- data/lib/cucumber/cli/configuration.rb +28 -6
- data/lib/cucumber/cli/main.rb +12 -12
- data/lib/cucumber/cli/options.rb +103 -77
- data/lib/cucumber/cli/profile_loader.rb +49 -26
- data/lib/cucumber/configuration.rb +44 -29
- data/lib/cucumber/constantize.rb +2 -5
- data/lib/cucumber/deprecate.rb +31 -7
- data/lib/cucumber/errors.rb +5 -7
- data/lib/cucumber/events/envelope.rb +9 -0
- data/lib/cucumber/events/gherkin_source_parsed.rb +11 -0
- data/lib/cucumber/events/hook_test_step_created.rb +13 -0
- data/lib/cucumber/events/step_activated.rb +2 -1
- data/lib/cucumber/events/test_case_created.rb +13 -0
- data/lib/cucumber/events/test_case_ready.rb +12 -0
- data/lib/cucumber/events/test_step_created.rb +13 -0
- data/lib/cucumber/events/undefined_parameter_type.rb +10 -0
- data/lib/cucumber/events.rb +14 -7
- data/lib/cucumber/file_specs.rb +6 -6
- data/lib/cucumber/filters/activate_steps.rb +5 -3
- data/lib/cucumber/filters/broadcast_test_case_ready_event.rb +12 -0
- data/lib/cucumber/filters/prepare_world.rb +5 -9
- data/lib/cucumber/filters/quit.rb +1 -3
- data/lib/cucumber/filters/tag_limits/verifier.rb +2 -4
- data/lib/cucumber/filters.rb +1 -0
- data/lib/cucumber/formatter/ansicolor.rb +40 -52
- data/lib/cucumber/formatter/ast_lookup.rb +163 -0
- data/lib/cucumber/formatter/backtrace_filter.rb +10 -8
- data/lib/cucumber/formatter/console.rb +69 -69
- data/lib/cucumber/formatter/console_counts.rb +4 -9
- data/lib/cucumber/formatter/console_issues.rb +6 -3
- data/lib/cucumber/formatter/duration.rb +1 -1
- data/lib/cucumber/formatter/duration_extractor.rb +3 -1
- data/lib/cucumber/formatter/errors.rb +6 -0
- data/lib/cucumber/formatter/fanout.rb +2 -0
- data/lib/cucumber/formatter/html.rb +11 -598
- data/lib/cucumber/formatter/http_io.rb +147 -0
- data/lib/cucumber/formatter/ignore_missing_messages.rb +1 -1
- data/lib/cucumber/formatter/interceptor.rb +11 -30
- data/lib/cucumber/formatter/io.rb +55 -13
- data/lib/cucumber/formatter/json.rb +115 -122
- data/lib/cucumber/formatter/junit.rb +72 -55
- data/lib/cucumber/formatter/message.rb +23 -0
- data/lib/cucumber/formatter/message_builder.rb +255 -0
- data/lib/cucumber/formatter/pretty.rb +360 -153
- data/lib/cucumber/formatter/progress.rb +30 -32
- data/lib/cucumber/formatter/publish_banner_printer.rb +77 -0
- data/lib/cucumber/formatter/query/hook_by_test_step.rb +31 -0
- data/lib/cucumber/formatter/query/pickle_by_test.rb +26 -0
- data/lib/cucumber/formatter/query/pickle_step_by_test_step.rb +26 -0
- data/lib/cucumber/formatter/query/step_definitions_by_test_step.rb +40 -0
- data/lib/cucumber/formatter/query/test_case_started_by_test_case.rb +40 -0
- data/lib/cucumber/formatter/rerun.rb +22 -4
- data/lib/cucumber/formatter/stepdefs.rb +1 -2
- data/lib/cucumber/formatter/steps.rb +8 -6
- data/lib/cucumber/formatter/summary.rb +16 -8
- data/lib/cucumber/formatter/unicode.rb +15 -17
- data/lib/cucumber/formatter/url_reporter.rb +17 -0
- data/lib/cucumber/formatter/usage.rb +17 -14
- data/lib/cucumber/gherkin/data_table_parser.rb +17 -6
- data/lib/cucumber/gherkin/formatter/ansi_escapes.rb +13 -17
- data/lib/cucumber/gherkin/formatter/escaping.rb +2 -2
- data/lib/cucumber/gherkin/steps_parser.rb +17 -8
- data/lib/cucumber/glue/dsl.rb +19 -0
- data/lib/cucumber/glue/hook.rb +34 -11
- data/lib/cucumber/glue/invoke_in_world.rb +13 -18
- data/lib/cucumber/glue/proto_world.rb +37 -44
- data/lib/cucumber/glue/registry_and_more.rb +71 -12
- data/lib/cucumber/glue/registry_wrapper.rb +31 -0
- data/lib/cucumber/glue/snippet.rb +23 -22
- data/lib/cucumber/glue/step_definition.rb +42 -20
- data/lib/cucumber/glue/world_factory.rb +1 -1
- data/lib/cucumber/hooks.rb +11 -11
- data/lib/cucumber/multiline_argument/data_table/diff_matrices.rb +2 -2
- data/lib/cucumber/multiline_argument/data_table.rb +97 -64
- data/lib/cucumber/multiline_argument/doc_string.rb +1 -1
- data/lib/cucumber/multiline_argument.rb +4 -6
- data/lib/cucumber/platform.rb +3 -3
- data/lib/cucumber/rake/task.rb +16 -18
- data/lib/cucumber/rspec/disable_option_parser.rb +9 -8
- data/lib/cucumber/rspec/doubles.rb +3 -5
- data/lib/cucumber/running_test_case.rb +2 -53
- data/lib/cucumber/runtime/after_hooks.rb +8 -4
- data/lib/cucumber/runtime/before_hooks.rb +8 -4
- data/lib/cucumber/runtime/for_programming_languages.rb +4 -2
- data/lib/cucumber/runtime/step_hooks.rb +6 -2
- data/lib/cucumber/runtime/support_code.rb +13 -15
- data/lib/cucumber/runtime/user_interface.rb +6 -16
- data/lib/cucumber/runtime.rb +77 -59
- data/lib/cucumber/step_definition_light.rb +4 -3
- data/lib/cucumber/step_definitions.rb +2 -2
- data/lib/cucumber/step_match.rb +12 -17
- data/lib/cucumber/step_match_search.rb +2 -1
- data/lib/cucumber/term/ansicolor.rb +9 -9
- data/lib/cucumber/term/banner.rb +56 -0
- data/lib/cucumber/version +1 -1
- data/lib/cucumber.rb +1 -1
- metadata +272 -81
- data/lib/cucumber/core_ext/string.rb +0 -11
- data/lib/cucumber/events/gherkin_source_parsed.rb~ +0 -14
- data/lib/cucumber/formatter/ast_lookup.rb~ +0 -9
- data/lib/cucumber/formatter/cucumber.css +0 -286
- data/lib/cucumber/formatter/cucumber.sass +0 -247
- data/lib/cucumber/formatter/hook_query_visitor.rb +0 -42
- data/lib/cucumber/formatter/html_builder.rb +0 -121
- data/lib/cucumber/formatter/inline-js.js +0 -30
- data/lib/cucumber/formatter/jquery-min.js +0 -154
- data/lib/cucumber/formatter/json_pretty.rb +0 -11
- data/lib/cucumber/formatter/legacy_api/adapter.rb +0 -1028
- data/lib/cucumber/formatter/legacy_api/ast.rb +0 -394
- data/lib/cucumber/formatter/legacy_api/results.rb +0 -50
- data/lib/cucumber/formatter/legacy_api/runtime_facade.rb +0 -32
- data/lib/cucumber/step_argument.rb +0 -25
data/CONTRIBUTING.md
CHANGED
@@ -1,87 +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.
|
94
|
+
|
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].
|
97
|
+
|
98
|
+
### Look for existing issues and pull requests
|
99
|
+
|
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.
|
105
|
+
|
106
|
+
If you're not sure, don't hesitate to just open a new issue. We can always merge
|
107
|
+
and de-duplicate later.
|
108
|
+
|
109
|
+
### Submitting a pull request
|
110
|
+
|
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
|
15
159
|
|
16
|
-
|
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`.
|
17
164
|
|
18
|
-
|
165
|
+
### Using a local Gemfile
|
19
166
|
|
20
|
-
|
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`.
|
21
170
|
|
22
|
-
|
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.
|
23
174
|
|
24
|
-
A `Gemfile.local
|
25
|
-
your normal development workflow.
|
175
|
+
A `Gemfile.local` may look like this:
|
26
176
|
|
27
|
-
|
177
|
+
```ruby
|
178
|
+
# Gemfile.local
|
28
179
|
|
29
|
-
|
30
|
-
|
31
|
-
gem 'pry-byebug'
|
32
|
-
gem 'byebug'
|
33
|
-
~~~
|
180
|
+
# Include the regular Gemfile
|
181
|
+
eval File.read('Gemfile')
|
34
182
|
|
35
|
-
|
183
|
+
# Include your favorites development gems
|
184
|
+
group :development do
|
185
|
+
gem 'byebug'
|
186
|
+
gem 'pry'
|
187
|
+
gem 'pry-byebug'
|
36
188
|
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
(if you want to have your own version, that is fine but
|
42
|
-
bump version in a commit by itself so we can ignore when we merge your change)
|
43
|
-
* Send us a pull request.
|
189
|
+
gem 'debase', require: false
|
190
|
+
gem 'ruby-debug-ide', require: false
|
191
|
+
end
|
192
|
+
```
|
44
193
|
|
45
|
-
|
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]`.
|
46
197
|
|
47
|
-
|
48
|
-
|
49
|
-
bundle exec rake
|
198
|
+
To use your local Gemfile per default, you can also execute
|
199
|
+
`bundle config set --local gemfile Gemfile.local`.
|
50
200
|
|
51
|
-
|
201
|
+
### First timer? Welcome!
|
52
202
|
|
53
|
-
|
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)'.
|
54
205
|
|
55
|
-
|
56
|
-
[
|
57
|
-
help us to correct style violations reported here:
|
58
|
-
[.rubocop_todo.yaml](https://github.com/cucumber/cucumber-ruby/blob/master/.rubocop_todo.yml).
|
206
|
+
Remember: Cucumber is more than `cucumber-ruby`. You can look for good first
|
207
|
+
issues in [other cucumber reporistories](#find-the-appropriate-repository).
|
59
208
|
|
60
|
-
|
209
|
+
### Having trouble getting started with the code? We're here to help!
|
61
210
|
|
62
|
-
|
63
|
-
|
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.
|
64
214
|
|
65
|
-
|
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].
|
66
220
|
|
67
|
-
|
68
|
-
bundle exec rake
|
69
|
-
git commit -m "Release X.Y.Z"
|
70
|
-
rake release
|
221
|
+
### Additional documentation and notice
|
71
222
|
|
72
|
-
|
223
|
+
You can find additional documentation in the [docs](./docs) directory such as
|
224
|
+
(non-exhaustive list):
|
73
225
|
|
74
|
-
|
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)
|
75
228
|
|
76
|
-
Current release managers:
|
77
|
-
* [Matt Wynne](https://rubygems.org/profiles/mattwynne)
|
78
|
-
* [Aslak Hellesøy](https://rubygems.org/profiles/aslakhellesoy)
|
79
|
-
* [Oleg Sukhodolsky](https://rubygems.org/profiles/os97673)
|
80
|
-
* [Steve Tooke](https://rubygems.org/profiles/tooky)
|
81
|
-
* [Björn Rasmusson](https://rubygems.org/profiles/brasmusson)
|
82
|
-
* [Andrew Walter](https://rubygems.org/profiles/xtrasimplicity)
|
83
229
|
|
84
|
-
|
230
|
+
<!-- Links -->
|
85
231
|
|
86
|
-
|
87
|
-
|
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,39 +1,161 @@
|
|
1
|
-
|
2
|
-
|
1
|
+
<p align="center">
|
2
|
+
<img src="./.github/img/cucumber-open-logo.png" alt="Cucumber Open - Supported by Smartbear" width="428" />
|
3
|
+
</p>
|
3
4
|
|
4
|
-
|
5
|
+
# Cucumber
|
5
6
|
|
7
|
+
[![OpenCollective](https://opencollective.com/cucumber/backers/badge.svg)](https://opencollective.com/cucumber)
|
8
|
+
[![OpenCollective](https://opencollective.com/cucumber/sponsors/badge.svg)](https://opencollective.com/cucumber)
|
9
|
+
[![pull requests](https://oselvar.com/api/badge?label=pull%20requests&csvUrl=https%3A%2F%2Fraw.githubusercontent.com%2Fcucumber%2Foselvar-github-metrics%2Fmain%2Fdata%2Fcucumber%2Fcucumber-ruby%2FpullRequests.csv)](https://oselvar.com/github/cucumber/oselvar-github-metrics/main/cucumber/cucumber-ruby)
|
10
|
+
[![issues](https://oselvar.com/api/badge?label=issues&csvUrl=https%3A%2F%2Fraw.githubusercontent.com%2Fcucumber%2Foselvar-github-metrics%2Fmain%2Fdata%2Fcucumber%2Fcucumber-ruby%2Fissues.csv)](https://oselvar.com/github/cucumber/oselvar-github-metrics/main/cucumber/cucumber-ruby)
|
11
|
+
[![Test cucumber](https://github.com/cucumber/cucumber-ruby/actions/workflows/cucumber-ruby.yml/badge.svg)](https://github.com/cucumber/cucumber-ruby/actions/workflows/cucumber-ruby.yml)
|
6
12
|
[![Code Climate](https://codeclimate.com/github/cucumber/cucumber-ruby.svg)](https://codeclimate.com/github/cucumber/cucumber-ruby)
|
7
|
-
[![Coverage Status](https://coveralls.io/repos/cucumber/cucumber-ruby/badge.svg?branch=
|
8
|
-
[![Dependency Status](https://gemnasium.com/cucumber/cucumber-ruby.svg)](https://gemnasium.com/cucumber/cucumber-ruby)
|
9
|
-
|
10
|
-
# Cucumber
|
13
|
+
[![Coverage Status](https://coveralls.io/repos/cucumber/cucumber-ruby/badge.svg?branch=main)](https://coveralls.io/r/cucumber/cucumber-ruby?branch=main)
|
11
14
|
|
12
15
|
Cucumber is a tool for running automated tests written in plain language. Because they're
|
13
16
|
written in plain language, they can be read by anyone on your team. Because they can be
|
14
17
|
read by anyone, you can use them to help improve communication, collaboration and trust on
|
15
18
|
your team.
|
16
19
|
|
17
|
-
|
20
|
+
<p align="center">
|
21
|
+
<img src="./.github/img/gherkin-example.png" alt="Cucumber Gherkin Example" width="728" />
|
22
|
+
</p>
|
23
|
+
|
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
|
42
|
+
|
43
|
+
or install the gem directly:
|
44
|
+
|
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
|
52
|
+
|
53
|
+
- Ruby 3.0
|
54
|
+
- Ruby 2.7
|
55
|
+
- Ruby 2.6
|
56
|
+
- Ruby 2.5
|
57
|
+
- Ruby 2.4
|
58
|
+
- Ruby 2.3
|
59
|
+
- JRuby 9.2 (with [some limitations](https://github.com/cucumber/cucumber-ruby/blob/main/docs/jruby-limitations.md))
|
60
|
+
|
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
|
90
|
+
|
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
|
18
145
|
|
19
|
-
|
20
|
-
* Documentation: https://docs.cucumber.io
|
21
|
-
* Ruby API Documentation: http://www.rubydoc.info/github/cucumber/cucumber-ruby/
|
22
|
-
* Support forum: https://groups.google.com/group/cukes
|
23
|
-
* Chat: ([Slack](https://cucumber.io/support#slack) and [Gitter](https://cucumber.io/support#gitter))
|
146
|
+
For more command line options
|
24
147
|
|
25
|
-
|
148
|
+
$ bundle exec cucumber --help
|
26
149
|
|
27
|
-
|
28
|
-
|
29
|
-
* Ruby 2.4
|
30
|
-
* Ruby 2.3
|
31
|
-
* Ruby 2.2
|
32
|
-
* JRuby 9.1
|
150
|
+
You can also find documentation on the command line possibilities in
|
151
|
+
[features/docs/cli](features/docs/cli).
|
33
152
|
|
34
|
-
##
|
153
|
+
## Documentation and support
|
35
154
|
|
36
|
-
|
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/)
|
37
159
|
|
38
160
|
## Copyright
|
39
161
|
|
data/bin/cucumber
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
#!/usr/bin/env ruby
|
2
2
|
file_name = File.dirname(__FILE__) + '/../lib'
|
3
|
-
|
3
|
+
$LOAD_PATH.unshift(file_name) unless $LOAD_PATH.include?(file_name)
|
4
4
|
|
5
5
|
require 'simplecov_setup'
|
6
6
|
require 'cucumber/rspec/disable_option_parser'
|
@@ -7,7 +7,7 @@ require 'cucumber/cli/profile_loader'
|
|
7
7
|
|
8
8
|
module Autotest::CucumberMixin
|
9
9
|
def self.included(receiver)
|
10
|
-
receiver::ALL_HOOKS << [
|
10
|
+
receiver::ALL_HOOKS << %i[run_features ran_features]
|
11
11
|
end
|
12
12
|
|
13
13
|
attr_accessor :features_to_run
|
@@ -23,26 +23,22 @@ module Autotest::CucumberMixin
|
|
23
23
|
reset_features
|
24
24
|
add_sigint_handler
|
25
25
|
|
26
|
-
self.last_mtime = Time.now if $f
|
27
|
-
|
28
26
|
loop do # ^c handler
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
hook :all_good
|
36
|
-
end
|
37
|
-
wait_for_changes
|
38
|
-
# Once tests and features are green, reset features every
|
39
|
-
# time a file is changed to see if anything breaks.
|
40
|
-
reset_features
|
41
|
-
rescue Interrupt
|
42
|
-
break if self.wants_to_quit
|
43
|
-
reset
|
44
|
-
reset_features
|
27
|
+
get_to_green
|
28
|
+
if tainted
|
29
|
+
rerun_all_tests
|
30
|
+
rerun_all_features if all_good
|
31
|
+
else
|
32
|
+
hook :all_good
|
45
33
|
end
|
34
|
+
wait_for_changes
|
35
|
+
# Once tests and features are green, reset features every
|
36
|
+
# time a file is changed to see if anything breaks.
|
37
|
+
reset_features
|
38
|
+
rescue Interrupt
|
39
|
+
break if wants_to_quit
|
40
|
+
reset
|
41
|
+
reset_features
|
46
42
|
end
|
47
43
|
hook :quit
|
48
44
|
end
|
@@ -51,12 +47,13 @@ module Autotest::CucumberMixin
|
|
51
47
|
features_to_run == ''
|
52
48
|
end
|
53
49
|
|
54
|
-
def get_to_green
|
55
|
-
|
50
|
+
def get_to_green # rubocop:disable Naming/AccessorMethodName
|
51
|
+
loop do
|
56
52
|
super
|
57
53
|
run_features
|
58
54
|
wait_for_changes unless all_features_good
|
59
|
-
|
55
|
+
break if all_features_good
|
56
|
+
end
|
60
57
|
end
|
61
58
|
|
62
59
|
def rerun_all_features
|
@@ -71,67 +68,63 @@ module Autotest::CucumberMixin
|
|
71
68
|
def run_features
|
72
69
|
hook :run_features
|
73
70
|
Tempfile.open('autotest-cucumber') do |dirty_features_file|
|
74
|
-
cmd =
|
71
|
+
cmd = make_cucumber_cmd(features_to_run, dirty_features_file.path)
|
75
72
|
break if cmd.empty?
|
76
|
-
puts cmd unless $q
|
77
73
|
old_sync = $stdout.sync
|
78
74
|
$stdout.sync = true
|
79
75
|
self.results = []
|
80
76
|
line = []
|
81
77
|
begin
|
82
|
-
open("| #{cmd}", 'r') do |f|
|
78
|
+
open("| #{cmd}", 'r') do |f| # rubocop:disable Security/Open
|
83
79
|
until f.eof?
|
84
80
|
c = f.getc || break
|
85
|
-
|
86
|
-
print c
|
87
|
-
else
|
88
|
-
putc c
|
89
|
-
end
|
81
|
+
print(c)
|
90
82
|
line << c
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
else
|
95
|
-
line.pack 'c*'
|
96
|
-
end
|
97
|
-
line.clear
|
98
|
-
end
|
83
|
+
next unless c == "\n"
|
84
|
+
results << line.join
|
85
|
+
line.clear
|
99
86
|
end
|
100
87
|
end
|
101
88
|
ensure
|
102
89
|
$stdout.sync = old_sync
|
103
90
|
end
|
104
91
|
self.features_to_run = dirty_features_file.read.strip
|
105
|
-
self.tainted = true unless
|
92
|
+
self.tainted = true unless features_to_run == ''
|
106
93
|
end
|
107
94
|
hook :ran_features
|
108
95
|
end
|
109
96
|
|
110
|
-
def make_cucumber_cmd(features_to_run,
|
111
|
-
return '' if features_to_run
|
97
|
+
def make_cucumber_cmd(features_to_run, _dirty_features_filename)
|
98
|
+
return '' if features_to_run.empty?
|
112
99
|
|
113
100
|
profile_loader = Cucumber::Cli::ProfileLoader.new
|
114
101
|
|
115
|
-
profile
|
116
|
-
|
117
|
-
|
102
|
+
profile = profile(profile_loader)
|
103
|
+
|
104
|
+
args = created_args(features_to_run, profile)
|
118
105
|
|
106
|
+
"#{Cucumber::RUBY_BINARY} #{Cucumber::BINARY} #{args}"
|
107
|
+
end
|
108
|
+
|
109
|
+
def profile(profile_loader)
|
110
|
+
profile ||= 'autotest-all' if profile_loader.profile?('autotest-all') && features_to_run == :all
|
111
|
+
profile ||= 'autotest' if profile_loader.profile?('autotest')
|
112
|
+
profile || nil
|
113
|
+
end
|
114
|
+
|
115
|
+
def created_args(features_to_run, profile)
|
119
116
|
args = if profile
|
120
117
|
['--profile', profile]
|
121
118
|
else
|
122
|
-
%w
|
119
|
+
%w[--format] << (features_to_run == :all ? 'progress' : 'pretty')
|
123
120
|
end
|
124
121
|
# No --color option as some IDEs (Netbeans) don't output them very well ([31m1 failed step[0m)
|
125
|
-
args += %w
|
122
|
+
args += %w[--format rerun --out] << dirty_features_filename
|
126
123
|
args << (features_to_run == :all ? '' : features_to_run)
|
127
124
|
|
128
|
-
#
|
129
|
-
unless features_to_run == :all
|
130
|
-
args << 'features/step_definitions' << 'features/support'
|
131
|
-
end
|
132
|
-
|
133
|
-
args = args.join(' ')
|
125
|
+
# All steps becom undefined during rerun unless the following is run.
|
126
|
+
args << 'features/step_definitions' << 'features/support' unless features_to_run == :all
|
134
127
|
|
135
|
-
|
128
|
+
args.join(' ')
|
136
129
|
end
|
137
130
|
end
|