-
Notifications
You must be signed in to change notification settings - Fork 5
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.
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
(MINOR) improve R53 AssertHostedZoneExists
func
#20
Conversation
This makes the function naming more consistent with that of `AssertRecordExistsInHostedZone` as was originally suggested here: #15 (comment) > I think this would be better named as AssertRecordExistsInHostedZone, since route53 is already part of the package name.
It appears this was incorrectly implemented: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/route53#Client.ListHostedZonesByName
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved. Agreed that this doesn't need to be a major version bump, especially since we are still in 0.x
versions so there shouldn't be a hard expectation of interface stability yet.
Hmm... you appear to be correct, perhaps I was not fully ☕ 'd up that day. Given the pattern established with the EC2 methods, I agree that the methods here should likely include |
Per discussion, it seems the inclusion of `*Route53*` is perhaps best for consistency's sake: #20 (comment)
@yardbirdsax Thanks for the feedback. I've pushed another commit such that both Route53 assertion functions include |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Please just call out the changes in a ## CHANGES
section in the extended description of your merge commit, and include (MINOR)
in your main title. You can check the last commit for an example. Thanks for the work!
AssertHostedZoneExists
funcAssertHostedZoneExists
func
SUMMARY
AssertRoute53HostedZoneExists
toAssertHostedZoneExists
-- and therefore, in theory, introduces a breaking change -- I don't believe the originalAssertRoute53HostedZoneExists
was functioning properly due to issue Route53Client does not correctly implement ListHostedZonesByName #19 ~DEVELOPER IMPACT
While this does change the method name from
AssertRoute53HostedZoneExists
toAssertHostedZoneExists
-- and therefore, in theory, introduces a breaking change -- I don't believe the originalAssertRoute53HostedZoneExists
was functioning properly due to issue #19Contribution Checklist
Discussion question
This PR changes the func name from
AssertRoute53HostedZoneExists
toAssertHostedZoneExists
, as per PR 15 discussion:However, I believe ☝️ is not quite correct.
route53
is not actually part of the package name, if I understand correctly. The package name isaws
. So, should the func names include*Route53*
or not? As a frame of reference, the EC2-related funcs do appear to include*EC2*
in their names: https://github.com/HBOCodeLabs/infratest/blob/main/pkg/aws/ec2.go#L57Update: I've changed both Route53 assertion functions to include
*Route53*
in their name, as is consistent with the otherinfratest
functions.