Rename repository_identifier to repository and service_identifer to service_account (#21)

robgodfrey · web-flow · commit a6438f6d8e5d · 2023-10-05T10:18:56.000+01:00
diff --git a/.circleci/test-deploy.yml b/.circleci/test-deploy.yml
@@ -29,7 +29,7 @@ jobs:
     steps:
       - checkout
       - cloudsmith-circleci/authenticate_with_oidc:
-          service_identifier: "circleci-orb-testing"
+          service_account: "circleci-orb-testing"
       - run:
           name: Assert environment variables have been set
           command: | 
@@ -38,9 +38,9 @@ jobs:
               echo "Test failed: CLOUDSMITH_ORGANISATION has not been set correctly."
               exit 1
             fi
-            if [ $CLOUDSMITH_SERVICE_IDENTIFIER != "circleci-orb-testing" ]
+            if [ $CLOUDSMITH_SERVICE_ACCOUNT != "circleci-orb-testing" ]
             then
-              echo "Test failed: CLOUDSMITH_SERVICE_IDENTIFIER has not been set."
+              echo "Test failed: CLOUDSMITH_SERVICE_ACCOUNT has not been set."
               exit 1
             fi
             if [ -z $CLOUDSMITH_OIDC_TOKEN ]
@@ -56,8 +56,8 @@ jobs:
     steps:
       - checkout
       - cloudsmith-circleci/set_env_vars_for_pip:
-          repository_identifier: "circleci-orb-testing"
-          service_identifier: "circleci-orb-testing"
+          repository: "circleci-orb-testing"
+          service_account: "circleci-orb-testing"
       - run:
           name: Assert environment variables have been set
           command: | 
diff --git a/README.md b/README.md
@@ -10,10 +10,9 @@ A CircleCI orb to assist with downloading from and publishing packages to Clouds
 
 The orb commands need the following parameters:
 
-* `repository_identifier` : The identity/slug of the Cloudsmith repository
+* `repository` : The identity/slug of the Cloudsmith repository
 
-
-* `service_identifier` : The identity/slug of the Cloudsmith service account to use when authenticating with OIDC
+* `service_account` : The identity/slug of the Cloudsmith service account to use when authenticating with OIDC
 
 This can be found in the [Cloudsmith UI](https://cloudsmith.io/orgs/financial-times/).
 
diff --git a/src/commands/authenticate_with_oidc.yml b/src/commands/authenticate_with_oidc.yml
@@ -2,9 +2,9 @@ description:
   Utility command to authenticate with Cloudsmith using OpenID Connect (OIDC) and if successful generate a short-lived
   OIDC token for use in subsequent requests to cloudsmith. The token is valid for up to 2 hours.
 
-  The environment variables CLOUDSMITH_SERVICE_IDENTIFIER and CLOUDSMITH_OIDC_TOKEN are set.
+  The environment variables CLOUDSMITH_SERVICE_ACCOUNT and CLOUDSMITH_OIDC_TOKEN are set.
 parameters:
-  service_identifier:
+  service_account:
     description: The identity/slug of the Cloudsmith service account to use when authenticating
     type: string
 steps:
@@ -18,7 +18,7 @@ steps:
   - run:
       name: Configure Cloudsmith service account
       command: |
-        echo "export CLOUDSMITH_SERVICE_IDENTIFIER=\"<<parameters.service_identifier>>\"" >> "$BASH_ENV"
+        echo "export CLOUDSMITH_SERVICE_ACCOUNT=\"<<parameters.service_account>>\"" >> "$BASH_ENV"
   - run:
       name: Authenticate with OIDC
       command: <<include(scripts/authenticate_with_oidc.sh)>>
diff --git a/src/commands/set_env_vars_for_pip.yml b/src/commands/set_env_vars_for_pip.yml
@@ -1,23 +1,23 @@
 description:
   Authenticates to Cloudsmith and generates a pip index url string which is assigned to the CLOUDSMITH_PIP_INDEX_URL environment variable.
 parameters:
-  repository_identifier:
+  repository:
     description: The identity/slug of the Cloudsmith repository
     type: string
-  service_identifier:
+  service_account:
     description: The identity/slug of the Cloudsmith service account to use when authenticating with OIDC
     type: string
 steps:
   - authenticate_with_oidc:
-      service_identifier: <<parameters.service_identifier>>
+      service_account: <<parameters.service_account>>
   - run:
       name: Configure Cloudsmith domains
       command: <<include(scripts/configure_cloudsmith_domains.sh)>>
   - run:
       name: Configure Cloudsmith repository
       command: |
-        echo "export CLOUDSMITH_REPOSITORY_IDENTIFIER=\"<<parameters.repository_identifier>>\"" >> $BASH_ENV
-        echo "CLOUDSMITH_REPOSITORY_IDENTIFIER=<<parameters.repository_identifier>>"
+        echo "export CLOUDSMITH_REPOSITORY=\"<<parameters.repository>>\"" >> $BASH_ENV
+        echo "CLOUDSMITH_REPOSITORY=<<parameters.repository>>"
   - run:
       name: Set environment variables for pip
       command: <<include(scripts/set_env_vars_for_pip.sh)>>
diff --git a/src/examples/configure_pip.yml b/src/examples/configure_pip.yml
@@ -11,8 +11,8 @@ usage:
       steps:
         - checkout
         - ft-cloudsmith/set_env_vars_for_pip:
-            repository_identifier: "your-repository-identifier"
-            service_identifier: "your-service-identifier"
+            repository: "your-repository-id"
+            service_account: "your-service-account-id"
         - run: python -m pip config set global.index-url "$CLOUDSMITH_PIP_INDEX_URL"
         - run: python -m pip install -r requirements.txt
   workflows:
diff --git a/src/examples/pip_install_package.yml b/src/examples/pip_install_package.yml
@@ -11,8 +11,8 @@ usage:
       steps:
         - checkout
         - ft-cloudsmith/set_env_vars_for_pip:
-            repository_identifier: "your-repository-identifier"
-            service_identifier: "your-service-identifier"
+            repository: "your-repository-id"
+            service_account: "your-service-account-id"
         - run: python -m pip install your-package==0.0.0 --index-url "$CLOUDSMITH_PIP_INDEX_URL"
   workflows:
     main:
diff --git a/src/examples/pip_install_requirements.yml b/src/examples/pip_install_requirements.yml
@@ -11,8 +11,8 @@ usage:
       steps:
         - checkout
         - ft-cloudsmith/set_env_vars_for_pip:
-            repository_identifier: "your-repository-identifier"
-            service_identifier: "your-service-identifier"
+            repository: "your-repository-id"
+            service_account: "your-service-account-id"
         - run: python -m pip install -r requirements.txt --index-url "$CLOUDSMITH_PIP_INDEX_URL"
   workflows:
     main:
diff --git a/src/scripts/authenticate_with_oidc.sh b/src/scripts/authenticate_with_oidc.sh
@@ -11,16 +11,16 @@ then
   exit 1
 fi
 
-if [ -z "$CLOUDSMITH_SERVICE_IDENTIFIER" ]
+if [ -z "$CLOUDSMITH_SERVICE_ACCOUNT" ]
 then
-  echo "Unable to generate OIDC token. Environment variable CLOUDSMITH_SERVICE_IDENTIFIER is not set."
+  echo "Unable to generate OIDC token. Environment variable CLOUDSMITH_SERVICE_ACCOUNT is not set."
   exit 1
 fi
 
-echo "Generating Cloudsmith OIDC token for service account: $CLOUDSMITH_ORGANISATION/$CLOUDSMITH_SERVICE_IDENTIFIER"
+echo "Generating Cloudsmith OIDC token for service account: $CLOUDSMITH_ORGANISATION/$CLOUDSMITH_SERVICE_ACCOUNT"
 
 RESPONSE=$(curl -X POST -H "Content-Type: application/json" \
-            -d "{\"oidc_token\":\"$CIRCLE_OIDC_TOKEN_V2\", \"service_slug\":\"$CLOUDSMITH_SERVICE_IDENTIFIER\"}" \
+            -d "{\"oidc_token\":\"$CIRCLE_OIDC_TOKEN_V2\", \"service_slug\":\"$CLOUDSMITH_SERVICE_ACCOUNT\"}" \
             --silent --show-error "https://api.cloudsmith.io/openid/$CLOUDSMITH_ORGANISATION/")
 
 CLOUDSMITH_OIDC_TOKEN=$(echo "$RESPONSE" | grep -o '"token": "[^"]*' | grep -o '[^"]*$')
@@ -39,6 +39,6 @@ else
 
   echo "The following environment variables have been exported. The OIDC token has been masked below."
   echo ""
-  echo "CLOUDSMITH_SERVICE_IDENTIFIER=$CLOUDSMITH_SERVICE_IDENTIFIER"
+  echo "CLOUDSMITH_SERVICE_ACCOUNT=$CLOUDSMITH_SERVICE_ACCOUNT"
   echo "CLOUDSMITH_OIDC_TOKEN=********"
 fi
diff --git a/src/scripts/set_env_vars_for_pip.sh b/src/scripts/set_env_vars_for_pip.sh
@@ -5,15 +5,15 @@
 
 set +e
 
-if [ -z "$CLOUDSMITH_SERVICE_IDENTIFIER" ] || [ -z "$CLOUDSMITH_OIDC_TOKEN" ]
+if [ -z "$CLOUDSMITH_SERVICE_ACCOUNT" ] || [ -z "$CLOUDSMITH_OIDC_TOKEN" ]
 then
   echo "Unable to find an OIDC token to use. Please ensure the authenticate_with_oidc command has been run before this command."
   exit 1
 fi
 
-if [ -z "$CLOUDSMITH_REPOSITORY_IDENTIFIER" ]
+if [ -z "$CLOUDSMITH_REPOSITORY" ]
 then
-  echo "Unable to set environment variables for pip. Env var CLOUDSMITH_REPOSITORY_IDENTIFIER is not defined."
+  echo "Unable to set environment variables for pip. Env var CLOUDSMITH_REPOSITORY is not defined."
   exit 1
 fi
 
@@ -24,10 +24,10 @@ then
 fi
 
 
-CLOUDSMITH_PIP_INDEX_URL="https://$CLOUDSMITH_SERVICE_IDENTIFIER:$CLOUDSMITH_OIDC_TOKEN@$CLOUDSMITH_DOWNLOADS_DOMAIN/basic/$CLOUDSMITH_REPOSITORY_IDENTIFIER/python/simple/"
+CLOUDSMITH_PIP_INDEX_URL="https://$CLOUDSMITH_SERVICE_ACCOUNT:$CLOUDSMITH_OIDC_TOKEN@$CLOUDSMITH_DOWNLOADS_DOMAIN/basic/$CLOUDSMITH_REPOSITORY/python/simple/"
 
 echo "export CLOUDSMITH_PIP_INDEX_URL=\"$CLOUDSMITH_PIP_INDEX_URL\"" >> "$BASH_ENV"
 
 echo "The following environment variables have been exported. Note, the OIDC token has been masked below."
 echo ""
-echo "CLOUDSMITH_PIP_INDEX_URL=https://$CLOUDSMITH_SERVICE_IDENTIFIER:********@$CLOUDSMITH_DOWNLOADS_DOMAIN/basic/$CLOUDSMITH_REPOSITORY_IDENTIFIER/python/simple/"
+echo "CLOUDSMITH_PIP_INDEX_URL=https://$CLOUDSMITH_SERVICE_ACCOUNT:********@$CLOUDSMITH_DOWNLOADS_DOMAIN/basic/$CLOUDSMITH_REPOSITORY/python/simple/"
