Enable C++ branch coverage when using gcov 8 or later.

Branch coverage was disabled due to a gcov bug, but this was fixed for GCC 8: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=84879. It doesn't make sense to disable all C++ branch coverage for everyone because of a bug in an old GCC version. Closes #18879. RELNOTES: Enable C++ branch coverage if gcov version is 8 or newer. PiperOrigin-RevId: 547165873 Change-Id: I581d9902dc73910f686155548c3bf94c7a1d9207
bazelbuild · Jul 11, 2023 · 57ae1ff · 57ae1ff
1 parent fe678ea
commit 57ae1ff
Show file tree

Hide file tree

Showing 6 changed files with 228 additions and 25 deletions.
diff --git a/src/test/shell/bazel/bazel_cc_code_coverage_test.sh b/src/test/shell/bazel/bazel_cc_code_coverage_test.sh
@@ -376,6 +376,11 @@ function test_cc_test_coverage_gcov() {
       output_file_json="output_file.json"
       zcat $agcda $tgcda $dagcda > $output_file_json
 
+      # Remove all branch information from the json.
+      # We disable branch coverage for gcov 7 and it is easier to remove it
+      # than it is to put it back.
+      # Replace "branches": [..] with "branches": [] - (non-empty [..])
+      sed -E -i 's/"branches": \[[^]]+]/"branches": \[\]/g' "$output_file_json"
       assert_gcov_coverage_srcs_a_cc_json "$output_file_json"
       assert_gcov_coverage_srcs_t_cc_json "$output_file_json"
       assert_gcov_coverage_srcs_b_h_json "$output_file_json"

diff --git a/src/test/shell/bazel/bazel_coverage_cc_test_gcc.sh b/src/test/shell/bazel/bazel_coverage_cc_test_gcc.sh
@@ -110,6 +110,26 @@ was not found in actual coverage report:
 <$( cat "$output_file" )>"
 }
 
+# Asserts if the given expected coverage result is included in the given output
+# file, accounting for the fact that branch coverage is disabled for gcov v7
+#
+# - expected coverage The expected result that must be included in the output.
+# - output_file       The location of the coverage output file.
+function assert_cc_coverage_result() {
+  local expected_coverage="${1}"; shift
+  local output_file="${1}"; shift
+
+  # we disable branch coverage when using gcov 7 so we should strip all branch
+  # information from the "expected" result before checking.
+  # gcov -v | grep "gcov" outputs a line that looks like this:
+  # gcov (Debian 7.3.0-5) 7.3.0
+  local gcov_version="$(gcov -v | grep "gcov" | cut -d " " -f 4 | cut -d "." -f 1)"
+  if [[ "$gcov_version" -le 7 ]]; then
+    expected_coverage=$(echo "$expected_coverage" | grep -v "^BR")
+  fi
+  assert_coverage_result "$expected_coverage" "$output_file"
+}
+
 # Returns the path of the code coverage report that was generated by Bazel by
 # looking at the current $TEST_log. The method fails if TEST_log does not
 # contain any coverage report for a passed test.
@@ -139,14 +159,18 @@ FN:3,_Z1ab
 FNDA:1,_Z1ab
 FNF:1
 FNH:1
+BRDA:4,0,0,1
+BRDA:4,0,1,0
+BRF:2
+BRH:1
 DA:3,1
 DA:4,1
 DA:5,1
 DA:7,0
 LH:3
 LF:4
 end_of_record"
-  assert_coverage_result "$expected_result_a_cc" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_a_cc" "$coverage_file_path"
   # t.cc is not included in the coverage report because test targets are not
   # instrumented by default.
   assert_not_contains "SF:t\.cc" "$coverage_file_path"
@@ -277,7 +301,7 @@ DA:10,1
 LH:5
 LF:5
 end_of_record"
-  assert_coverage_result "$expected_result_num_lib" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_num_lib" "$coverage_file_path"
 
   local expected_result_a_header="SF:examples/cpp/foo/bar/baz/a_header.h
 FN:3,_ZNK1A12num_whateverEv
@@ -289,7 +313,7 @@ DA:4,1
 LH:2
 LF:2
 end_of_record"
-  assert_coverage_result "$expected_result_a_header" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_a_header" "$coverage_file_path"
 
   local coverage_result_num_lib_header="SF:examples/cpp/num-lib.h
 FN:14,_ZN3num6NumLib18add_number_inlinedEi
@@ -301,7 +325,7 @@ DA:15,1
 LH:2
 LF:2
 end_of_record"
-  assert_coverage_result "$coverage_result_num_lib_header" "$coverage_file_path"
+  assert_cc_coverage_result "$coverage_result_num_lib_header" "$coverage_file_path"
 }
 
 function test_cc_test_gcov_multiple_headers() {
@@ -371,6 +395,10 @@ FN:4,_Z1ab
 FNDA:1,_Z1ab
 FNF:1
 FNH:1
+BRDA:5,0,0,1
+BRDA:5,0,1,0
+BRF:2
+BRH:1
 DA:4,1
 DA:5,1
 DA:6,1
@@ -383,6 +411,10 @@ FN:1,_Z1bi
 FNDA:1,_Z1bi
 FNF:1
 FNH:1
+BRDA:2,0,0,1
+BRDA:2,0,1,0
+BRF:2
+BRH:1
 DA:1,1
 DA:2,1
 DA:3,1
@@ -393,8 +425,8 @@ end_of_record"
   local expected_result_t_cc="SF:coverage_srcs/t.cc"
 
   ############## Asserting the coverage results ##############
-  assert_coverage_result "$expected_result_a_cc" "$coverage_file_path"
-  assert_coverage_result "$expected_result_b_h" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_a_cc" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_b_h" "$coverage_file_path"
   # coverage_srcs/t.cc is not included in the coverage report because the test
   # targets are not instrumented by default.
   assert_not_contains "SF:coverage_srcs/t\.cc" "$coverage_file_path"
@@ -469,6 +501,10 @@ FN:4,_Z1ab
 FNDA:1,_Z1ab
 FNF:1
 FNH:1
+BRDA:5,0,0,1
+BRDA:5,0,1,0
+BRF:2
+BRH:1
 DA:4,1
 DA:5,1
 DA:6,1
@@ -481,6 +517,10 @@ FN:1,_Z1bi
 FNDA:1,_Z1bi
 FNF:1
 FNH:1
+BRDA:2,0,0,1
+BRDA:2,0,1,0
+BRF:2
+BRH:1
 DA:1,1
 DA:2,1
 DA:3,1
@@ -491,14 +531,14 @@ end_of_record"
   local expected_result_t_cc="SF:coverage_srcs/t.cc"
 
   ############## Asserting the coverage results ##############
-  assert_coverage_result "$expected_result_a_cc" "$coverage_file_path"
-  assert_coverage_result "$expected_result_b_h" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_a_cc" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_b_h" "$coverage_file_path"
   # iostream should not be in the final coverage report because it is a syslib.
   assert_not_contains "iostream" "$coverage_file_path"
   # coverage_srcs/t.cc should be included in the coverage report. We don't check
   # for the full contents of the t.cc report because it might vary from system
   # to system depending on the system headers.
-  assert_coverage_result "$expected_result_t_cc" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_t_cc" "$coverage_file_path"
 }
 
 function test_cc_test_gcov_same_header_different_libs() {
@@ -602,6 +642,10 @@ FN:4,_Z1ab
 FNDA:1,_Z1ab
 FNF:1
 FNH:1
+BRDA:5,0,0,1
+BRDA:5,0,1,0
+BRF:2
+BRH:1
 DA:4,1
 DA:5,1
 DA:6,1
@@ -616,6 +660,12 @@ FNDA:1,_Z7b_for_ai
 FNDA:1,_Z7b_for_ci
 FNF:2
 FNH:2
+BRDA:3,0,0,1
+BRDA:3,0,1,0
+BRDA:12,0,0,0
+BRDA:12,0,1,1
+BRF:4
+BRH:2
 DA:2,1
 DA:3,1
 DA:4,1
@@ -632,6 +682,10 @@ FN:4,_Z1cb
 FNDA:1,_Z1cb
 FNF:1
 FNH:1
+BRDA:5,0,0,0
+BRDA:5,0,1,1
+BRF:2
+BRH:1
 DA:4,1
 DA:5,1
 DA:6,0
@@ -641,9 +695,9 @@ LF:4
 end_of_record"
 
   ############## Asserting the coverage results ##############
-  assert_coverage_result "$expected_result_a_cc" "$coverage_file_path"
-  assert_coverage_result "$expected_result_b_h" "$coverage_file_path"
-  assert_coverage_result "$expected_result_c_cc" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_a_cc" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_b_h" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_c_cc" "$coverage_file_path"
   # coverage_srcs/t.cc is not included in the coverage report because the test
   # targets are not instrumented by default.
   assert_not_contains "SF:coverage_srcs/t\.cc" "$coverage_file_path"
@@ -769,6 +823,10 @@ FNDA:2,_Z10a_redirectv
 FNDA:1,_Z1ab
 FNF:2
 FNH:2
+BRDA:5,0,0,1
+BRDA:5,0,1,0
+BRF:2
+BRH:1
 DA:4,1
 DA:5,1
 DA:6,1
@@ -787,6 +845,12 @@ FNDA:1,_Z7b_for_ci
 FNDA:3,_Z9b_for_allv
 FNF:3
 FNH:3
+BRDA:3,0,0,1
+BRDA:3,0,1,0
+BRDA:12,0,0,0
+BRDA:12,0,1,1
+BRF:4
+BRH:2
 DA:2,1
 DA:3,1
 DA:4,1
@@ -807,6 +871,10 @@ FNDA:1,_Z10c_redirectv
 FNDA:1,_Z1cb
 FNF:2
 FNH:2
+BRDA:5,0,0,0
+BRDA:5,0,1,1
+BRF:2
+BRH:1
 DA:4,1
 DA:5,1
 DA:6,0
@@ -818,9 +886,9 @@ LF:6
 end_of_record"
 
   ############## Asserting the coverage results ##############
-  assert_coverage_result "$expected_result_a_cc" "$coverage_file_path"
-  assert_coverage_result "$expected_result_b_h" "$coverage_file_path"
-  assert_coverage_result "$expected_result_c_cc" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_a_cc" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_b_h" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_c_cc" "$coverage_file_path"
   # coverage_srcs/t.cc is not included in the coverage report because the test
   # targets are not instrumented by default.
   assert_not_contains "SF:coverage_srcs/t\.cc" "$coverage_file_path"
@@ -1017,6 +1085,10 @@ FN:4,_Z1ab
 FNDA:1,_Z1ab
 FNF:1
 FNH:1
+BRDA:5,0,0,1
+BRDA:5,0,1,0
+BRF:2
+BRH:1
 DA:4,1
 DA:5,1
 DA:6,1
@@ -1029,6 +1101,10 @@ FN:1,_Z1bb
 FNDA:1,_Z1bb
 FNF:1
 FNH:1
+BRDA:2,0,0,1
+BRDA:2,0,1,0
+BRF:2
+BRH:1
 DA:1,1
 DA:2,1
 DA:3,1
@@ -1037,8 +1113,8 @@ LH:3
 LF:4
 end_of_record'
 
-  assert_coverage_result "$expected_result_a_cc" "$coverage_file_path"
-  assert_coverage_result "$expected_result_b_cc" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_a_cc" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_b_cc" "$coverage_file_path"
 }
 
 function test_external_cc_target_coverage_not_collected_by_default() {
@@ -1057,6 +1133,10 @@ FN:1,_Z1bb
 FNDA:1,_Z1bb
 FNF:1
 FNH:1
+BRDA:2,0,0,1
+BRDA:2,0,1,0
+BRF:2
+BRH:1
 DA:1,1
 DA:2,1
 DA:3,1
@@ -1065,7 +1145,7 @@ LH:3
 LF:4
 end_of_record'
 
-  assert_coverage_result "$expected_result_b_cc" "$coverage_file_path"
+  assert_cc_coverage_result "$expected_result_b_cc" "$coverage_file_path"
   assert_not_contains "SF:external/other_repo/a.cc" "$coverage_file_path"
 }
 

diff --git a/src/test/shell/bazel/bazel_coverage_java_test.sh b/src/test/shell/bazel/bazel_coverage_java_test.sh
@@ -132,6 +132,26 @@ was not found in actual coverage report:
 <$( cat "$output_file" )>"
 }
 
+# Asserts if the given expected coverage result is included in the given output
+# file, accounting for the fact that branch coverage is disabled for gcov v7
+#
+# - expected coverage The expected result that must be included in the output.
+# - output_file       The location of the coverage output file.
+function assert_cc_coverage_result() {
+  local expected_coverage="${1}"; shift
+  local output_file="${1}"; shift
+
+  # we disable branch coverage when using gcov 7 so we should strip all branch
+  # information from the "expected" result before checking.
+  # gcov -v | grep "gcov" outputs a line that looks like this:
+  # gcov (Debian 7.3.0-5) 7.3.0
+  local gcov_version="$(gcov -v | grep "gcov" | cut -d " " -f 4 | cut -d "." -f 1)"
+  if [[ "$gcov_version" -le 7 ]]; then
+    expected_coverage=$(echo "$expected_coverage" | grep -v "^BR")
+  fi
+  assert_coverage_result "$expected_coverage" "$output_file"
+}
+
 # Returns the path of the code coverage report that was generated by Bazel by
 # looking at the current $TEST_log. The method fails if TEST_log does not
 # contain any coverage report for a passed test.
@@ -1133,6 +1153,14 @@ FN:5,main
 FNDA:1,main
 FNF:1
 FNH:1
+BRDA:6,0,0,1
+BRDA:6,0,1,0
+BRDA:8,0,0,0
+BRDA:8,0,1,1
+BRDA:11,0,0,1
+BRDA:11,0,1,0
+BRF:6
+BRH:3
 DA:5,1
 DA:6,1
 DA:7,1
@@ -1143,7 +1171,7 @@ DA:12,1
 LH:6
 LF:7
 end_of_record"
-  assert_coverage_result "$coverage_result_num_lib_header" "$coverage_file_path"
+  assert_cc_coverage_result "$coverage_result_num_lib_header" "$coverage_file_path"
 }
 
 function setup_external_java_target() {