9fd55657d0
* Remove skip-ci article from docs Skipping CI causes a hiccup in the PR merging and approval process. Molly and I talked about this, and we probably need to revisit our github process revolving around this, but since it is presently causing an issue, it probably shouldn't be in the docs. We can always add it back if we change our minds. * Add a maintainers doc This doc will give us a place to store information, like the discussion that Molly and I had around skipping CI, so that anyone with Repo access can find and contribute to how we run the project.
59 lines
2.3 KiB
Markdown
59 lines
2.3 KiB
Markdown
---
|
|
title: Testing/QA Guide
|
|
items:
|
|
- acceptance-tests.md
|
|
- integration-tests.md
|
|
- unit-functional-tests.md
|
|
- preact-tests.md
|
|
- accessibility-tests.md
|
|
- regression-tests.md
|
|
- code-coverage.md
|
|
- codeclimate.md
|
|
---
|
|
|
|
We use the following testing tools:
|
|
|
|
- [**RSpec**](http://rspec.info/) for testing the Rails backend
|
|
- [**Capybara**](https://github.com/teamcapybara/capybara) with
|
|
[**webdrivers**](https://github.com/titusfortner/webdrivers) for acceptance
|
|
testing
|
|
- [**guard-rspec**](https://github.com/guard/guard-rspec) for automated testing
|
|
- [**Jest**](https://jestjs.io/) for testing the frontend
|
|
- [**jest-axe**](https://github.com/nickcolley/jest-axe) for detecting basic
|
|
a11y regressions
|
|
- [**preact-render-spy**](https://github.com/mzgoddard/preact-render-spy) for
|
|
testing Preact components
|
|
- [**SimpleCov**](https://github.com/colszowka/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](https://codeclimate.com/github/thepracticaldev/dev.to)
|
|
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](https://guides.rubyonrails.org/testing.html).
|
|
|
|
## 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.
|
|
|
|
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.
|
|
|
|
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](/installation).
|