Automatically install Amazon.Lambda.TestTool #28
Conversation
normj
force-pushed
the
normj/install-testtool
branch
from
c0ad606 to
fee0285
Compare
| using System.Diagnostics; | ||
| using System.Text; | ||
|
|
||
| namespace Aspire.Hosting.AWS.Utils.Internal; |
There was a problem hiding this comment.
I didn't want to expose this interface as part of our public API but for unit testing purposes I need to implement the interface and making the interface internal doesn't work for that even marking the assembly internal visible to. So I went with the compromise of putting this in an "Internal" namespace.
…ol which is the Lambda service emulator
normj
force-pushed
the
normj/install-testtool
branch
from
fee0285 to
ffbb42b
Compare
| namespace Aspire.Hosting.AWS.Lambda; | ||
|
|
||
| /// <summary> | ||
| /// Lambda lifecycle hook takes care of getting Amazon.Lambda.TestTool is installed if there was |
There was a problem hiding this comment.
nit: is installed -> installed.
Directory.Packages.props
Outdated
There was a problem hiding this comment.
Unrelated to this change, but why does the entire solution has 1 Directory.Packages.props? So anytime we add a new package, we are adding it for the entire solution?
There was a problem hiding this comment.
The repo was setup so that it had centralized package versioning. But in the individual project files you still specify the package you want to use. But in the project you don't set a version. For example in the project file of Aspire.Hosting.AWS we add the packages but don't set the version.
<ItemGroup>
<PackageReference Include="Aspire.Hosting" />
<PackageReference Include="Amazon.CDK.Lib" />
<PackageReference Include="AWSSDK.Core" />
<PackageReference Include="AWSSDK.CloudFormation" />
</ItemGroup>
This way you only have to update the version of a package in one place for all projects in a repository.
| { | ||
| internal void AddCommandLineArguments(IList<object> arguments) | ||
| { | ||
| arguments.Add("lambda-test-tool"); |
There was a problem hiding this comment.
isn't the name of our tool dotnet-lambda-test-tool?
There was a problem hiding this comment.
apparently dotnet lambda-test-tool works and so does dotnet-lambda-test-tool.
There was a problem hiding this comment.
Discussed in sync meeting and we are on the same page now.
| @@ -14,4 +14,22 @@ internal class LambdaEmulatorAnnotation(EndpointReference endpoint) : IResourceA | |||
| /// The HTTP endpoint for the Lambda runtime emulator. | |||
| /// </summary> | |||
| public EndpointReference Endpoint { get; init; } = endpoint; | |||
|
|
|||
| /// <summary> | |||
| /// If set to true Amazon.Lambda.TestTool will updated/installed during AppHost startup. Amazon.Lambda.TestTool is | |||
There was a problem hiding this comment.
the name and the description are saying 2 different things. The name suggests that we won't auto install, but the description is saying that we will?
| namespace Aspire.Hosting.AWS.Lambda; | ||
|
|
||
| /// <summary> | ||
| /// Options that can be added the Lambda emulator resource. |
There was a problem hiding this comment.
nit: add "to" between "added" and "the"
| public class LambdaEmulatorOptions | ||
| { | ||
| /// <summary> | ||
| /// If set to true, Amazon.Lambda.TestTool will updated/installed during AppHost startup. Amazon.Lambda.TestTool is |
| { | ||
| internal void AddCommandLineArguments(IList<object> arguments) | ||
| { | ||
| arguments.Add("lambda-test-tool"); |
There was a problem hiding this comment.
same question on tool name
There was a problem hiding this comment.
also didn't we change the behavior so that you need to specify the port for the emulator to run? won't this error out as is?
| { | ||
| if (builder.Resources.FirstOrDefault(x => x.TryGetAnnotationsOfType<LambdaEmulatorAnnotation>(out _)) is not ExecutableResource serviceEmulator) | ||
| /// <summary> | ||
| /// Add the Lambda service emulator resource. The AddAWSLambdaFunction method will automatically add the Lambda service emulator if it hasn't |
There was a problem hiding this comment.
could you add doc references to "AddAWSLambdaFunction" and "LambdaEmulatorOptions"
|
|
||
| private async Task<string> GetCurrentInstalledVersionAsync(CancellationToken cancellationToken) | ||
| { | ||
| var results = await processCommandService.RunProcessAndCaptureOuputAsync(logger, "dotnet", "lambda-test-tool --tool-info", cancellationToken); |
There was a problem hiding this comment.
might need to update based on other PR changes aws/aws-lambda-dotnet#1969
normj
force-pushed
the
normj/install-testtool
branch
from
dbba606 to
0de32d3
Compare
Description of changes:
If the Lambda service emulator is added there will be a check made to see if Amazon.Lambda.TestTool is installed and up to date. If not then it will be installed via the
dotnet tool installcommand.The Lambda service emulator is added to the collection resources as part of the first invoke of
AddAWSLambdaFunction. If the user wants to customize the installation or disable it they can call the newAddAWSLambdaServiceEmulatormethod before callingAddAWSLambdaFunction. TheAddAWSLambdaServiceEmulatortakes in anLambdaEmulatorOptionsthat allows disabling the auto install, overriding the version to install or allowing downgrading the version. By default if a newer version of the tooling is already installed then what the Aspire.Hosting.AWS is looking for we will allow assuming the user knows what they are doing.While going through the area I did some minor clean work.
This PR is depending on the Amazon.Lambda.TestTool [PR#](aws/aws-lambda-dotnet#1969) that adds a new
--tool-infoswitch that Aspire can used to get metadata about the currently installed version.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.