Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mmendesas/walnutjs
A framework that helps you build your e2e tests easily using the BDD style
https://github.com/mmendesas/walnutjs
automation bdd-style cucumber e2e-tests es6 nodejs selenium ui-testing
Last synced: about 4 hours ago
JSON representation
A framework that helps you build your e2e tests easily using the BDD style
- Host: GitHub
- URL: https://github.com/mmendesas/walnutjs
- Owner: mmendesas
- License: mit
- Created: 2017-02-10T19:24:21.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T04:21:56.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T20:05:49.705Z (7 months ago)
- Topics: automation, bdd-style, cucumber, e2e-tests, es6, nodejs, selenium, ui-testing
- Language: JavaScript
- Homepage: https://mmendesas.github.io/walnutjs/
- Size: 12.5 MB
- Stars: 16
- Watchers: 6
- Forks: 10
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# **walnutjs**
**walnutjs** is a collection of generic steps for interact with web-applications.
You can easily simulate user interactions using a business-readable way.
You only need to write some feature files using the **Gherkin** syntax and plan your tests with **BDD (Behavior Driven Development)** pattern.
Enjoy It!
[](https://www.npmjs.com/package/walnutjs)
[](https://circleci.com/gh/mmendesas/walnutjs)
[](https://www.npmjs.com/package/walnutjs)
[](https://github.com/dwyl/esta/issues)
```sh
Usage: walnut [options]
Walnut Framework - Automated BDD Tests for Web Applications
Options:
-V, --version output the version number
-c, --config path to JSON config file
-t, --tags name of tag to run (default: [])
-m, --execMethod execution method [e.g runOnlyAPI]
-h, --help output usage information
```
> Please see our wiki **[DOCs](https://github.com/sednemm/walnutjs/wiki)** for more details.
## Getting Started
These instructions will give you a sample feature file to show you how easy is to make your own tests
### Prerequisites
Before continue, check that you have completed the following requirements:
* [**java**](https://www.java.com/en/download/) - Java runtime environment - _tested on 1.8.0_211_
* [**nodejs**](https://nodejs.org) - A javascript runtime - _tested on v10.16.0_
* **selenium webserver**:
* [**webdriver-manager**](https://www.npmjs.com/package/webdriver-manager) - A selenium server and browser driver manager.
* [**zalenium**](https://opensource.zalando.com/zalenium/) - A flexible and scalable selenium grid.
### Setup the project
1. Start by creating a simple `nodejs` project and add **walnutjs** to it:
```sh
mkdir my-app && cd my-app
npm init -y
npm i --save walnutjs
```
2. Setting up a `walnut-config.js` file inside rootFolder based on [this file](https://github.com/mmendesas/walnutjs-boilerplate/blob/master/walnut-config.json)
3. Create a folder structure like that:
```sh
> my-app
> test
> features
sample.feature
> step-defs
custom-steps.js
> locators
locators.json
> params
params.json
```
> You can create these folders above on your own, just be sure to indicate the correct paths inside `walnut-config.js` file.
4. Add the folowing content to `locators.json` file:
```json
{
"containers":[
{
"name": "GoogleHome",
"locators":[
{ "key": "SearchInput", "type": "name", "value": "q" },
{ "key": "SearchButton", "type": "p:xpath", "value": "//input[@value='{0}']" }
]
}
]
}
```
5. Add the following content to `sample.feature` file:
```gherkin
Feature: First test with walnutjs
@simple_web
Scenario: I want see the Google Page
Given user navigates to 'http://www.google.com'
When user fills 'GoogleHome-SearchInput' by replacing text with 'led zeppelin wikipedia'
And user clicks on 'GoogleResult-SearchButton'
```
6. Before execution check that `selenium webserver` was started correctly. For this sample we will use `webdriver-manager`
```sh
webdriver-manager start
...
10:15:57.230 INFO [SeleniumServer.boot] - Selenium Server is up and running on port 4444
```
7. Define a single start script in your `package.json`:
```json
"scripts": {
"start": "walnut",
}
```
8. Execute your script
```sh
npm start
```
> You can also run using `$(npm bin)/walnut` on your terminal
### More details
> Review this [project boilerplate](https://github.com/mmendesas/walnutjs-test) to get more insights and [this documentation](https://github.com/mmendesas/walnutjs/wiki) to see more details.
## Running the tests
Just run the following command inside the root folder:
* test: `npm run test`
* coverage: `npm run coverage`
## Built With
* [nodejs](https://nodejs.org/en/) - A JavaScript runtime
* [cucumber](https://www.npmjs.com/package/cucumber) - tool for running automated tests written in plain language
* [selenium-webdriver](https://www.npmjs.com/package/selenium-webdriver) - The official Webdriver Javascript bindings from the Selenium project.
## Authors
* **Marcio Mendes** - *Initial work* - [mmendesas](https://github.com/mmendesas)
See also the list of [contributors](https://github.com/mmendesas/walnutjs/graphs/contributors) who participated in this project.
## License
This project is licensed under the MIT License.