* Updated to keep in syhc with Jenkins integration

   * Encoding issues
   * Using @contextlib for file open
* Adding support to work with BitBucket Pipelines

Author: TimSVector

README.md

@@ -12,9 +12,13 @@ This integration allows the user to build, execute, generate reports, and genera
 [VectorCAST](http://vector.com/vectorcast) Projects in various CI/CD tools
 
 Results can be published in the following formats
-* Coverage results to **_GitLab_**, **_SonarQube_**: **_Cobertura_** (xml_data/cobertura) and **_Extended Cobertura_**
+* Coverage results 
+   * To **_GitLab Pipeline_ **, **_Microsoft Azure_**, **_GitHub Actions_**, **_SonarQube_**: **_Cobertura_** (xml_data/cobertura) 
+   * To **_BitBucket Pipelines_**: **_Cobertura_** sent via REST API
+   * To **_Jenkins_**: **_Extended Cobertura_** for Jenkins Coverage Plugin support
+
 * Test Results
-    * To **_GitLab_**: **_JUnit_** (xml_data/junit)
+    * To _GitLab Pipeline_ **, **_Microsoft Azure_**, **_GitHub Actions_**, **_BitBucket Pipelines_**, and **_Jenkins_** : **_JUnit_** (xml_data/junit)
     * To **_SonarQube_**: **_CppUnit_** (xml_data/sonarqube)  
 * Static Analysis to **_GitLab_**: **_CodeClimate_** (pclp/gl-code-quality-report.json)
 
@@ -27,16 +31,17 @@ The python scrip `vcast_exec.py` is the main driver for build/execute VectorCAST
 The api for vcast_exec.py follows:
 
 ```
-    vpython vcast_exec.py --help
-    usage: vcast_exec.py [-h] [--build-execute] [--build | --incremental] [--output_dir OUTPUT_DIR]
-                         [--source_root SOURCE_ROOT] [--html_base_dir HTML_BASE_DIR] 
-                         [--cobertura] [--cobertura_extended] [--lcov] [--junit] 
-                         [--export_rgw] [--sonarqube] [--pclp_input PCLP_INPUT]
-                         [--pclp_output_html PCLP_OUTPUT_HTML] 
-                         [--exit_with_failed_count [EXIT_WITH_FAILED_COUNT]] 
-                         [--aggregate] [--metrics] [--fullstatus] [--utfull] [--tcmr] [--index] 
-                         [--jobs JOBS] [--ci] [--level LEVEL] [--environment ENVIRONMENT] 
-                         [--gitlab | --azure] [--print_exc] [--timing] [--version]
+    usage: vcast_exec.py [-h] [--build-execute] [--build | --incremental]
+                         [--output_dir OUTPUT_DIR] [--source_root SOURCE_ROOT]
+                         [--html_base_dir HTML_BASE_DIR] [--cobertura]
+                         [--cobertura_extended] [--lcov] [--junit] [--export_rgw]
+                         [--sonarqube] [--pclp_input PCLP_INPUT]
+                         [--pclp_output_html PCLP_OUTPUT_HTML]
+                         [--exit_with_failed_count [EXIT_WITH_FAILED_COUNT]]
+                         [--aggregate] [--metrics] [--fullstatus] [--utfull]
+                         [--tcmr] [--index] [--jobs JOBS] [--ci] [-l LEVEL]
+                         [-e ENVIRONMENT] [--gitlab | --azure] [--print_exc]
+                         [--timing] [-v] [--version]
                          [ManageProject]
 
     positional arguments:
@@ -56,41 +61,54 @@ The api for vcast_exec.py follows:
       Options generating metrics
 
       --output_dir OUTPUT_DIR
-                            Set the base directory of the xml_data directory. Default is the workspace directory
+                            Set the base directory of the xml_data directory.
+                            Default is the workspace directory
       --source_root SOURCE_ROOT
-                            Set the absolute path for the source file in coverage reporting
+                            Set the absolute path for the source file in coverage
+                            reporting
       --html_base_dir HTML_BASE_DIR
-                            Set the base directory of the html_reports directory. The default is the workspace directory
+                            Set the base directory of the html_reports directory.
+                            The default is the workspace directory
       --cobertura           Generate coverage results in Cobertura xml format
-      --cobertura_extended  Generate coverage results in extended Cobertura xml format
+      --cobertura_extended  Generate coverage results in extended Cobertura xml
+                            format
       --lcov                Generate coverage results in an LCOV format
       --junit               Generate test results in Junit xml format
       --export_rgw          Export RGW data
-      --sonarqube           Generate test results in SonarQube Generic test execution report format (CppUnit)
+      --sonarqube           Generate test results in SonarQube Generic test
+                            execution report format (CppUnit)
       --pclp_input PCLP_INPUT
-                            Generate static analysis results from PC-lint Plus XML file to generic static analysis format (codequality)
+                            Generate static analysis results from PC-lint Plus XML
+                            file to generic static analysis format (codequality)
       --pclp_output_html PCLP_OUTPUT_HTML
-                            Generate static analysis results from PC-lint Plus XML file to an HTML output
+                            Generate static analysis results from PC-lint Plus XML
+                            file to an HTML output
       --exit_with_failed_count [EXIT_WITH_FAILED_COUNT]
-                            Returns failed test case count as script exit. Set a value to indicate a percentage above which the job will be marked as failed
+                            Returns failed test case count as script exit. Set a
+                            value to indicate a percentage above which the job
+                            will be marked as failed
 
     Report Selection:
       VectorCAST Manage reports that can be generated
 
       --aggregate           Generate aggregate coverage report VectorCAST Project
       --metrics             Generate metrics reports for VectorCAST Project
       --fullstatus          Generate full status reports for VectorCAST Project
-      --utfull              Generate Full Reports for each VectorCAST environment in project
-      --tcmr                Generate Test Cases Management Reports for each VectorCAST environment in project
-      --index               Generate an index.html report that ties all the other HTML reports together
+      --utfull              Generate Full Reports for each VectorCAST environment
+                            in project
+      --tcmr                Generate Test Cases Management Reports for each
+                            VectorCAST environment in project
+      --index               Generate an index.html report that ties all the other
+                            HTML reports together
 
     Build/Execution Options:
       Options that effect build/execute operation
 
       --jobs JOBS           Number of concurrent jobs (default = 1)
       --ci                  Use Continuous Integration Licenses
       -l LEVEL, --level LEVEL
-                            Environment Name if only doing single environment. Should be in the form of compiler/testsuite
+                            Environment Name if only doing single environment.
+                            Should be in the form of compiler/testsuite
       -e ENVIRONMENT, --environment ENVIRONMENT
                             Environment Name if only doing single environment.
       --gitlab              Build using GitLab CI (default)
@@ -103,9 +121,16 @@ The api for vcast_exec.py follows:
       --timing              Prints timing information for metrics generation
       -v, --verbose         Enable verbose output
       --version             Displays the version information
+
 ```
 
 # Change log
+10/2025
+* Updated to keep in syhc with Jenkins integration
+   * Encoding issues  
+   * Using @contextlib for file open
+* Adding support to work with BitBucket Pipelines
+
 8/2025
 * Add unit test Full Report creation
 * Updated index.html to be more readable

__init__.py

@@ -21,3 +21,4 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 #
+

cobertura.py

@@ -37,10 +37,16 @@
 from collections import defaultdict
 from pprint import pprint
 import argparse
+try:
+    from safe_open import open
+except:
+    pass
 
 fileList = []
 
-from vcast_utils import dump, checkVectorCASTVersion
+from vcast_utils import dump, checkVectorCASTVersion, getVectorCASTEncoding
+
+encFmt = getVectorCASTEncoding()
 
 def write_xml(x, name, verbose = False):
 
@@ -52,7 +58,8 @@ def write_xml(x, name, verbose = False):
 
     xml_str += etree.tostring(x,pretty_print=True).decode()
 
-    open(name + ".xml", "w").write(xml_str)
+    with open(name + ".xml", "wb") as fd: 
+        fd.write(xml_str.encode(encFmt,"replace"))
 
 def getCoveredFunctionCount(source):
     if len(source.functions) == 0:
@@ -86,7 +93,12 @@ def getFileXML(testXml, coverAPI, verbose = False, extended = False, source_root
 
 
     fname = coverAPI.display_name
-    fpath = os.path.relpath(coverAPI.display_path,prj_dir).replace("\\","/")
+    fpath = coverAPI.display_path
+    try:
+        fpath = os.path.relpath(fpath,prj_dir).replace("\\","/")
+    except:
+        fpath = fpath.replace("\\","/")
+        pass
 
     branch_totals = float(coverAPI.metrics.branches + coverAPI.metrics.mcdc_branches)
     branch_covered = float(coverAPI.metrics.max_covered_branches + coverAPI.metrics.max_covered_mcdc_branches)
@@ -335,11 +347,13 @@ def procesCoverage(coverXML, coverApi, extended = False, source_root = ""):
 
     if extended:
         for func in coverApi.functions:
-                      
+    
+            if isinstance(func.instrumented_functions[0].parameterized_name, bool):
+                continue
+                
             method = etree.SubElement(methods, "method")
-            
             method.attrib['name'] = func.name
-            method.attrib['signature'] = func.instrumented_functions[0].parameterized_name.replace(func.name,"",1)
+            method.attrib['signature'] = func.instrumented_functions[0].parameterized_name.replace(func.name,"",1)    
             method.attrib['line-rate'] = str(func.metrics.max_covered_statements_pct/100.0)
 
             statementPercentStr = "{:.2f}".format(func.metrics.max_covered_statements_pct) + "% (" + str(func.metrics.max_covered_statements) + "/" + str(func.metrics.statements) + ")"             
@@ -375,11 +389,13 @@ def procesCoverage(coverXML, coverApi, extended = False, source_root = ""):
     return processStatementBranchMCDC(coverApi, lines, extended)
 
 def runCoverageResultsMP(packages, mpFile, verbose = False, extended=False, source_root = ""):
-
-    vcproj = VCProjectApi(mpFile)
-    api = vcproj.project.cover_api
 
-    return runCoberturaResults(packages, api, verbose = False, extended = extended, source_root = source_root)
+    with VCProjectApi(mpFile) as vcproj:
+        api = vcproj.project.cover_api
+        
+        results = runCoberturaResults(packages, api, verbose = False, extended = extended, source_root = source_root)
+    
+    return results
 
 def runCoberturaResults(packages, api, verbose = False, extended = False, source_root = ""):
 
@@ -437,8 +453,7 @@ def runCoberturaResults(packages, api, verbose = False, extended = False, source
         except:
             prj_dir = os.getcwd().replace("\\","/") + "/"    
 
-    # get a sorted listed of all the files with the proj directory stripped off
-     
+    # get a sorted listed of all the files with the proj directory stripped off     
     for file in api.SourceFile.all():  
         if file.display_name == "":
             continue
@@ -447,7 +462,11 @@ def runCoberturaResults(packages, api, verbose = False, extended = False, source
 
         fname = file.display_name
         fpath = file.display_path.rsplit('.',1)[0]
-        fpath = os.path.relpath(fpath,prj_dir).replace("\\","/")
+        try:
+            fpath = os.path.relpath(fpath,prj_dir).replace("\\","/")
+        except:
+            fpath = fpath.replace("\\","/")
+            pass
 
         # print("*", file.name, file.display_name, fpath)
 
@@ -717,8 +736,8 @@ def generateCoverageResults(inFile, azure = False, xml_data_dir = "xml_data", ve
     coverages.attrib['timestamp'] = str(datetime.now())
 
     tool_version = os.path.join(os.environ['VECTORCAST_DIR'], "DATA", "tool_version.txt")
-    with open(tool_version,"r") as fd:
-        ver = fd.read()
+    with open(tool_version,"rb") as fd:
+        ver = fd.read().decode(encFmt,"replace")
 
     coverages.attrib['version'] = "VectorCAST " + ver.rstrip()
 
@@ -736,7 +755,7 @@ def generateCoverageResults(inFile, azure = False, xml_data_dir = "xml_data", ve
     if MCDC_rate   != -1.0: print ("mcdc pairs: {:.2f}% ({:d} out of {:d})".format(MCDC_rate*100.0, cov_mcdc, total_mcdc))
 
     if statement_rate   != -1.0: print ("coverage: {:.2f}% of statements".format(statement_rate*100.0))
-    print ("complexity: {:d}".format(complexity))
+    if complexity       != -1.0: print ("complexity: {:d}".format(complexity))
     source = etree.SubElement(sources, "source")
     source.text = "./"
 

copy_build_dir.py

@@ -237,9 +237,8 @@ def run(ManageProjectName, Level, BaseName, Env, workspace, vCastProjectWorkspac
 
 def getVcastProjectWorkspace(args):
 
-    vc_api = VCProjectApi(args.ManageProject)
-    vCastProjectWorkspace = vc_api.project.workspace
-    vc_api.close()
+    with VCProjectApi(args.ManageProject) as vcproj:
+        vCastProjectWorkspace = vcproj.project.workspace
 
     return vCastProjectWorkspace
 

create_index_html.py

@@ -3,6 +3,9 @@
 import argparse
 import glob
 
+from vcast_utils import dump, checkVectorCASTVersion, getVectorCASTEncoding
+
+encFmt = getVectorCASTEncoding()
 
 class cd:
     """Context manager for changing the current working directory"""
@@ -17,8 +20,9 @@ def __exit__(self, etype, value, traceback):
         os.chdir(self.savedPath)
 
 def searchKeyword(search_string, filename):
-    with open(filename, "r") as f:
-        for line_number, line in enumerate(f, start=1):
+    with open(filename, "rb") as fd:
+        for line_number, line in enumerate(fd, start=1):
+            line = line.decode(encFmt, "replace")
             if search_string in line:
                 start_idx = line.find(search_string)
                 if start_idx != -1: 
@@ -100,26 +104,24 @@ def create_index_html(mpName, isGitLab = False, output_dir = ""):
     global baseOutputDir
     baseOutputDir = output_dir
 
-    api = VCProjectApi(mpName)
-    # Set custom report directory to the where this script was
-    # found. Must contain sections/index_section.py
-    rep_path = pathlib.Path(__file__).parent.resolve()
+    with VCProjectApi(mpName) as vcproj: 
+        # Set custom report directory to the where this script was
+        # found. Must contain sections/index_section.py
+        rep_path = pathlib.Path(__file__).parent.resolve()
 
-    if usingGitLabCI:
-        output_file=os.path.join(baseOutputDir,"index.html")
-    else:
-        output_file=os.path.join(baseOutputDir,"index.html")
-        
-    CustomReport.report_from_api(
-            api=api,
-            title="HTML Reports",
-            report_type="INDEX_FILE",
-            formats=["HTML"],
-            output_file=output_file,
-            sections=['CUSTOM_HEADER', 'REPORT_TITLE', 'TABLE_OF_CONTENTS','INDEX_SECTION', 'CUSTOM_FOOTER'],
-            customization_dir=rep_path)
-
-    api.close()
+        if usingGitLabCI:
+            output_file=os.path.join(baseOutputDir,"index.html")
+        else:
+            output_file=os.path.join(baseOutputDir,"index.html")
+            
+        CustomReport.report_from_api(
+                api=vcproj,
+                title="HTML Reports",
+                report_type="INDEX_FILE",
+                formats=["HTML"],
+                output_file=output_file,
+                sections=['CUSTOM_HEADER', 'REPORT_TITLE', 'TABLE_OF_CONTENTS','INDEX_SECTION', 'CUSTOM_FOOTER'],
+                customization_dir=rep_path)
 
 def create_index_html_body ():