Update environment variable name behavior to allow for blank aliases

README.md

@@ -1,69 +1,93 @@
 # Use AWS Secrets Manager secrets in GitHub jobs
-​
+
 To use a secret in a GitHub job, you can use a GitHub action to retrieve secrets from AWS Secrets Manager and add them as masked [Environment variables](https://docs.github.com/en/actions/learn-github-actions/environment-variables) in your GitHub workflow. For more information about GitHub Actions, see [Understanding GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) in the *GitHub Docs*.
-​
 
 When you add a secret to your GitHub environment, it is available to all other steps in your GitHub job. Follow the guidance in [Security hardening for GitHub Actions](https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions) to help prevent secrets in your environment from being misused.
-​
-
-Environment variables have stricter naming requirements than secrets, so this action transforms secret names to meet those requirements. For example, the action transforms lowercase letters to uppercase letters. Because of the transformed names, two environment variables might end up with the same name. For example, a secret named "MySecret" and a secret named "mysecret" would both become environment variables named "MYSECRET". In this case, the action will fail, because environment variable names must be unique. Instead, you must specify the name you want to use for the environment variable.
-​
 
 You can set the entire string in the secret value as the environment variable value, or if the string is JSON, you can parse the JSON to set individual environment variables for each JSON key-value pair. If the secret value is a binary, the action converts it to a string.
-​
 
 To view the environment variables created from your secrets, turn on debug logging. For more information, see [Enabling debug logging](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging) in the *GitHub Docs*.
-​
-​
+
+To use the environment variables created from your secrets, see [Environment variables](https://docs.github.com/en/actions/learn-github-actions/environment-variables) in the *GitHub Docs*.
+
 ### Prerequisites
-​
+
 To use this action, you first need to configure AWS credentials and set the AWS Region in your GitHub environment by using the `configure-aws-credentials` step. Follow the instructions in [Configure AWS Credentials Action For GitHub Actions](https://github.com/aws-actions/configure-aws-credentials) to **Assume role directly using GitHub OIDC provider**. This allows you to use short-lived credentials and avoid storing additional access keys outside of Secrets Manager.
-​
+
 The IAM role the action assumes must have the following permissions:
-+ `GetSecretValue` on the secrets you want to retrieve
-+ `ListSecrets` on all secrets
-+ (Optional) `Decrypt` on the KMS key if the secrets are encrypted with a customer managed key.
-​
-For more information, see [Authentication and access control for AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html).
-​
++ `GetSecretValue` on the secrets you want to retrieve.
++ `ListSecrets` on all secrets.
++ \(Optional\) `Decrypt` on the KMS key if the secrets are encrypted with a customer managed key.
+
+For more information, see [Authentication and access control for AWS Secrets Manager](auth-and-access.md).
+
 ### Usage
-​
+
 To use the action, add a step to your workflow that uses the following syntax.
-​
+
 ```
 - name: Step name
   uses: aws-actions/aws-secretsmanager-get-secrets@v1
   with:
     secret-ids: |
       secretId1
-      ENV_VAR, secretId2
+      ENV_VAR_NAME, secretId2
     parse-json-secrets: (Optional) true|false
 ```
+Parameters
 
-### Parameters
-- `secret-ids`: Secret ARNS, names, and name prefixes. 
+- `secret-ids` Secret ARNS, names, and name prefixes. 
 
-By default, the step creates each environment variable name from the secret name, transformed to include only uppercase letters, numbers, and underscores, and so that it doesn't begin with a number. 
+By default, the step creates each environment variable name from the secret name, transformed to include only uppercase letters, numbers, and underscores, and so that it doesn't begin with a number.   
 
-To set the environment variable name, enter it before the secret ID, followed by a comma. For example `ENV_VAR_1, secretId` creates an environment variable named **ENV_VAR_1** from the secret `secretId`. 
+To set the environment variable name, enter it before the secret ID, followed by a comma. For example `ENV_VAR_1, secretId` creates an environment variable named **ENV\_VAR\_1** from the secret `secretId`. 
 
-The environment variable name can consist of uppercase letters, numbers, and underscores.  
+The environment variable name can consist of uppercase letters, numbers, and underscores. 
 
 To use a prefix, enter at least three characters followed by an asterisk. For example `dev*` matches all secrets with a name beginning in **dev**. The maximum number of matching secrets that can be retrieved is 100. If you set the variable name, and the prefix matches multiple secrets, then the action fails.
-​
+
 - `parse-json-secrets`
 
 (Optional - default false) By default, the action sets the environment variable value to the entire JSON string in the secret value. 
 
 Set `parse-json-secrets` to `true` to create environment variables for each key/value pair in the JSON.
 
 Note that if the JSON uses case-sensitive keys such as "name" and "Name", the action will have duplicate name conflicts. In this case, set `parse-json-secrets` to `false` and parse the JSON secret value separately. 
-​
+
+### Environment variable naming
+
+The environment variables created by the action are named the same as the secrets they come from. Environment variables have stricter naming requirements than secrets, so the action transforms secret names to meet those requirements. For example, the action transforms lowercase letters to uppercase letters. If you parse the JSON of the secret, then the environment variable name includes both the secret name and the JSON key name, for example `MYSECRET_KEYNAME`.
+
+If two environment variables would end up with the same name, the action fails. In this case, you must specify the names you want to use for the environment variables as *aliases*.
+
+Examples of when the names might conflict:
++ A secret named "MySecret" and a secret named "mysecret" would both become environment variables named "MYSECRET".
++ A secret named "Secret_keyname" and a JSON-parsed secret named "Secret" with a key named "keyname" would both become environment variables named "SECRET_KEYNAME".
+
+You can set the environment variable name by specifying an *alias*, as shown in the following example which creates a variable named `ENV_VAR_NAME`.
+
+```
+secret-ids: |
+  ENV_VAR_NAME, secretId2
+```
+
+**Blank aliases**
++ If you set `parse-json-secrets: true` and enter a blank alias, followed by a comma and then the secret ID, the action names the environment variable the same as the parsed JSON keys. The variable names do not include the secret name. 
+
+  If the secret doesn't contain valid JSON, then the action creates one environment variable and names it the same as the secret name.
++ If you set `parse-json-secrets: false` and enter a blank alias, followed by a comma and the secret ID, the action names the environment variables as if you did not specify an alias.
+
+The following example shows a blank alias.
+
+```
+,secret2
+```
+
 ### Examples
-​
-**Example 1: Get secrets by name and by ARN**  
+
+**Example 1 Get secrets by name and by ARN**  
 The following example creates environment variables for secrets identified by name and by ARN.  
-​
+
 ```
 - name: Get secrets by name and by ARN
   uses: aws-actions/aws-secretsmanager-get-secrets@v1
@@ -75,51 +99,52 @@ The following example creates environment variables for secrets identified by na
       /prod/example/secret
       SECRET_ALIAS_1,test/secret
       SECRET_ALIAS_2,arn:aws:secretsmanager:us-east-2:123456789012:secret:test2-a1b2c3
+      ,secret2
 ```
-
-
 Environment variables created:  
-​
+
 ```
 EXAMPLESECRETNAME: secretValue1
 TEST1: secretValue2
 _0_TEST_SECRET: secretValue3
 _PROD_EXAMPLE_SECRET: secretValue4
 SECRET_ALIAS_1: secretValue5
 SECRET_ALIAS_2: secretValue6
+SECRET2: secretValue7
 ```
-​
-**Example 2: Get all secrets that begin with a prefix**  
+
+**Example 2 Get all secrets that begin with a prefix**  
 The following example creates environment variables for all secrets with names that begin with *beta*.  
-​
+
 ```
 - name: Get Secret Names by Prefix
   uses: aws-actions/aws-secretsmanager-get-secrets@v1
   with:
     secret-ids: |
       beta*    # Retrieves all secrets that start with 'beta'
 ```
-Assuming the search for `beta` produces 3 results (`betaSecretName`, `betaTest` and `beta/NewSecret`, environment variables created:  
-​
+Environment variables created:  
+
 ```
 BETASECRETNAME: secretValue1
 BETATEST: secretValue2
 BETA_NEWSECRET: secretValue3
 ```
-​
-**Example 3: Parse JSON in secret**  
+
+**Example 3 Parse JSON in secret**  
 The following example creates environment variables by parsing the JSON in the secret.  
-​
+
 ```
 - name: Get Secrets by Name and by ARN
   uses: aws-actions/aws-secretsmanager-get-secrets@v1
   with:
     secret-ids: |
       test/secret
-    parse-json-secrets: true
+      ,secret2
+      parse-json-secrets: true
 ```
 The secret `test/secret` has the following secret value.  
-​
+
 ```
 {
   "api_user": "user",
@@ -129,12 +154,22 @@ The secret `test/secret` has the following secret value.
   }
 }
 ```
+The secret `secret2` has the following secret value.  
+
+```
+{
+  "myusername": "alejandro_rosalez",
+  "mypassword": "EXAMPLE_PASSWORD"
+}
+```
 Environment variables created:  
-​
+
 ```
 TEST_SECRET_API_USER: "user"
 TEST_SECRET_API_KEY: "key"
 TEST_SECRET_CONFIG_ACTIVE: "true"
+MYUSERNAME: "alejandro_rosalez"
+MYPASSWORD: "EXAMPLE_PASSWORD"
 ```
 
 ## Security
@@ -143,5 +178,4 @@ See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more inform
 
 ## License
 
-This library is licensed under the MIT-0 License. See the LICENSE file.
-
+This library is licensed under the MIT-0 License. See the LICENSE file.

__tests__/index.test.ts

@@ -32,11 +32,23 @@ const ENV_NAME_4 = 'ARN_ALIAS';
 const SECRET_4 = "secretString2";
 const TEST_ARN_INPUT = ENV_NAME_4 + "," + TEST_ARN_1;
 
+const BLANK_NAME = "test/blank";
+const SECRET_FOR_BLANK = '{"username": "integ", "password": "integpw", "config": {"id1": "example1"}}';
+const BLANK_ALIAS_INPUT = "," + BLANK_NAME;
+
+const BLANK_NAME_2 = "test/blank2";
+const SECRET_FOR_BLANK_2 = "blankNameSecretString";
+const BLANK_ALIAS_INPUT_2 = "," + BLANK_NAME_2;
+
+const BLANK_NAME_3 = "test/blank3";
+const SECRET_FOR_BLANK_3 = '{"username": "integ", "password": "integpw", "config": {"id2": "example2"}}';
+const BLANK_ALIAS_INPUT_3 = "," + BLANK_NAME_3;
+
 // Mock the inputs for Github action
 jest.mock('@actions/core', () => {
     return {
-        getMultilineInput: jest.fn((name: string, options?: core.InputOptions) =>  [TEST_NAME, TEST_INPUT_3, TEST_ARN_INPUT] ),
-        getBooleanInput: jest.fn((name: string, options?: core.InputOptions) => true),
+        getMultilineInput: jest.fn(),
+        getBooleanInput: jest.fn(),
         setFailed: jest.fn(),
         info: jest.fn(),
         debug: jest.fn(),
@@ -59,6 +71,11 @@ describe('Test main action', () => {
     });
 
     test('Retrieves and sets the requested secrets as environment variables, parsing JSON', async () => {
+        const booleanSpy = jest.spyOn(core, "getBooleanInput").mockReturnValue(true);
+        const multilineInputSpy = jest.spyOn(core, "getMultilineInput").mockReturnValue(
+            [TEST_NAME, TEST_INPUT_3, TEST_ARN_INPUT, BLANK_ALIAS_INPUT]
+        );
+
         // Mock all Secrets Manager calls
         smMockClient
             .on(GetSecretValueCommand, { SecretId: TEST_NAME_1})
@@ -84,10 +101,12 @@ describe('Test main action', () => {
                         Name: TEST_NAME_2
                     }
                 ]
-            });
+            })
+            .on(GetSecretValueCommand, { SecretId: BLANK_NAME })
+            .resolves({ Name: BLANK_NAME, SecretString: SECRET_FOR_BLANK });
 
         await run();
-        expect(core.exportVariable).toHaveBeenCalledTimes(7);
+        expect(core.exportVariable).toHaveBeenCalledTimes(10);
         expect(core.setFailed).not.toHaveBeenCalled();
 
         // JSON secrets should be parsed
@@ -99,17 +118,81 @@ describe('Test main action', () => {
         expect(core.exportVariable).toHaveBeenCalledWith(ENV_NAME_3, SECRET_3);
         expect(core.exportVariable).toHaveBeenCalledWith(ENV_NAME_4, SECRET_4);
 
-        expect(core.exportVariable).toHaveBeenCalledWith(CLEANUP_NAME, JSON.stringify(['TEST_ONE_USER', 'TEST_ONE_PASSWORD', 'TEST_TWO_USER', 'TEST_TWO_PASSWORD', ENV_NAME_3, ENV_NAME_4]));
+        // Case when alias is blank, but still comma delimited in workflow and json is parsed
+        // ex: ,test5/secret
+        expect(core.exportVariable).toHaveBeenCalledWith("USERNAME", "integ");
+        expect(core.exportVariable).toHaveBeenCalledWith("PASSWORD", "integpw");
+        expect(core.exportVariable).toHaveBeenCalledWith("CONFIG_ID1", "example1");
+
+        expect(core.exportVariable).toHaveBeenCalledWith(
+            CLEANUP_NAME,
+            JSON.stringify([
+                'TEST_ONE_USER', 'TEST_ONE_PASSWORD',
+                'TEST_TWO_USER', 'TEST_TWO_PASSWORD',
+                ENV_NAME_3,
+                ENV_NAME_4,
+                "USERNAME", "PASSWORD", "CONFIG_ID1"
+            ])
+        );
+
+        booleanSpy.mockClear();
+        multilineInputSpy.mockClear();
+    });
+
+    test('Defaults to correct behavior with empty string alias', async () => {
+        const booleanSpy = jest.spyOn(core, "getBooleanInput").mockReturnValue(false);
+        const multilineInputSpy = jest.spyOn(core, "getMultilineInput").mockReturnValue(
+            [BLANK_ALIAS_INPUT_2, BLANK_ALIAS_INPUT_3]
+        );
+
+        smMockClient
+            .on(GetSecretValueCommand, { SecretId: BLANK_NAME_2 })
+            .resolves({ Name: BLANK_NAME_2, SecretString: SECRET_FOR_BLANK_2 })
+            .on(GetSecretValueCommand, { SecretId: BLANK_NAME_3 })
+            .resolves({ Name: BLANK_NAME_3, SecretString: SECRET_FOR_BLANK_3 });
+
+        await run();
+        expect(core.exportVariable).toHaveBeenCalledTimes(3);
+        expect(core.setFailed).not.toHaveBeenCalled();
+
+        // Case when alias is blank, but still comma delimited in workflow and no json is parsed
+        // ex: ,test/blank2
+        expect(core.exportVariable).toHaveBeenCalledWith("TEST_BLANK2", "blankNameSecretString");
+        expect(core.exportVariable).toHaveBeenCalledWith("TEST_BLANK3", '{"username": "integ", "password": "integpw", "config": {"id2": "example2"}}');
+
+        expect(core.exportVariable).toHaveBeenCalledWith(
+            CLEANUP_NAME,
+            JSON.stringify([
+                "TEST_BLANK2",
+                "TEST_BLANK3"
+            ])
+        );
+
+        booleanSpy.mockClear();
+        multilineInputSpy.mockClear();
     });
 
     test('Fails the action when an error occurs in Secrets Manager', async () => {
+        const booleanSpy = jest.spyOn(core, "getBooleanInput").mockReturnValue(true);
+        const multilineInputSpy = jest.spyOn(core, "getMultilineInput").mockReturnValue(
+            [TEST_NAME, TEST_INPUT_3, TEST_ARN_INPUT]
+        );
+
         smMockClient.onAnyCommand().resolves({});
 
         await run();
         expect(core.setFailed).toHaveBeenCalledTimes(1);
+
+        booleanSpy.mockClear();
+        multilineInputSpy.mockClear();
     });
 
     test('Fails the action when multiple secrets exported the same variable name', async () => {
+        const booleanSpy = jest.spyOn(core, "getBooleanInput").mockReturnValue(true);
+        const multilineInputSpy = jest.spyOn(core, "getMultilineInput").mockReturnValue(
+            [TEST_NAME, TEST_INPUT_3, TEST_ARN_INPUT]
+        );
+
         smMockClient
             .on(GetSecretValueCommand, { SecretId: TEST_NAME_1})
             .resolves({ Name: TEST_NAME_1, SecretString: SECRET_1 })
@@ -140,5 +223,8 @@ describe('Test main action', () => {
 
         await run();
         expect(core.setFailed).toHaveBeenCalledTimes(1);
+
+        booleanSpy.mockClear();
+        multilineInputSpy.mockClear();
     });
 });

__tests__/utils.test.ts

@@ -31,6 +31,8 @@ const TEST_NAME_1 = 'test/secret1';
 const VALID_ARN_2 = 'arn:aws:secretsmanager:ap-south-1:123456789000:secret:test2-aBcdef';
 const TEST_NAME_2 = 'test/secret2';
 
+const VALID_ARN_3 = 'arn:aws:secretsmanager:ap-south-1:123456789000:secret:test3-aBcdef';
+
 const INVALID_ARN = 'aws:secretsmanager:us-east-1:123456789000:secret:test3-aBcdef';
 
 jest.mock('@actions/core');
@@ -330,9 +332,14 @@ describe('Test secret parsing and handling', () => {
         expect(extractAliasAndSecretIdFromInput(`ARN_ALIAS,${VALID_ARN_1}`)).toEqual(['ARN_ALIAS', VALID_ARN_1]);
     });
 
-    test('Returns blank for alias if none is provided', () => {
-        expect(extractAliasAndSecretIdFromInput("test/secret")).toEqual(['', 'test/secret']);
-        expect(extractAliasAndSecretIdFromInput(VALID_ARN_1)).toEqual(['', VALID_ARN_1]);
+    test('Returns undefined for alias if none is provided', () => {
+        expect(extractAliasAndSecretIdFromInput("test/secret")).toEqual([undefined, 'test/secret']);
+        expect(extractAliasAndSecretIdFromInput(VALID_ARN_1)).toEqual([undefined, VALID_ARN_1]);
+    });
+
+    test('Returns empty string for alias if none is provided, but comma delimited', () => {
+        expect(extractAliasAndSecretIdFromInput(" , test/secret")).toEqual(['', 'test/secret']);
+        expect(extractAliasAndSecretIdFromInput(" , "+VALID_ARN_3)).toEqual(['', VALID_ARN_3]);
     });
 
     test('Throws an error if the provided alias cannot be used as the environment name', () => {