Add Openshift appDomain in Quickstarter Pipeline context

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 * Fix Tailor deployment drifts for D, Q envs ([#1055](https://github.com/opendevstack/ods-jenkins-shared-library/pull/1055))
 * Update api version in ocp templates for image, buildconfig, route and deploymentconfig ([#1072](https://github.com/opendevstack/ods-jenkins-shared-library/issues/1072))
+* Add Openshift appDomain context value in Quickstarter pipeline, optimize the way to get appDomain from cluster ([#997](https://github.com/opendevstack/ods-quickstarters/issues/997))
 * Fix excessive number of Api calls to Jira to retrieve the last document version ([#654](https://github.com/opendevstack/ods-jenkins-shared-library/issues/654))
 
 ## [4.3.4] - 2024-02-20

src/org/ods/component/Context.groovy

@@ -2,7 +2,6 @@ package org.ods.component
 
 import org.ods.util.ShellWithRetry
 import org.ods.util.Logger
-import org.ods.services.ServiceRegistry
 import org.ods.services.BitbucketService
 import org.ods.services.GitService
 import org.ods.services.NexusService
@@ -11,6 +10,8 @@ import com.cloudbees.groovy.cps.NonCPS
 import groovy.json.JsonSlurperClassic
 import groovy.json.JsonOutput
 import java.util.concurrent.ExecutionException
+import org.ods.util.IPipelineSteps
+import org.ods.util.PipelineSteps
 
 @SuppressWarnings(['MethodCount', 'UnnecessaryObjectReferences'])
 class Context implements IContext {
@@ -23,6 +24,7 @@ class Context implements IContext {
     private final def script
     // config is a map of config properties to customise the behaviour.
     private final Map config
+    private final IPipelineSteps steps
     private final Logger logger
     // artifact store, the interface to MRP
     private final def artifactUriStore = [builds: [:], deployments: [:]]
@@ -37,6 +39,7 @@ class Context implements IContext {
         this.config = config
         this.logger = logger
         this.localCheckoutEnabled = localCheckoutEnabled
+        this.steps = new PipelineSteps(script)
     }
 
     def assemble() {
@@ -571,17 +574,11 @@ class Context implements IContext {
     }
 
     String getOpenshiftApplicationDomain () {
-        if (!config.environment) {
-            logger.debug('Could not get application domain, as no environment is available')
-            return ''
-        }
-        if (!this.appDomain) {
-            logger.startClocked("${config.componentId}-get-oc-app-domain")
-            this.appDomain = ServiceRegistry.instance.get(OpenShiftService).
-                getApplicationDomain(config.targetProject)
-            logger.debugClocked("${config.componentId}-get-oc-app-domain")
+        def appDomain = appDomain
+        if (!appDomain) {
+            this.appDomain = appDomain = OpenShiftService.getApplicationDomain(steps)
         }
-        this.appDomain
+        return appDomain
     }
 
     // set the rollout retry

src/org/ods/component/ScanWithTrivyStage.groovy

@@ -60,7 +60,7 @@ class ScanWithTrivyStage extends Stage {
         String errorMessages = ''
         int returnCode = scanViaCli(options.scanners, options.vulType, options.format,
             options.additionalFlags, options.reportFile, options.nexusDataBaseRepository,
-            openShift.getApplicationDomain(context.cdProject))
+            openShift.getApplicationDomain())
         if ([TrivyService.TRIVY_SUCCESS].contains(returnCode)) {
             try {
                 URI reportUriNexus = archiveReportInNexus(options.reportFile, options.nexusReportRepository)

src/org/ods/quickstarter/Context.groovy

@@ -145,4 +145,9 @@ class Context implements IContext {
         config.odsGitRef
     }
 
+    @NonCPS
+    String getAppDomain() {
+        config.appDomain
+    }
+
 }

src/org/ods/quickstarter/IContext.groovy

@@ -71,4 +71,7 @@ interface IContext {
     // alias for odsGitRef
     String getGitBranch()
 
+    // get app domain of the Openshift cluster
+    String getAppDomain()
+
 }

src/org/ods/quickstarter/Pipeline.groovy

@@ -2,20 +2,20 @@ package org.ods.quickstarter
 
 import org.ods.services.BitbucketService
 import org.ods.services.NexusService
-
-import org.ods.util.Logger
-import org.ods.util.ILogger
+import org.ods.services.OpenShiftService
+import org.ods.util.IPipelineSteps
+import org.ods.util.PipelineSteps
 
 class Pipeline implements Serializable {
 
     private final def script
     private final Map config
-    private final ILogger logger
+    private final IPipelineSteps steps
 
     Pipeline(def script, Map config) {
         this.script = script
         this.config = config
-        this.logger = new Logger(script, false)
+        this.steps = new PipelineSteps(script)
     }
 
     @SuppressWarnings(['AbcMetric', 'UnnecessaryObjectReferences'])
@@ -99,6 +99,10 @@ class Pipeline implements Serializable {
         }
     }
 
+    private initappDomain() {
+        config.appDomain = OpenShiftService.getApplicationDomain(steps)
+    }
+
     private onAgentNode(Map config, Closure block) {
         if (!config.podContainers) {
             if (!config.containsKey('alwaysPullImage')) {
@@ -148,6 +152,7 @@ class Pipeline implements Serializable {
             annotations: config.annotations,
         ) {
             script.node(podLabel) {
+                initappDomain()
                 IContext context = new Context(config)
                 block(context)
             }

src/org/ods/quickstarter/RenderJenkinsfileStage.groovy

@@ -20,7 +20,7 @@ class RenderJenkinsfileStage extends Stage {
         def target = "${context.targetDir}/${config.target}"
         script.sh(
             script: """
-            sed 's|@project_id@|${context.projectId}|g; s|@component_id@|${context.componentId}|g; s|@component_type@|${context.sourceDir}|g; s|@git_url_http@|${context.gitUrlHttp}|g; s|@ods_namespace@|${context.odsNamespace}|g; s|@ods_image_tag@|${context.odsImageTag}|g; s|@ods_git_ref@|${context.odsGitRef}|g; s|@agent_image_tag@|${context.agentImageTag}|g; s|@shared_library_ref@|${context.sharedLibraryRef}|g' ${source} > ${target}
+            sed 's|@project_id@|${context.projectId}|g; s|@component_id@|${context.componentId}|g; s|@component_type@|${context.sourceDir}|g; s|@git_url_http@|${context.gitUrlHttp}|g; s|@ods_namespace@|${context.odsNamespace}|g; s|@ods_image_tag@|${context.odsImageTag}|g; s|@ods_git_ref@|${context.odsGitRef}|g; s|@agent_image_tag@|${context.agentImageTag}|g; s|@shared_library_ref@|${context.sharedLibraryRef}|g; s|@app_domain@|${context.appDomain}|g' ${source} > ${target}
             """,
             label: "Render '${config.source}' to '${config.target}'"
         )

src/org/ods/services/OpenShiftService.groovy

@@ -9,8 +9,6 @@ import org.ods.util.ILogger
 import org.ods.util.IPipelineSteps
 import org.ods.util.PodData
 
-import java.security.SecureRandom
-
 @SuppressWarnings(['ClassSize', 'MethodCount'])
 @TypeChecked
 class OpenShiftService {
@@ -51,6 +49,18 @@ class OpenShiftService {
         ).toString().trim()
     }
 
+    static String getConsoleUrl(IPipelineSteps steps) {
+        String routeUrl = steps.sh(
+            script: 'oc whoami --show-console',
+            label: 'Get OpenShift Console URL',
+            returnStdout: true
+        )
+        if (!routeUrl) {
+            throw new RuntimeException ("Cannot get cluster console url!")
+        }
+        return routeUrl.trim()
+    }
+
     static boolean tooManyEnvironments(IPipelineSteps steps, String projectId, Integer limit) {
         steps.sh(
             returnStdout: true,
@@ -69,30 +79,15 @@ class OpenShiftService {
         exists
     }
 
-    static String getApplicationDomainOfProject(IPipelineSteps steps, String project) {
-        if (!envExists(steps, project)) {
-            String currentClusterUrl = getApiUrl(steps)
-            throw new IOException ("OCP project ${project} on server ${currentClusterUrl}" +
-                ' does not exist - cannot create route to retrieve host / domain name!' +
-                ' If this is needed, please create project on cluster!')
+    static String getApplicationDomain(IPipelineSteps steps) {
+        def routeUrl = getConsoleUrl(steps)
+
+        def routePrefixLength = routeUrl.indexOf('.')
+        if (routePrefixLength < 0) {
+            throw new RuntimeException ("Route does not contain a dot: ${routeUrl}")
         }
-        def routeName = 'test-route-' + (System.currentTimeMillis() +
-            new SecureRandom().nextInt(1000))
-        steps.sh (
-            script: "oc -n ${project} create route edge ${routeName} --service=dummy --port=80 | true",
-            label: "create dummy route for extraction (${routeName})"
-        )
-        def routeUrl = steps.sh (
-            script: "oc -n ${project} get route ${routeName} -o jsonpath='{.spec.host}'",
-            returnStdout: true,
-            label: 'get cluster route domain'
-        ).toString().trim()
-        def routePrefixLength = "${routeName}-${project}".length() + 1
-        def openShiftPublicHost = routeUrl[routePrefixLength..-1]
-        steps.sh (
-            script: "oc -n ${project} delete route ${routeName} | true",
-            label: "delete dummy route for extraction (${routeName})"
-        )
+
+        def openShiftPublicHost = routeUrl[routePrefixLength+1..-1]
         return openShiftPublicHost
     }
 
@@ -168,7 +163,7 @@ class OpenShiftService {
         def excludeFlag = target.exclude ? "--exclude ${target.exclude}" : ''
         def includeArg = target.include ?: ''
         def paramFileFlag = paramFile ? "--param-file ${paramFile}" : ''
-        params << "ODS_OPENSHIFT_APP_DOMAIN=${getApplicationDomain(project)}".toString()
+        params << "ODS_OPENSHIFT_APP_DOMAIN=${getApplicationDomain()}".toString()
         def paramFlags = params.collect { "--param ${it}" }.join(' ')
         def preserveFlags = preserve.collect { "--preserve ${it}" }.join(' ')
         doTailorApply(project, "${selectorFlag} ${excludeFlag} ${paramFlags} ${preserveFlags} ${paramFileFlag} ${tailorPrivateKeyFlag} ${verifyFlag} --ignore-unknown-parameters ${includeArg}")
@@ -474,8 +469,8 @@ class OpenShiftService {
         m
     }
 
-    String getApplicationDomain(String project) {
-        getApplicationDomainOfProject(steps, project)
+    String getApplicationDomain() {
+        getApplicationDomain(steps)
     }
 
     // imageInfoForImageUrl expects an image URL like one of the following:
@@ -1304,7 +1299,6 @@ class OpenShiftService {
         } catch (ex) {
             throw new TailorDeploymentException(ex)
         }
-
     }
 
     private void doTailorExport(
@@ -1338,7 +1332,7 @@ class OpenShiftService {
         }
 
         // Replace values from envParams with parameters, and add parameters into template.
-        envParams['ODS_OPENSHIFT_APP_DOMAIN'] = getApplicationDomain(project)
+        envParams['ODS_OPENSHIFT_APP_DOMAIN'] = getApplicationDomain()
         def templateParams = ''
         def sedReplacements = ''
         envParams.each { key, val ->

test/groovy/org/ods/component/ContextSpec.groovy

@@ -4,7 +4,9 @@ import org.ods.PipelineScript
 import org.ods.util.ILogger
 import org.ods.util.Logger
 import org.ods.util.ShellWithRetry
+import org.ods.util.IPipelineSteps
 import spock.lang.*
+import org.ods.services.OpenShiftService
 
 class ContextSpec extends Specification {
 
@@ -154,4 +156,19 @@ class ContextSpec extends Specification {
         uut.determineEnvironment()
     }
 
+    def "get openshift cluster domain"() {
+        given:
+        def steps = Stub(IPipelineSteps)
+        GroovySpy(OpenShiftService, constructorArgs: [steps, new Logger(steps, false)], global: true)
+        def context = new Context(steps, null, logger)
+        def expectedDomain = 'apps.openshift.com'
+        OpenShiftService.getApplicationDomain(_) >> expectedDomain
+
+        when:
+        def domain = context.getOpenshiftApplicationDomain()
+
+        then:
+        domain == expectedDomain
+    }
+
 }

test/groovy/org/ods/services/OpenShiftServiceSpec.groovy

@@ -566,4 +566,63 @@ class OpenShiftServiceSpec extends SpecHelper {
           'Deployment'      |   'rs'
     }
 
+    def "getConsoleUrl from cluster"() {
+        given:
+        def steps = Stub(IPipelineSteps)
+        def service = new OpenShiftService(steps, new Logger(steps, false))
+        def routeUrl = 'https://console-openshift-console.apps.openshift.com'
+        steps.sh( { it.script == 'oc whoami --show-console' } ) >> routeUrl
+
+        when:
+        def result = service.getConsoleUrl(steps)
+
+        then: 
+        result == routeUrl
+    }
+
+    @Unroll
+    def "getConsoleUrl from cluster if null or empty"() {
+        given:
+        def steps = Stub(IPipelineSteps)
+        def service = new OpenShiftService(steps, new Logger(steps, false))
+        steps.sh(_) >> routeUrl
+
+        when:
+        def result = service.getConsoleUrl(steps)
+
+        then:
+        thrown(RuntimeException)
+
+        where:
+        routeUrl << [null, '']
+    }
+
+    def "getApplicationDomain from consoleUrl"() {
+        given:
+        def steps = Stub(IPipelineSteps)
+        GroovySpy(OpenShiftService, constructorArgs: [steps, new Logger(steps, false)], global: true)
+        def routeUrl = 'https://console-openshift-console.apps.openshift.com'
+        def expectedDomain = "apps.openshift.com"
+        OpenShiftService.getConsoleUrl(_) >> routeUrl
+
+        when:
+        def domain = OpenShiftService.getApplicationDomain(steps)
+
+        then:
+        domain == expectedDomain
+    }
+
+    def "getApplicationDomain from consoleUrl if no dot"() {
+        given:
+        def steps = Stub(IPipelineSteps)
+        GroovySpy(OpenShiftService, constructorArgs: [steps, new Logger(steps, false)], global: true)
+        def routeUrl = 'https://console-openshift-console-apps-openshift-com'
+        OpenShiftService.getConsoleUrl(_) >> routeUrl
+
+        when:
+        def domain = OpenShiftService.getApplicationDomain(steps)
+
+        then:
+        thrown(RuntimeException)
+    }
 }