Skip to content

Commit

Permalink
pw_transfer: Integration test documentation
Browse files Browse the repository at this point in the history
Tested by viewing the generated docs in the browser, and adding the line
to the footer.

Bug: b/228516801
Cq-Include-Trybots: luci.pigweed.try:pigweed-integration-transfer
Change-Id: If5d43c4bda558d77e91c1ff99cd0d5f2e9b11e56
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/92144
Reviewed-by: Erik Gilling <konkers@google.com>
Commit-Queue: Ted Pudlik <tpudlik@google.com>
  • Loading branch information
tpudlik authored and CQ Bot Account committed Apr 21, 2022
1 parent be03c36 commit 35e9f41
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions pw_transfer/docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -321,3 +321,29 @@ Receiver flow
signal_completion[Signal completion]-->done

done([Transfer complete])


-----------------
Integration tests
-----------------
The ``pw_transfer`` module has a set of integration tests that verify the
correctness of implementations in different languages.
`Test source code <https://cs.opensource.google/pigweed/pigweed/+/main:pw_transfer/integration_test/>`_.

To run the tests on your machine, run

.. code:: bash
$ bazel run pw_transfer/integration_test:cross_language_integration_test
CI/CQ integration
=================
`Current status of the test in CI <https://ci.chromium.org/p/pigweed/builders/ci/pigweed-integration-transfer>`_.

By default, these tests are not run in CQ (on presubmit) because they are too
slow. However, you can request that the tests be run in presubmit on your
change by adding to following line to the commit message footer:

.. code::
Cq-Include-Trybots: luci.pigweed.try:pigweed-integration-transfer

0 comments on commit 35e9f41

Please sign in to comment.