using cirrus

Author: SamirM-BE

.cirrus.star

@@ -1,4 +1,4 @@
-load("github.com/SonarSource/cirrus-modules@b1f898b04170567791e1fd75f691f0266aab60af", "load_features") # 3.0.4
+load("github.com/SonarSource/cirrus-modules@5cd6425fdb78665f07284f2c12d495618a7bbc0a", "load_features") # 3.1.0
 
 def main(ctx):
     return load_features(ctx, only_if=dict())

.cirrus.yml

@@ -6,19 +6,21 @@ env:
   CIRRUS_SHELL: bash
 
 eks_container_definition: &CONTAINER_DEFINITION
-  image: ${CIRRUS_AWS_ACCOUNT}.dkr.ecr.eu-central-1.amazonaws.com/base:latest
+  image: 460386131003.dkr.ecr.eu-central-1.amazonaws.com/base-pr-118:node22-yarn2.4.3
   cluster_name: ${CIRRUS_CLUSTER_NAME}
   region: eu-central-1
   namespace: default
-  docker_arguments:
-    CIRRUS_AWS_ACCOUNT: ${CIRRUS_AWS_ACCOUNT}
 
 build_task:
   auto_cancellation: $CIRRUS_BRANCH != 'master' && $CIRRUS_BRANCH != 'stable'
   eks_container:
     <<: *CONTAINER_DEFINITION
-    cpu: 2
-    memory: 2G
+    builder_role: cirrus-builder
+    builder_image: docker-builder-v*
+    builder_instance_type: t2.small
+    dockerfile: .cirrus/Dockerfile
+    docker_arguments:
+      CIRRUS_AWS_ACCOUNT: ${CIRRUS_AWS_ACCOUNT}
   env:
     ARTIFACTORY_DEPLOY_ACCESS_TOKEN: VAULT[development/artifactory/token/${CIRRUS_REPO_OWNER}-${CIRRUS_REPO_NAME}-qa-deployer access_token]
     SONAR_HOST_URL: VAULT[development/kv/data/sonarcloud data.url]
@@ -38,7 +40,7 @@ build_task:
 
   build_script:
     - source cirrus-env BUILD
-    - regular_npm_build_deploy_analyze
+    - ./.cirrus/npm_build_deploy_analyze
 
 promote_task:
   depends_on:

.cirrus/Dockerfile

@@ -0,0 +1,28 @@
+ARG CIRRUS_AWS_ACCOUNT
+FROM ${CIRRUS_AWS_ACCOUNT}.dkr.ecr.eu-central-1.amazonaws.com/base:j17-latest
+
+USER root
+
+# Update package list
+RUN apt-get update -y
+
+# Install some tools
+RUN apt-get install -y jq
+
+# Install vim
+RUN apt-get install -y vim
+
+# Install Node.js
+ARG NODE_VERSION=20.*
+RUN apt-get install -y nodejs=${NODE_VERSION}
+
+# Install Yarn
+RUN npm install -g yarn
+
+# Install sonar-scanner-npm
+RUN npm install -g sonarqube-scanner
+
+# Clean up cache after packages installation
+RUN apt-get clean
+
+USER sonarsource

analyze .cirrus/analyze

@@ -1,28 +1,15 @@
 #!/bin/bash
 set -euo pipefail
 
-echo "Starting script..."
-
-# SonarQube-related utility functions
-
-: "${SONAR_HOST_URL?Environment variable missing}"
-: "${SONAR_TOKEN?Environment variable missing}"
-
-echo "SONAR_HOST_URL: $SONAR_HOST_URL"
-echo "SONAR_TOKEN: $SONAR_TOKEN"
-
 git fetch --unshallow || true
 
 if [ -n "${GITHUB_BASE_BRANCH:-}" ]; then
     echo "Fetching base branch: $GITHUB_BASE_BRANCH"
     git fetch origin "${GITHUB_BASE_BRANCH}"
 fi
 
-if [ -z "$PIPELINE_ID" ]; then
+if [ -z "${PIPELINE_ID:-}" ]; then
   PIPELINE_ID=$BUILD_NUMBER
-  echo "PIPELINE_ID not set, using BUILD_NUMBER: $BUILD_NUMBER"
-else
-  echo "PIPELINE_ID: $PIPELINE_ID"
 fi
 
 # Runs the SonarQube scanner with default and additional parameters.
@@ -31,16 +18,24 @@ run_sonar_scanner() {
 
     local additional_params=("$@")
 
-    echo "Running sonar-scanner with parameters: ${additional_params[*]}"
+    # echo "Running SonarQube scanner..."
+    if [ -z "${SONAR_HOST_URL:-}" ]; then
+      echo "SONAR_HOST_URL is required for SonarQube scanner"
+      exit 1
+    fi
+
+    if [ -z "${SONAR_TOKEN:-}" ]; then
+      echo "SONAR_TOKEN is required for SonarQube scanner"
+      exit 1
+    fi
 
-    sonar-scanner -X \
+    npx sonarqube-scanner -X \
         -Dsonar.host.url="$SONAR_HOST_URL" \
         -Dsonar.token="$SONAR_TOKEN" \
         -Dsonar.analysis.buildNumber="$BUILD_NUMBER" \
         -Dsonar.analysis.pipeline="$PIPELINE_ID" \
         -Dsonar.analysis.sha1="$GIT_SHA1" \
         -Dsonar.analysis.repository="$GITHUB_REPO" \
         "${additional_params[@]}"
+    echo "SonarQube scanner finished"
 }
-
-echo "Script finished."

includes/cirrus-env .cirrus/includes/cirrus-env

@@ -4,38 +4,31 @@
 set -euo pipefail
 
 fetch_git_history() {
-    echo "Fetching git history..."
     git fetch --unshallow || true
 }
 
 fetch_pr_references() {
     if [ -n "${GITHUB_BASE_BRANCH:-}" ]; then
-        echo "Fetching PR references for base branch: $GITHUB_BASE_BRANCH"
         git fetch origin "${GITHUB_BASE_BRANCH}"
     fi
 }
 
 is_master_branch() {
-    echo "Checking if current branch is master: $GITHUB_BRANCH"
     [[ "${GITHUB_BRANCH}" == "master" ]]
 }
 
 is_maintenance_branch() {
-    echo "Checking if current branch is a maintenance branch: $GITHUB_BRANCH"
     [[ "${GITHUB_BRANCH}" == "branch-"* ]]
 }
 
 is_pull_request() {
-    echo "Checking if this is a pull request: ${PULL_REQUEST:-}"
     [[ "${PULL_REQUEST:-}" != "false" ]]
 }
 
 is_dogfood_branch() {
-    echo "Checking if current branch is a dogfood branch: $GITHUB_BRANCH"
     [[ "${GITHUB_BRANCH}" == "dogfood-on-"* ]]
 }
 
 is_long_lived_feature_branch() {
-    echo "Checking if current branch is a long-lived feature branch: $GITHUB_BRANCH"
     [[ "${GITHUB_BRANCH}" == "feature/long/"* ]]
 }

includes/cirrus_error_advices .cirrus/includes/cirrus_error_advices

@@ -1,13 +1,14 @@
 #!/bin/bash
+# shellcheck source=/dev/null
 
 set -euo pipefail
 
 source "$(dirname "$0")"/includes/git_utils
 source "$(dirname "$0")"/includes/version_util
-source analyze
+source "$(dirname "$0")"/analyze
+source "$(dirname "$0")"/npm_deploy
 
-# source npm_deploy
-source npm_version_utils
+source "$(dirname "$0")"/npm_version_utils
 
 
 if is_master_branch && ! is_pull_request; then
@@ -19,27 +20,27 @@ if is_master_branch && ! is_pull_request; then
   CURRENT_VERSION=$(get_current_version)
   echo "Current version: $CURRENT_VERSION"
 
-  # set_npm_version_with_build_id "$BUILD_NUMBER"
+  set_npm_version_with_build_id "$BUILD_NUMBER"
   echo "Set npm version with build ID: $BUILD_NUMBER."
 
   check_version_format "$PROJECT_VERSION"
   echo "Checked version format: $PROJECT_VERSION."
 
   echo "Installing npm dependencies..."
-  npm ci
+  yarn install --immutable
 
   echo "Running tests..."
-  npm test
+  yarn test
 
   echo "Running Sonar Scanner..."
   run_sonar_scanner \
       -Dsonar.projectVersion="$CURRENT_VERSION"
 
   echo "Building project..."
-  npm run build
+  yarn build
 
   echo "Publishing to JFrog..."
-  jfrog_npm_publish
+  jfrog_npm_publish "$@"
 
 elif is_maintenance_branch && not_pull_request; then
   git fetch origin "${GITHUB_BRANCH}"
@@ -57,13 +58,13 @@ elif is_maintenance_branch && not_pull_request; then
     check_version_format "$CURRENT_VERSION"
   fi
 
-  npm ci
-  npm test
+  yarn install --immutable
+  yarn test
   run_sonar_scanner \
       -Dsonar.branch.name="$GITHUB_BRANCH"
 
-  npm run build
-  jfrog_npm_publish
+  yarn build
+  jfrog_npm_publish "$@"
 
 elif is_pull_request; then
   # Do not deploy a SNAPSHOT version but the release version related to this build and PR
@@ -74,24 +75,24 @@ elif is_pull_request; then
 
     check_version_format "$PROJECT_VERSION"
 
-    npm ci
+    yarn install --immutable
 
-    npm test
+    yarn test
     run_sonar_scanner \
       -Dsonar.analysis.prNumber="$PULL_REQUEST"
 
-    npm run build
-    jfrog_npm_publish
+    yarn build
+    jfrog_npm_publish "$@"
 
   else
     echo '======= no deploy ======='
 
-    npm ci
+    yarn install --immutable
 
     run_sonar_scanner \
       -Dsonar.analysis.prNumber="$PULL_REQUEST"
 
-    npm run build
+    yarn build
   fi
 
 elif is_dogfood_branch && not_pull_request; then
@@ -102,21 +103,21 @@ elif is_dogfood_branch && not_pull_request; then
   set_npm_version_with_build_id "$BUILD_NUMBER"
   check_version_format "$PROJECT_VERSION"
 
-  npm ci
-  npm run build
-  jfrog_npm_publish
+  yarn install --immutable
+  yarn build
+  jfrog_npm_publish "$@"
 
 elif is_long_lived_feature_branch && not_pull_request; then
-  npm ci
+  yarn install --immutable
 
-  npm test
+  yarn test
   run_sonar_scanner \
       -Dsonar.branch.name="$GITHUB_BRANCH"
 
-  npm run build
+  yarn build
 
 else
-  npm ci
-  npm test
-  npm run build
+  yarn install --immutable
+  yarn test
+  yarn build
 fi

includes/git_utils .cirrus/includes/git_utils

@@ -16,6 +16,7 @@ jfrog_npm_publish() {
   local build_name=${3:-$CIRRUS_REPO_NAME}
   local build_number=${4:-$BUILD_NUMBER}
 
+
   jfrog npm-config --repo-resolve "$repo_resolve" --repo-deploy "$repo_deploy"
   jfrog npm publish --build-name="$build_name" --build-number="$build_number"
   jfrog rt build-publish "$build_name" "$build_number"

includes/jfrog_utils.sh .cirrus/includes/jfrog_utils.sh

@@ -5,24 +5,26 @@ set -euo pipefail
 PACKAGE_JSON="package.json"
 
 function get_current_version() {
-  jq -r .version "$PACKAGE_JSON"
+  CURRENT_VERSION=$(jq -r .version "$PACKAGE_JSON")
+
+  if [ -z "$CURRENT_VERSION" ] || [ "$CURRENT_VERSION" == "null" ]; then
+    echo "Could not get version from $PACKAGE_JSON" >&2
+    exit 1
+  fi
+
+  echo "$CURRENT_VERSION"
 }
 
 function set_npm_version_with_build_id() {
   local BUILD_ID=$1
 
   CURRENT_VERSION=$(get_current_version)
 
-  if [ -z "$CURRENT_VERSION" ] || [ "$CURRENT_VERSION" == "null" ]; then
-    echo "Could not get version from $PACKAGE_JSON" >&2
-    exit 1
-  fi
-
   RELEASE_VERSION=${CURRENT_VERSION%"-SNAPSHOT"}
 
   # In case of 2 digits, we need to add the 3rd digit (0 obviously)
   # Mandatory in order to compare versions (patch VS non patch)
-  DIGIT_COUNT=$(echo "${RELEASE_VERSION//./ }" | wc --words)
+  DIGIT_COUNT=$(echo "${RELEASE_VERSION//./ }" | wc -w)
   if [ "$DIGIT_COUNT" -lt 3 ]; then
       RELEASE_VERSION="$RELEASE_VERSION.0"
   fi

includes/version_util .cirrus/includes/version_util

@@ -0,0 +1,11 @@
+/*
+ * Copyright (C) 2014-2024 SonarSource SA
+ * All rights reserved
+ * mailto:info AT sonarsource DOT com
+ */
+
+function helloNpm() {
+  return "hello NPM"
+}
+
+module.exports = helloNpm