The automated tests are based on the Cypress testing tool: https://docs.cypress.io
We have 2 test suites, one suite has been developed for OnDemand version 3.x with the old FASRC configuration. This suite is called fasrcv3
The second suite based on OnDemand version 3.x and the Sid and FASRC profiles. This suite is called ondemand
The fasrcv3 suites will deprecated and deleted once the new OnDemand environments are deployed into Staging and Production.
The automated tests has been developed and tested using:
node/18.16.0npm/9.5.1
Install Homebrew:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Use a tool to manage multiple versions of Node, like n
brew install n
Install Node.js with n.
# Download and install a Node version:
n 18.16.0
# Use n to select the Node version 18.16.0:
n
# Verify current Node version:
node --version
npm install
To run tests against a remote environment, you need to be connected to the appropriate VPN, @iqssrc, @fasrc or @fasse.
Cypress can be configured using environment variables. We use a feature of Cypress to setup and environment file: cypress.env.json with environment specific configuration. Each make task that executes a test will create a copy of the environment specific file into the cypress.env.json file.
In order to support the multiple OnDemand environments, we have created several configuration files for each one of them:
ondemand/cypress.env.json.local- to be removed.ondemand/cypress.env.json.dev-cannonondemand/cypress.env.json.dev-fasseondemand/cypress.env.json.qa-cannonondemand/cypress.env.json.prod-cannonondemand/cypress.env.json.prod-fasse
The following make tasks will execute the tests for FASRC v3:
make fasrcv3 CONFIG=prod-cannonmake fasrcv3 CONFIG=prod-cannon.amake fasrcv3 CONFIG=prod-cannon.bmake fasrcv3 CONFIG=prod-cannon.cmake fasrcv3 CONFIG=prod-fassemake fasrcv3 CONFIG=prod-fasse.amake fasrcv3 CONFIG=prod-fasse.bmake fasrcv3 CONFIG=prod-fasse.c
The following make tasks will execute the tests for OnDemand v3 with the FASRC and Sid profiles against the different environments:
make ondemand CONFIG=prod-cannonmake ondemand CONFIG=prod-cannon.amake ondemand CONFIG=prod-cannon.bmake ondemand CONFIG=prod-cannon.cmake ondemand CONFIG=prod-fassemake ondemand CONFIG=prod-fasse.amake ondemand CONFIG=prod-fasse.bmake ondemand CONFIG=prod-fasse.c
Depending on the environment set in the CONFIG variable, the tests will be run on the following servers:
| Environment | Server URL |
|---|---|
| dev-cannon.a | https://b-dev-cannonooda.rc.fas.harvard.edu/ |
| dev-fasse.a | https://h-dev-fasseooda.rc.fas.harvard.edu/ |
| qa-cannon.a | https://b-qa-cannonooda.rc.fas.harvard.edu/ |
| qa-fasse.a | https://h-qa-fasseooda.rc.fas.harvard.edu/ |
| prod-cannon | https://rcood.rc.fas.harvard.edu/ |
| prod-cannon.a | https://b-cannonooda.rc.fas.harvard.edu/ |
| prod-cannon.b | https://b-cannonoodb.rc.fas.harvard.edu/ |
| prod-cannon.c | https://b-cannonoodc.rc.fas.harvard.edu/ |
| prod-fasse | https://fasseood.rc.fas.harvard.edu/ |
| prod-fasse.a | https://h-fasseooda.rc.fas.harvard.edu/ |
| prod-fasse.b | https://h-fasseoodb.rc.fas.harvard.edu/ |
| prod-fasse.c | https://h-fasseoodc.rc.fas.harvard.edu/ |
In order to connect to the dashboard, we need to provide the automated tests with credentials. We can set environment variables or a credentials file. The environment variables are:
OOD_USERNAMEOOD_PASSWORD
example: env OOD_USERNAME=ood OOD_PASSWORD=ood make ondemand CONFIG=prod-fasse
The credentials file can be droped at the root of the project: credentials.json. This is a JSON format file with the username and password, example:
{
"username": "ood",
"password": "ood"
}
For all the local environments, the credentials are already configured in the environment configuration.
We can run Cypress through npm, a cypress script was added to the package.json file.
The -- parameter is added to pass parameters from the command line to the executed script through npm.
When using the Cypress CLI, please ensure that the right environment has been copied into cypress.env.json file.
As well, we need to pass the environment that we are using to select the appropriate based URL.
Full list of environments and URLs here
Opening Cypress UI
env OOD_ENVIRONMENT=prod-cannon npm run cypress -- open
Running all tests inside a folder
env OOD_ENVIRONMENT=prod-fasse npm run cypress -- run --spec "cypress/e2e/ondemand/sid/*"
Running an individual test
env OOD_ENVIRONMENT=prod-cannon.a npm run cypress -- run --spec "cypress/e2e/ondemand/fasrcv3/footer.cy.js"
env OOD_ENVIRONMENT=prod-cannon.b npm run cypress -- run --spec "cypress/e2e/ondemand/fasrc/homepage.cy.js"
env OOD_ENVIRONMENT=prod-cannon.c npm run cypress -- run --spec "cypress/e2e/ondemand/sid/supportticket.cy.js"
Running with other browsers
env OOD_ENVIRONMENT=prod-fasse.a npm run cypress -- run --browser chrome"
Tests are located under: cypress/e2e/*
General constants and utilites: cypress/support/base.js and cypress/support/utils/*
Reading credentials utility: cypress/plugins/index.js
Cypress API reference: https://docs.cypress.io/api/table-of-contents
Information about Cypress and Docker can be found here
We use cypress/base to run the automated tests within Docker. The image is configured in the Makefile
When running through Docker, Cypress prints some error messages:
[226:1117/145128.491783:ERROR:bus.cc(392)] Failed to connect to the bus: Could not parse server address: Unknown address type (examples of valid types are "tcp" and on UNIX "unix")
According to Cypress support, these are messages printed by the Electron browser and it is fine to ignore
Manually testing the SSL certificate of each individual host with cUrl
nslookup b-cannonooda-01.rc.fas.harvard.edu
curl -v --resolve rcood.rc.fas.harvard.edu:443:10.242.123.101 --head https://rcood.rc.fas.harvard.edu/pun/sys/dashboard
* SSL certificate verify ok.
* using HTTP/1.x
> HEAD /pun/sys/dashboard HTTP/1.1
> Host: rcood.rc.fas.harvard.edu
> User-Agent: curl/8.7.1
> Accept: */*
>
* Request completely sent off
< HTTP/1.1 401 Unauthorized
HTTP/1.1 401 Unauthorized
< Date: Fri, 25 Oct 2024 15:15:29 GMT
Date: Fri, 25 Oct 2024 15:15:29 GMT
< Server: Apache
Server: Apache
< Content-Security-Policy: frame-ancestors https://*.rc.fas.harvard.edu;
Content-Security-Policy: frame-ancestors https://*.rc.fas.harvard.edu;
< Strict-Transport-Security: max-age=63072000; includeSubDomains; preload
Strict-Transport-Security: max-age=63072000; includeSubDomains; preload
< WWW-Authenticate: Basic realm="private"
WWW-Authenticate: Basic realm="private"
< Content-Type: text/html; charset=iso-8859-1
Content-Type: text/html; charset=iso-8859-1