Skip to content

Nullable Custom Resource ResponseURL #455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
talenfisher merged 2 commits into from
Nov 18, 2021
Merged

Nullable Custom Resource ResponseURL #455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd0de41
LAMBJ-142 Nullable Custom Resource ResponseURL
talenfisher Nov 18, 2021
7511202
LAMBJ-142 Update Release Notes
talenfisher Nov 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/releases/v0.9.0-beta4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Enhancements

- CloudFormationStackEvent objects are now serializable.
- ResponseURL is now an optional argument to custom resource requests, to allow for easier testing.
- The lambda output for Custom Resources is now the full response that would've been sent to CloudFormation, rather than just the output data.

# Bug Fixes

Expand Down
23 changes: 13 additions & 10 deletions src/CustomResource/CustomResourceLambdaHost.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ namespace Lambdajection.CustomResource
{
/// <inheritdoc />
public sealed class CustomResourceLambdaHost<TLambda, TLambdaParameter, TLambdaOutput, TLambdaStartup, TLambdaConfigurator, TLambdaConfigFactory>
: LambdaHostBase<TLambda, CustomResourceRequest<TLambdaParameter>, TLambdaOutput, TLambdaStartup, TLambdaConfigurator, TLambdaConfigFactory>
: LambdaHostBase<TLambda, CustomResourceRequest<TLambdaParameter>, CustomResourceResponse<TLambdaOutput>, TLambdaStartup, TLambdaConfigurator, TLambdaConfigFactory>
where TLambda : class, ICustomResourceProvider<TLambdaParameter, TLambdaOutput>
where TLambdaParameter : class
where TLambdaOutput : class, ICustomResourceOutputData
Expand All @@ -35,13 +35,13 @@ public CustomResourceLambdaHost()
/// Initializes a new instance of the <see cref="CustomResourceLambdaHost{TLambda, TLambdaParameter, TLambdaOutput, TLambdaStartup, TLambdaConfigurator, TLambdaConfigFactory}" /> class.
/// </summary>
/// <param name="build">The builder action to run on the lambda.</param>
internal CustomResourceLambdaHost(Action<LambdaHostBase<TLambda, CustomResourceRequest<TLambdaParameter>, TLambdaOutput, TLambdaStartup, TLambdaConfigurator, TLambdaConfigFactory>> build)
internal CustomResourceLambdaHost(Action<LambdaHostBase<TLambda, CustomResourceRequest<TLambdaParameter>, CustomResourceResponse<TLambdaOutput>, TLambdaStartup, TLambdaConfigurator, TLambdaConfigFactory>> build)
: base(build)
{
}

/// <inheritdoc />
public override async Task<TLambdaOutput> InvokeLambda(
public override async Task<CustomResourceResponse<TLambdaOutput>> InvokeLambda(
Stream inputStream,
CancellationToken cancellationToken = default
)
Expand Down Expand Up @@ -92,14 +92,17 @@ public override async Task<TLambdaOutput> InvokeLambda(
};
}

await httpClient.PutJson(
requestUri: input.ResponseURL,
payload: response,
contentType: null,
cancellationToken: cancellationToken
);
if (input.ResponseURL != null)
{
await httpClient.PutJson(
requestUri: input.ResponseURL,
payload: response,
contentType: null,
cancellationToken: cancellationToken
);
}

return response.Data!;
return response;
}

[MethodImpl(MethodImplOptions.AggressiveInlining)]
Expand Down
2 changes: 1 addition & 1 deletion src/CustomResource/CustomResourceRequest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public class CustomResourceRequest
/// has been created/updated/deleted.
/// </summary>
/// <value>The response URL.</value>
public virtual Uri ResponseURL { get; set; } = new Uri("http://localhost");
public virtual Uri? ResponseURL { get; set; }

/// <summary>
/// Gets or sets the Id of the CloudFormation stack that the
Expand Down
56 changes: 46 additions & 10 deletions tests/Unit/CustomResource/CustomResourceLambdaHostTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ [Substitute] IHttpClient httpClient
await host.InvokeLambda(inputStream, cancellationToken);

await httpClient.Received().PutJson(
Is(request.ResponseURL),
Is(request.ResponseURL!),
Is<CustomResourceResponse<TestCustomResourceOutputData>>(response =>
response.Status == CustomResourceResponseStatus.Success &&
response.Data == data
Expand Down Expand Up @@ -234,7 +234,7 @@ [Substitute] IHttpClient httpClient
await host.InvokeLambda(inputStream, cancellationToken);

await httpClient.Received().PutJson(
Is(request.ResponseURL),
Is(request.ResponseURL!),
Is<CustomResourceResponse<TestCustomResourceOutputData>>(response =>
response.Status == CustomResourceResponseStatus.Success &&
response.StackId == stackId
Expand Down Expand Up @@ -272,7 +272,7 @@ [Substitute] IHttpClient httpClient
await host.InvokeLambda(inputStream, cancellationToken);

await httpClient.Received().PutJson(
Is(request.ResponseURL),
Is(request.ResponseURL!),
Is<CustomResourceResponse<TestCustomResourceOutputData>>(response =>
response.Status == CustomResourceResponseStatus.Success &&
response.RequestId == requestId
Expand Down Expand Up @@ -310,7 +310,7 @@ [Substitute] IHttpClient httpClient
await host.InvokeLambda(inputStream, cancellationToken);

await httpClient.Received().PutJson(
Is(request.ResponseURL),
Is(request.ResponseURL!),
Is<CustomResourceResponse<TestCustomResourceOutputData>>(response =>
response.Status == CustomResourceResponseStatus.Success &&
response.LogicalResourceId == logicalResourceId
Expand Down Expand Up @@ -350,7 +350,7 @@ [Substitute] IHttpClient httpClient
await host.InvokeLambda(inputStream, cancellationToken);

await httpClient.Received().PutJson(
Is(request.ResponseURL),
Is(request.ResponseURL!),
Is<CustomResourceResponse<TestCustomResourceOutputData>>(response =>
response.Status == CustomResourceResponseStatus.Success &&
response.PhysicalResourceId == physicalResourceId
Expand All @@ -360,6 +360,42 @@ await httpClient.Received().PutJson(
);
}

[Test, Auto]
public async Task ShouldNotRespondSuccessIfResponseURLIsNull(
ServiceCollection serviceCollection,
string stackId,
JsonSerializer serializer,
CustomResourceRequest<object> request,
[Substitute] TestCustomResourceLambda lambda,
[Substitute] IHttpClient httpClient
)
{
serviceCollection.AddSingleton(httpClient);
request.ResponseURL = null;

var serviceProvider = serviceCollection.BuildServiceProvider();
var cancellationToken = new CancellationToken(false);
var host = new TestCustomResourceLambdaHost(lambdaHost =>
{
lambdaHost.Lambda = lambda;
lambdaHost.Scope = serviceProvider.CreateScope();
lambdaHost.Serializer = serializer;
});

request.RequestType = CustomResourceRequestType.Create;
request.StackId = stackId;

using var inputStream = await StreamUtils.CreateJsonStream(request);
await host.InvokeLambda(inputStream, cancellationToken);

await httpClient.DidNotReceiveWithAnyArgs().PutJson(
default!,
default(CustomResourceResponse<TestCustomResourceOutputData>)!,
default!,
default!
);
}

[Test, Auto]
public async Task ShouldRespondFailureWithReason(
string reason,
Expand Down Expand Up @@ -393,7 +429,7 @@ [Substitute] IHttpClient httpClient
await host.InvokeLambda(inputStream, cancellationToken);

await httpClient.Received().PutJson(
Is(request.ResponseURL),
Is(request.ResponseURL!),
Is<CustomResourceResponse<TestCustomResourceOutputData>>(response =>
response.Status == CustomResourceResponseStatus.Failed &&
response.Reason == reason
Expand Down Expand Up @@ -506,7 +542,7 @@ [Substitute] IHttpClient httpClient
await host.InvokeLambda(inputStream, cancellationToken);

await httpClient.Received().PutJson(
Is(request.ResponseURL),
Is(request.ResponseURL!),
Is<CustomResourceResponse<TestCustomResourceOutputData>>(response =>
response.Status == CustomResourceResponseStatus.Failed &&
response.RequestId == requestId
Expand Down Expand Up @@ -549,7 +585,7 @@ [Substitute] IHttpClient httpClient
await host.InvokeLambda(inputStream, cancellationToken);

await httpClient.Received().PutJson(
Is(request.ResponseURL),
Is(request.ResponseURL!),
Is<CustomResourceResponse<TestCustomResourceOutputData>>(response =>
response.Status == CustomResourceResponseStatus.Failed &&
response.StackId == stackId
Expand Down Expand Up @@ -592,7 +628,7 @@ [Substitute] IHttpClient httpClient
await host.InvokeLambda(inputStream, cancellationToken);

await httpClient.Received().PutJson(
Is(request.ResponseURL),
Is(request.ResponseURL!),
Is<CustomResourceResponse<TestCustomResourceOutputData>>(response =>
response.Status == CustomResourceResponseStatus.Failed &&
response.LogicalResourceId == logicalResourceId
Expand Down Expand Up @@ -635,7 +671,7 @@ [Substitute] IHttpClient httpClient
await host.InvokeLambda(inputStream, cancellationToken);

await httpClient.Received().PutJson(
Is(request.ResponseURL),
Is(request.ResponseURL!),
Is<CustomResourceResponse<TestCustomResourceOutputData>>(response =>
response.Status == CustomResourceResponseStatus.Failed &&
response.PhysicalResourceId == physicalResourceId
Expand Down