Feature/non gxp validation

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## Unreleased
+- Change initial project validation to take into account non GxP requirement([#1006](https://github.com/opendevstack/ods-jenkins-shared-library/pull/1006))
 - Make IS_GXP property available for CFTP documents ([#996](https://github.com/opendevstack/ods-jenkins-shared-library/issues/996))
 - Use a consistent notion of document version and remove header ([#987](https://github.com/opendevstack/ods-jenkins-shared-library/issues/987))
 - Improve Document Generation Experience ([#991](https://github.com/opendevstack/ods-jenkins-shared-library/issues/991))

src/org/ods/orchestration/usecase/JiraUseCase.groovy

@@ -380,6 +380,7 @@ class JiraUseCase {
         def releaseStatusIssueKey = this.project.buildParams.releaseStatusJiraIssueKey
         if (message) {
             String commentToAdd = "${message}\n\nSee: ${this.steps.env.RUN_DISPLAY_URL}"
+            commentToAdd += "\n\nPlease note that for a successful Deploy to D, the above-mentioned issues need to be in status Done."
             logger.debug("Adding comment to Jira issue with key ${releaseStatusIssueKey}: ${commentToAdd}")
             this.jira.appendCommentToIssue(releaseStatusIssueKey, commentToAdd)
             logger.info("Comment was added to Jira issue with key ${releaseStatusIssueKey}: ${commentToAdd}")

src/org/ods/orchestration/usecase/LeVADocumentUseCase.groovy

@@ -50,7 +50,7 @@ import java.time.LocalDateTime
     'PublicMethodsBeforeNonPublicMethods'])
 class LeVADocumentUseCase extends DocGenUseCase {
 
-    protected static final boolean IS_GXP_PROJECT_DEFAULT = true
+    private static final String NOT_MANDATORY_CONTENT = 'Not mandatory.'
 
     protected static Map DOCUMENT_TYPE_NAMES = [
         (DocumentType.CSD as String)        : 'Combined Specification Document',
@@ -1000,20 +1000,14 @@ class LeVADocumentUseCase extends DocGenUseCase {
                 sections: sections,
                 documentHistory: docHistory?.getDocGenFormat() ?: [],
                 documentHistoryLatestVersionId: docHistory?.latestVersionId ?: 1,
-                isGxpProject: isGxpProject(this.project.getProjectProperties()),
+                isGxpProject: this.project.isGxpProject(),
             ]
         ]
-
         def uri = this.createDocument(documentType, null, data_, [:], null, getDocumentTemplateName(documentType), watermarkText)
         this.updateJiraDocumentationTrackingIssue(documentType, uri, docHistory?.getVersion() as String)
         return uri
     }
 
-    protected boolean isGxpProject(Map projectProperties) {
-        String isGxp = projectProperties."PROJECT.IS_GXP"
-        return isGxp != null ? isGxp.toBoolean() : IS_GXP_PROJECT_DEFAULT
-    }
-
     @NonCPS
     private def computeKeysInDocForTIP(def data) {
         return data.collect { it.key }
@@ -1528,7 +1522,7 @@ class LeVADocumentUseCase extends DocGenUseCase {
             date_created  : LocalDateTime.now().toString(),
             buildParameter: this.project.buildParams,
             git           : repo ? repo.data.git : this.project.gitData,
-            gxp           : isGxpProject(this.project.getProjectProperties()),
+            gxp           : project.isGxpProject(),
             openShift     : [apiUrl: this.project.getOpenShiftApiUrl()],
             jenkins       : [
                 buildNumber: this.steps.env.BUILD_NUMBER,
@@ -1693,10 +1687,14 @@ class LeVADocumentUseCase extends DocGenUseCase {
             throw new RuntimeException("Error: unable to create ${documentType}. " +
                 'Could not obtain document chapter data from Jira.')
         }
-        // Extract-out the section, as needed for the DocGen interface
-        return sections.collectEntries { sec ->
-            [(sec.section): sec + [content: this.convertImages(sec.content)]]
+
+        def sectionCollection = sections.collectEntries { sec ->
+            [(sec.section): sec + [content: this.project.replaceIssueContentWithNonMandatoryText(sec) ?
+                '<p><em>' + this.NOT_MANDATORY_CONTENT + '</em></p>' : this.convertImages(sec.content)]]
         }
+
+        // Extract-out the section, as needed for the DocGen interface
+        return sectionCollection
     }
 
     protected Map getDocumentSectionsFileOptional(String documentType) {

src/org/ods/orchestration/util/MROPipelineUtil.groovy

@@ -10,7 +10,6 @@ import org.ods.orchestration.dependency.DependencyGraph
 import org.ods.orchestration.dependency.Node
 import org.ods.services.OpenShiftService
 import org.ods.services.ServiceRegistry
-import org.ods.orchestration.util.DeploymentDescriptor
 import org.ods.orchestration.phases.DeployOdsComponent
 import org.ods.orchestration.phases.FinalizeOdsComponent
 import org.ods.orchestration.phases.FinalizeNonOdsComponent
@@ -21,6 +20,7 @@ import org.yaml.snakeyaml.Yaml
 class MROPipelineUtil extends PipelineUtil {
 
     class PipelineConfig {
+
         // TODO: deprecate .pipeline-config.yml in favor of release-manager.yml
         static final List FILE_NAMES = ["release-manager.yml", ".pipeline-config.yml"]
 
@@ -36,23 +36,27 @@ class MROPipelineUtil extends PipelineUtil {
 
         static final List PHASE_EXECUTOR_TYPES = [
             PHASE_EXECUTOR_TYPE_MAKEFILE,
-            PHASE_EXECUTOR_TYPE_SHELLSCRIPT
+            PHASE_EXECUTOR_TYPE_SHELLSCRIPT,
         ]
 
         static final List<String> INSTALLABLE_REPO_TYPES = [
             REPO_TYPE_ODS_CODE as String,
             REPO_TYPE_ODS_SERVICE as String,
-            REPO_TYPE_ODS_INFRA as String
+            REPO_TYPE_ODS_INFRA as String,
         ]
+
     }
 
     class PipelineEnvs {
+
         static final String DEV = "dev"
         static final String QA = "qa"
         static final String PROD = "prod"
+
     }
 
     class PipelinePhases {
+
         static final String BUILD = "Build"
         static final String DEPLOY = "Deploy"
         static final String FINALIZE = "Finalize"
@@ -61,6 +65,7 @@ class MROPipelineUtil extends PipelineUtil {
         static final String TEST = "Test"
 
         static final List ALWAYS_PARALLEL = []
+
     }
 
     static final String COMPONENT_METADATA_FILE_NAME = 'metadata.yml'
@@ -88,46 +93,6 @@ class MROPipelineUtil extends PipelineUtil {
         }
     }
 
-    private void executeODSComponent(Map repo, String baseDir, boolean failfast = true,
-        String jenkinsFile = 'Jenkinsfile') {
-        this.steps.dir(baseDir) {
-            if (repo.data.openshift.resurrectedBuild) {
-                logger.info("Repository '${repo.id}' is in sync with OpenShift, no need to rebuild")
-                return
-            }
-            def job
-            def env = []
-            env.addAll(this.project.getMainReleaseManagerEnv())
-            this.project.buildParams.each { key, value ->
-                env << "BUILD_PARAM_${key.toUpperCase()}=${value}"
-            }
-            env << "NOTIFY_BB_BUILD=${!project.isWorkInProgress}"
-            this.steps.withEnv (env) {
-                job = this.loadGroovySourceFile("${baseDir}/${jenkinsFile}")
-            }
-            // Collect ODS build artifacts for repo.
-            // We get a map with at least two keys ("build" and "deployments").
-            def buildArtifacts = job.getBuildArtifactURIs()
-            buildArtifacts.each { k, v ->
-                if (k != 'failedStage') {
-                    repo.data.openshift[k] = v
-                }
-            }
-            def versionAndBuild = "${this.project.buildParams.version}/${this.steps.env.BUILD_NUMBER}"
-            repo.data.openshift[DeploymentDescriptor.CREATED_BY_BUILD_STR] = versionAndBuild
-            this.logger.debug("Collected ODS build artifacts for repo '${repo.id}': ${repo.data.openshift}")
-
-            if (buildArtifacts.failedStage) {
-                repo.data << ['failedStage': buildArtifacts.failedStage]
-                if (failfast) {
-                    throw new RuntimeException("Error: aborting due to previous errors in repo '${repo.id}'.")
-                } else {
-                    this.logger.warn("Got errors in repo '${repo.id}', will fail delayed.")
-                }
-            }
-        }
-    }
-
     Map loadPipelineConfig(String path, Map repo) {
         if (!path?.trim()) {
             throw new IllegalArgumentException("Error: unable to parse pipeline config. 'path' is undefined.")
@@ -226,7 +191,7 @@ class MROPipelineUtil extends PipelineUtil {
             repo.id,
             {
                 checkoutNotReleaseManagerRepo(repo, recheckout)
-            }
+            },
         ]
     }
 
@@ -265,7 +230,7 @@ class MROPipelineUtil extends PipelineUtil {
             previousSucessfulCommit: lastSuccessCommit,
             url: scm.GIT_URL,
             baseTag: this.project.baseTag,
-            targetTag: this.project.targetTag
+            targetTag: this.project.targetTag,
         ]
         def repoPath = "${this.steps.env.WORKSPACE}/${REPOS_BASE_DIR}/${repo.id}"
         loadPipelineConfig(repoPath, repo)
@@ -283,66 +248,6 @@ class MROPipelineUtil extends PipelineUtil {
         }
     }
 
-    private Map checkOutNotReleaseManagerRepoInNotPromotionMode(Map repo, boolean isWorkInProgress) {
-        Map scmResult = [ : ]
-        String gitReleaseBranch = this.project.gitReleaseBranch
-        if ("master" == gitReleaseBranch) {
-            gitReleaseBranch = repo.branch
-        }
-
-        // check if release manager repo already has a release branch
-        if (git.remoteBranchExists(gitReleaseBranch)) {
-            try {
-                scmResult.scm = checkoutBranchInRepoDir(repo, gitReleaseBranch)
-                scmResult.scmBranch = gitReleaseBranch
-            } catch (ex) {
-                if (! isWorkInProgress) {
-                    this.logger.warn """
-                                Checkout of '${gitReleaseBranch}' for repo '${repo.id}' failed.
-                                Attempting to checkout '${repo.branch}' and create the release branch from it.
-                                """
-                    // Possible reasons why this might happen:
-                    // * Release branch manually created in RM repo
-                    // * Repo is added to metadata.yml file on a release branch
-                    // * Release branch has been deleted in repo
-
-                    scmResult.scm = createBranchFromDefaultBranch(repo, gitReleaseBranch)
-                    scmResult.scmBranch = gitReleaseBranch
-                } else {
-                    this.logger.warn """
-                                Checkout of '${gitReleaseBranch}' for repo '${repo.id}' failed.
-                                Attempting to checkout branch '${repo.branch}'.
-                                """
-                    scmResult.scm = checkoutBranchInRepoDir(repo, repo.branch)
-                    scmResult.scmBranch = repo.branch
-                }
-            }
-        } else {
-            if (! isWorkInProgress) {
-                scmResult.scm = createBranchFromDefaultBranch(repo, gitReleaseBranch)
-                scmResult.scmBranch = gitReleaseBranch
-            } else {
-                this.logger.info("Since in WIP and no release branch exists (${this.project.gitReleaseBranch}), checking out branch ${repo.branch} for repo ${repo.id}")
-                scmResult.scm = checkoutBranchInRepoDir(repo, repo.branch)
-                scmResult.scmBranch = repo.branch
-            }
-        }
-        return scmResult
-    }
-
-    private def createBranchFromDefaultBranch(Map repo, String branchName) {
-        this.logger.info("Creating branch ${branchName} from branch ${repo.branch} for repo ${repo.id} ")
-        def scm = checkoutBranchInRepoDir(repo, repo.branch)
-        if (repo.branch != branchName) {
-            steps.dir("${REPOS_BASE_DIR}/${repo.id}") {
-                git.checkoutNewLocalBranch(branchName)
-            }
-        } else {
-            this.logger.info("No need to create branch ${branchName} for repo ${repo.id} ")
-        }
-        return scm
-    }
-
     def checkoutTagInRepoDir(Map repo, String tag) {
         this.logger.info("Checkout tag ${repo.id}@${tag}")
         def credentialsId = this.project.services.bitbucket.credentials.id
@@ -460,7 +365,7 @@ class MROPipelineUtil extends PipelineUtil {
                         postExecute(this.steps, repo)
                     }
                 }
-            }
+            },
         ]
     }
 
@@ -497,6 +402,106 @@ class MROPipelineUtil extends PipelineUtil {
         }
     }
 
+    private void executeODSComponent(Map repo, String baseDir, boolean failfast = true,
+                                     String jenkinsFile = 'Jenkinsfile') {
+        this.steps.dir(baseDir) {
+            if (repo.data.openshift.resurrectedBuild) {
+                logger.info("Repository '${repo.id}' is in sync with OpenShift, no need to rebuild")
+                return
+            }
+            def job
+            def env = []
+            env.addAll(this.project.getMainReleaseManagerEnv())
+            this.project.buildParams.each { key, value ->
+                env << "BUILD_PARAM_${key.toUpperCase()}=${value}"
+            }
+            env << "NOTIFY_BB_BUILD=${!project.isWorkInProgress}"
+            this.steps.withEnv (env) {
+                job = this.loadGroovySourceFile("${baseDir}/${jenkinsFile}")
+            }
+            // Collect ODS build artifacts for repo.
+            // We get a map with at least two keys ("build" and "deployments").
+            def buildArtifacts = job.getBuildArtifactURIs()
+            buildArtifacts.each { k, v ->
+                if (k != 'failedStage') {
+                    repo.data.openshift[k] = v
+                }
+            }
+            def versionAndBuild = "${this.project.buildParams.version}/${this.steps.env.BUILD_NUMBER}"
+            repo.data.openshift[DeploymentDescriptor.CREATED_BY_BUILD_STR] = versionAndBuild
+            this.logger.debug("Collected ODS build artifacts for repo '${repo.id}': ${repo.data.openshift}")
+
+            if (buildArtifacts.failedStage) {
+                repo.data << ['failedStage': buildArtifacts.failedStage]
+                if (failfast) {
+                    throw new RuntimeException("Error: aborting due to previous errors in repo '${repo.id}'.")
+                } else {
+                    this.logger.warn("Got errors in repo '${repo.id}', will fail delayed.")
+                }
+            }
+        }
+    }
+
+    private Map checkOutNotReleaseManagerRepoInNotPromotionMode(Map repo, boolean isWorkInProgress) {
+        Map scmResult = [ : ]
+        String gitReleaseBranch = this.project.gitReleaseBranch
+        if ("master" == gitReleaseBranch) {
+            gitReleaseBranch = repo.branch
+        }
+
+        // check if release manager repo already has a release branch
+        if (git.remoteBranchExists(gitReleaseBranch)) {
+            try {
+                scmResult.scm = checkoutBranchInRepoDir(repo, gitReleaseBranch)
+                scmResult.scmBranch = gitReleaseBranch
+            } catch (ex) {
+                if (! isWorkInProgress) {
+                    this.logger.warn """
+                                Checkout of '${gitReleaseBranch}' for repo '${repo.id}' failed.
+                                Attempting to checkout '${repo.branch}' and create the release branch from it.
+                                """
+                    // Possible reasons why this might happen:
+                    // * Release branch manually created in RM repo
+                    // * Repo is added to metadata.yml file on a release branch
+                    // * Release branch has been deleted in repo
+
+                    scmResult.scm = createBranchFromDefaultBranch(repo, gitReleaseBranch)
+                    scmResult.scmBranch = gitReleaseBranch
+                } else {
+                    this.logger.warn """
+                                Checkout of '${gitReleaseBranch}' for repo '${repo.id}' failed.
+                                Attempting to checkout branch '${repo.branch}'.
+                                """
+                    scmResult.scm = checkoutBranchInRepoDir(repo, repo.branch)
+                    scmResult.scmBranch = repo.branch
+                }
+            }
+        } else {
+            if (! isWorkInProgress) {
+                scmResult.scm = createBranchFromDefaultBranch(repo, gitReleaseBranch)
+                scmResult.scmBranch = gitReleaseBranch
+            } else {
+                this.logger.info("Since in WIP and no release branch exists (${this.project.gitReleaseBranch}), checking out branch ${repo.branch} for repo ${repo.id}")
+                scmResult.scm = checkoutBranchInRepoDir(repo, repo.branch)
+                scmResult.scmBranch = repo.branch
+            }
+        }
+        return scmResult
+    }
+
+    private createBranchFromDefaultBranch(Map repo, String branchName) {
+        this.logger.info("Creating branch ${branchName} from branch ${repo.branch} for repo ${repo.id} ")
+        def scm = checkoutBranchInRepoDir(repo, repo.branch)
+        if (repo.branch != branchName) {
+            steps.dir("${REPOS_BASE_DIR}/${repo.id}") {
+                git.checkoutNewLocalBranch(branchName)
+            }
+        } else {
+            this.logger.info("No need to create branch ${branchName} for repo ${repo.id} ")
+        }
+        return scm
+    }
+
     private boolean isRepoModified(Map repo) {
         if (!repo.data.envStateCommit) {
             logger.debug("Last recorded commit of '${repo.id}' cannot be retrieved.")
@@ -583,7 +588,7 @@ class MROPipelineUtil extends PipelineUtil {
                 OpenShiftService.DEPLOYMENTCONFIG_KIND,
                 deploymentDescriptor.deploymentNames
             )
-        } catch(ex) {
+        } catch (ex) {
             logger.info(
                 "Resurrection of previous build for '${repo.id}' not possible as " +
                 "not all deployments could be retrieved: ${ex.message}"
@@ -613,4 +618,5 @@ class MROPipelineUtil extends PipelineUtil {
         repo.data.openshift.deployments = deployments
         logger.debug("Data from previous Jenkins build:\r${repo.data.openshift}")
     }
+
 }