APIGW: fix TestInvokeMethod path logic #13030

bentsku · 2025-08-19T17:58:43Z

Motivation

We got a report that the TestInvokeMethod would not work when the pathWithQueryString was not provided. After testing in AWS, it showed that this parameter was not required and this was an assumption that stayed from the previous implementation.

This PR implements more tests around this parameter and the behavior of AWS when it is not provided.

It also showed AWS is not sending the same log response when the integration is of type MOCK.

I took the opportunity to refactor a bit the utilities we have around TestInvokeMethod, because it is quite tricky to snapshot match as it returns a big string with newlines that we would like to snapshot match more precisely.

Changes

fix the behavior of TestInvokeMethod when pathWithQueryString is not provided: it will fallback to the Resource path value
fix the behavior when it cannot extract the path parameters from the provided path: it won't fail but silently set the path parameters to an empty map
add a new log template for MOCK integration, this should probably be revisited at some point
improve the existing tests and add more cases
refactor the test utilities
remove overly verbose stack trace logging when debug is enabled when we don't match a route in API Gateway REST API router

bentsku · 2025-08-19T17:59:03Z

localstack-core/localstack/services/apigateway/next_gen/execute_api/test_invoke.py


    # we do not need a true HTTP request for the context, as we are skipping all the parsing steps and using the
    # provider data
    invocation_context = RestApiInvocationContext(
        request=Request(method=http_method),
    )
-    path_query = test_request.get("pathWithQueryString", "/").split("?")
+    test_request_path = test_request.get("pathWithQueryString") or resource_path


this single line is effectively the fix for it

bentsku · 2025-08-19T17:59:30Z

localstack-core/localstack/services/apigateway/next_gen/execute_api/test_invoke.py

+    try:
+        # this is AWS behavior, it will accept any value for the `pathWithQueryString`, even if it doesn't match
+        # the expected format. It will just fall back to no value if it cannot parse the path parameters out of it
+        _, path_parameters = RestAPIResourceRouter(deployment).match(invocation_context)
+    except Exception:
+        path_parameters = {}


this is also part of the fix, due to the ability to pass invalid values, but it was not strictly needed for the sample to work

github-actions · 2025-08-19T18:09:26Z

Test Results - Preflight, Unit

22 144 tests ±0 20 407 ✅ ±0 6m 19s ⏱️ -3s
1 suites ±0 1 737 💤 ±0
1 files ±0 0 ❌ ±0

Results for commit 12c143c. ± Comparison against base commit 3f463b5.

♻️ This comment has been updated with latest results.

github-actions · 2025-08-19T18:13:47Z

LocalStack Community integration with Pro

2 files ± 0 2 suites ±0 18m 16s ⏱️ - 1h 25m 44s
1 159 tests - 3 474 1 091 ✅ - 3 102 68 💤 - 372 0 ❌ ±0
1 161 runs - 3 474 1 091 ✅ - 3 102 70 💤 - 372 0 ❌ ±0

Results for commit 12c143c. ± Comparison against base commit 3f463b5.

This pull request removes 3474 tests.

tests.aws.scenario.bookstore.test_bookstore.TestBookstoreApplication ‑ test_lambda_dynamodb
tests.aws.scenario.bookstore.test_bookstore.TestBookstoreApplication ‑ test_opensearch_crud
tests.aws.scenario.bookstore.test_bookstore.TestBookstoreApplication ‑ test_search_books
tests.aws.scenario.bookstore.test_bookstore.TestBookstoreApplication ‑ test_setup
tests.aws.scenario.kinesis_firehose.test_kinesis_firehose.TestKinesisFirehoseScenario ‑ test_kinesis_firehose_s3
tests.aws.scenario.lambda_destination.test_lambda_destination_scenario.TestLambdaDestinationScenario ‑ test_destination_sns
tests.aws.scenario.lambda_destination.test_lambda_destination_scenario.TestLambdaDestinationScenario ‑ test_infra
tests.aws.scenario.loan_broker.test_loan_broker.TestLoanBrokerScenario ‑ test_prefill_dynamodb_table
tests.aws.scenario.loan_broker.test_loan_broker.TestLoanBrokerScenario ‑ test_stepfunctions_input_recipient_list[step_function_input0-SUCCEEDED]
tests.aws.scenario.loan_broker.test_loan_broker.TestLoanBrokerScenario ‑ test_stepfunctions_input_recipient_list[step_function_input1-SUCCEEDED]
…

♻️ This comment has been updated with latest results.

github-actions · 2025-08-19T18:18:09Z

Test Results (amd64) - Acceptance

7 tests ±0 5 ✅ ±0 3m 6s ⏱️ -1s
1 suites ±0 2 💤 ±0
1 files ±0 0 ❌ ±0

Results for commit 12c143c. ± Comparison against base commit 3f463b5.

♻️ This comment has been updated with latest results.

github-actions · 2025-08-19T18:23:00Z

Test Results (amd64) - Integration, Bootstrap

5 files 5 suites 35m 13s ⏱️
1 183 tests 1 116 ✅ 67 💤 0 ❌
1 189 runs 1 116 ✅ 73 💤 0 ❌

Results for commit 12c143c.

♻️ This comment has been updated with latest results.

joe4dev

Thank you for the thorough parity improvements 🚀

joe4dev · 2025-08-19T18:13:49Z

localstack-core/localstack/services/apigateway/next_gen/execute_api/test_invoke.py

+        # this is AWS behavior, it will accept any value for the `pathWithQueryString`, even if it doesn't match
+        # the expected format. It will just fall back to no value if it cannot parse the path parameters out of it
+        _, path_parameters = RestAPIResourceRouter(deployment).match(invocation_context)
+    except Exception:


Are we ok swalling the exception here, or are there scenarios where debug logs would be necessary to understand a bug in .match?

Yes, I thought we're fine, the routing step is already done and we're using it only to extract the path parameters. As the input can be anything, any error could surface. I was thinking about adding debug logs, but I wasn't sure it would be very useful. But maybe just a warning for user could still be useful somehow 🤔 I'll add something

joe4dev · 2025-08-19T18:14:54Z

localstack-core/localstack/services/apigateway/next_gen/execute_api/test_invoke.py

@@ -45,6 +45,19 @@
 {formatted_date} : Method completed with status: {method_response_status}
 """

+TEST_INVOKE_TEMPLATE_MOCK = """Execution log for request {request_id}


praise: neat detail considering these verbose mock logs ✨

joe4dev · 2025-08-19T18:17:18Z

tests/aws/services/apigateway/conftest.py

+
+    # we want to do very precise matching on the log, and splitting on new lines will help in case the snapshot
+    # fails
+    # the snapshot library does not allow to ignore an array index as the last node, so we need to put it in a dict


FYI: @tiurin snapshot library limitation to consider tracking

This was copy-pasted from the previous utility, I actually fixed that issue with localstack/localstack-snapshot#16 but we don't yet have a release of localstack-snapshot 😅 soon I'll update these!

joe4dev · 2025-08-19T18:19:51Z

tests/aws/services/apigateway/test_apigateway_api.py

+            target_resource_id=resource_id,
+            method="GET",
+        )
+        # assert "HTTP Method: GET, Resource Path: /pets/123" in response["log"]


nit: Is this comment intentional (same below)?

Ah, good catch! I'll update them, I think I had the case once that the snapshots were not exactly what I was expecting from AWS, so those made sure that we got what we wanted. Will update them 👍

bentsku added 2 commits August 19, 2025 19:52

update test utility around TestInvokeMethod

961be57

fix TestInvokeMethod to fallback to resource path

39dde0a

bentsku added this to the 4.8 milestone Aug 19, 2025

bentsku self-assigned this Aug 19, 2025

bentsku added aws:apigateway Amazon API Gateway semver: patch Non-breaking changes which can be included in patch releases labels Aug 19, 2025

bentsku commented Aug 19, 2025

View reviewed changes

joe4dev approved these changes Aug 19, 2025

View reviewed changes

address PR comments

12c143c

bentsku marked this pull request as ready for review August 19, 2025 21:31

bentsku requested a review from cloutierMat as a code owner August 19, 2025 21:31

bentsku merged commit 7b9533a into main Aug 19, 2025
42 of 44 checks passed

bentsku deleted the apigw/fix-test-invoke branch August 19, 2025 22:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

APIGW: fix TestInvokeMethod path logic #13030

APIGW: fix TestInvokeMethod path logic #13030

Uh oh!

bentsku commented Aug 19, 2025 •

edited

Loading

Uh oh!

bentsku Aug 19, 2025

Uh oh!

bentsku Aug 19, 2025

Uh oh!

github-actions bot commented Aug 19, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Aug 19, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Aug 19, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Aug 19, 2025 •

edited

Loading

Uh oh!

joe4dev left a comment

Uh oh!

joe4dev Aug 19, 2025

Uh oh!

bentsku Aug 19, 2025

Uh oh!

joe4dev Aug 19, 2025

Uh oh!

joe4dev Aug 19, 2025

Uh oh!

bentsku Aug 19, 2025 •

edited

Loading

Uh oh!

joe4dev Aug 19, 2025

Uh oh!

bentsku Aug 19, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

APIGW: fix TestInvokeMethod path logic #13030

APIGW: fix TestInvokeMethod path logic #13030

Uh oh!

Conversation

bentsku commented Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Changes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results - Preflight, Unit

Uh oh!

github-actions bot commented Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

LocalStack Community integration with Pro

Uh oh!

github-actions bot commented Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results (amd64) - Acceptance

Uh oh!

github-actions bot commented Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results (amd64) - Integration, Bootstrap

Uh oh!

joe4dev left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bentsku Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bentsku commented Aug 19, 2025 •

edited

Loading

github-actions bot commented Aug 19, 2025 •

edited

Loading

github-actions bot commented Aug 19, 2025 •

edited

Loading

github-actions bot commented Aug 19, 2025 •

edited

Loading

github-actions bot commented Aug 19, 2025 •

edited

Loading

bentsku Aug 19, 2025 •

edited

Loading