BUILD-9877 code review

Author: julien-carsique-sonarsource

config-pip/action.yml

@@ -74,9 +74,8 @@ runs:
       run: |
         echo "ARTIFACTORY_READER_ROLE=${ARTIFACTORY_READER_ROLE}" >> "$GITHUB_ENV"
 
-    - name: Fetch Artifactory credentials from Vault
+    - uses: SonarSource/vault-action-wrapper@320bd31b03e5dacaac6be51bbbb15adf7caccc32 # 3.1.0
       id: secrets
-      uses: SonarSource/vault-action-wrapper@320bd31b03e5dacaac6be51bbbb15adf7caccc32 # 3.1.0
       with:
         secrets: |
           development/artifactory/token/{REPO_OWNER_NAME_DASH}-${{ env.ARTIFACTORY_READER_ROLE }} username | ARTIFACTORY_USERNAME;
@@ -85,11 +84,9 @@ runs:
     - name: Run pip configuration script
       id: config
       shell: bash
-      working-directory: ${{ inputs.working-directory }}
       env:
         # Use custom Artifactory URL if provided, otherwise construct from repox-url
-        ARTIFACTORY_URL:
-          ${{ inputs.repox-artifactory-url != '' && inputs.repox-artifactory-url ||
+        ARTIFACTORY_URL: ${{ inputs.repox-artifactory-url != '' && inputs.repox-artifactory-url ||
           format('{0}/artifactory', inputs.repox-url) }}
         ARTIFACTORY_USERNAME: ${{ fromJSON(steps.secrets.outputs.vault).ARTIFACTORY_USERNAME }}
         ARTIFACTORY_ACCESS_TOKEN: ${{ fromJSON(steps.secrets.outputs.vault).ARTIFACTORY_ACCESS_TOKEN }}

config-pip/config.sh

@@ -11,51 +11,29 @@
 
 set -euo pipefail
 
-# Validate required environment variables
-if [[ -z "${ARTIFACTORY_URL:-}" ]]; then
-  echo "ERROR: ARTIFACTORY_URL is required" >&2
-  exit 1
-fi
-
-if [[ -z "${ARTIFACTORY_USERNAME:-}" ]]; then
-  echo "ERROR: ARTIFACTORY_USERNAME is required" >&2
-  exit 1
-fi
-
-if [[ -z "${ARTIFACTORY_ACCESS_TOKEN:-}" ]]; then
-  echo "ERROR: ARTIFACTORY_ACCESS_TOKEN is required" >&2
-  exit 1
-fi
+: "${ARTIFACTORY_URL:?}" "${ARTIFACTORY_USERNAME:?}" "${ARTIFACTORY_ACCESS_TOKEN:?}"
 
 configure_pip() {
   echo "Configuring pip to use Artifactory..."
 
   # Extract the host from ARTIFACTORY_URL
   local repox_host="${ARTIFACTORY_URL#https://}"
   repox_host="${repox_host#http://}"
-
   echo "Repox host: $repox_host"
 
-  # Create pip config directory
   mkdir -p "$HOME/.pip"
-
-  # Write pip configuration with Artifactory credentials
-  cat > ~/.pip/pip.conf <<EOF
+  cat > "${HOME}/.pip/pip.conf" <<EOF
 [global]
-index-url = https://$ARTIFACTORY_USERNAME:$ARTIFACTORY_ACCESS_TOKEN@$repox_host/api/pypi/sonarsource-pypi/simple
+index-url = https://${ARTIFACTORY_USERNAME}:${ARTIFACTORY_ACCESS_TOKEN}@$repox_host/api/pypi/sonarsource-pypi/simple
 EOF
-
-  echo "✓ pip configuration completed successfully"
-  echo "  Configuration file: ${HOME}/.pip/pip.conf"
-
+  echo "Configuration file: ${HOME}/.pip/pip.conf"
   return 0
 }
 
 main() {
   echo "::group::Configure pip"
   configure_pip
   echo "::endgroup::"
-
   return 0
 }
 

spec/config-pip_spec.sh

@@ -11,7 +11,6 @@ export ARTIFACTORY_ACCESS_TOKEN="test-token"
 
 # Expected output messages
 MESSAGE_CONFIGURING_PIP="Configuring pip to use Artifactory..."
-MESSAGE_PIP_CONFIGURATION_SUCCESS="✓ pip configuration completed successfully"
 MESSAGE_REPOX_HOST="Repox host: repox.jfrog.io/artifactory"
 
 Describe 'config-pip/config.sh'
@@ -45,13 +44,12 @@ Describe 'configure_pip()'
   It 'creates pip config directory, file and correct content'
     When call configure_pip
     The status should be success
-    The lines of output should equal 4
+    The lines of output should equal 3
     The lines of error should equal 0
     The line 1 should equal "$MESSAGE_CONFIGURING_PIP"
     The line 2 should equal "$MESSAGE_REPOX_HOST"
-    The line 3 should equal "$MESSAGE_PIP_CONFIGURATION_SUCCESS"
-    The line 4 should start with "  Configuration file: "
-    The line 4 should end with "/.pip/pip.conf"
+    The line 3 should start with "Configuration file: "
+    The line 3 should end with "/.pip/pip.conf"
     The path "${HOME}/.pip" should be directory
     The path "${HOME}/.pip/pip.conf" should be file
     The contents of file "${HOME}/.pip/pip.conf" should equal "[global]
@@ -62,47 +60,17 @@ index-url = https://test-user:[email protected]/artifactory/api/pypi/son
     export ARTIFACTORY_URL="https://repox.jfrog.io:8080/artifactory"
     When call configure_pip
     The status should be success
-    The lines of output should equal 4
+    The lines of output should equal 3
     The lines of error should equal 0
     The line 1 should equal "$MESSAGE_CONFIGURING_PIP"
     The line 2 should equal "Repox host: repox.jfrog.io:8080/artifactory"
-    The line 3 should equal "$MESSAGE_PIP_CONFIGURATION_SUCCESS"
-    The line 4 should start with "  Configuration file: "
-    The line 4 should end with "/.pip/pip.conf"
+    The line 3 should start with "Configuration file: "
+    The line 3 should end with "/.pip/pip.conf"
     The contents of file "${HOME}/.pip/pip.conf" should equal "[global]
 index-url = https://test-user:[email protected]:8080/artifactory/api/pypi/sonarsource-pypi/simple"
   End
 End
 
-Describe 'Environment variable validation'
-  It 'fails when ARTIFACTORY_URL is not set'
-    unset ARTIFACTORY_URL
-    When run script config-pip/config.sh
-    The status should be failure
-    The lines of output should equal 0
-    The lines of error should equal 1
-    The error should equal "ERROR: ARTIFACTORY_URL is required"
-  End
-
-  It 'fails when ARTIFACTORY_USERNAME is not set'
-    unset ARTIFACTORY_USERNAME
-    When run script config-pip/config.sh
-    The status should be failure
-    The lines of output should equal 0
-    The lines of error should equal 1
-    The error should equal "ERROR: ARTIFACTORY_USERNAME is required"
-  End
-
-  It 'fails when ARTIFACTORY_ACCESS_TOKEN is not set'
-    unset ARTIFACTORY_ACCESS_TOKEN
-    When run script config-pip/config.sh
-    The status should be failure
-    The lines of output should equal 0
-    The lines of error should equal 1
-    The error should equal "ERROR: ARTIFACTORY_ACCESS_TOKEN is required"
-  End
-End
-
 Describe 'main()'
   BeforeEach 'common_setup'
   AfterEach 'common_cleanup'
@@ -112,15 +80,14 @@ Describe 'main()'
     export ARTIFACTORY_ACCESS_TOKEN="my-secret-token"
     When run script config-pip/config.sh
     The status should be success
-    The lines of output should equal 6
+    The lines of output should equal 5
     The lines of error should equal 0
     The line 1 should equal "::group::Configure pip"
     The line 2 should equal "$MESSAGE_CONFIGURING_PIP"
     The line 3 should equal "$MESSAGE_REPOX_HOST"
-    The line 4 should equal "$MESSAGE_PIP_CONFIGURATION_SUCCESS"
-    The line 5 should start with "  Configuration file: "
-    The line 5 should end with "/.pip/pip.conf"
-    The line 6 should equal "::endgroup::"
+    The line 4 should start with "Configuration file: "
+    The line 4 should end with "/.pip/pip.conf"
+    The line 5 should equal "::endgroup::"
     The path "${HOME}/.pip/pip.conf" should be file
     The contents of file "${HOME}/.pip/pip.conf" should equal "[global]
 index-url = https://my-user:[email protected]/artifactory/api/pypi/sonarsource-pypi/simple"