Add SQS event source support for TestTool

.autover/changes/e390422f-955d-4699-97cf-67725872e746.json

@@ -0,0 +1,11 @@
+{
+  "Projects": [
+    {
+      "Name": "Amazon.Lambda.TestTool",
+      "Type": "Minor",
+      "ChangelogMessages": [
+        "Add SQS event source support"
+      ]
+    }
+  ]
+}

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Amazon.Lambda.TestTool.csproj

@@ -1,8 +1,8 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk.Web">
 
   <Import Project="..\..\..\..\buildtools\common.props" />
   <PropertyGroup>
-    <OutputType>Exe</OutputType>  
+    <OutputType>Exe</OutputType>
     <Description>A tool to help debug and test your .NET AWS Lambda functions locally.</Description>
     <TargetFramework>net8.0</TargetFramework>
     <Nullable>enable</Nullable>
@@ -17,7 +17,7 @@
     <ToolCommandName>dotnet-lambda-test-tool</ToolCommandName>
     <Version>0.9.1</Version>
     <NoWarn>NU5100</NoWarn>
-    <RollForward>Major</RollForward>	
+    <RollForward>Major</RollForward>
     <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
@@ -26,7 +26,10 @@
   </ItemGroup>
 
   <ItemGroup>
+    <PackageReference Include="Amazon.Lambda.SQSEvents" Version="2.2.0" />
+    <PackageReference Include="AWSSDK.Extensions.NETCore.Setup" Version="3.7.400" />
     <PackageReference Include="AWSSDK.Lambda" Version="3.7.411.17" />
+    <PackageReference Include="AWSSDK.SQS" Version="3.7.400.109" />
     <PackageReference Include="Spectre.Console" Version="0.49.1" />
     <PackageReference Include="Spectre.Console.Cli" Version="0.49.1" />
     <PackageReference Include="Amazon.Lambda.APIGatewayEvents" Version="2.7.1" />
@@ -38,7 +41,7 @@
     <Exec Command="dotnet msbuild ../../../../Libraries/src/Amazon.Lambda.RuntimeSupport/Amazon.Lambda.RuntimeSupport.csproj --getProperty:TargetFrameworks" ConsoleToMSBuild="true">
       <Output TaskParameter="ConsoleOutput" PropertyName="RuntimeSupportTargetFrameworks" />
     </Exec>
-    
+
     <ItemGroup>
       <TempFrameworks Include="$(RuntimeSupportTargetFrameworks.Split(';'))" />
       <TargetFrameworks Include="@(TempFrameworks)" Condition="'%(Identity)' != 'netstandard2.0'" />

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Commands/RunCommand.cs

@@ -7,6 +7,7 @@
 using Amazon.Lambda.TestTool.Extensions;
 using Amazon.Lambda.TestTool.Models;
 using Amazon.Lambda.TestTool.Processes;
+using Amazon.Lambda.TestTool.Processes.SQSEventSource;
 using Amazon.Lambda.TestTool.Services;
 using Amazon.Lambda.TestTool.Services.IO;
 using Spectre.Console.Cli;
@@ -31,17 +32,17 @@ public override async Task<int> ExecuteAsync(CommandContext context, RunCommandS
         {
             EvaluateEnvironmentVariables(settings);
 
-            if (!settings.LambdaEmulatorPort.HasValue && !settings.ApiGatewayEmulatorPort.HasValue)
+            if (!settings.LambdaEmulatorPort.HasValue && !settings.ApiGatewayEmulatorPort.HasValue && string.IsNullOrEmpty(settings.SQSEventSourceConfig))
             {
                 throw new ArgumentException("At least one of the following parameters must be set: " +
-                                            "--lambda-emulator-port or --api-gateway-emulator-port");
+                                            "--lambda-emulator-port, --api-gateway-emulator-port or --sqs-eventsource-config");
             }
 
             var tasks = new List<Task>();
 
             if (settings.LambdaEmulatorPort.HasValue)
             {
-                var testToolProcess = TestToolProcess.Startup(settings, cancellationTokenSource.Token);
+                var testToolProcess = TestToolProcess.Startup(settings, toolInteractiveService, cancellationTokenSource.Token);
                 tasks.Add(testToolProcess.RunningTask);
 
                 if (!settings.NoLaunchWindow)
@@ -70,10 +71,16 @@ public override async Task<int> ExecuteAsync(CommandContext context, RunCommandS
                 }
 
                 var apiGatewayEmulatorProcess =
-                    ApiGatewayEmulatorProcess.Startup(settings, cancellationTokenSource.Token);
+                    ApiGatewayEmulatorProcess.Startup(settings, toolInteractiveService, cancellationTokenSource.Token);
                 tasks.Add(apiGatewayEmulatorProcess.RunningTask);
             }
 
+            if (!string.IsNullOrEmpty(settings.SQSEventSourceConfig))
+            {
+                var sqsEventSourceProcess = SQSEventSourceProcess.Startup(settings, cancellationTokenSource.Token);
+                tasks.Add(sqsEventSourceProcess.RunningTask);
+            }
+
             await Task.WhenAny(tasks);
 
             return CommandReturnCodes.Success;
@@ -132,5 +139,15 @@ private void EvaluateEnvironmentVariables(RunCommandSettings settings)
                 throw new ArgumentException($"Value for {API_GATEWAY_EMULATOR_PORT} environment variable was not a valid port number");
             }
         }
+
+        if (settings.SQSEventSourceConfig != null && settings.SQSEventSourceConfig.StartsWith(Constants.ArgumentEnvironmentVariablePrefix, StringComparison.CurrentCultureIgnoreCase))
+        {
+            var envVariable = settings.SQSEventSourceConfig.Substring(Constants.ArgumentEnvironmentVariablePrefix.Length);
+            if (!environmentVariables.Contains(envVariable))
+            {
+                throw new InvalidOperationException($"Environment variable {envVariable} for the SQS event source config was empty");
+            }
+            settings.SQSEventSourceConfig = environmentVariables[envVariable]?.ToString();
+        }
     }
 }

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Commands/Settings/RunCommandSettings.cs

@@ -53,4 +53,12 @@ public sealed class RunCommandSettings : CommandSettings
     [CommandOption("--api-gateway-emulator-port <PORT>")]
     [Description("The port number used for the test tool's API Gateway emulator.")]
     public int? ApiGatewayEmulatorPort { get; set; }
+
+    /// <summary>
+    /// The configuration for the SQS event source. The format of the config is a comma delimited key pairs. For example \"QueueUrl=queue-url,FunctionName=function-name,VisibilityTimeout=100\".
+    /// Possible keys are: BatchSize, DisableMessageDelete, FunctionName, LambdaRuntimeApi, Profile, QueueUrl, Region, VisibilityTimeout
+    /// </summary>
+    [CommandOption("--sqs-eventsource-config <CONFIG>")]
+    [Description("The configuration for the SQS event source. The format of the config is a comma delimited key pairs. For example \"QueueUrl=<queue-url>,FunctionName=<function-name>,VisibilityTimeout=100\". Possible keys are: BatchSize, DisableMessageDelete, FunctionName, LambdaRuntimeApi, Profile, QueueUrl, Region, VisibilityTimeout")]
+    public string? SQSEventSourceConfig { get; set; }
 }

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Constants.cs

@@ -84,4 +84,10 @@ public abstract class Constants
     /// The Visual Studio Marketplace link for the AWS Toolkit for Visual Studio.
     /// </summary>
     public const string LinkVsToolkitMarketplace = "https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.AWSToolkitforVisualStudio2022";
+
+    /// <summary>
+    /// Prefix this is used for values of command line arguments that support the value being stored in an environment variable.
+    /// This used in the Aspire integration where it is often easier to pass configuration via environment variables.
+    /// </summary>
+    public const string ArgumentEnvironmentVariablePrefix = "env:";
 }

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Processes/ApiGatewayEmulatorProcess.cs

@@ -40,7 +40,7 @@ public class ApiGatewayEmulatorProcess
     /// <summary>
     /// Creates the Web API and runs it in the background.
     /// </summary>
-    public static ApiGatewayEmulatorProcess Startup(RunCommandSettings settings, CancellationToken cancellationToken = default)
+    public static ApiGatewayEmulatorProcess Startup(RunCommandSettings settings, IToolInteractiveService toolInteractiveService, CancellationToken cancellationToken = default)
     {
         if (settings.ApiGatewayEmulatorMode is null)
         {
@@ -62,6 +62,11 @@ public static ApiGatewayEmulatorProcess Startup(RunCommandSettings settings, Can
 
         var app = builder.Build();
 
+        if (!app.Environment.IsProduction())
+        {
+            app.Services.GetRequiredService<ILoggerFactory>().AddProvider(new ToolInteractiveLoggerProvider(toolInteractiveService));
+        }
+
         app.MapHealthChecks("/__lambda_test_tool_apigateway_health__");
 
         app.Lifetime.ApplicationStarted.Register(() =>