From 5a89d983ddc25cd6515c687033ca505a04e46662 Mon Sep 17 00:00:00 2001 From: Michael Rebello Date: Thu, 24 Oct 2019 11:40:23 -0700 Subject: [PATCH] docs: add docs for running tests locally (#538) Signed-off-by: Michael Rebello Signed-off-by: JP Simard --- mobile/docs/root/development/development.rst | 1 + .../docs/root/development/testing/testing.rst | 40 +++++++++++++++++++ 2 files changed, 41 insertions(+) create mode 100644 mobile/docs/root/development/testing/testing.rst diff --git a/mobile/docs/root/development/development.rst b/mobile/docs/root/development/development.rst index 31e80914c9b3..f74c8bde7b4d 100644 --- a/mobile/docs/root/development/development.rst +++ b/mobile/docs/root/development/development.rst @@ -10,4 +10,5 @@ developing Envoy Mobile. :maxdepth: 2 performance/performance + testing/testing tools/tools diff --git a/mobile/docs/root/development/testing/testing.rst b/mobile/docs/root/development/testing/testing.rst new file mode 100644 index 000000000000..2cf91510c965 --- /dev/null +++ b/mobile/docs/root/development/testing/testing.rst @@ -0,0 +1,40 @@ +.. _testing: + +Testing +======= + +Envoy Mobile strives to have a high standard of code quality and test coverage for the entire +project. + +All unit tests are in the various ``library/`` directories of the repository, +and are run on CI for all PRs and merges to master. + +Tests may be run locally as outlined below. + +.. note:: + + The overall project testing strategy is being revisited as part of :issue:`#197 <197>`. + +---------- +Java tests +---------- + +To run the entire Java unit test suite locally, use the following Bazel command: + +``./bazelw test --test_output=all --build_tests_only //library/java/test/...`` + +------------ +Kotlin tests +------------ + +To run the entire Kotlin unit test suite locally, use the following Bazel command: + +``./bazelw test --test_output=all --build_tests_only //library/kotlin/test/...`` + +----------- +Swift tests +----------- + +To run the entire Swift unit test suite locally, use the following Bazel command: + +``./bazelw test --test_output=all --build_tests_only //library/swift/test/...``