Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/contino/cucumber-declarative-gherkin
Reference implementation of Declarative Gherkin for Cucumber testing.
https://github.com/contino/cucumber-declarative-gherkin
bdd cucumber cucumber-js cucumberjs declarative-gherkin gherkin gherkin-dsl webdriverio
Last synced: 3 months ago
JSON representation
Reference implementation of Declarative Gherkin for Cucumber testing.
- Host: GitHub
- URL: https://github.com/contino/cucumber-declarative-gherkin
- Owner: contino
- License: apache-2.0
- Created: 2021-03-06T20:58:51.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-08-28T19:45:32.000Z (over 1 year ago)
- Last Synced: 2023-08-29T01:59:41.896Z (over 1 year ago)
- Topics: bdd, cucumber, cucumber-js, cucumberjs, declarative-gherkin, gherkin, gherkin-dsl, webdriverio
- Language: TypeScript
- Homepage:
- Size: 11.4 MB
- Stars: 4
- Watchers: 97
- Forks: 5
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cucumber-declarative-gherkin
## START HERE
See [quick notes](/quick-notes.md) for recent notes on getting this demo setup on your local workstation (which should be replaced by containerized instructions in the future).
## WARNING
At the time of writing 2 vulnerabilities are present in upstream
npm dependencies.
- Meow issue
- @wdio/[email protected] requires trim-newlines@^1.0.0 via a transitive dependency on [email protected]
- Waiting for meow to release its patch and be picked up
- [Mewo issue](https://github.com/sindresorhus/meow/issues/186)
- ecstatic issue
- @nrwl/[email protected] requires ecstatic@^3.3.2 via [email protected]
- @nrwl/[email protected] requires ecstatic@^3.3.2 via a transitive dependency on [email protected]
- This is being fixed by http-server in this [PR](https://github.com/http-party/http-server/pull/631)
## Overview
This is a training aide to help people learn Declarative Gherkin. It is not
easy to learn Declarative Gherkin. Thus, this app helps people understand how
to take what they learned in training and see a working implementation.
## Where to Start?
Want to learn more about declarative Gherkin, read the training or
look at the docs [here](./docs/declarative-gherkin.md).
Want to see the declarative Gherkin, go into the `first-bank-of-change/features`
folder.
Want to run the declarative Gherkin:
1. Install the perquisites
1. Run `nvm use` in the root folder
1. run `npm install` in the `first-bank-of-change` folder
1. run `npm run e2e`
1. Then open the file
`cucumber-declarative-gherkin/first-bank-of-change/.tmp/report/index.html` in a browser
**NOTE:** The e2e test will fail. It is to demo the advance logging.
navigate to the failing scenario to see a screenshot, test suite failure
location and client logging entries.
## Perquisites
- Need Node and NPM, built with node 14.16.0
- NX needs to be installed globally
- `npm i -g nx`
## Run the Example App
This demo uses a single app with everything running in memory. No servers are
used for this demo.
From the repo root folder run `npm run start`, then go to `http:\\localhost:4200`.
## Local Development
When developing locally, you can run `npm run start` it will watch your file
changes and reload. In addition, when working on e2e tests, run
`npm run e2e-dev`, it only runs the test suite.
To run lint, use `npm run lint`
To run unit tests, use `npm run test`
### Generate Cucumber Step Definitions
WebdriverIO Cucumber framework does not generate the step definitions when
they are missing. So, we use the VS Code extension
[Jest-cucumber code generator](https://marketplace.visualstudio.com/items?itemName=Piotr-Porzuczek.jest-cucumber-code-generator-extension).
**NOTE:** the plugin generates regex requiring alteration, example:
Failing regex:
```gehrkin
Then(/^they see a submittal response (.*)$/
```
Correct regex: (Double quotes)
```gehrkin
Then(/^they see a submittal response "(.*)"$/
```
Without the double quotes, the string will contain them and fail comparisons.
### Troubleshooting e2e Tests
See [Cucumber Logging](./docs/cucumber-logging.md)