updated readme

This commit is contained in:
Niels Lyngsø
2020-09-25 11:36:43 +02:00
parent 9286282eca
commit 78724c11eb

View File

@@ -1,34 +1,36 @@
# Umbraco Acceptance Tests
### Prerequisites
- NodeJS 12+
- A running installed Umbraco on url: [https://localhost:44331](https://localhost:44331) (Default development port)
- Install using a `SqlServer`/`LocalDb` as the tests execute too fast for `SqlCE` to handle.
- User information in `cypress.env.json` (See [Getting started](#getting-started))
### Getting started
The tests are located in the project/folder as `Umbraco.Tests.AcceptanceTests`. Make sure you run `npm install` in that folder, or let your IDE do that.
Next, it is important that you create a new file in the root of the project called `cypress.env.json`.
This file is already added to `.gitignore` and can contain values that are different for each developer machine.
The file needs the following content:
```
{
"username": "<email for superadmin>",
"password": "<password for superadmin>"
}
```
Replace the `<email for superadmin>` and `<password for superadmin>` placeholders with correct info.
### Executing tests
There are two npm scripts that can be used to execute the test:
1. `npm run test`
- Executes the tests headless.
1. `npm run ui`
- Executes the tests in a browser handled by a cypress application.
In case of errors it is recommended to use the UI to debug.
# Umbraco Acceptance Tests
### Prerequisites
- NodeJS 12+
- A running installed Umbraco on url: [https://localhost:44331](https://localhost:44331) (Default development port)
- Install using a `SqlServer`/`LocalDb` as the tests execute too fast for `SqlCE` to handle.
### Getting started
The tests are located in the project/folder as `Umbraco.Tests.AcceptanceTests`. Make sure you run `npm install` in that folder, or let your IDE do that.
The script will ask you to enter the username and password for a superadmin user of your Umbraco CMS.
### Executing tests
There are two npm scripts that can be used to execute the test:
1. `npm run test`
- Executes the tests headless.
1. `npm run ui`
- Executes the tests in a browser handled by a cypress application.
In case of errors it is recommended to use the UI to debug.
### Enviroment Configuration
The enviroment configuration is begin setup by the npm installation script.
This results in the creation of this file: `cypress.env.json`.
This file is already added to `.gitignore` and can contain values that are different for each developer machine.
The file has the following content:
```
{
"username": "<email for superadmin>",
"password": "<password for superadmin>"
}
```
You can change this if you like or run the config script to reset the values, type "npm run config" in your terminal.