SBA.gov Cypress Integration Tests

The suite of in-browser UI tests SBA.gov

Running Cypress

Cypress can run in a few ways.

1. Local Run - Cypress can be run locally to aid in test creation and development. This is the typical way cypress is run during development and is an interactive mode that aids in development.
2. Docker Run - Cypress can be run in a container to be used for scheduled testing or testing linked to builds in the deployment pipeline

Local Run - Running cypress locally with the UI

Install cypress and dependencies

npm install

Run cypress normally

npx cypress open

or...

Run cypress w/ environment variables

This is required to run the drupal tests with credentials to log in to drupal and test drupal functionality

./run-cypress.sh <environment> <drupal-username> <drupal-password>

This will run Cypress using the cypress open command to use the Cypress UI for local testing and development.

Docker Run - Running cypress in a Docker container

This is how the automatic runs are executed.

• environment: base environment name like "mint", "avery"
• param-store-name: the name of the aws param store to use to get drupal username and password. This is usually the same as the environment name like "amy" or "pat"
• file (optional): specific test file to run

Please make sure to run this before checking in code to ensure that it will run remotely

./run-cypress-docker.sh <environment> [param-store-name] [file]

• <environment>: defaults to mint if not provided
• [param-store-name]: Optional parameter. If not provided uses the same value as environment
• [file]: Optional. Path to what test file to run. Must provide other parameters if this is provided.

This will build the container and run the tests against the provided environment using the credentials from the param store provided.

To Build the Docker Container

./build.sh

Builds the docker container using the current repository. First thime this run can take a bit of time. Subsequent builds should go quickly as long as the installation has not changed.

Download the latest test results

aws s3 sync s3://sbagovlower-test-results/cypress/<environment>/latest/ .

Gets the latest test results from the S3 bucket. Must have access to this AWS instance to pull down this data.

To Deploy

git tag latest -f && git push origin latest -f

Using Cypress

Cypress Folder Structure

Everything essential for cypress is located in the /cypress folder. You can read more about the folder structure within the Cypress documentation

The only exception is how the /integration folder is structured. This folder has two sub folders.

• cypress/integration/tests: contains all tests that should be automatically run. The automatic processes that run tests look in here and run everything. Only check in tests here that should ALWAYS be run and potentially often.
• cypress/integration/tools: Is a sandbox of tools for developers to use to aid in development and testing. These tests are not automatically run and should be manually executed. These are tests that might have special configurations or be templates for other tests that can be tweaked on the fly.

Cypress Best Practices

Please be sure to follow the Cypress Best Practices in building good tests.

Some additional best practices to consider are:

• Avoid unnecessary UI interactions - use a cy.visit() to go to a page directly rather than clicking your way through interfaces unless it is absolutely necessary to test the entire user flow.

Project Details

Changelog

Refer to the changelog for details on API updates. CHANGELOG

License

The SBA.gov Integration Tests is licensed permissively under the Apache License v2.0. A copy of that license is distributed with this software.

Contributing

We welcome contributions. Please read CONTRIBUTING for how to contribute.

Code Of Conduct

We strive for a welcoming and inclusive environment for the SBA.gov Integration Tests project.

Please follow this guidelines in all interactions:

1. Be Respectful: use welcoming and inclusive language.
2. Assume best intentions: seek to understand other's opinions.

Security Issues

Please do not submit an issue on GitHub for a security vulnerability. Please contact the development team through SBA Website Support.

Be sure to include all the pertinent information.

_{The agency reserves the right to change this policy at any time.}