https://github.com/abhinaba-ghosh/cypress-e2e-boilerplate
:fire: Cypress starter pack for UI + API automation [Cypress + Typescript + Allure +Docker + Jenkins]
https://github.com/abhinaba-ghosh/cypress-e2e-boilerplate
allure api circleci cypress cypress-io docker e2e jenkins starter-kit typescript ui
Last synced: 25 days ago
JSON representation
:fire: Cypress starter pack for UI + API automation [Cypress + Typescript + Allure +Docker + Jenkins]
- Host: GitHub
- URL: https://github.com/abhinaba-ghosh/cypress-e2e-boilerplate
- Owner: abhinaba-ghosh
- Created: 2020-05-13T20:41:30.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-07T11:01:52.000Z (over 5 years ago)
- Last Synced: 2024-10-18T08:34:39.490Z (12 months ago)
- Topics: allure, api, circleci, cypress, cypress-io, docker, e2e, jenkins, starter-kit, typescript, ui
- Language: JavaScript
- Homepage:
- Size: 438 KB
- Stars: 9
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cy-fy
Cypress starter pack for UI and API automation testing. Simple and neat folder structure in combination with typescript will help you write test faster. The Jenkinsfile and Dockerfiles will guide you to setup the CI/CD pipeline quickly.
## Get started
#### System Requirement
- Git (download form [here](https://git-scm.com/downloads))
- Node (download from [here](https://nodejs.org/en/download/))
- Java Run Time (download from [here](https://www.oracle.com/in/java/technologies/javase-downloads.html))
- Chrome, Firefox and Edge
#### Project setup
- Git clone the project
- install dependencies by `npm ci`
#### Test configuration setup
#### Test configuration
- UI test environment file is located at `config/ui.config.json`
- API test environment file is located at `config/api.config.json`
## Run Tests
#### Run UI test scenarios
```js
// this will clean and run the UI cucumber scenarios in headless mode
npm run cy:e2e
// At the time of develop test code, you may want to see and debug the execution
npm run cy:ui:dev
```
#### Run tests in multiple browsers
```js
// by-default test will be triggered in Electron
npm run cy:ui:run
// to run in chrome
npm run cy:ui:run -- --browser chrome
// to run in firefox
npm run cy:ui:run -- --browser firefox
// to run in edge
npm run cy:ui:run -- --browser edge
```
#### Run API test scenarios
```js
npm run cy:api
```
## Generate Reports
As this project deals with both API and UI, reports will be generated differently rather dumping everything into the same file.
```js
// to generate UI allure reports
npm run report:ui
// to generate API allure reports
npm run report:api
```
## Lint test codes
Linting is a great way to maintain coding standards and quality across the project. Here we use ESLint to ensure the same.
```js
npm run lint
```
## Folder structure
```bash
├── cypress
│ ├── fixtures
│ ├── integration
│ │ ├── api
│ │ ├── **/*.spec.ts
│ │ ├── ui
│ │ ├── pages
│ │ ├── specs
│ ├── plugins
│ ├── support
```
- _**fixures**_: fixtures are used as external pieces of static data that can be used by your tests. Read more [here](https://docs.cypress.io/guides/core-concepts/writing-and-organizing-tests.html#Fixture-Files)
- _**plugins**_: plugin file contains the helper libraries to achieve a specific tasks. Different cypress plugins can be found [here](https://docs.cypress.io/plugins/index.html)
- _**support**_: By default Cypress will automatically include the support file cypress/support/index.js. This file runs before every single spec file.
- _**integration**_: integration folder contains the actual tests. The ui test scenarios are stored in `ui` folder. `specs` folder contains all test files. `pages` folder contains all page actions. `api` folder contains all api test cases.
## Quick guide to write tests
## Generate reports
Reports will be generated separately for API and UI test cases but will have the same essence of Allure.
