Integrating changes from gitlab integration (vcast_exec.py) and for missing file detection

Author: TimSVector

src/main/resources/scripts/create_index_html.py

@@ -58,24 +58,28 @@ def getReportName(filename):
     return reportName, reportType
 
 usingGitLabCI = False
+baseOutputDir = ""
 
-def create_index_html(mpName, isGitLab = False):
+def create_index_html(mpName, isGitLab = False, output_dir = ""):
     import pathlib
     from vector.apps.DataAPI.vcproject_api import VCProjectApi
     from vector.apps.ReportBuilder.custom_report import CustomReport
 
     global usingGitLabCI
     usingGitLabCI = isGitLab
 
+    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()
 
     if usingGitLabCI:
-        output_file="index.html"
+        output_file=os.path.join(baseOutputDir,"index.html")
     else:
-        output_file="index.html"
+        output_file=os.path.join(baseOutputDir,"index.html")
 
     CustomReport.report_from_api(
             api=api,
@@ -90,9 +94,9 @@ def create_index_html(mpName, isGitLab = False):
 
 def create_index_html_body ():
 
-    tempHtmlReportList = glob.glob("*.html")
-    tempHtmlReportList += glob.glob("html_reports/*.html")
-    tempHtmlReportList += glob.glob("management/*.html")
+    tempHtmlReportList =  glob.glob(os.path.join(baseOutputDir,"*.html"))
+    tempHtmlReportList += glob.glob(os.path.join(baseOutputDir,"html_reports/*.html"))
+    tempHtmlReportList += glob.glob(os.path.join(baseOutputDir,"management/*.html"))
 
     htmlReportList = []
     try:

src/main/resources/scripts/generate_pclp_reports.py

@@ -303,6 +303,11 @@ def generate_source():
     return output, listOfContent
 
 def generate_html_report(mpName, input_xml, output_html):
+
+    if not os.path.exists(input_xml):
+        print(f"{input_xml} was not found. Skipping PCLP HTML reporting")
+        return
+
     import pathlib
     from vector.apps.DataAPI.vcproject_api import VCProjectApi
     from vector.apps.ReportBuilder.custom_report import CustomReport
@@ -485,6 +490,11 @@ def write_output(output, filename):
             file.write(output.decode('utf-8'))
 
 def generate_reports(input_xml, output_text = None, output_html = None, output_json = None, output_gitlab = None, full_mp_name = None):
+    
+    if not os.path.exists(input_xml):
+        print(f"{input_xml} was not found. Skipping PCLP reporting")
+        return
+
     msgs = parse_msgs(input_xml)
     msgs.sort(key=lambda msg: (msg.file == "", msg.file, int(msg.line) if msg.line != "" else 0))
     if output_text:

src/main/resources/scripts/vcast_exec.py

@@ -64,6 +64,20 @@ class CITool(Enum):
     BAMBOO = "Bamboo"
     UNKNOWN = "Unknown CI/CD"
 
+def displayVersion():
+    versionInfo = "Version Unknown"
+
+    # Get absolute path to directory containing the current script
+    script_dir = os.path.dirname(os.path.abspath(__file__))
+
+    # Build path to VERSION.txt
+    version_path = os.path.join(script_dir, 'VERSION.txt')    
+    
+    if os.path.exists(version_path):
+        with open(version_path,"r") as fd:
+            versionInfo = fd.read()
+    print("vc_scripts_submodule Version: ", versionInfo)
+
 class VectorCASTExecute(object):
 
     def detect_ci_tool(self):
@@ -124,10 +138,12 @@ def __init__(self, args):
         self.failed_count = 0
 
         if args.output_dir:
+            self.output_dir = args.output_dir
             self.xml_data_dir = os.path.join(args.output_dir, 'xml_data')
             if not os.path.exists(self.xml_data_dir):
                 os.makedirs(self.xml_data_dir)
         else:
+            self.output_dir = ""
             self.xml_data_dir = "xml_data"
 
         if args.build and not args.build_execute:
@@ -230,7 +246,8 @@ def generateIndexHtml(self):
                 prj_dir = os.getcwd().replace("\\","/") + "/"
 
             tempHtmlReportList = glob.glob("*.html")
-            tempHtmlReportList += glob.glob(os.path.join(args.html_base_dir, "*.html"))
+            tempHtmlReportList += glob.glob(os.path.join(self.xml_data_dir, "*.html"))
+            tempHtmlReportList += glob.glob(os.path.join(self.html_base_dir, "*.html"))
             htmlReportList = []
 
             for report in tempHtmlReportList:
@@ -240,7 +257,7 @@ def generateIndexHtml(self):
                     htmlReportList.append(report)
 
             from create_index_html import create_index_html
-            create_index_html(self.FullMP, self.ciTool == CITool.GITLAB)
+            create_index_html(self.FullMP, self.ciTool == CITool.GITLAB, output_dir=self.output_dir)
 
     def runJunitMetrics(self):
         print("Creating JUnit Metrics")
@@ -323,29 +340,38 @@ def runPcLintPlusMetrics(self):
             print("PC-lint Plus Metrics file: " + report_name)
             generate_pclp_reports.generate_reports(self.pclp_input, output_gitlab = report_name)
 
-            if args.pclp_output_html:
+            if self.pclp_output_html:
                 print("Creating PC-lint Plus Findings")
                 generate_pclp_reports.generate_html_report(self.FullMP, self.pclp_input, self.pclp_output_html)
 
     def runReports(self):
         if self.aggregate:
+            agg_rpt_name = os.path.join(self.output_dir, self.mpName + "_aggregate_report.html")
             print("Creating Aggregate Coverage Report")
-            self.manageWait.exec_manage_command ("--create-report=aggregate --output=" + self.mpName + "_aggregate_report.html")
+            if os.path.exists(agg_rpt_name): 
+                os.remove(agg_rpt_name)
+            self.manageWait.exec_manage_command ("--create-report=aggregate --output=" + agg_rpt_name)
             self.needIndexHtml = True
         if self.metrics:
+            met_rpt_name = os.path.join(self.output_dir, self.mpName + "_metrics_report.html")
             print("Creating Metrics Report")
-            self.manageWait.exec_manage_command ("--create-report=metrics --output=" + self.mpName + "_metrics_report.html")
+            if os.path.exists(met_rpt_name): 
+                os.remove(met_rpt_name)
+            self.manageWait.exec_manage_command ("--create-report=metrics --output=" + met_rpt_name)
             self.needIndexHtml = True
         if self.fullstatus:
+            fs_rpt_name = os.path.join(self.output_dir, self.mpName + "_full_status_report.html")
+            if os.path.exists(fs_rpt_name): 
+                os.remove(fs_rpt_name)
             print("Creating Full Status Report")
-            self.manageWait.exec_manage_command ("--full-status=" + self.mpName + "_full_status_report.html")
+            self.manageWait.exec_manage_command ("--full-status=" + fs_rpt_name)
             self.needIndexHtml = True
 
     def generateTestCaseMgtRpt(self):
-        if not os.path.exists("management"):
-            os.makedirs("management")
+        if not os.path.exists(os.path.join(self.output_dir, "management")):
+            os.makedirs(os.path.join(self.output_dir, "management"))
         else:
-            for file in glob.glob("management/*_management_report.html"):
+            for file in glob.glob(os.path.join(self.output_dir, "management","*_management_report.html")):
                 os.remove(file)
 
         if checkVectorCASTVersion(21):
@@ -360,7 +386,7 @@ def generateTestCaseMgtRpt(self):
                     self.needIndexHtml = True
 
                     report_name = env.compiler.name + "_" + env.testsuite.name + "_" + env.name + "_management_report.html"
-                    report_name = os.path.join("management",report_name)
+                    report_name = os.path.join(self.output_dir, "management",report_name)
                     print(f"Creating Test Case Management HTML report for {env.name} in {report_name}")
                     env.api.report(report_type="MANAGEMENT_REPORT", formats=["HTML"], output_file=report_name)
         else:
@@ -424,7 +450,7 @@ def runExec(self):
 if __name__ == '__main__':
 
     parser = argparse.ArgumentParser()
-    parser.add_argument('ManageProject', help='VectorCAST Project Name')
+    parser.add_argument('ManageProject', nargs='?', help='VectorCAST Project Name')
 
     actionGroup = parser.add_argument_group('Script Actions', 'Options for the main tasks')
     actionGroup.add_argument('--build-execute', help='Builds and exeuctes the VectorCAST Project', action="store_true", default = False)
@@ -469,10 +495,24 @@ def runExec(self):
     actionGroup.add_argument('--print_exc', help='Prints exceptions', action="store_true", default = False)
     actionGroup.add_argument('--timing', help='Prints timing information for metrics generation', action="store_true", default = False)
     actionGroup.add_argument('-v', '--verbose',   help='Enable verbose output', action="store_true", default = False)
-    
+    actionGroup.add_argument('--version', help='Displays the version information', action="store_true", default = False)
 
     args = parser.parse_args()
 
+    # Conditional requirement check
+    if not args.version and not args.ManageProject:
+        parser.error("ManageProject is required unless --version is specified")
+        sys.exit(0)
+
+    if args.ManageProject and not os.path.isfile(args.ManageProject):
+        print ("Manage project (.vcm file) provided does not exist: " + args.ManageProject)
+        print ("exiting...")
+        sys.exit(-1)
+
+    if args.version:
+        displayVersion()
+        sys.exit(0)
+
     if args.ci:
         os.environ['VCAST_USE_CI_LICENSES'] = "1"