Set profile as an optional parameter in the cli (#59)

* fix: allow profile to be empty to use env * Add the parameter split * fix linting * debug: add -x to alpine executor * debug: add -x to alpine executor * Fix: update aws-cli version * Fix: apply same change to copy * Add test with arguments * Fix: names and dependencies on tests * Fix: names and dependencies on tests
CircleCI-Public · Oct 15, 2024 · 7c18f79 · 7c18f79
1 parent d199b2e
commit 7c18f79
Show file tree

Hide file tree

Showing 10 changed files with 28 additions and 16 deletions.
diff --git a/.circleci/test-deploy.yml b/.circleci/test-deploy.yml
@@ -1,7 +1,7 @@
 version: 2.1
 orbs:
-  orb-tools: circleci/orb-tools@12.0
-  aws-cli: circleci/aws-cli@4.0
+  orb-tools: circleci/orb-tools@12.1.1
+  aws-cli: circleci/aws-cli@5.1.1
   aws-s3: {}
 filters: &filters
   tags:
@@ -13,6 +13,7 @@ release-filters: &release-filters
     only: /^v[0-9]+\.[0-9]+\.[0-9]+$/
 executors:
   alpine:
+    shell: sh -eox pipefail
     docker:
       - image: alpine:latest
   docker-base:
@@ -50,6 +51,7 @@ workflows:
           context: [CPE-OIDC]
           filters: *filters
           matrix:
+            alias: integration-test
             parameters:
               executor: ["alpine", "docker-base"]
       - aws-s3/sync:
@@ -63,7 +65,12 @@ workflows:
           from: "$HOME/bucket"
           to: "s3://orb-testing-1/s3-orb"
           profile_name: "OIDC-User"
+          arguments: 
           context: [CPE-OIDC]
+          matrix:
+            alias: sync
+            parameters:
+              arguments: ["'--exclude *.hmtl' '--cache-control public,max-age=31536000,immutable'", ""] 
           filters: *filters
       - aws-s3/copy:
           pre-steps:
@@ -79,14 +86,14 @@ workflows:
           context: [CPE-OIDC]
           filters: *filters
           requires:
-            - aws-s3/sync
+            - sync
       - orb-tools/pack:
           filters: *release-filters
       - orb-tools/publish:
           orb_name: circleci/aws-s3
           vcs_type: << pipeline.project.type >>
           pub_type: production
           enable_pr_comment: true
-          requires: [orb-tools/pack, integration-test-alpine, integration-test-docker-base, aws-s3/copy, aws-s3/sync]
+          requires: [orb-tools/pack, integration-test, aws-s3/copy, sync]
           context: orb-publisher
           filters: *release-filters
diff --git a/src/commands/copy.yml b/src/commands/copy.yml
@@ -14,7 +14,7 @@ parameters:
   profile_name:
     description: AWS profile name to be configured.
     type: string
-    default: "default"
+    default: ""
   role_arn:
     description: |
       The Amazon Resource Name (ARN) of the role that the caller is assuming.

diff --git a/src/commands/sync.yml b/src/commands/sync.yml
@@ -18,7 +18,7 @@ parameters:
   profile_name:
     description: AWS profile name to be configured.
     type: string
-    default: "default"
+    default: ""
   when:
     description: |
       Add the when attribute to a job step to override its default behavior

diff --git a/src/examples/authentication_with_jobs.yml b/src/examples/authentication_with_jobs.yml
@@ -7,7 +7,7 @@ usage:
   orbs:
     aws-s3: circleci/[email protected]
     # Importing aws-cli orb is required
-    aws-cli: circleci/aws-cli@4.0
+    aws-cli: circleci/aws-cli@5.1.1
   workflows:
     s3-example:
       jobs:

diff --git a/src/examples/override_credentials.yml b/src/examples/override_credentials.yml
@@ -5,7 +5,7 @@ usage:
   orbs:
     aws-s3: circleci/[email protected]
     # Importing aws-cli orb is required
-    aws-cli: circleci/aws-cli@4.0
+    aws-cli: circleci/aws-cli@5.1.1
   jobs:
     build:
       docker:

diff --git a/src/examples/sync_and_copy_with_oidc.yml b/src/examples/sync_and_copy_with_oidc.yml
@@ -9,7 +9,7 @@ usage:
   orbs:
     aws-s3: circleci/[email protected]
     # Importing aws-cli orb is required
-    aws-cli: circleci/aws-cli@4.0
+    aws-cli: circleci/aws-cli@5.1.1
   jobs:
     sync_and_copy:
       docker:

diff --git a/src/jobs/copy.yml b/src/jobs/copy.yml
@@ -14,7 +14,7 @@ parameters:
   profile_name:
     description: AWS profile name to be configured.
     type: string
-    default: "default"
+    default: ""
   auth:
     description: |
       The authentication method used to access your AWS account. Import the aws-cli orb in your config and

diff --git a/src/jobs/sync.yml b/src/jobs/sync.yml
@@ -14,7 +14,7 @@ parameters:
   profile_name:
     description: AWS profile name to be configured.
     type: string
-    default: "default"
+    default: ""
   auth:
     description: |
       The authentication method used to access your AWS account. Import the aws-cli orb in your config and

diff --git a/src/scripts/copy.sh b/src/scripts/copy.sh
@@ -8,10 +8,12 @@ if [ -n "${ORB_STR_ARGUMENTS}" ]; then
     IFS=' '
     set --
     for arg in $(echo "${ORB_STR_ARGUMENTS}" | sed 's/,[ ]*/,/g'); do
-    set -- "$@" "$arg"
+        set -- "$@" "$arg"
     done
 fi
-
+if [ -n "${ORB_STR_PROFILE_NAME}" ]; then
+    set -- "$@" --profile "${ORB_STR_PROFILE_NAME}"
+fi
 set -x
-aws s3 cp "${ORB_EVAL_FROM}" "${ORB_EVAL_TO}" --profile "${ORB_STR_PROFILE_NAME}" "$@"
+aws s3 cp "${ORB_EVAL_FROM}" "${ORB_EVAL_TO}" "$@"
 set +x
diff --git a/src/scripts/sync.sh b/src/scripts/sync.sh
@@ -9,9 +9,12 @@ if [ -n "${ORB_STR_ARGUMENTS}" ]; then
     IFS=' '
     set --
     for arg in $(echo "${ORB_STR_ARGUMENTS}" | sed 's/,[ ]*/,/g'); do
-    set -- "$@" "$arg"
+        set -- "$@" "$arg"
     done
 fi
+if [ -n "${ORB_STR_PROFILE_NAME}" ]; then
+    set -- "$@" --profile "${ORB_STR_PROFILE_NAME}"
+fi
 set -x
-aws s3 sync "${ORB_EVAL_FROM}" "${ORB_EVAL_TO}" --profile "${ORB_STR_PROFILE_NAME}" "$@"
+aws s3 sync "${ORB_EVAL_FROM}" "${ORB_EVAL_TO}" "$@"
 set +x