Golden Tests improvements

.github/workflows/continuous-integration-workflow.yml

@@ -165,10 +165,10 @@ jobs:
         name: Checkout repository
         uses: actions/[email protected]
       - 
-        name: Setup Go 1.18
+        name: Setup Go 1.23
         uses: actions/setup-go@v5
         with:
-          go-version: 1.18
+          go-version: 1.23
       -
         name: Verify all Go files are formatted with gofmt
         working-directory: tests
@@ -186,7 +186,7 @@ jobs:
         name: Verify all Go tests pass linting
         uses: golangci/golangci-lint-action@v6
         with:
-          version: v1.49.0
+          version: v1.60.1
           working-directory: tests
           args: --timeout=10m
       -

CHANGELOG.md

@@ -8,6 +8,7 @@
 - Webhook Proxy maintenance ([#1298](https://github.com/opendevstack/ods-core/pull/1298))
 - Update SonarQube to 10.x non LTS ([#1300](https://github.com/opendevstack/ods-core/issues/1300))
 - Jenkins maintenance ([#1299](https://github.com/opendevstack/ods-core/pull/1299)) and update java version in Jenkins ([#1295](https://github.com/opendevstack/ods-core/issues/1295))
+- Update and fix golden tests ([#1233](https://github.com/opendevstack/ods-core/issues/1233))
 
 ### Fixed
 

tests/Jenkinsfile

@@ -0,0 +1,181 @@
+properties([
+    parameters([
+        string(
+            name: 'Quickstarter',
+            description: 'Enter the quickstarter name which is to be tested. Use "all" to test all the quickstarters together'
+        ),
+        string(
+            name: 'QuickstarterRepository',
+            defaultValue: 'ods-quickstarters',
+            description: 'Enter the repository name for the quickstarter which is to be tested'
+        ),
+        string(
+            name: 'quickstarterRef',
+            defaultValue: '4.x',
+            description: 'Enter the reference for the quickstarter (e.g., branch, tag, or commit)'
+        ),
+        string(
+            name: 'configurationRef',
+            defaultValue: 'master',
+            description: 'Enter the reference for the configuration (e.g., branch, tag, or commit)'
+        ),
+        string(
+            name: 'Project',
+            description: 'Enter the project name (in lower case) where the quickstarter will be provisioned'
+        ),
+        string(
+            name: 'ODS_NAMESPACE',
+            defaultValue: 'ods',
+            description: 'Enter the ods namespae to fetch the jenkins agent. Include "-cd" if the ODS Namespace is not ods as default'
+        ),
+        string(
+            name: 'ODS_URL',
+            defaultValue: 'https://github.com/opendevstack',
+            description: 'Enter the whole URL of the ODS files (https included)'
+        ),
+        string(
+            name: 'JENKINS_AGENT_TAG',
+            defaultValue: '4.x',
+            description: 'Enter the tag for the jenkins golang agent'
+        ),
+        string(
+            name: 'SONAR_QUALITY_PROFILE',
+            description: 'Enter the tag for the jenkins golang agent'
+        ),
+        text(
+            name: 'excludedQuickstarters',
+            defaultValue: '''inf-terraform-aws
+inf-terraform-azure
+ods-document-gen-svc
+ods-provisioning-app
+release-manager
+ds-jupyter-lab
+ds-rshiny''',
+            description: 'Enter the list of excluded quickstarters, one per line'
+        )        
+    ]),
+    disableConcurrentBuilds(),
+    buildDiscarder(logRotator(numToKeepStr: '10')),
+])
+
+// The project that we will use to test the quickstarters
+def project = params.Project
+// The Quickstarter to test
+def quickstarter = params.Quickstarter
+// Namespace fo the cd project
+def odsNamespace = params.ODS_NAMESPACE
+// odsReference
+def odsRef = params.quickstarterRef?:"master"
+// configurationReference
+def confRef = params.configurationRef?:"master"
+// QS repo
+def QUICKSTARTER_REPO = params.QuickstarterRepository
+
+// URIS of the repositories used 
+def QUICK_STARTERS_URL = "${ODS_URL}/${QUICKSTARTER_REPO}.git"
+def QUICK_STARTERS_BRANCH = "${quickstarterRef}"
+
+def ODS_CONFIGURATION_URL = "${ODS_URL}/ods-configuration.git"
+def ODS_CONFIGURATION_BRANCH = "${confRef}"
+
+def ODS_CORE_URL = "${ODS_URL}/ods-core.git"
+def ODS_CORE_BRANCH = "${quickstarterRef}"
+
+def JENKINS_AGENT_TAG = "${JENKINS_AGENT_TAG}"
+def SONAR_QUALITY_PROFILE = "${SONAR_QUALITY_PROFILE}"
+
+// List of QS that we want to exclude from the execution of the job.
+def excludedQS = params.excludedQuickstarters?:''
+
+
+echo "QUICKSTARTER_REPO : ${QUICKSTARTER_REPO}"             
+
+// Jenkins DeploymentConfig environment variables
+def dockerRegistry
+node {
+  dockerRegistry = env.DOCKER_REGISTRY
+}
+
+// We need a golang version >= 17, so if we don't have one we need to build it. 
+// trigger pipeline
+
+def conts = containerTemplate(
+  name: 'jnlp',
+  image: "${dockerRegistry}/${odsNamespace}/jenkins-agent-golang:${JENKINS_AGENT_TAG}",
+  workingDir: '/tmp',
+  alwaysPullImage: true,
+  args: ''
+)
+def podLabel = "qs-tests"
+
+podTemplate(
+  label: podLabel,
+  cloud: 'openshift',
+  containers: [conts],
+  volumes: [],
+  serviceAccount: 'jenkins'
+) {
+  node(podLabel) {
+
+    stage('Init') {
+        currentBuild.description = "Testing QS"
+
+        dir("${QUICKSTARTER_REPO}"){
+            git branch: "${QUICK_STARTERS_BRANCH}",
+                credentialsId: "${project}-cd-cd-user-with-password",
+                url: "${QUICK_STARTERS_URL}"
+        }
+        dir('ods-configuration'){
+            git branch: "${ODS_CONFIGURATION_BRANCH}",
+                credentialsId: "${project}-cd-cd-user-with-password",
+                url: "${ODS_CONFIGURATION_URL}"
+        }
+
+        dir('ods-core'){          
+            git branch: "${ODS_CORE_BRANCH}",
+                credentialsId: "${project}-cd-cd-user-with-password",
+                url: "${ODS_CORE_URL}"
+
+            // Write the file used to exclude Quickstarters in the tests
+            echo "Writing file quickStartersExclusionList.txt"
+            writeFile file: './tests/quickStartersExclusionList.txt', text: excludedQS
+        }
+    }
+
+    stage('Test') {
+        echo "${WORKSPACE}"
+
+        // If we select 'all' no one parameter will be provided, so it will try to test all the Quickstarters
+        // that have a test defined in the testdata folder.
+        def quickstarter_to_test = ""
+        quickstarter_to_test = "-q ${quickstarter}"
+
+        echo "QUICKSTARTER TO TEST : ${quickstarter_to_test}"
+        echo "QUICKSTARTER REPO : ${QUICKSTARTER_REPO}"
+        echo "Project : ${project}"
+
+        // In different environments SONAR_QUALITY_PROFILE can be different, with this env variable we provide 
+        // the needed value
+        withEnv([
+          "CGO_ENABLED=0", 
+          "GOMODCACHE=${WORKSPACE}/.cache", 
+          "SONAR_QUALITY_PROFILE=${SONAR_QUALITY_PROFILE}",
+          "ODS_GIT_REF=${odsRef}"]) {
+            sh """
+                cd ods-core/tests
+                ls -lrta
+                ./quickstarter-test.sh -p ${project} -qf "${QUICKSTARTER_REPO}/..." ${quickstarter_to_test} || true
+            """
+        }
+
+    }
+
+    stage('Get test results') {
+        archiveArtifacts artifacts: 'ods-core/tests/*.txt', followSymlinks: false
+        archiveArtifacts artifacts: 'ods-core/tests/test-quickstarter-report.xml', followSymlinks: false
+        junit(testResults:"ods-core/tests/test-quickstarter-report.xml", allowEmptyResults:true)        
+
+    }
+  }
+}
+

tests/Makefile

@@ -7,8 +7,16 @@ MAKEFLAGS += --no-builtin-rules
 ### By default we test all quickstarters located in ods-quickstarters
 QS := ods-quickstarters/...
 
+# Load environment variables from .env file
+include ../../ods-configuration/ods-core.env
+export $(shell sed 's/=.*//' ../../ods-configuration/ods-core.env)
+
 ### By default we do not parallelize tests
 PARALLEL := 1
+PROJECT := unitt
+SONAR_PROFILE := "Sonar way"
+QUICKSTARTER_REPOSITORY := ods-quickstarters
+configurationRef := master
 
 ## Full test of existing ODS core installation. Caution: Creates UNITT project and ODSVERIFY project.
 test: smoketest verify test-create-projects
@@ -33,21 +41,28 @@ test-create-projects:
 	@(./create-projects-test.sh)
 .PHONY: test-create-projects
 
-## Run quickstarter tests within existing ODS installation. Depends on UNITT project.
+## Create Jenkins pipeline using REST API
+jenkins-pipeline:
+	@(envsubst < jenkinsPipelineCreation.sh)
+	@(./jenkinsPipelineCreation.sh -p $(PROJECT) -q $(QUICKSTARTER_REPOSITORY) -s $(SONAR_PROFILE) -c $(configurationRef))
+.PHONY: jenkins-pipeline
+
+## Run quickstarter tests within existing ODS installation. Depends on UNITT project (default).
 test-quickstarter:
-	@(./quickstarter-test.sh $(QS) $(PARALLEL))
+	@(./quickstarter-test.sh -p $(PROJECT) -q $(QS) -pa $(PARALLEL))
 .PHONY: test-quickstarter
 
 ## Install tools required for tests.
 prep-tools:
 	which go-junit-report || go get github.com/jstemmer/go-junit-report
+	which golangci-lint || curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin v1.60.1
 .PHONY: prep-tools
 
 ## Lint
 lint:
 	echo "Checking code ..."
 	golangci-lint --version
-	golangci-lint run --go=1.18
+	golangci-lint run --go=1.23
 .PHONY: lint
 
 ### HELP

tests/go.mod

@@ -1,33 +1,44 @@
 module github.com/opendevstack/ods-core/tests
 
-go 1.13
+go 1.23
 
 require (
 	github.com/ghodss/yaml v1.0.0
-	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/google/go-cmp v0.5.1
+	github.com/jstemmer/go-junit-report v0.9.1
+	github.com/openshift/api v0.0.0-20180801171038-322a19404e37
+	github.com/openshift/client-go v3.9.0+incompatible
+	k8s.io/api v0.0.0-20190222213804-5cb15d344471
+	k8s.io/apimachinery v0.0.0-20190221213512-86fb29eff628
+	k8s.io/client-go v0.0.0-20190228174230-b40b2a5939e4
+)
+
+require (
+	github.com/gogo/protobuf v1.3.1 // indirect
 	github.com/golang/protobuf v1.4.2 // indirect
 	github.com/google/btree v1.0.0 // indirect
-	github.com/google/go-cmp v0.5.1
+	github.com/google/gofuzz v1.0.0 // indirect
 	github.com/googleapis/gnostic v0.4.0 // indirect
 	github.com/gregjones/httpcache v0.0.0-20190611155906-901d90724c79 // indirect
 	github.com/imdario/mergo v0.3.8 // indirect
 	github.com/json-iterator/go v1.1.8 // indirect
-	github.com/jstemmer/go-junit-report v0.9.1
 	github.com/kr/pretty v0.2.1 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 // indirect
 	github.com/modern-go/reflect2 v1.0.1 // indirect
-	github.com/openshift/api v0.0.0-20180801171038-322a19404e37
-	github.com/openshift/client-go v3.9.0+incompatible
 	github.com/peterbourgon/diskv v2.0.1+incompatible // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
 	golang.org/x/crypto v0.17.0 // indirect
+	golang.org/x/net v0.10.0 // indirect
 	golang.org/x/oauth2 v0.0.0-20191202225959-858c2ad4c8b6 // indirect
+	golang.org/x/sys v0.15.0 // indirect
+	golang.org/x/term v0.15.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
 	golang.org/x/time v0.0.0-20191024005414-555d28b269f0 // indirect
+	google.golang.org/appengine v1.4.0 // indirect
+	google.golang.org/protobuf v1.23.0 // indirect
 	gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/yaml.v2 v2.2.7 // indirect
-	k8s.io/api v0.0.0-20190222213804-5cb15d344471
-	k8s.io/apimachinery v0.0.0-20190221213512-86fb29eff628
-	k8s.io/client-go v0.0.0-20190228174230-b40b2a5939e4
 	k8s.io/klog v1.0.0 // indirect
 	sigs.k8s.io/yaml v1.1.0 // indirect
 )