SONAR-23559 Improves editions and versions setting for sonarqube chart

SonarSource · Jan 2, 2025 · c0667c1 · c0667c1
1 parent 552f8af
commit c0667c1
Show file tree

Hide file tree

Showing 100 changed files with 1,649 additions and 258 deletions.
diff --git a/.cirrus/Dockerfile b/.cirrus/Dockerfile
@@ -1,7 +1,7 @@
 ARG CIRRUS_AWS_ACCOUNT
-FROM ${CIRRUS_AWS_ACCOUNT:-275878209202}.dkr.ecr.eu-central-1.amazonaws.com/base:j11-latest as tools
+FROM ${CIRRUS_AWS_ACCOUNT:-275878209202}.dkr.ecr.eu-central-1.amazonaws.com/base:j11-latest AS tools
 
-FROM docker:20.10
+FROM docker:27.4
 
 USER root
 
@@ -27,24 +27,25 @@ ENV PATH=/usr/bin/google-cloud-sdk/bin:${PATH}
 
 RUN apk add --update --no-cache \
     aws-cli \
-    ca-certificates \
     bash \
-    jq \
-    moreutils \
+    ca-certificates \
     curl \
     gcompat \
     git \
     gnupg \
+    go \
+    jq \
     libc6-compat \
     libstdc++ \
+    moreutils \
     openssh-client \
     py3-pip \
     py3-wheel \
     python3 && \
-    pip install --upgrade pip==24.2
+    pip install --break-system-packages --upgrade pip==24.2
 
-RUN pip install "yamllint==${YAMLLINT_VERSION}" && \
-    pip install "yamale==${YAMALE_VERSION}"
+RUN pip install --break-system-packages "yamllint==${YAMLLINT_VERSION}" && \
+    pip install --break-system-packages "yamale==${YAMALE_VERSION}"
 
 RUN set -eux; \
     curl -sL ${HELM_BASE_URL}/${HELM_TAR_FILE} -o ${HELM_TAR_FILE} ; \

diff --git a/.cirrus/schema_test.sh b/.cirrus/schema_test.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -euo pipefail
+
+cd "$(dirname "$0")/../tests/unit-test"
+
+go test -timeout=0 -v schema_test.go
diff --git a/.cirrus/tasks.yml b/.cirrus/tasks.yml
@@ -137,6 +137,17 @@ chart_static_compatibility_test_task:
     - ./.cirrus/build_chart_dependencies.sh charts/sonarqube-dce
     - ./.cirrus/unit_helm_compatibility_test.sh sonarqube-dce
 
+chart_schema_test_task:
+  eks_container:
+    <<: *CONTAINER_TEMPLATE
+    cpu: 1
+    memory: 2Gb
+  <<: *CLONE_SCRIPT_TEMPLATE
+  script:
+    - ./.cirrus/build_chart_dependencies.sh charts/sonarqube
+    - ./.cirrus/build_chart_dependencies.sh charts/sonarqube-dce
+    - ./.cirrus/schema_test.sh
+
 chart_fixture_test_task:
   <<: *ONLY_ON_NON_RELEASE_DRAFT_TEMPLATE
   timeout_in: 30m

diff --git a/.tool-versions b/.tool-versions
@@ -1,3 +1,4 @@
 gcloud      470.0.0
 helm-ct     3.10.1
 kubeconform 0.6.3
+golang 1.22.0
diff --git a/charts/sonarqube/CHANGELOG.md b/charts/sonarqube/CHANGELOG.md
@@ -6,6 +6,7 @@ All changes to this chart will be documented in this file.
 * Update ingress-nginx subchart to 4.11.3
 * Support Kubernetes v1.32
 * Remove the default passcode provided with `monitoringPasscode`
+* Improves editions and versions setting for sonarqube chart
 
 ## [10.8.1]
 * Update Chart's version to 10.8.1

diff --git a/charts/sonarqube/Chart.yaml b/charts/sonarqube/Chart.yaml
@@ -38,6 +38,8 @@ annotations:
       description: "Support Kubernetes v1.32"
     - kind: changed
       description: "Remove the default passcode provided with 'monitoringPasscode'"
+    - kind: changed
+      description: "Improves editions and versions setting for sonarqube chart"
   artifacthub.io/containsSecurityUpdates: "false"
   artifacthub.io/images: |
     - name: sonarqube

diff --git a/charts/sonarqube/ci/cirrus-values.yaml b/charts/sonarqube/ci/cirrus-values.yaml
@@ -1,3 +1,6 @@
+community:
+  enabled: true
+
 image:
   pullSecrets:
     - name: pullsecret

diff --git a/charts/sonarqube/openshift-verifier/values.yaml b/charts/sonarqube/openshift-verifier/values.yaml
@@ -1,3 +1,6 @@
+community:
+  enabled: true
+
 OpenShift:
   enabled: true
   route:

diff --git a/charts/sonarqube/templates/_helpers.tpl b/charts/sonarqube/templates/_helpers.tpl
@@ -58,17 +58,39 @@ Expand the Application Image name.
 
 {{/*
   Define the image.tag value that computes the right tag to be used as `sonarqube.image`
+  The tag is derived from the following parameters:
+  - .Values.image.tag
+  - .Values.community.enabled
+  - .Values.community.buildNumber
+  - .Values.edition
+  - .Chart.AppVersion
+
+  The logic to generate the tag is as follows:
+  There should not be a default edition, with users that specify it.
+  The edition must be one of these values: developer/enterprise.
+  When “edition“ is used and “image.tag” is not, we use “appVersion” for paid editions and the latest release of SQ-CB for the community.
+  The CI supports the release of the Server edition.
 */}}
 {{- define "image.tag" -}}
-{{- if empty .Values.image.tag -}}
-{{- if and (not (empty .Values.edition)) (or (eq .Values.edition "developer") (eq .Values.edition "enterprise")) -}}
-{{- printf "%s-%s"  .Chart.AppVersion .Values.edition -}}
-{{- else if or (.Values.community.enabled) (and (not (empty .Values.edition)) (eq .Values.edition "community"))  -}}
-{{- printf "%s-%s" .Values.community.buildNumber "community" -}}
-{{- end -}}
-{{- else -}}
-{{- .Values.image.tag -}}
-{{- end -}}
+  {{- $imageTag := "" -}}
+  {{- if not (empty .Values.edition) -}}
+    {{- if or (empty .Values.image) (empty .Values.image.tag) -}}
+      {{- $imageTag = printf "%s-%s" .Chart.AppVersion .Values.edition -}}
+    {{- else -}}
+      {{- $imageTag = printf "%s" .Values.image.tag -}}
+    {{- end -}}
+  {{- else if (and (.Values.community) .Values.community.enabled) -}}
+    {{- if or (empty .Values.image) (empty .Values.image.tag) -}}
+      {{- if not (empty .Values.community.buildNumber) -}}
+        {{- $imageTag = printf "%s-%s" .Values.community.buildNumber "community" -}}
+      {{- else -}}
+        {{- $imageTag = printf "community" -}}
+      {{- end -}}
+    {{- else -}}
+      {{- $imageTag = printf "%s" .Values.image.tag -}}
+    {{- end -}}
+  {{- end -}}
+  {{- printf "%s" $imageTag -}}
 {{- end -}}
 
 {{/*
@@ -431,4 +453,4 @@ Remove incompatible user/group values that do not work in Openshift out of the b
 
 {{- $accountDeprecation := (include "deepMerge" (dict "map1" $map1 "map2" $map2)) -}}
 {{- $accountDeprecation }}
-{{- end -}}
+{{- end -}}
diff --git a/charts/sonarqube/values.schema.json b/charts/sonarqube/values.schema.json
@@ -6,14 +6,10 @@
     "properties": {
         "edition": {
             "type": "string",
-            "enum": ["community", "developer", "enterprise"],
-            "properties": {
-                "community": {
-                    "type": "string",
-                    "deprecated": true,
-                    "$comment": "(DEPRECATED) Please use `community.enabled` instead"
-                }
-            }
+            "enum": [
+                "developer",
+                "enterprise"
+            ]
         },
         "persistence": {
             "type": "object",
@@ -40,8 +36,7 @@
                 }
             }
         },
-        "OpenShift":
-        {
+        "OpenShift": {
             "type": "object",
             "properties": {
                 "createSCC": {
@@ -98,7 +93,10 @@
         },
         "replicaCount": {
             "type": "integer",
-            "enum": [0, 1]
+            "enum": [
+                0,
+                1
+            ]
         },
         "jvmOpts": {
             "type": "string",
@@ -172,20 +170,17 @@
             "deprecated": true,
             "$comment": "(DEPRECATED) this option will be removed in the next major release"
         },
-        "curlContainerImage":
-        {
+        "curlContainerImage": {
             "type": "string",
             "deprecated": true,
             "$comment": "(DEPRECATED) please use `setAdminPassword.image` at the value top level"
         },
-        "adminJobAnnotations":
-        {
+        "adminJobAnnotations": {
             "type": "object",
             "deprecated": true,
             "$comment": "(DEPRECATED) please use `setAdminPassword.annotations` at the value top level"
         },
-        "sonarqubeFolder":
-        {
+        "sonarqubeFolder": {
             "type": "string",
             "deprecated": true,
             "$comment": "(DEPRECATED) This value will is no longer required and will be dropped in future releases"
@@ -205,5 +200,65 @@
                 }
             }
         }
-    }
- }
+    },
+    "allOf": [
+        {
+            "if": {
+                "properties": {
+                    "community": {
+                        "properties": {
+                            "enabled": {
+                                "const": true
+                            }
+                        }
+                    }
+                }
+            },
+            "then": {
+                "properties": {
+                    "edition": {
+                        "maxLength": 0
+                    }
+                }
+            }
+        },
+        {
+            "if": {
+                "properties": {
+                    "community": {
+                        "properties": {
+                            "enabled": {
+                                "const": false
+                            }
+                        }
+                    }
+                }
+            },
+            "then": {
+                "required": [
+                    "edition"
+                ]
+            }
+        },
+        {
+            "if": {
+                "not": {
+                    "properties": {
+                        "community": {
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean"
+                                }
+                            }
+                        }
+                    }
+                }
+            },
+            "then": {
+                "required": [
+                    "edition"
+                ]
+            }
+        }
+    ]
+}
diff --git a/charts/sonarqube/values.yaml b/charts/sonarqube/values.yaml
@@ -48,19 +48,17 @@ OpenShift:
     # labels:
     #  external: 'true'
 
-# (DEPRECATED) The "community" value as the default of "edition" is deprecated and will be removed in the next release (in favor of an empty value). Please set "community" to "true", if you want to use SonarQube Community Build.
-edition: "community"
+# Configure the edition of SonarQube Server to deploy: developer or enterprise
+# edition: ""
 
 # Set the chart to use the latest released SonarQube Community Build
 community:
-  enabled: true
+  enabled: false
   buildNumber: "24.12.0.100206"
 
 image:
   repository: sonarqube
-  # (DEPRECATED) The "image.tag" parameter is set to be empty as default.
-  # image.tag is set according to the edition and community fields, user-defined have precedance.
-  # tag: 10.8.1-{{ .Values.edition }}
+  # tag: ""
   pullPolicy: IfNotPresent
   # If using a private repository, the imagePullSecrets to use
   # pullSecrets:

diff --git a/tests/dynamic-compatibility-test/README.md b/tests/dynamic-compatibility-test/README.md
@@ -1,9 +1,17 @@
-## Execute tests
+# Execute tests
 
-In order to execute the dynamic compability test locally, you need to have a k8s cluster running (configurations stored in the default folder), go (at least version 1.13).
+## Dynamic compatibility tests
 
-When the pre-requisites are fullfilled, just run:
+In order to execute the dynamic compatibility test locally, you need to have a k8s cluster running (configurations stored in the default folder), go (at least version 1.22).
 
-```
+When the pre-requisites are fulfilled, just run:
+
+```bash
 go test -timeout=0 -v sonarqube_standard_dynamic_test.go pod_utils.go
-```
+```
+
+## Schema validation tests
+
+```bash
+go test -v schema_test.go
+```