Address comments

Author: mbfreder

packages/core/src/shared/sam/build.ts

@@ -19,7 +19,7 @@ import globals from '../extensionGlobals'
 import { TreeNode } from '../treeview/resourceTreeDataProvider'
 import { telemetry } from '../telemetry/telemetry'
 import { getSpawnEnv } from '../env/resolveEnv'
-import { getProjectRoot, getSamCliPathAndVersion, isDotnetRuntime } from './utils'
+import { getErrorCode, getProjectRoot, getSamCliPathAndVersion, isDotnetRuntime } from './utils'
 import { getConfigFileUri, validateSamBuildConfig } from './config'
 import { runInTerminal } from './processTerminal'
 
@@ -236,7 +236,7 @@ export async function runBuild(arg?: TreeNode): Promise<SamBuildResult> {
     } catch (error) {
         throw ToolkitError.chain(error, 'Failed to build SAM template', {
             details: { ...resolveBuildArgConflict(buildFlags) },
-            code: error instanceof ToolkitError ? error.code : undefined,
+            code: getErrorCode(error),
         })
     }
 }

packages/core/src/shared/sam/deploy.ts

@@ -24,7 +24,7 @@ import { Wizard } from '../wizards/wizard'
 import { addTelemetryEnvVar } from './cli/samCliInvokerUtils'
 import { validateSamDeployConfig, SamConfig, writeSamconfigGlobal } from './config'
 import { TemplateItem, createStackPrompter, createBucketPrompter, createTemplatePrompter } from './sync'
-import { getProjectRoot, getSamCliPathAndVersion, getSource } from './utils'
+import { getErrorCode, getProjectRoot, getSamCliPathAndVersion, getSource } from './utils'
 import { runInTerminal } from './processTerminal'
 
 export interface DeployParams {
@@ -394,7 +394,7 @@ export async function runDeploy(arg: any, wizardParams?: DeployParams): Promise<
         } catch (error) {
             throw ToolkitError.chain(error, 'Failed to deploy SAM template', {
                 details: { ...deployFlags },
-                code: error instanceof ToolkitError ? error.code : undefined,
+                code: getErrorCode(error),
             })
         }
         return {

packages/core/src/shared/sam/processTerminal.ts

@@ -12,28 +12,16 @@ import { CancellationError } from '../utilities/timeoutUtils'
 import { getLogger } from '../logger'
 import { removeAnsi } from '../utilities/textUtilities'
 import { isAutomation } from '../vscode/env'
-import { getSamCliErrorMessage, SamCliErrorTypes } from './utils'
+import { throwIfErrorMatches } from './utils'
 
 let oldTerminal: ProcessTerminal | undefined
 export async function runInTerminal(proc: ChildProcess, cmd: string) {
     const handleResult = (result?: ChildProcessResult) => {
         if (result && result.exitCode !== 0) {
-            const defaultMessage = `sam ${cmd} exited with a non-zero exit code: ${result.exitCode}`
-            if (result.stderr.includes('is up to date')) {
-                throw ToolkitError.chain(result.error, defaultMessage, {
-                    code: 'NoUpdateExitCode',
-                })
-            }
-            for (const errorType in SamCliErrorTypes) {
-                const errorMessage = getSamCliErrorMessage(result.stderr)
-                if (errorMessage.includes(SamCliErrorTypes[errorType as keyof typeof SamCliErrorTypes])) {
-                    throw ToolkitError.chain(result.error, errorMessage, {
-                        code: errorType,
-                    })
-                }
-            }
+            throwIfErrorMatches(result)
 
             // If no specific error matched, throw the default non-zero exit code error.
+            const defaultMessage = `sam ${cmd} exited with a non-zero exit code: ${result.exitCode}`
             throw ToolkitError.chain(result.error, defaultMessage, {
                 code: 'NonZeroExitCode',
             })

packages/core/src/shared/sam/sync.ts

@@ -41,7 +41,7 @@ import { IamConnection } from '../../auth/connection'
 import { CloudFormationTemplateRegistry } from '../fs/templateRegistry'
 import { TreeNode } from '../treeview/resourceTreeDataProvider'
 import { getSpawnEnv } from '../env/resolveEnv'
-import { getProjectRoot, getProjectRootUri, getSamCliPathAndVersion, getSource } from './utils'
+import { getErrorCode, getProjectRoot, getProjectRootUri, getSamCliPathAndVersion, getSource } from './utils'
 import { runInTerminal } from './processTerminal'
 
 const localize = nls.loadMessageBundle()
@@ -663,7 +663,7 @@ export async function runSync(
         } catch (err) {
             throw ToolkitError.chain(err, 'Failed to sync SAM application', {
                 details: { ...params },
-                code: err instanceof ToolkitError ? err.code : undefined,
+                code: getErrorCode(err),
             })
         }
     })

packages/core/src/shared/sam/utils.ts

@@ -15,6 +15,7 @@ import { ToolkitError } from '../errors'
 import { SamCliSettings } from './cli/samCliSettings'
 import { SamCliInfoInvocation } from './cli/samCliInfo'
 import { parse } from 'semver'
+import { ChildProcessResult } from '../utilities/processUtils'
 
 /**
  * @description determines the root directory of the project given Template Item
@@ -93,12 +94,27 @@ export function getSamCliErrorMessage(stderr: string): string {
     return lines[lines.length - 1]
 }
 
+export function getErrorCode(error: unknown): string | undefined {
+    return error instanceof ToolkitError ? error.code : undefined
+}
+
+export function throwIfErrorMatches(result: ChildProcessResult) {
+    const errorMessage = getSamCliErrorMessage(result.stderr)
+    for (const errorType in SamCliErrorTypes) {
+        if (errorMessage.includes(SamCliErrorTypes[errorType as keyof typeof SamCliErrorTypes])) {
+            throw ToolkitError.chain(result.error, errorMessage, {
+                code: errorType,
+            })
+        }
+    }
+}
+
 export enum SamCliErrorTypes {
     DockerUnreachable = 'Docker is unreachable.',
     ResolveS3AndS3Set = 'Cannot use both --resolve-s3 and --s3-bucket parameters in non-guided deployments.',
     DeployStackStatusMissing = 'Was not able to find a stack with the name:',
     DeployStackOutPutFailed = 'Failed to get outputs from stack',
     DeployBucketRequired = 'Templates with a size greater than 51,200 bytes must be deployed via an S3 Bucket.',
-    NoUpdate = 'is up to date',
+    NoUpdateExitCode = 'is up to date',
     ChangeSetEmpty = 'No changes to deploy. Stack is up to date',
 }

packages/core/src/test/shared/sam/utils.test.ts

@@ -12,12 +12,14 @@ import {
     getSource,
     isDotnetRuntime,
     getSamCliErrorMessage,
+    throwIfErrorMatches,
 } from '../../../shared/sam/utils'
 import { TemplateItem } from '../../../shared/sam/sync'
 import { RegionNode } from '../../../awsexplorer/regionNode'
 import { Region } from '../../../shared/regions/endpoints'
-import { RegionProvider } from '../../../shared'
+import { RegionProvider, ToolkitError } from '../../../shared'
 import { DeployedResource, DeployedResourceNode } from '../../../awsService/appBuilder/explorer/nodes/deployedNode'
+import { ChildProcessResult } from '../../../shared/utilities/processUtils'
 
 describe('SAM utils', async function () {
     it('returns the projectRoot', async function () {
@@ -166,4 +168,24 @@ describe('SAM utils', async function () {
             )
         })
     })
+
+    describe('throwIfErrorMatches', async function () {
+        it('should throw a ToolkitError with the correct code when an error message matches', () => {
+            const mockError = new Error('Mock Error')
+            const mockResult: ChildProcessResult = {
+                exitCode: 1,
+                error: mockError,
+                stdout: '',
+                stderr: 'Docker is unreachable.',
+            }
+            assert.throws(
+                () => throwIfErrorMatches(mockResult),
+                (e: any) => {
+                    assert.strictEqual(e instanceof ToolkitError, true)
+                    assert.strictEqual(e.code, 'DockerUnreachable')
+                    return true
+                }
+            )
+        })
+    })
 })