Calls to sam deploy and package no longer use the --profile command line argument. Environment Variables are used for the child process instead. (#879)

awschristou · web-flow · commit fd136c6afc91 · 2020-01-03T11:46:15.000-08:00
diff --git a/package.nls.json b/package.nls.json
@@ -162,10 +162,10 @@
     "AWS.samcli.detect.settings.not.updated": "No settings changes necessary.",
     "AWS.samcli.deploy.general.error": "An error occurred while deploying a SAM Application. {0}",
     "AWS.samcli.deploy.workflow.init": "Building SAM Application...",
-    "AWS.samcli.deploy.workflow.packaging": "Packaging SAM Application to S3 Bucket: {0} with profile: {1}",
-    "AWS.samcli.deploy.workflow.stackName.initiated": "Deploying SAM Application to CloudFormation Stack: {0} with profile: {1}",
+    "AWS.samcli.deploy.workflow.packaging": "Packaging SAM Application to S3 Bucket: {0}",
+    "AWS.samcli.deploy.workflow.stackName.initiated": "Deploying SAM Application to CloudFormation Stack: {0}",
     "AWS.samcli.deploy.workflow.start": "Starting SAM Application deployment...",
-    "AWS.samcli.deploy.workflow.success": "Successfully deployed SAM Application to CloudFormation Stack: {0} with profile: {1}",
+    "AWS.samcli.deploy.workflow.success": "Successfully deployed SAM Application to CloudFormation Stack: {0}",
     "AWS.samcli.deploy.workflow.success.general": "SAM Application deployment succeeded.",
     "AWS.samcli.deploy.workflow.error": "Failed to deploy SAM application.",
     "AWS.samcli.deploy.parameters.mandatoryPrompt.message": "The template {0} contains parameters without default values. In order to deploy, you must provide values for these parameters. Configure them now?",
diff --git a/src/credentials/credentialsUtilities.ts b/src/credentials/credentialsUtilities.ts
@@ -0,0 +1,19 @@
+/*!
+ * Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { Credentials } from 'aws-sdk'
+
+export function asEnvironmentVariables(credentials: Credentials): NodeJS.ProcessEnv {
+    const environmentVariables: NodeJS.ProcessEnv = {}
+
+    environmentVariables.AWS_ACCESS_KEY = credentials.accessKeyId
+    environmentVariables.AWS_ACCESS_KEY_ID = credentials.accessKeyId
+    environmentVariables.AWS_SECRET_KEY = credentials.secretAccessKey
+    environmentVariables.AWS_SECRET_ACCESS_KEY = credentials.secretAccessKey
+    environmentVariables.AWS_SESSION_TOKEN = credentials.sessionToken
+    environmentVariables.AWS_SECURITY_TOKEN = credentials.sessionToken
+
+    return environmentVariables
+}
diff --git a/src/lambda/commands/deploySamApplication.ts b/src/lambda/commands/deploySamApplication.ts
@@ -8,6 +8,7 @@ import * as path from 'path'
 import * as vscode from 'vscode'
 import * as nls from 'vscode-nls'
 
+import { asEnvironmentVariables } from '../../credentials/credentialsUtilities'
 import { AwsContext, NoActiveCredentialError } from '../../shared/awsContext'
 import { makeTemporaryToolkitFolder } from '../../shared/filesystemUtilities'
 import { RegionProvider } from '../../shared/regions/regionProvider'
@@ -26,7 +27,7 @@ const localize = nls.loadMessageBundle()
 interface DeploySamApplicationParameters {
     sourceTemplatePath: string
     deployRootFolder: string
-    profile: string
+    environmentVariables: NodeJS.ProcessEnv
     region: string
     packageBucketName: string
     destinationStackName: string
@@ -61,13 +62,13 @@ export async function deploySamApplication(
         awsContext,
         window = getDefaultWindowFunctions()
     }: {
-        awsContext: Pick<AwsContext, 'getCredentialProfileName'>
+        awsContext: Pick<AwsContext, 'getCredentials'>
         window?: WindowFunctions
     }
 ): Promise<void> {
     try {
-        const profile: string | undefined = awsContext.getCredentialProfileName()
-        if (!profile) {
+        const credentials = await awsContext.getCredentials()
+        if (!credentials) {
             throw new NoActiveCredentialError()
         }
 
@@ -84,7 +85,7 @@ export async function deploySamApplication(
             destinationStackName: deployWizardResponse.stackName,
             packageBucketName: deployWizardResponse.s3Bucket,
             parameterOverrides: deployWizardResponse.parameterOverrides,
-            profile,
+            environmentVariables: asEnvironmentVariables(credentials),
             region: deployWizardResponse.region,
             sourceTemplatePath: deployWizardResponse.template.fsPath
         }
@@ -156,9 +157,8 @@ async function packageOperation(params: {
 }): Promise<void> {
     params.channelLogger.info(
         'AWS.samcli.deploy.workflow.packaging',
-        'Packaging SAM Application to S3 Bucket: {0} with profile: {1}',
-        params.deployParameters.packageBucketName,
-        params.deployParameters.profile
+        'Packaging SAM Application to S3 Bucket: {0}',
+        params.deployParameters.packageBucketName
     )
 
     const buildTemplatePath = getBuildTemplatePath(params.deployParameters.deployRootFolder)
@@ -168,7 +168,7 @@ async function packageOperation(params: {
         {
             sourceTemplateFile: buildTemplatePath,
             destinationTemplateFile: packageTemplatePath,
-            profile: params.deployParameters.profile,
+            environmentVariables: params.deployParameters.environmentVariables,
             region: params.deployParameters.region,
             s3Bucket: params.deployParameters.packageBucketName
         },
@@ -185,17 +185,16 @@ async function deployOperation(params: {
     try {
         params.channelLogger.info(
             'AWS.samcli.deploy.workflow.stackName.initiated',
-            'Deploying SAM Application to CloudFormation Stack: {0} with profile: {1}',
-            params.deployParameters.destinationStackName,
-            params.deployParameters.profile
+            'Deploying SAM Application to CloudFormation Stack: {0}',
+            params.deployParameters.destinationStackName
         )
 
         const packageTemplatePath = getPackageTemplatePath(params.deployParameters.deployRootFolder)
 
         await runSamCliDeploy(
             {
                 parameterOverrides: params.deployParameters.parameterOverrides,
-                profile: params.deployParameters.profile,
+                environmentVariables: params.deployParameters.environmentVariables,
                 templateFile: packageTemplatePath,
                 region: params.deployParameters.region,
                 stackName: params.deployParameters.destinationStackName
@@ -232,9 +231,8 @@ async function deploy(params: {
 
         params.channelLogger.info(
             'AWS.samcli.deploy.workflow.success',
-            'Successfully deployed SAM Application to CloudFormation Stack: {0} with profile: {1}',
-            params.deployParameters.destinationStackName,
-            params.deployParameters.profile
+            'Successfully deployed SAM Application to CloudFormation Stack: {0}',
+            params.deployParameters.destinationStackName
         )
 
         params.window.showInformationMessage(
@@ -264,9 +262,6 @@ function enhanceAwsCloudFormationInstructions(
         )
     ) {
         message += ` --region ${deployParameters.region}`
-        if (deployParameters.profile) {
-            message += ` --profile ${deployParameters.profile}`
-        }
     }
 
     return message
diff --git a/src/shared/sam/cli/samCliDeploy.ts b/src/shared/sam/cli/samCliDeploy.ts
@@ -10,7 +10,7 @@ import { logAndThrowIfUnexpectedExitCode, SamCliProcessInvoker } from './samCliI
 export interface SamCliDeployParameters {
     templateFile: string
     parameterOverrides: Map<string, string>
-    profile: string
+    environmentVariables: NodeJS.ProcessEnv
     region: string
     stackName: string
 }
@@ -29,16 +29,17 @@ export async function runSamCliDeploy(
         '--capabilities',
         'CAPABILITY_IAM',
         '--region',
-        deployArguments.region,
-        '--profile',
-        deployArguments.profile
+        deployArguments.region
     ]
     if (deployArguments.parameterOverrides.size > 0) {
         const overrides = [...map(deployArguments.parameterOverrides.entries(), ([key, value]) => `${key}=${value}`)]
         args.push('--parameter-overrides', ...overrides)
     }
 
-    const childProcessResult = await invoker.invoke({ arguments: args })
+    const childProcessResult = await invoker.invoke({
+        arguments: args,
+        spawnOptions: { env: deployArguments.environmentVariables }
+    })
 
     logAndThrowIfUnexpectedExitCode(childProcessResult, 0, logger)
 }
diff --git a/src/shared/sam/cli/samCliPackage.ts b/src/shared/sam/cli/samCliPackage.ts
@@ -15,7 +15,7 @@ export interface SamCliPackageParameters {
      * The SAM Template produced by SAM CLI's packaging
      */
     destinationTemplateFile: string
-    profile: string
+    environmentVariables: NodeJS.ProcessEnv
     region: string
     s3Bucket: string
 }
@@ -35,10 +35,11 @@ export async function runSamCliPackage(
             '--output-template-file',
             packageArguments.destinationTemplateFile,
             '--region',
-            packageArguments.region,
-            '--profile',
-            packageArguments.profile
-        ]
+            packageArguments.region
+        ],
+        spawnOptions: {
+            env: packageArguments.environmentVariables
+        }
     })
 
     logAndThrowIfUnexpectedExitCode(childProcessResult, 0, logger)
diff --git a/src/test/lambda/commands/deploySamApplication.test.ts b/src/test/lambda/commands/deploySamApplication.test.ts
@@ -119,9 +119,10 @@ describe('deploySamApplication', async () => {
         }
     }
 
-    let testProfileName: string | undefined
-    const awsContext: Pick<AwsContext, 'getCredentialProfileName'> = {
-        getCredentialProfileName: () => testProfileName
+    const placeholderCredentials = ({} as any) as AWS.Credentials
+    let testCredentials: AWS.Credentials | undefined
+    const awsContext: Pick<AwsContext, 'getCredentials'> = {
+        getCredentials: async () => testCredentials
     }
 
     let channelLogger: FakeChannelLogger
@@ -143,7 +144,7 @@ describe('deploySamApplication', async () => {
         const templatePath = path.join(tempToolkitFolder, 'template.yaml')
         writeFile(templatePath)
 
-        testProfileName = 'profile'
+        testCredentials = placeholderCredentials
         invokerCalledCount = 0
         samDeployWizardResponse = {
             parameterOverrides: new Map<string, string>(),
@@ -180,7 +181,7 @@ describe('deploySamApplication', async () => {
     })
 
     it('informs user of error when user is not logged in', async () => {
-        testProfileName = undefined
+        testCredentials = undefined
 
         await deploySamApplication(
             {
diff --git a/src/test/shared/sam/cli/samCliDeploy.test.ts b/src/test/shared/sam/cli/samCliDeploy.test.ts
@@ -4,7 +4,7 @@
  */
 
 import * as assert from 'assert'
-import { runSamCliDeploy } from '../../../../shared/sam/cli/samCliDeploy'
+import { runSamCliDeploy, SamCliDeployParameters } from '../../../../shared/sam/cli/samCliDeploy'
 import { getTestLogger } from '../../../globalSetup.test'
 import { assertThrowsError } from '../../utilities/assertUtils'
 import {
@@ -20,7 +20,6 @@ import {
 } from './testSamCliProcessInvoker'
 
 describe('runSamCliDeploy', async () => {
-    const fakeProfile = 'profile'
     const fakeRegion = 'region'
     const fakeStackName = 'stackName'
     const fakeTemplateFile = 'template'
@@ -36,16 +35,7 @@ describe('runSamCliDeploy', async () => {
             assertArgNotPresent(args, '--parameter-overrides')
         })
 
-        await runSamCliDeploy(
-            {
-                profile: fakeProfile,
-                parameterOverrides: new Map<string, string>(),
-                region: fakeRegion,
-                stackName: fakeStackName,
-                templateFile: fakeTemplateFile
-            },
-            invoker
-        )
+        await runSamCliDeploy(makeSampleSamCliDeployParameters(new Map<string, string>()), invoker)
 
         assert.strictEqual(invokeCount, 1, 'Unexpected invoke count')
     })
@@ -62,38 +52,27 @@ describe('runSamCliDeploy', async () => {
         })
 
         await runSamCliDeploy(
-            {
-                profile: fakeProfile,
-                parameterOverrides: new Map<string, string>([['key1', 'value1'], ['key2', 'value2']]),
-                region: fakeRegion,
-                stackName: fakeStackName,
-                templateFile: fakeTemplateFile
-            },
+            makeSampleSamCliDeployParameters(
+                new Map<string, string>([
+                    ['key1', 'value1'],
+                    ['key2', 'value2']
+                ])
+            ),
             invoker
         )
 
         assert.strictEqual(invokeCount, 1, 'Unexpected invoke count')
     })
 
-    it('includes a template, stack name, region, and profile ', async () => {
+    it('includes a template, stack name, and region', async () => {
         const invoker = new MockSamCliProcessInvoker(args => {
             invokeCount++
             assertArgsContainArgument(args, '--template-file', fakeTemplateFile)
             assertArgsContainArgument(args, '--stack-name', fakeStackName)
             assertArgsContainArgument(args, '--region', fakeRegion)
-            assertArgsContainArgument(args, '--profile', fakeProfile)
         })
 
-        await runSamCliDeploy(
-            {
-                profile: fakeProfile,
-                parameterOverrides: new Map<string, string>(),
-                region: fakeRegion,
-                stackName: fakeStackName,
-                templateFile: fakeTemplateFile
-            },
-            invoker
-        )
+        await runSamCliDeploy(makeSampleSamCliDeployParameters(new Map<string, string>()), invoker)
 
         assert.strictEqual(invokeCount, 1, 'Unexpected invoke count')
     })
@@ -103,13 +82,7 @@ describe('runSamCliDeploy', async () => {
 
         const error = await assertThrowsError(async () => {
             await runSamCliDeploy(
-                {
-                    profile: fakeProfile,
-                    parameterOverrides: new Map<string, string>(),
-                    region: fakeRegion,
-                    stackName: fakeStackName,
-                    templateFile: fakeTemplateFile
-                },
+                makeSampleSamCliDeployParameters(new Map<string, string>()),
                 badExitCodeProcessInvoker
             )
         }, 'Expected an error to be thrown')
@@ -121,4 +94,14 @@ describe('runSamCliDeploy', async () => {
             0
         )
     })
+
+    function makeSampleSamCliDeployParameters(parameterOverrides: Map<string, string>): SamCliDeployParameters {
+        return {
+            environmentVariables: {},
+            parameterOverrides: parameterOverrides,
+            region: fakeRegion,
+            stackName: fakeStackName,
+            templateFile: fakeTemplateFile
+        }
+    }
 })
diff --git a/src/test/shared/sam/cli/samCliPackage.test.ts b/src/test/shared/sam/cli/samCliPackage.test.ts
