Small changes for using VcProject API as a @contextlib.contextmanager and some error detection

Author: TimSVector

README.md

@@ -348,6 +348,9 @@ By selecting individual cases, you can view the execution reports, providing ins
 
 ## Known Issues
 
+### Imported Results with Cobertura and LCOV output
+New output formats were added, extended cobertura format output for use with Jenkins Coverage Plugin and LCOV output support.  These reporting scripts do not currently support generating coverage metrics based off of imported results.
+
 ### VectorCAST Reports and Jenkins Content Security 
 
 VectorCAST HTML reports for metrics were updated to use cascading style sheets (CSS) in the 2019 release and 2020 for top level project metrics. This was done to offer users greater flexibility in displaying metrics. To maintain single file HTML format, VectorCAST Reports used inline CSS. Inline CSS was disallowed under Jenkins more restrictive CSP.

src/main/resources/scripts/cobertura.py

@@ -389,23 +389,26 @@ 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)
+    
+    with VCProjectApi(mpFile) as vcproj:
 
-    anyLocalResults, anyImportedResults = checkProjectResults(vcproj)
+        anyLocalResults, anyImportedResults = checkProjectResults(vcproj)
 
-    if anyImportedResults:
-        importedResultsError = "  ** Cobertura results does not processing imported results at this time\n\n"
-        print(importedResultsError)
-        return [-1] * 19
-        
-    if not anyLocalResults:
-        localResultsError = "  ** No local results in project to process\n\n"
-        print(localResultsError)
-        return [-1] * 19
+        if anyImportedResults:
+            importedResultsError = "  ** Cobertura results does not processing imported results at this time\n\n"
+            print(importedResultsError)
+            return [-1] * 19
+            
+        if not anyLocalResults:
+            localResultsError = "  ** No local results in project to process\n\n"
+            print(localResultsError)
+            return [-1] * 19
 
-    api = vcproj.project.cover_api
+        api = vcproj.project.cover_api
+        
+        results = runCoberturaResults(packages, api, verbose = False, extended = extended, source_root = source_root)
 
-    return runCoberturaResults(packages, api, verbose = False, extended = extended, source_root = source_root)
+    return results
 
 def runCoberturaResults(packages, api, verbose = False, extended = False, source_root = ""):
 

src/main/resources/scripts/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
 

src/main/resources/scripts/create_index_html.py

@@ -104,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 ():
 

src/main/resources/scripts/full_report_no_toc.py

@@ -36,23 +36,6 @@ def generate_full_status(manageProject):
     mpName = os.path.splitext(os.path.basename(manageProject))[0]
     full_report_name = mpName + "_full_report.html"
     metrics_report_name = mpName + "_metrics_report.html"
-
-    # try:
-        # from vector.apps.DataAPI.vcproject_api import VCProjectApi
-        # api = VCProjectApi(manageProject)
-        
-        # api.report(report_type="MANAGE_STATUS_FULL_REPORT", formats=["HTML"], output_file=full_report_name   , environments=api.Environment.all(), levels = [])
-        # api.report(report_type="MANAGE_METRICS_REPORT"    , formats=["HTML"], output_file=metrics_report_name, environments=api.Environment.all(), levels = [])
-            
-        # shutil.copy(full_report_name,full_report_name + "_tmp")
-        # fixup_reports.fixup_2020_reports(full_report_name + "_tmp")
-        
-        # shutil.copy(metrics_report_name,metrics_report_name + "_tmp")
-        # fixup_reports.fixup_2020_reports(metrics_report_name + "_tmp")
-
-        # api.close()
-        
-    # except:
 
     from managewait import ManageWait
 

src/main/resources/scripts/generate-results.py

@@ -556,15 +556,13 @@ def buildReports(FullManageProjectName = None,
         print("Cleanup: " + str(time.time()))
     if useNewReport and not legacy:
         try:
-            api = VCProjectApi(FullManageProjectName)
-            tool_version = api.tool_version
-            if tool_version.startswith("20"):
-                use_manage_api = False
-            else:
-                use_manage_api = True
-            api.close()
+            with VCProjectApi(FullManageProjectName) as vcproj:
+                tool_version = vcproj.tool_version
+                if tool_version.startswith("20"):
+                    use_manage_api = False
+                else:
+                    use_manage_api = True
         except:
-            ##teePrint.teePrint("   *INFO: Issue getting tool version from: " + FullManageProjectName)
             use_manage_api = False
 
         if use_manage_api:

src/main/resources/scripts/generate_lcov.py

@@ -39,85 +39,22 @@
 from pprint import pprint
 import subprocess
 import argparse
-import inspect
 
 from vcast_utils import dump, checkVectorCASTVersion, getVectorCASTEncoding, checkProjectResults
 try:
     from safe_open import open
 except:
     pass
 
-from vector.apps.DataAPI.coverdb import SourceFunction
-
-orig_iter = SourceFunction.iterate_coverage  # snapshot original method
-
 try:
     import math
     INF = math.inf
 except Exception:
     INF = float("inf")  # Py2-compatible
-
 encFmt = getVectorCASTEncoding()
 
 fileList = []
 
-# specifically for 2022sp8 issue with start/end being None
-def _safe_iterate_coverage(self, **kwargs):
-
-    # Drop-in wrapper for SourceFile.iterate_coverage()
-    #  - Accepts any kwargs (future-proof)
-    #  - Provides sane defaults for start/end
-    #  - Adds encoding only if supported
-    #  - Filters kwargs to match the original method's signature (no TypeError)
-    
-
-    # Always present in VC versions
-    kwargs.setdefault("aggregate", True)
-
-    # Pull caller/attributes (don't coerce yet)
-    start = kwargs.get("start", getattr(self, "start_line", None))
-    end   = kwargs.get("end",   getattr(self, "end_line",   None))
-
-    # --- IMPORTANT: handle the "both missing" case FIRST ---
-    if start is None and end is None:
-        start = 0
-        try:
-            if getattr(self, "instrumented_files", None):
-                end = os.path.getsize(self.instrumented_files[0].display_path)
-            else:
-                end = INF
-        except Exception:
-            end = INF
-
-    # Now handle single-None cases (keep legitimate 0)
-    if start is None:
-        start = 0
-    if end is None:
-        end = INF
-
-    kwargs["start"] = start
-    kwargs["end"]   = end
-    
-    # Let caller override; otherwise provide encoding
-    kwargs.setdefault("encoding", encFmt)
-
-    # Filter kwargs to what the current VectorCAST build supports
-    try:
-        sig = inspect.signature(orig_iter)   # Py3
-        valid = set(sig.parameters.keys())
-    except Exception:
-        spec = inspect.getargspec(orig_iter) # Py2
-        valid = set(spec.args)
-
-    safe_kwargs = {k: v for k, v in kwargs.items() if k in valid}
-
-    for line in orig_iter(self, **safe_kwargs):
-        yield line
-
-def lcov_iterate_coverage(sf, **kwargs):
-    # Your safe wrapper logic here
-    return _safe_iterate_coverage(sf, **kwargs)
-
 def getCoveredFunctionCount(source):
     if len(source.functions) == 0:
         return 0,0
@@ -205,23 +142,25 @@ def get_function_name_line_number(file_path, function, initial_guess):
 
 def runCoverageResultsMP(mpFile, verbose = False, testName = "", source_root = ""):
 
-    vcproj = VCProjectApi(mpFile)
+    with VCProjectApi(mpFile) as vcproj:
 
-    anyLocalResults, anyImportedResults = checkProjectResults(vcproj)
+        anyLocalResults, anyImportedResults = checkProjectResults(vcproj)
 
-    if anyImportedResults:
-        importedResultsError = "  ** LCOV results does not processing imported results at this time\n\n"
-        print(importedResultsError)
-        return importedResultsError
-        
-    if not anyLocalResults:
-        localResultsError = "  ** No local results in project to process\n\n"
-        print(localResultsError)
-        return localResultsError
+        if anyImportedResults:
+            importedResultsError = "  ** LCOV results does not processing imported results at this time\n\n"
+            print(importedResultsError)
+            return importedResultsError
+            
+        if not anyLocalResults:
+            localResultsError = "  ** No local results in project to process\n\n"
+            print(localResultsError)
+            return localResultsError
 
-    api = vcproj.project.cover_api
+        api = vcproj.project.cover_api
+        
+        results = runGcovResults(api, verbose = verbose, testName = vcproj.project.name, source_root=source_root)
 
-    return runGcovResults(api, verbose = verbose, testName = vcproj.project.name, source_root=source_root)
+    return results
 
 def runGcovResults(api, verbose = False, testName = "", source_root = "") :
 
@@ -305,7 +244,7 @@ def runGcovResults(api, verbose = False, testName = "", source_root = "") :
 
             lastLine = None
 
-            for line in lcov_iterate_coverage(func):
+            for line in func.iterate_coverage():
                 if has_any_coverage(line):
                     lastLine = line
                     LF += 1

src/main/resources/scripts/generate_pclp_reports.py

@@ -324,21 +324,19 @@ def generate_html_report(mpName, input_xml, output_html):
     if output_html is None:
         output_html = "pclp_findings.html"
 
-    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()
-    CustomReport.report_from_api(
-            api=api,
-            title="PC-Lint Plus Results",
-            report_type="INDEX_FILE",
-            formats=["HTML"],
-            output_file=output_html,
-            sections=['CUSTOM_HEADER', 'REPORT_TITLE', 'TABLE_OF_CONTENTS','PCLP_SUMMARY_SECTION','PCLP_DETAILS_SECTION','PCLP_SOURCE_SECTION', 'CUSTOM_FOOTER'],
-            customization_dir=rep_path)
-
-    api.close()
+    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()
+        CustomReport.report_from_api(
+                api=vcproj,
+                title="PC-Lint Plus Results",
+                report_type="INDEX_FILE",
+                formats=["HTML"],
+                output_file=output_html,
+                sections=['CUSTOM_HEADER', 'REPORT_TITLE', 'TABLE_OF_CONTENTS','PCLP_SUMMARY_SECTION','PCLP_DETAILS_SECTION','PCLP_SOURCE_SECTION', 'CUSTOM_FOOTER'],
+                customization_dir=rep_path)
 
 def has_any_coverage(line):
 

src/main/resources/scripts/generate_sonarqube_testresults.py

@@ -275,6 +275,12 @@ def __init__(self, FullManageProjectName, verbose = False,
 
         self.cleanupXmlDataDir()
 
+    def __del__(self):
+        try:
+            self.api.close()
+        except:
+            pass
+
     def cleanupXmlDataDir(self):
         path=os.path.join(self.xml_data_dir,"sonarqube")
         import glob
@@ -296,11 +302,6 @@ def cleanupXmlDataDir(self):
                 print("   *INFO: File System Error creating directory: " + path + ".  Check console for environment build/execution errors")
                 if print_exc:  traceback.print_exc()
 
-    def __del__(self):
-        try:
-            self.api.close()
-        except:
-            pass
 
     def generate_local_results(self, results, key):
         # get the level from the name

src/main/resources/scripts/generate_xml.py

@@ -690,7 +690,10 @@ def cleanupXmlDataDir(self):
                 if print_exc:  traceback.print_exc()
 
     def __del__(self):
-        self.api.close()
+        try:
+            self.api.close()
+        except:
+            pass
 
 # GenerateManageXml