updates from 0.79

Author: TimSVector

src/main/java/com/vectorcast/plugins/vectorcastexecution/job/NewPipelineJob.java

@@ -451,6 +451,15 @@ private String correctPath(final String in) {
         return in.replace("\\", "/").replace("\"", "\\\"");
     }
 
+    /**
+     * Format the multiline to either be the multiline or empty "".
+     *
+     * @param in input string
+     * @return String correct path.
+     */
+    private String getMultiLineString(String sInVar) {
+        return (sInVar == null || sInVar.trim().isEmpty()) ? "\"\"" : "'''" + sInVar + "'''\n";
+    }
     /**
      * Generates the <script> portion of the config.xml
      * which defines the pipeline for this pipeline job.
@@ -504,16 +513,16 @@ private String generateJenkinsfile() throws IOException {
             + "//\n"
             + "// ===========================================================\n"
             + "\n"
-            + "def VC_Manage_Project  = \'" + getManageProjectName() + "\'\n"
-            + "def VC_EnvSetup        = '''" + setup + "'''\n"
-            + "def VC_Build_Preamble  = \"" + preamble + "\"\n"
-            + "def VC_EnvTeardown     = '''" + teardown + "'''\n"
+            + "def VC_Manage_Project = \'" + getManageProjectName() + "\'\n"
+            + "def VC_EnvSetup = " + getMultiLineString(setup)
+            + "def VC_Build_Preamble = \"" + preamble + "\"\n"
+            + "def VC_EnvTeardown = " + getMultiLineString(teardown)
             + "def scmStep () { " + pipelineSCM + " }\n"
-            + "def VC_usingSCM = "
-            + String.valueOf(pipelineSCM.length() != 0) + "\n"
-            + "def VC_postScmStepsCmds = '''" + postCheckoutCmds + "'''\n"
-            + "def VC_sharedArtifactDirectory = '''"
-            + sharedArtifactDirectory + "'''\n"
+            + "def VC_usingSCM = " + String.valueOf(pipelineSCM.length() != 0)
+            +   "\n"
+            + "def VC_postScmStepsCmds = " 
+            +   getMultiLineString(postCheckoutCmds)
+            + "def VC_sharedArtifactDirectory = " + sharedArtifactDir + "\"\n"
             + "def VC_Agent_Label = '" + getNodeLabel() + "'\n"
             + "def VC_waitTime = '"  + getWaitTime() + "'\n"
             + "def VC_waitLoops = '" + getWaitLoops() + "'\n"
@@ -530,7 +539,8 @@ private String generateJenkinsfile() throws IOException {
             + "def VC_pclpResultsPattern = '" + getPclpResultsPattern() + "'\n"
             + "def VC_useSquore = "
             +   String.valueOf(getSquoreCommand().length() != 0) + "\n"
-            + "def VC_squoreCommand = '''" + getSquoreCommand() + "'''\n"
+            + "def VC_squoreCommand = " 
+            +     getMultiLineString(getSquoreCommand())
             + "def VC_useCoverageHistory = " + getUseCoverageHistory() + "\n"
             + "def VC_useStrictImport = " + getUseStrictTestcaseImport() + "\n"
             + "def VC_useRGW3 = " + getUseRGW3() + "\n"

src/main/resources/scripts/baseJenkinsfile.groovy

@@ -9,7 +9,37 @@ def VC_Use_Threshold = true
 //
 // Generic file from VectorCAST Pipeline Plug-in DO NOT ALTER
 //
-// ===============================================================
+// ===============================================================        
+
+// Gathering global variables to be used by functions
+def VC = [
+    mpName: VC_Manage_Project
+    setup: VC_EnvSetup
+    preable: VC_Build_Preamble
+    teardown: VC_EnvTeardown
+    oneChkDir: VC_useOneCheckoutDir
+    usingSCM: VC_usingSCM
+    postSCMSteps: VC_postScmStepsCmds
+    maxParallel: VC_maxParallel
+    useRGW3: VC_useRGW3
+    waitTime: VC_waitTime
+    waitLoops: VC_waitLoops
+    useCI: VC_useCILicense
+    useCBT: VC_useCBT
+    useCoverPlgin: VC_useCoveragePlugin
+    sharedBldDir: VC_sharedArtifactDirectory
+    strictImp: VC_useStrictImport
+    useCoverHist: VC_useCoverageHistory
+    useImpRst: VC_useImportedResults
+    useLocImpRst: VC_useLocalImportedResults
+    useExtImpRst: VC_useExternalImportedResults
+    extRst: VC_externalResultsFilename
+    usePclp: VC_usePCLintPlus 
+    pLcpCmd: VC_pclpCommand 
+    pLcpRsltPattern: VC_pclpResultsPattern
+    useSquore: VC_useSquore 
+    squoreCmd: VC_squoreCommand
+]
 
 // ===============================================================
 //
@@ -409,10 +439,7 @@ def runCommands(cmds, envSetup, useCILicense) {
 //
 // ===============================================================
 
-def setupManageProject(waitTime, waitLoops, manageProject, useCILicense, 
-        sharedArtifactDirectory, envSetup, useExternalImportedResults, 
-        useImportedResults, useLocalImportedResults, externalResultsFilename,
-        useStrictImport, useOneCheckoutDir) {
+def setupManageProject(VC) {
 
     def mpName = getMPname(manageProject)
 
@@ -479,11 +506,7 @@ def setupManageProject(waitTime, waitLoops, manageProject, useCILicense,
 //
 // ===============================================================
 
-def transformIntoStep(inputString, useOneCheckoutDir, usingSCM, envSetup,
-        useRGW3, waitTime, waitLoops, manageProject, useCILicense,
-        envTeardown, useCBT, sharedArtifactDirectory, 
-        useExternalImportedResults, buildPreamble, useImportedResults,
-        useStrictImport, useLocalImportedResults, externalResultsFilename) {
+def transformIntoStep(inputString, VC) {
 
     def compiler = ""
     def test_suite = ""
@@ -549,10 +572,7 @@ def transformIntoStep(inputString, useOneCheckoutDir, usingSCM, envSetup,
                 if (usingSCM && !useOneCheckoutDir) {
 
                     // set options for each manage project pulled out out of SCM
-                    setupManageProject(waitTime, waitLoops, manageProject, useCILicense, 
-                        sharedArtifactDirectory, envSetup, useExternalImportedResults, 
-                        useImportedResults, useLocalImportedResults, externalResultsFilename,
-                        useStrictImport, useOneCheckoutDir)
+                    setupManageProject(VC)
                 }
 
                 // setup the commands for building, executing, and transferring information
@@ -632,19 +652,11 @@ def transformIntoStep(inputString, useOneCheckoutDir, usingSCM, envSetup,
 // Notes    : Use to get a list of system and unit tests jobs
 //
 // ===============================================================
-def stepsForJobList(localEnvList, useOneCheckoutDir, usingSCM, envSetup,
-        useRGW3, waitTime, waitLoops, manageProject, useCILicense,
-        envTeardown, useCBT, sharedArtifactDirectory, 
-        useExternalImportedResults, buildPreamble, useImportedResults,
-        useStrictImport, useLocalImportedResults, externalResultsFilename) {
+def stepsForJobList(localEnvList, VC) {
 
     def jobList = [:]
     localEnvList.each {
-        jobList[it] =  transformIntoStep(it, useOneCheckoutDir, usingSCM, envSetup,
-            useRGW3, waitTime, waitLoops, manageProject, useCILicense,
-            envTeardown, useCBT, sharedArtifactDirectory, 
-            useExternalImportedResults, buildPreamble, useImportedResults,
-            useStrictImport, useLocalImportedResults, externalResultsFilename)
+        jobList[it] =  transformIntoStep(it, VC)
     }
 
     return jobList
@@ -669,14 +681,6 @@ pipeline {
     agent {label VC_Agent_Label as String}
 
     stages {
-        // Place holder for previous stages the customer may need to use
-        stage('Previous-Stage') {
-            steps {
-                script {
-                    println "place holder for previous stages"
-                }
-            }
-        }
 
         // If we are using a single checkout directory option, do the checkout here
         // This stage also includes the implementation for the parameterized Jenkins job
@@ -852,17 +856,10 @@ pipeline {
         stage('System Test Build-Execute Stage') {
             steps {
                 script {
-                    setupManageProject(VC_waitTime, VC_waitLoops, VC_Manage_Project, VC_useCILicense, 
-                        VC_sharedArtifactDirectory, VC_EnvSetup, VC_useExternalImportedResults, 
-                        VC_useImportedResults, VC_useLocalImportedResults, VC_externalResultsFilename,
-                        VC_useStrictImport, VC_useOneCheckoutDir)
+                    setupManageProject(VC)
 
                     // Get the job list from the system test environment listed
-                    def jobs = stepsForJobList(StEnvList, VC_useOneCheckoutDir, VC_usingSCM, VC_EnvSetup,
-                        VC_useRGW3, VC_waitTime, VC_waitLoops, VC_Manage_Project, VC_useCILicense,
-                        VC_EnvTeardown, VC_useCBT, VC_sharedArtifactDirectory, 
-                        VC_useExternalImportedResults, VC_Build_Preamble, VC_useImportedResults,
-                        VC_useStrictImport, VC_useLocalImportedResults, VC_externalResultsFilename)
+                    def jobs = stepsForJobList(StEnvList, VC)
 
                     // run each of those jobs in serial
                     jobs.each { name, job ->
@@ -877,17 +874,10 @@ pipeline {
         stage('Unit Test Build-Execute Stage') {
             steps {
                 script {
-                    setupManageProject(VC_waitTime, VC_waitLoops, VC_Manage_Project, VC_useCILicense, 
-                        VC_sharedArtifactDirectory, VC_EnvSetup, VC_useExternalImportedResults, 
-                        VC_useImportedResults, VC_useLocalImportedResults, VC_externalResultsFilename,
-                        VC_useStrictImport, VC_useOneCheckoutDir)
+                    setupManageProject(VC)
 
                     // Get the job list from the unit test environment listed
-                    def jobs = stepsForJobList(UtEnvList, VC_useOneCheckoutDir, VC_usingSCM, VC_EnvSetup,
-                        VC_useRGW3, VC_waitTime, VC_waitLoops, VC_Manage_Project, VC_useCILicense,
-                        VC_EnvTeardown, VC_useCBT, VC_sharedArtifactDirectory, 
-                        VC_useExternalImportedResults, VC_Build_Preamble, VC_useImportedResults,
-                        VC_useStrictImport, VC_useLocalImportedResults, VC_externalResultsFilename)
+                    def jobs = stepsForJobList(UtEnvList, VC)
 
                     if (VC_maxParallel > 0) {
                         def runningJobs = [:]
@@ -1235,14 +1225,5 @@ pipeline {
                 }
             }
         }
-
-        // Place holder for previous stages the customer may need to use
-        stage('Next-Stage') {
-            steps {
-                script {
-                    println "place holder for next stages"
-                }
-            }
-        }
     }
 }

src/main/resources/scripts/cobertura.py

@@ -23,12 +23,17 @@
 #
 
 from lxml import etree
+
+from vcast_utils import dump, checkVectorCASTVersion, getVectorCASTEncoding
+
 try:
     from vector.apps.DataAPI.vcproject_api import VCProjectApi 
     from vector.apps.DataAPI.vcproject_models import VCProject
 except:
     pass
+
 from vector.apps.DataAPI.cover_api import CoverApi
+
 try:
     from vector.apps.DataAPI.unit_test_api import UnitTestApi
 except:
@@ -41,11 +46,11 @@
     from safe_open import open
 except:
     pass
+    
+import shutil
 
 fileList = []
 
-from vcast_utils import dump, checkVectorCASTVersion, getVectorCASTEncoding, checkProjectResults
-
 encFmt = getVectorCASTEncoding()
 
 def write_xml(x, name, verbose = False):
@@ -54,12 +59,19 @@ def write_xml(x, name, verbose = False):
         print(etree.tostring(x,pretty_print=True))
 
     xml_str =  "<?xml version='1.0' encoding='UTF-8'?>\n"
-    xml_str += "<!DOCTYPE coverage SYSTEM 'http://cobertura.sourceforge.net/xml/coverage-04.dtd'>\n"
+    xml_str += "<!DOCTYPE coverage SYSTEM 'coverage-extended-04.dtd'>\n"
 
     xml_str += etree.tostring(x,pretty_print=True).decode()
 
     with open(name + ".xml", "wb") as fd: 
         fd.write(xml_str.encode(encFmt,"replace"))
+        
+    # copy .dtd file over for verification
+    inFile = "vc_scripts/coverage-extended-04.dtd"
+    outFile = os.path.join(os.path.dirname(name),"coverage-extended-04.dtd")
+    
+    if os.path.exist(inFile):
+        shutil.copy(inFile,outFile)
 
 def getCoveredFunctionCount(source):
     if len(source.functions) == 0:
@@ -116,8 +128,8 @@ def getFileXML(testXml, coverAPI, verbose = False, extended = False, source_root
     file = None
 
     if verbose:
-        print ("   fname   = ", fname)
-        print ("   fpath   = ", fpath)
+        print ("   fname   = " + fname)
+        print ("   fpath   = " + fpath)
 
     for element in testXml.iter():
         if element.tag == "class" and element.attrib['filename'] == fpath:
@@ -390,23 +402,10 @@ def procesCoverage(coverXML, coverApi, extended = False, source_root = ""):
 
 def runCoverageResultsMP(packages, mpFile, verbose = False, extended=False, source_root = ""):
 
-    with VCProjectApi(mpFile) as 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
-
-        api = vcproj.project.cover_api
-        
-        results = runCoberturaResults(packages, api, verbose = False, extended = extended, source_root = source_root)
+    vcproj = VCProjectApi(mpFile)
+    api = vcproj.project.cover_api    
+    results = runCoberturaResults(packages, api, verbose = False, extended = extended, source_root = source_root)
+    vcproj.close()
 
     return results
 
@@ -781,8 +780,8 @@ def generateCoverageResults(inFile, azure = False, xml_data_dir = "xml_data", ve
 if __name__ == '__main__':
 
     if not checkVectorCASTVersion(21):
-        print("Cannot create Cobertura metrics. Please upgrade VectorCAST")
-        sys.exit()
+        print ("Cannot create Cobertura metrics. Please upgrade VectorCAST")
+        sys.exit(0)
 
     parser = argparse.ArgumentParser()
     parser.add_argument('ManageProject',     help='Manager Project Name')