Renamed "collect_coverage_data.py" to "collect_line_and_branch_coverage.py" and revised script.

Tools/collect_coverage_data.py

-# Collect HTML coverage reports (created by Maven's jacoco plugin) and average the result of all moduls.
-# Use top-level pom.xml to look into correct subdirectories.
-#
-# Wach out: call this script from root directory of project. E.g.
-#
-#   python Tools/my_script.py
-
-import xml.etree.ElementTree as ET
-
-import os
-import re
-
-def get_modules_from_pom_file(filename="pom.xml"):
-    xml_name_spaces = {
-            "default": "http://maven.apache.org/POM/4.0.0"
-    }
-    
-    xml_tree = ET.parse(filename)
-    xml_root = xml_tree.getroot()
-    
-    exclude_list = ["VadereAnnotation"]
-    
-    modules = xml_root.findall("default:modules/default:module", xml_name_spaces)
-    module_names = [module.text for module in modules if module.text not in exclude_list]
-    
-    return module_names
-
-def read_coverage_data_for_modules(module_names):
-        module_to_coverage = dict()
-
-        default_coverage_file = "target/site/coverage-reports/index.html"
-
-        for module in module_names:
-            coverage_path = os.path.join(module, default_coverage_file)
-
-            with open(coverage_path, "r") as file:
-                coverage_report = file.read()
-
-                regex_pattern = re.compile(r"Total.*?([0-9]{1,3})%")
-                match = regex_pattern.search(coverage_report)
-
-                if match:
-                    module_to_coverage[module] = match.group(1)
-                else:
-                    raise Exception("Coverage data not found for module: {}".format(module))
-
-        return module_to_coverage
-
-if __name__ == "__main__":
-    module_names = get_modules_from_pom_file()
-    module_to_coverage = read_coverage_data_for_modules(module_names)
-
-    print(module_to_coverage)

Tools/collect_line_and_branch_coverage.py

+# Extract line and branch coverage (in percentage) from HTML coverage reports
+# which are created by Maven's jacoco plugin.
+# Use top-level pom.xml to search in correct subdirectories.
+#
+# Wach out: call this script from root directory of project. E.g.
+#
+#   python Tools/my_script.py
+
+import xml.etree.ElementTree as ET
+
+import os
+import re
+
+def get_modules_from_pom_file(filename="pom.xml"):
+    """Return a list of submodules which where found in passed "pom.xml"."""
+
+    xml_name_spaces = {
+            "default": "http://maven.apache.org/POM/4.0.0"
+    }
+    
+    xml_tree = ET.parse(filename)
+    xml_root = xml_tree.getroot()
+    
+    exclude_list = ["./VadereAnnotation", "./VadereGui"]
+    
+    modules = xml_root.findall("default:modules/default:module", xml_name_spaces)
+    module_names = [module.text for module in modules if module.text not in exclude_list]
+    
+    return module_names
+
+def extract_line_and_branch_coverage(module_names):
+    """Return a dictionary which maps module name to line and branch coverage tuple."""
+
+    module_to_coverage = dict()
+
+    default_coverage_file = "target/site/coverage-reports/index.html"
+
+    for module in module_names:
+        coverage_path = os.path.join(module, default_coverage_file)
+
+        with open(coverage_path, "r") as file:
+            coverage_report = file.read()
+
+            regex_pattern = re.compile(r"Total.*?([0-9]{1,3})%.*?([0-9]{1,3})%")
+            match = regex_pattern.search(coverage_report)
+
+            if match:
+                line_coverage = float(match.group(1))
+                branch_coverage = float(match.group(2))
+                module_to_coverage[module] = (line_coverage, branch_coverage)
+            else:
+                raise Exception("Coverage data not found for module: {}".format(module))
+
+    return module_to_coverage
+
+def print_averaged_line_coverage(coverage_data):
+    """GitLab CI tools read out the stdout output of the build process. Therefore, print coverage info to stdout."""
+
+    total_modules = len(coverage_data)
+    line_coverage_data = [line_coverage for (line_coverage, branch_coverage) in coverage_data.values()]
+    branch_coverage_data = [branch_coverage for (line_coverage, branch_coverage) in coverage_data.values()]
+
+    summed_line_coverage_data = sum(line_coverage_data)
+    summed_branch_coverage_data = sum(branch_coverage_data)
+
+    # By default, GitLab CI parses only integers.
+    averaged_line_coverage = int(round(summed_line_coverage_data / total_modules, 0))
+    averaged_branch_coverage = int(round(summed_branch_coverage_data / total_modules, 0))
+
+    print("Line Coverage: Total {}%".format(averaged_line_coverage))
+    print("Branch Coverage: {}%".format(averaged_branch_coverage))
+
+if __name__ == "__main__":
+    module_names = get_modules_from_pom_file()
+    module_to_coverage = extract_line_and_branch_coverage(module_names)
+    print_averaged_line_coverage(module_to_coverage)

pom.xml

@@ -21,7 +21,7 @@
     <module>./VadereSimulator</module>
     <module>./VadereState</module>
     <module>./VadereUtils</module>
-    <module>VadereAnnotation</module>
+    <module>./VadereAnnotation</module>
   </modules>
   
 <!-- global dependencies! -->