Skip to content

Commit

Permalink
update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
amyreit committed Jun 26, 2023
1 parent 91dcd08 commit caa2994
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions src/test/cypressjs/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# How to run [Cypress.io](https://www.cypress.io/) automated UI tests
# How to run [Cypress.io](https://www.cypress.io/) automated UI tests Locallly

## Step 1: First time setting up local environment with Cypress
- Run `npm install` in the directory containing this `README.md`
- `node_modules` is created containing Cypress and its dependencies.

## Step 2: Setup URL you want the to test and the default java (2 options)
Update the value for `default_website_url` in `cypress.config.js` with target URL, update
the default_jdk with which java you want to test for tests that only test one, update the
locations of the java levels on your local machine
Update the value for `default_website_url` in `cypress.config.js` with target URL (usually either
the staging or production site). To execute the testOLStarterAll*.cy.js tests update the default java
and the location of the java levels on your local machine to the version you wish to test.

NOTE - do not check in the cypress.config.js file with any changes for your local environment

Expand All @@ -18,3 +18,11 @@ NOTE - do not check in the cypress.config.js file with any changes for your loca

NOTE - the testOLStarterAllGradle.cy.js and cypress/e2e/testOLMavenAllGradle.cy.js tests use a
lot of system memory and run more reliably headless

# Alternatively - Run Tests with GitHub Actions In Git

## Step 1: Go to https://github.com/OpenLiberty/openliberty.io/actions
Here you will see an action called 'General Starter and Redirect Tests'. This action will execute all of the tests in
the cypressjs/cypress/e2e directory with the exception of the testOLStarterAllMaven and testOLStarterAllGradle. These
two tests can be run from the starter repo - https://github.com/OpenLiberty/start.openliberty.io/actions.

0 comments on commit caa2994

Please sign in to comment.