Add validation for apigw creation with no routes #16649
Merged
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
jm96441n
reviewed
Mar 16, 2023
| @@ -769,6 +770,9 @@ func (e *APIGatewayConfigEntry) Validate() error { | |||
| return err | |||
| } | |||
|
|
|||
| if len(e.Listeners) == 0 { | |||
| return errors.New("api gateway must have at least one listener") | |||
There was a problem hiding this comment.
minor (and more stylistic than anything and not blocking), would we want to use a sentinel error here so callers could act on the error type in the future?
There was a problem hiding this comment.
So I don't feel like that matches the way the other validations are handled, but I'm also realizing I didn't follow that way either. Ex: https://github.com/hashicorp/consul/blob/main/agent/structs/config_entry_gateways.go#L803
I do think that is probably a good idea for the future though
There was a problem hiding this comment.
Especially because I think it sends a 500 error back right now
missylbytes
added
the
backport/1.15
t-eckert
approved these changes
Mar 20, 2023
mikemorris
approved these changes
Mar 20, 2023
3 tasks
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
To meet the standard (Gateways require at least one listener defined) we need to add checks in to verify that at least one listener is defined.
Testing & Reproduction steps
Open another terminal, create a file called gateway.hcl with the following content:
After creating the file, run the following command in the same terminal:
This should error out, saying "api gateway must have at least one listener"
PR Checklist