d2ef01ecc2
We are no longer using the Percy service, so this code is not required anymore. Removes the percy agent, the gem, and all references to Percy.snapshot and percy: true. |
||
|---|---|---|
| .. | ||
| acceptance-tests.md | ||
| accessibility-tests.md | ||
| approvals-tests.md | ||
| code-coverage.md | ||
| codeclimate.md | ||
| frontend-tests.md | ||
| integration-tests.md | ||
| readme.md | ||
| regression-tests.md | ||
| test-flags.md | ||
| unit-functional-tests.md | ||
| title | items | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Testing/QA Guide |
|
We use the following testing tools:
- RSpec for testing the Rails backend
- Capybara with webdrivers for acceptance testing
- guard-rspec for automated testing
- Jest for testing the frontend
- jest-axe for detecting basic a11y regressions
- preact-testing-library for testing Preact components
- SimpleCov for tracking overall test coverage on the backend
We strive to provide tests for each pull request that adds new features or fixes a bug. Ideally, we test the functionality of the frontend and the backed.
If you'd like to help us improve our test coverage, we recommend checking out our total coverage and writing tests for selected files based on SimpleCov's test coverage results. You can also check out Code Climate summary which includes the test coverage.
If you're new to writing tests in general or with Rails, we recommend reading about testing with Rails, RSpec, and Capybara first.
Continuous Integration & Continuous Deployment
We are using Travis for CI and CD. Travis will run a build (in an isolated environment for testing) for every push to this repository. We also recently added KnapsackPro to our Travis CI setup. KnapsackPro allows us to split up our tests evenly between 3 different jobs(virtual machines). These 3 jobs all run in parallel which helps decrease the time needed to run all of our specs.
If you want more information about your CI job or how long specific specs take to run you can find all of that information on our KnapsackPro public dashboard.
Keep in mind that a passing build does not necessarily mean the project won't run into any issues. Strive to write good tests for the code you wish to contribute.
Travis will deploy your pull request to production after CI passes and a member of the DEV team has approved it.
Our test suite is not perfect and sometimes a re-run is needed. If you encounter a "flaky spec" that fails intermittently please open an issue so we can address it. In order to get your test suite to pass after a flaky spec has failed simply retry the individual job that failed rather than the entire suite in order to save some time. When you retry the individual job, make sure to also retry the Deploy job. Even though you may not be deploying that job must complete for the entire build to pass.
Please note that you will need to have Elasticsearch installed and running for certain tests in our test suite. You can find instructions on how to install and run Elasticsearch specific your environment in the Installation Guide.