Add happy path for lambda test tool v2 #1934

gcbeattyAWS · 2025-01-21T19:20:00Z

Issue #, if available: DOTNET-7840

Description of changes:

Get happy path working for lambda test tool.
- Invoke the lambda with api gateway request
- Converting functions to async in order to work correctly.
- Integrating logic to convert lambda response into api gateway response
Update ApiGatewayResponseExtensions logic to handle correctly setting the headers. I was seeing Headers are read-only, response has already started. error, because we were setting the content type header after the body was set, so i updated the logic to set the headers first and refactored the logic a bit to make it look better
Update rout pathing logic to fix handling root path
Fix a bug in lambda response to api gateway response object. When a lambda returns a string in httpv2, it gets sent back as the encoded form \"stringhere\". Previously we were then setting the body to the encoded form "\test\", but in reality api gateways decodes the json string to just stringhere
Fix a bug for when the payload is an empty string, we should still be setting the body.
Added integration test to test end to end happy path by invoking a local lambda function with the api gateway

Testing Details

Ran test tool locally in api gateway mode
Ran local lambda function that returns a test response
went to chrome browser and verified that response appears
Ran all unit tests and integration tests and they passed

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

…nd back

gcbeattyAWS · 2025-01-21T19:43:17Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Extensions/ApiGatewayResponseExtensions.cs

+    /// </summary>
+    /// <param name="response">The <see cref="HttpResponse"/> to set the error on.</param>
+    /// <param name="emulatorMode">The <see cref="ApiGatewayEmulatorMode"/> determining the error format.</param>
+    private static async Task SetErrorResponse(HttpResponse response, ApiGatewayEmulatorMode emulatorMode)


this is just refactoring

gcbeattyAWS · 2025-01-21T22:16:18Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Extensions/ApiGatewayResponseExtensions.cs

+    /// <param name="headers">The single-value headers.</param>
+    /// <param name="multiValueHeaders">The multi-value headers.</param>
+    /// <param name="emulatorMode">The <see cref="ApiGatewayEmulatorMode"/> determining the default content type.</param>
+    private static void SetContentType(HttpResponse response, IDictionary<string, string>? headers, IDictionary<string, IList<string>>? multiValueHeaders, ApiGatewayEmulatorMode emulatorMode)


refactoring, not anything new

gcbeattyAWS · 2025-01-21T22:16:39Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Extensions/ApiGatewayResponseExtensions.cs

        SetResponseHeaders(response, apiResponse.Headers, emulatorMode, apiResponse.MultiValueHeaders);
-        SetResponseBody(response, apiResponse.Body, apiResponse.IsBase64Encoded);
-        SetContentTypeAndStatusCodeV1(response, apiResponse.Headers, apiResponse.MultiValueHeaders, apiResponse.StatusCode, emulatorMode);
+        response.StatusCode = apiResponse.StatusCode;


i had to move setting response headers before setting the body in order to fix some errors. see pr description for more details

gcbeattyAWS · 2025-01-21T22:16:51Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Extensions/ApiGatewayResponseExtensions.cs

-        else if (multiValueHeaders != null && multiValueHeaders.TryGetValue("Content-Type", out var multiValueContentType))
-        {
-            contentType = multiValueContentType.FirstOrDefault();
+            return;


this is a bug fix. a new integration test discovered an issue where if we had an empty string, the content length was not being set. so to fix it we do write empty string to the body, which will automatically set the content length

gcbeattyAWS · 2025-01-21T22:17:19Z

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

-            return Results.Ok();
+            if (response.FunctionError != null)
+            {
+                // TODO: Mimic API Gateway's behavior when Lambda function has an exception during invocation.


I will make a backlog sim for this

gcbeattyAWS · 2025-01-21T22:17:22Z

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

+
+    private static IAmazonLambda CreateLambdaServiceClient(ApiGatewayRouteConfig routeConfig)
+    {
+        // TODO: Handle routeConfig.Endpoint to null and use the settings versions of runtime.


I will make a backlog sim for this

gcbeattyAWS · 2025-01-21T22:44:34Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Services/ApiGatewayRouteConfigService.cs

@@ -181,12 +192,50 @@ private bool IsRouteConfigValid(ApiGatewayRouteConfig routeConfig)
    /// <returns>An <see cref="ApiGatewayRouteConfig"/> corresponding to Lambda function with an API Gateway HTTP Method and Path.</returns>
    public ApiGatewayRouteConfig? GetRouteConfig(string httpMethod, string path)


@normj what was the reason you had to make changes in this file in ef143c3#diff-e1cef17d258d2f0adc55f27ed60cc0763ee1acd18b66cf11cf77d765c1199003R189? i think i had your change and then removed it and ended up updating this file anyway when i was playing around with things. but i actually dont think changes are needed here. was there a specific scenario that wasn't working for you? all of the test cases pass in the previous version (in feature/lambdatesttool-v2 branch) and my new branch

i can remove the changes from the file then if we want to reduce the amount of code change in this PR, or maybe i can just leave the comments? What do we think?

I had to have that because I could configure a API Gateway request path to just the root (/). Without the StringSplitOptions.RemoveEmptyEntries the return segments would be an array of 1 and that being an empty string. That would fail the match.

gotcha. i will try out that scenario and see what happens

looks like that also fails with my new logic. i will update that to fix this case and also add a test case

i updated the logic to add a special case for handling the root path. i initially tried your way but that broke some other test cases, so it was easier to handle it with a special case.

I also added a unit test to verify that the root path works and tested it manually. Before my change, the unit test would fail and after my change, the unit test passes

gcbeattyAWS · 2025-01-22T18:03:37Z

Tools/LambdaTestTool-v2/src/Amazon.Lambda.TestTool/Extensions/InvokeResponseExtensions.cs

+            // return "test", it actually comes as "\"test\"" to response. So we need to get the raw string which is what api gateway does.
+            if (jsonElement.ValueKind == JsonValueKind.String)
+            {
+                response = jsonElement.GetString();


this is also a bug fix

gcbeattyAWS · 2025-01-22T18:07:35Z

...tests/Amazon.Lambda.TestTool.IntegrationTests/ApiGatewayResponseExtensionsAdditionalTests.cs

@@ -22,26 +22,6 @@ public ApiGatewayResponseExtensionsAdditionalTests(ApiGatewayIntegrationTestFixt
            _httpClient = new HttpClient();
        }

-        //[Fact]
-        //public async Task V2_SetsContentTypeApplicationJsonWhenNoStatusProvided()


i forgot to remove this in a previous pr. this is covered by #1927

normj and others added 9 commits January 15, 2025 13:48

Get happy path working from API Gateway emulator to Lambda function a…

39fe40c

…nd back

update to use new methods

fe99cd6

update route handling logic

eea93ab

update write body logic and fix tests

5acdac9

move integration test into same folder as tests

bec1f5c

add end to end test

4cb38a4

fix header logic

657d412

Add more tests and fix conversion logic

82d608a

fix empty string edge case

4abf824

gcbeattyAWS changed the title ~~Gcbeatty/fullpath~~ Add happy path for lambda test tool v2 Jan 21, 2025

remove launchsettingsfile

2f47e6e

gcbeattyAWS commented Jan 21, 2025

View reviewed changes

gcbeattyAWS added 3 commits January 21, 2025 14:56

add response.clear back

6598bee

more tests

b1578ab

update slnx file

0c8a2f7

gcbeattyAWS commented Jan 21, 2025

View reviewed changes

gcbeattyAWS marked this pull request as ready for review January 21, 2025 22:24

gcbeattyAWS requested review from philasmar and normj January 21, 2025 22:24

gcbeattyAWS commented Jan 21, 2025

View reviewed changes

add root test case

b8a58af

gcbeattyAWS commented Jan 22, 2025

View reviewed changes

normj approved these changes Jan 22, 2025

View reviewed changes

philasmar approved these changes Jan 23, 2025

View reviewed changes

gcbeattyAWS merged commit 9a2858d into feature/lambdatesttool-v2 Jan 23, 2025
4 checks passed

gcbeattyAWS deleted the gcbeatty/fullpath branch January 23, 2025 14:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add happy path for lambda test tool v2 #1934

Add happy path for lambda test tool v2 #1934

gcbeattyAWS commented Jan 21, 2025 •

edited

Loading

gcbeattyAWS Jan 21, 2025

gcbeattyAWS Jan 21, 2025

gcbeattyAWS Jan 21, 2025 •

edited

Loading

gcbeattyAWS Jan 21, 2025 •

edited

Loading

gcbeattyAWS Jan 21, 2025

gcbeattyAWS Jan 21, 2025

gcbeattyAWS Jan 21, 2025 •

edited

Loading

normj Jan 21, 2025 •

edited

Loading

gcbeattyAWS Jan 21, 2025

gcbeattyAWS Jan 21, 2025

gcbeattyAWS Jan 22, 2025 •

edited

Loading

gcbeattyAWS Jan 22, 2025

gcbeattyAWS Jan 22, 2025

		@@ -181,12 +192,50 @@ private bool IsRouteConfigValid(ApiGatewayRouteConfig routeConfig)
		/// <returns>An <see cref="ApiGatewayRouteConfig"/> corresponding to Lambda function with an API Gateway HTTP Method and Path.</returns>
		public ApiGatewayRouteConfig? GetRouteConfig(string httpMethod, string path)

Add happy path for lambda test tool v2 #1934

Add happy path for lambda test tool v2 #1934

Conversation

gcbeattyAWS commented Jan 21, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gcbeattyAWS Jan 21, 2025 • edited Loading

Choose a reason for hiding this comment

gcbeattyAWS Jan 21, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gcbeattyAWS Jan 21, 2025 • edited Loading

Choose a reason for hiding this comment

normj Jan 21, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gcbeattyAWS Jan 22, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gcbeattyAWS commented Jan 21, 2025 •

edited

Loading

gcbeattyAWS Jan 21, 2025 •

edited

Loading

gcbeattyAWS Jan 21, 2025 •

edited

Loading

gcbeattyAWS Jan 21, 2025 •

edited

Loading

normj Jan 21, 2025 •

edited

Loading

gcbeattyAWS Jan 22, 2025 •

edited

Loading