fix: validate unique names for monitors #666
Draft
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
…ent missing parameters in existing calls to makeMockReq
mjnagel
reviewed
Aug 15, 2024
mjnagel
reviewed
Aug 15, 2024
…or array to test mocks
mjnagel
reviewed
Aug 21, 2024
Comment on lines
+150
to
+152
| const monitorName = sanitizeResourceName( | ||
| monitor.description || `${Object.values(monitor.selector)}-${monitor.portName}`, | ||
| ); |
There was a problem hiding this comment.
Realized in retrospect we could just import generateMonitorName and use that here to ensure we keep this logic in sync with our name generation rather than duplicating.
| // Ensure serviceMonitors use a unique description or selector/portName used for generating the resource name | ||
| const monitorNames = new Set<string>(); | ||
|
|
||
| for (const monitor of monitors) { |
There was a problem hiding this comment.
Didn't think about this before but I think there's another edge case where podmonitors and servicemonitors should be allowed to have overlapping names, but this would deny them. We may need separate sets per type and check the kind in this loop.
Comment on lines
+155
to
+157
| return req.Deny( | ||
| `A serviceMonitor resource generated from the Package, ${pkg.metadata?.name} contains a duplicate name, please provide a unique description for each item in the monitor array`, | ||
| ); |
There was a problem hiding this comment.
nit: might be good to align this with the wording we use for the VirtualService check, and make sure we are capturing kind accurately here (pod vs svc monitor).
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
Added a new piece to the pepr operator's validator function. The new functionality loops through the Package CR's monitor array, adding each description field (or a dummy string in the event of no provided description) to a set, failing given a duplicate.
The sanitizeResourceName() function was used in the validator since its also used downstream to create the ServiceMonitor resource name based on the string from the monitor.description field.
...
Related Issue
Fixes #656
Type of change
Checklist before merging