aboutsummaryrefslogtreecommitdiff
path: root/tests/core/coverage/README.rst
diff options
context:
space:
mode:
authorSpandan Das <spandandas@google.com>2023-06-15 01:40:14 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>2023-06-15 01:40:14 +0000
commit780ccd3956961690db3e36d8fa1ed7649cb0057b (patch)
treed9fac15bb5a835ae6ba757dc5eaf6ef597ea44cf /tests/core/coverage/README.rst
parent9803cf8403d7105bddc1d5304d6e694b781a6605 (diff)
parent96939a977e4ffc1fec4dd7bdca23142216948ab7 (diff)
downloadbazelbuild-rules_go-780ccd3956961690db3e36d8fa1ed7649cb0057b.tar.gz
Merge remote-tracking branch 'aosp/upstream-master' into merge_rules_go am: 49dcd02124 am: 711a453236 am: 6cf433ad1b am: de80525bba am: 96939a977e
Original change: https://android-review.googlesource.com/c/platform/external/bazelbuild-rules_go/+/2625353 Change-Id: I32bead2047a7ae618c2688c609a950bc2055edf4 Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
Diffstat (limited to 'tests/core/coverage/README.rst')
-rw-r--r--tests/core/coverage/README.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/tests/core/coverage/README.rst b/tests/core/coverage/README.rst
new file mode 100644
index 00000000..aadc5fa9
--- /dev/null
+++ b/tests/core/coverage/README.rst
@@ -0,0 +1,23 @@
+.. _#2127: https://github.com/bazelbuild/rules_go/issues/2127
+
+coverage functionality
+======================
+
+coverage_test
+-------------
+
+Checks that ``bazel coverage`` on a ``go_test`` produces reasonable output.
+Libraries referenced by the test that pass ``--instrumentation_filter`` should
+have coverage data. Library excluded with ``--instrumentatiuon_filter`` should
+not have coverage data.
+
+binary_coverage_test
+--------------------
+
+Checks that ``bazel build --collect_code_coverage`` can instrument a
+``go_binary``. ``bazel coverage`` should also work, though it should fail
+with status 4 since the binary is not a test.
+
+This functionality isn't really complete. The generate test main package
+gathers and writes coverage data, and that's not present. This is just
+a regression test for a link error (`#2127`_).