Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(test): update test strategy to include links to metrics #810

Merged
merged 3 commits into from
Dec 17, 2024
Merged

docs(test): update test strategy to include links to metrics #810

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
94a73ce
docs(test): update test strategy to include links to metrics
Trinaa Dec 11, 2024
9223960
Merge branch 'master' into test_doc_update
jrconlin Dec 17, 2024
6649b14
Merge branch 'master' into test_doc_update
pjenvey Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/src/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,13 @@ Autopush is tested using a combination of functional, integration, and performan

Unit tests are written in the same Rust module as the code they are testing. Integration and Load Test code are in the `tests/` directory, both written in Python.

Presently, the Autopush test strategy does not require a minimum test coverage percentage for unit and integration tests. However, it is the goal that the service eventually have defined minimum coverage.
Load tests results should not go below a minimum performance threshold.
Presently, the Autopush test strategy does not require a minimum test coverage percentage for unit
tests. However, the recommended minimum performance threshold is 60%.

Test metrics are generated from Junit XML and coverage JSON files that are produced in CI/CD and
consumed by the ETE test metric pipeline. Visualizations of the metrics are available on the
[Autopush-rs Looker Dashboard][dashboard]. For more information on test metrics and the pipeline
see the [ETE team documentation][ete_docs].

The functional test strategy is three-tiered, composed of:

Expand Down Expand Up @@ -141,6 +146,8 @@ discretion of the Autopush Engineering Team.

For more details see the [README.md][load_tests_docs] file in the `tests/load` directory.

[dashboard]: https://mozilla.cloud.looker.com/dashboards/1977
[ete_docs]: https://mozilla.github.io/ecosystem-test-scripts/introduction.html
[unit_tests]: https://github.com/mozilla-services/autopush-rs/tree/master/
[unit_tests_docs]: ./testing.md#unit-tests
[bigtable_docs]: ./bigtable-emulation.md
Expand Down