-
Notifications
You must be signed in to change notification settings - Fork 3
[dmt] add webhook configuration annotations lint rule #412
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
Open
diyliv
wants to merge
13
commits into
main
Choose a base branch
from
feature/webhook-config-annotations-lint
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
7e96482
add webhook configuration annotations lint rule
diyliv f602210
add webhook-configuration-annotations to templates linter documentation
diyliv 3a0e45e
change webhook configuration annotations rule to warning level
diyliv a26aa96
make webhook configuration annotations rule configurable via dmtlint.…
diyliv e740e34
document dmtlint.yaml configuration for webhook rule impact level and…
diyliv 900e466
make webhook rule always default to warn, fix config filename in docs
diyliv ce45cea
use standard SetLevel pattern instead of hardcoded warn default
diyliv a64358b
add e2e tests for webhook configuration annotations rule
diyliv b9f5435
mention deploy-dependency before weight, improve Why it matters docs
diyliv 8071db5
fix deploy-dependency prefix match
diyliv ffc4ea0
fix e2e expected message
diyliv 977ed1d
remove ignored from webhook docs
diyliv d4a9cda
fix lint
diyliv File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| /* | ||
| Copyright 2025 Flant JSC | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package rules | ||
|
|
||
| import ( | ||
| "strings" | ||
|
|
||
| "github.com/deckhouse/dmt/pkg" | ||
| "github.com/deckhouse/dmt/pkg/errors" | ||
| ) | ||
|
|
||
| const ( | ||
| WebhookConfigurationRuleName = "webhook-configuration-annotations" | ||
|
|
||
| AnnotationWeight = "werf.io/weight" | ||
| AnnotationDeployDependency = "werf.io/deploy-dependency" | ||
| AnnotationDeployDependencyPrefix = "werf.io/deploy-dependency-" | ||
| ) | ||
|
|
||
| func NewWebhookConfigurationRule(excludeRules []pkg.KindRuleExclude) *WebhookConfigurationRule { | ||
| return &WebhookConfigurationRule{ | ||
| RuleMeta: pkg.RuleMeta{ | ||
| Name: WebhookConfigurationRuleName, | ||
| }, | ||
| KindRule: pkg.KindRule{ | ||
| ExcludeRules: excludeRules, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| type WebhookConfigurationRule struct { | ||
| pkg.RuleMeta | ||
| pkg.KindRule | ||
| } | ||
|
|
||
| // hasDeployDependencyAnnotation checks whether any annotation key starts with | ||
| // "werf.io/deploy-dependency". In practice werf uses suffixed keys such as | ||
| // "werf.io/deploy-dependency-deployment" or "werf.io/deploy-dependency-service", | ||
| // so a prefix match is required instead of an exact key match. | ||
| func hasDeployDependencyAnnotation(annotations map[string]string) bool { | ||
| for key := range annotations { | ||
| if strings.HasPrefix(key, AnnotationDeployDependencyPrefix) { | ||
| return true | ||
| } | ||
| } | ||
|
|
||
| return false | ||
| } | ||
|
|
||
| func (r *WebhookConfigurationRule) ValidateWebhookConfigurationAnnotations(m pkg.Module, errorList *errors.LintRuleErrorsList) { | ||
| errorList = errorList.WithRule(r.GetName()) | ||
|
|
||
| for _, object := range m.GetStorage() { | ||
| kind := object.Unstructured.GetKind() | ||
| if kind != "ValidatingWebhookConfiguration" && kind != "MutatingWebhookConfiguration" { | ||
| continue | ||
| } | ||
|
|
||
| if !r.Enabled(kind, object.Unstructured.GetName()) { | ||
| continue | ||
| } | ||
|
|
||
| annotations := object.Unstructured.GetAnnotations() | ||
|
|
||
| _, hasWeight := annotations[AnnotationWeight] | ||
| hasDeployDependency := hasDeployDependencyAnnotation(annotations) | ||
|
|
||
| if !hasWeight && !hasDeployDependency { | ||
| errorList.WithObjectID(object.Identity()). | ||
| WithFilePath(object.GetPath()). | ||
| Errorf("%s %q must have either %q annotation or an annotation with %q prefix", kind, object.Unstructured.GetName(), AnnotationWeight, AnnotationDeployDependency) | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.