Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/customcommander/cucumber-js-cukebook
Recipes for Cucumber.js
https://github.com/customcommander/cucumber-js-cukebook
cookbook cucumber-js testing-practices
Last synced: 19 days ago
JSON representation
Recipes for Cucumber.js
- Host: GitHub
- URL: https://github.com/customcommander/cucumber-js-cukebook
- Owner: customcommander
- License: mit
- Created: 2020-05-26T18:01:04.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-09-23T09:52:25.000Z (over 3 years ago)
- Last Synced: 2023-08-04T13:45:40.479Z (over 1 year ago)
- Topics: cookbook, cucumber-js, testing-practices
- Language: JavaScript
- Homepage:
- Size: 27.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cukebook
This cookbook shows how things _can_ be done so we can focus on automation rather than implementation.
## Avoid arrow functions
Don't:
```javascript
defineStep('I sign in', () => {
signIn(this.config.username, this.config.password); // TypeError
});
```
Do:
```javascript
defineStep('I sign in', function () {
signIn(this.config.username, this.config.password);
});
```
Why?
Cucumber sets the context of a step to the [World][doc-world]. If you use an arrow function that context will be the module implementing the step. Most likely not what you want.
## Prefer Cucumber expressions over regular expressions
In most cases you don't need regular expressions and you may find [Cucumber expressions][cucumber-expressions-doc] easier to the eyes.
### Exact match
```javascript
defineStep('I will match just this text', function () {
//...
});
```
```gherkin
When I will match just this text # match
Then I will match just this text and more # no match!
```
### Matching numbers
```javascript
defineStep('I order {int} burritos at £{float} each', function (amount, price) {
console.log(`${amount} × ${price} = ${amount * price}`);
});
```
```gherkin
When I order 10 burritos at £4.75 each # amount: 10, price: 4.75
```
### Matching strings and words
```javascript
// Match anything between double quotes or single quotes
// The quotes **are not** part of the match
defineStep('the text is {string}', function (str) {
console.log(str);
});
// Match a single word without whitespace
defineStep('the name is {word}', function (wrd) {
console.log(wrd);
});
```
```gherkin
When the text is "John Doe" # str: 'John Doe'
Then the name is generic # wrd: 'generic'
When the text is "" # str: '' (an empty string)
Then the name is empty # wrd: 'empty'
```
### Pluralisation
```javascript
// the text in parenthesis is optional
defineStep('I see {int} fox(es)', function (num) {
console.log(num);
});
```
```gherkin
When I see 1 fox # num: 1
When I see 10 foxes # num: 10
```
### Alternative(s)
```javascript
// match any single word separated by a slash
// ⚠️the match is **not** captured!
defineStep('I have a dog/cat/fish', function () {
this.owns_pet = true;
});
```
```gherkin
Given I have a dog # match
Given I have a cat # match
Given I have a fish # match
```
## Grow your vocabulary with custom types
```javascript
defineStep('I have {quantity} book(s)', function (amount) {
console.log(amount);
});
function between(min, max) {
return Math.floor(Math.random() * (max - min + 1) + min);
}
defineParameterType({
name: 'quantity',
regexp: /\d+|no|some/,
transformer: qty => {
if (qty === 'no') return 0;
if (qty === 'some') return between(1, 10);
return qty;
}
});
```
```gherkin
Given I have no book # amount: 0
Given I have 2 books # amount: 2
Given I have some books # amount: (random number between 1 and 10)
```
[package]: https://github.com/cucumber/cucumber-js
[doc-world]: https://github.com/cucumber/cucumber-js/blob/master/docs/support_files/world.md
[cucumber-expressions-doc]: https://cucumber.io/docs/cucumber/cucumber-expressions/