Skip to content

Commit

Permalink
Add to the readme, add notes on yarn
Browse files Browse the repository at this point in the history
  • Loading branch information
svevang committed Jul 1, 2024
1 parent 3200b96 commit e5f67f1
Showing 1 changed file with 56 additions and 13 deletions.
69 changes: 56 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,75 @@
# PRX Acceptance Tests

Acceptance tests for PRX systems
Acceptance tests for PRX systems using Cypress.

Written in [Cypress](https://www.cypress.io/)
## What is Cypress?

Cypress is a next-generation front end testing tool built for the modern web.
It enables you to write all types of tests:
- End-to-end tests
- Integration tests
- Unit tests

We're using for E2E tests to cover core functionality of apps at PRX.

## Requirements

- [Node.js](https://nodejs.org/) (preferably managed with [asdf](https://github.com/asdf-vm/asdf))
- [Yarn](https://yarnpkg.com/)

## Installation

You probably have NodeJS installed via `asdf` right?
1. Clone this repository
2. Install dependencies:
```sh
yarn install
```
3. Configure your test user/pass/fixtures:
```sh
cp env-example .env
# Edit .env with your settings
```

Then let's get started:
## Running Tests

```sh
yarn
There are two main ways to run Cypress tests:

# configure your test user/pass/fixtures
cp env-example .env
vi .env
### Headless Mode (Run)

# run the tests headless
Run tests in headless mode:
```sh
yarn test
```

# open cypress
This command runs all tests in the terminal without opening a browser window.
It's useful for continuous integration environments or when you want to quickly
run all tests.
### Interactive Mode (Open)
Open Cypress Test Runner:
```sh
yarn start
```
## Development
This command opens the Cypress Test Runner, a graphical user interface that allows you to:
- See all test files
- Choose specific tests to run
- Watch tests run in real time in the browser
- Debug tests using browser developer tools
The Test Runner is particularly useful during test development and debugging.
You can set a `debugger` statement or inspect the DOM!
## Writing Tests
Cypress tests are located in the `cypress/e2e` directory. To create a new test:
1. Create a new `.cy.ts` file in the `cypress/e2e` directory
2. Write your test using Cypress commands
3. Run your test using the Cypress Test Runner or command line
I'm still figuring it out, okay?
For more information on writing Cypress tests, refer to the [Cypress Documentation](https://docs.cypress.io/).
## License
Expand Down

0 comments on commit e5f67f1

Please sign in to comment.