Mocking AWS Calls for Unit Testing for API Gateway #497
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ellisonc
reviewed
Jul 13, 2023
| @@ -68,6 +68,7 @@ type ResourceType struct { | |||
|
|
|||
| type FilterRule struct { | |||
| NamesRegExp []Expression `yaml:"names_regex"` | |||
| // TODO(james): consider adding time filter rule here instead of passing in as function argument in other place. | |||
There was a problem hiding this comment.
I like this todo idea, it always seemed weird how that got tossed into ever function call
ellisonc
approved these changes
Jul 13, 2023
denis256
reviewed
Jul 13, 2023
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func GetTestSession(t *testing.T, approvedRegions []string, forbiddenRegions []string) *session.Session { |
There was a problem hiding this comment.
Hm, maybe I miss something, but the function GetTestSession() is not invoked in any place
There was a problem hiding this comment.
I modified the implementation a bit afterward. It's no longer being used. Will delete it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Making changes in code to have proper unit testing without calling AWS API - https://aws.amazon.com/blogs/developer/mocking-out-then-aws-sdk-for-go-for-unit-testing/.
Currently, we call AWS API within unit tests and it causes several problems:
Also, I believe we can reduce the code inside
GetAllResourcesfunction significantly with the new pattern of encapsulating "get resource" logic inside the ResourceType. Afterall, a better name forResourceTypewould be justResourcebut will make changes incrementally once this change looks good for everyone.Tackling issue: #494
TODOs
Read the Gruntwork contribution guidelines.
nuke_sandboxandnuke_phxdevopsjobs in.circleci/config.ymlhave been updated with appropriate exclusions (either directly in the job or via the.circleci/nuke_config.ymlfile) to prevent nuking IAM roles, groups, resources, etc that are important for the test accounts.Release Notes (draft)
Added / Removed / Updated [X].
Updated [Mocking AWS Calls for Unit Testing for API Gateway]
Migration Guide