Skip to content

TESTING.md

Latest commit

 

History

History
179 lines (106 loc) · 4.97 KB

TESTING.md

File metadata and controls

179 lines (106 loc) · 4.97 KB
Raw

Testing Linode Manager

Unit Tests

The unit tests for Linode manager are written in Typescript using the Jest testing framework. Unit tests end with the .test.tsx file extension and can be found throughout the codebase.

To run tests:

yarn && yarn test

Or you can run the tests in watch mode with:

yarn && yarn test --watch

To Run a specific file or files in a directory:

yarn test myFile.test.tsx
yarn test src/some-folder

Jest includes pattern matching out of the box, so you can also do things like run all tests whose filename contains "Linode" with

yarn test linode

To run a test in debug mode, add a debugger breakpoint inside one of the test cases, then run

yarn test:debug

Test execution will stop at the debugger statement, and you will be able to use Chrome's normal debugger to step through the tests (open chrome://inspect/#devices in Chrome).

End-to-End Tests

End-to-end Testing of the Linode Manager can be done locally by running Selenium & WebdriverIO tests alongside the local development environment, or by running multiple containers via docker-compose.

The Manager application has a suite of automated browser tests that live in the e2e/specs directory. These browser tests are written in Node.js using the WebdriverIO selenium framework. The configuration files for the WDIO test runner can be found in e2e/config.

Prior to running the tests, you must set MANAGER_USER= and MANAGER_PASS env variables in your .env file. These credentials will be used to login prior to each test.

Dependencies
  • Java JDK 8
brew cask uninstall java
brew tap caskroom/versions
brew cask install java8
  • Node.js 8 LTS (brew install node@8)
  • Google Chrome v60+ (brew cask install google-chrome)
  • Yarn (brew install yarn)

Run Suite

 yarn && yarn start  # Starts the local development environment

 ## New shell

 yarn selenium  # Starts selenium (Must be running to execute tests)

 ## New shell

 yarn e2e  # Executes specs matching e2e/specs/**/*.spec.js

Command Line Arguments

The yarn e2e command accepts a number of helpful command line arguments that facilitate writing and running tests locally.

Running an individual spec file:

yarn e2e --file [/path/to/test.spec.js]

Running E2E suite in a non-default browser

yarn e2e -b [chrome,firefox,headlessChrome,safari]

Run Suite in Docker Local Dev Environment

Dependencies
  • Docker v18+
  • Docker-Compose v1.20.1+
Prerequisites

In order to run the tests via docker-compose, you will need to update your OAuth Client Redirect URL to: https://manager-local:3000/oauth/callback. The recommendation is to generate a new OAuth client in the Manager, set the redirect url to the above, and set the REACT_APP_CLIENT_ID= to the new OAuth Client ID in the .env file. You must also set MANAGER_USER= and MANAGER_PASS env variables in your .env file. These credentials will be used to login prior to each test.

Running the Suite
docker-compose -f integration-test.yml up --build --exit-code-from manager-e2e

# OR if Yarn is installed:

yarn docker:e2e

Testing React Storybook Components

In addition to the Linode Manager E2E tests, there are also UI tests for the ReactJS components. The components are tested via Storybook and the test specs live in src/components/ComponentName/ComponentName.spec.js. The WDIO config lives in e2e/config/wdio.storybook.conf.js

Dependencies
  • Same as Testing Manager

Run Suite

 yarn storybook  # Starts storybook

 ## New shell

 yarn selenium  # Starts selenium (Must be running to execute tests)

 ## New shell

 yarn storybook:e2e  # Executes specs matching src/components/**/*.spec.js

Run a Single Test

yarn storybook:e2e --story StoryName # Executes spec matching src/components/StoryName/StoryName.spec.js

Run a Test in Non-Headless Chrome

yarn selenium

## New Shell

yarn storybook:e2e --debug --story StoryName # The --debug flag spawns a visible chrome session

Run Suite in Docker Environment

Dependencies
  • Same as Testing Manager
Running the Suite
docker-compose -f integration-test.yml up --build --exit-code-from manager-e2e

# OR if Yarn is installed:

yarn docker:e2e

Accessibility Testing

The axe-core accessibility testing script has been integrated into the webdriverIO-based testing framework to enable automated accessibility testing. At present, the script merely navigates to all routes described in e2e/constants.js, loads the page and runs the accessibility tests.

Dependencies
  • Same as E2E Manager tests

Run Suite

 yarn && yarn start # Starts the local development environment
 yarn axe

The test results will be saved as a JSON file with Critical accessibility violations appearing at the top of the list.