Update SAM CLI to accept a runtime parameter in local invokes

Author: mbfreder

packages/core/src/shared/sam/cli/samCliLocalInvoke.ts

@@ -217,6 +217,8 @@ export interface SamCliLocalInvokeInvocationArguments {
     name?: string
     /** AWS region */
     region?: string
+    /** Runtime to use for testing. Can be different from the one specified in the template. */
+    runtime?: string
 }
 
 /**
@@ -265,6 +267,7 @@ export class SamCliLocalInvokeInvocation {
             ...(this.args.parameterOverrides ?? [])
         )
         invokeArgs.push(...(this.args.extraArgs ?? []))
+        pushIf(invokeArgs, !!this.args.runtime, '--runtime', this.args.runtime)
 
         return await this.args.invoker.invoke({
             options: {

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

@@ -247,6 +247,7 @@ async function invokeLambdaHandler(
             parameterOverrides: config.parameterOverrides,
             name: config.name,
             region: config.region,
+            runtime: config.lambda?.runtime,
         }
 
         // sam local invoke ...

packages/core/src/test/shared/sam/cli/samCliLocalInvoke.test.ts

@@ -68,6 +68,10 @@ describe('SamCliLocalInvokeInvocation', async function () {
                 // `extraArgs` are appended to the end.
                 assert.strictEqual(invokeArgs.args[10], '--build-dir')
                 assert.strictEqual(invokeArgs.args[11], 'my/build/dir/')
+
+                // 'runtime' is the last argument.
+                assert.strictEqual(invokeArgs.args[invokeArgs.args.length - 2], '--runtime')
+                assert.strictEqual(invokeArgs.args[invokeArgs.args.length - 1], 'python3.10')
             }
         )
 
@@ -78,6 +82,7 @@ describe('SamCliLocalInvokeInvocation', async function () {
             environmentVariablePath: nonRelevantArg,
             invoker: taskInvoker,
             extraArgs: ['--build-dir', 'my/build/dir/'],
+            runtime: 'python3.10',
         }).execute()
     })
 
@@ -302,4 +307,39 @@ describe('SamCliLocalInvokeInvocation', async function () {
             invoker: taskInvoker,
         }).execute()
     })
+
+    it('Passes runtime to sam cli', async function () {
+        const runtime = 'python3.10'
+
+        const taskInvoker: SamLocalInvokeCommand = new TestSamLocalInvokeCommand(
+            (invokeArgs: SamLocalInvokeCommandArgs) => {
+                assertArgsContainArgument(invokeArgs.args, '--runtime', runtime)
+            }
+        )
+
+        await new SamCliLocalInvokeInvocation({
+            templateResourceName: nonRelevantArg,
+            templatePath: placeholderTemplateFile,
+            eventPath: placeholderEventFile,
+            environmentVariablePath: nonRelevantArg,
+            invoker: taskInvoker,
+            runtime: runtime,
+        }).execute()
+    })
+
+    it('Does not pass runtime to sam cli when undefined', async function () {
+        const taskInvoker: SamLocalInvokeCommand = new TestSamLocalInvokeCommand(
+            (invokeArgs: SamLocalInvokeCommandArgs) => {
+                assertArgNotPresent(invokeArgs.args, '--runtime')
+            }
+        )
+
+        await new SamCliLocalInvokeInvocation({
+            templateResourceName: nonRelevantArg,
+            templatePath: placeholderTemplateFile,
+            eventPath: placeholderEventFile,
+            environmentVariablePath: nonRelevantArg,
+            invoker: taskInvoker,
+        }).execute()
+    })
 })