Skip to content

fix: 21634 Check for semver constraint matching in application webhook handler #21648

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.

Sign up for GitHub

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

Merged
crenshaw-dev merged 1 commit into from
Mar 27, 2025
Merged

fix: 21634 Check for semver constraint matching in application webhook handler #21648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions util/webhook/webhook.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (
"strings"
"sync"

"github.com/Masterminds/semver/v3"
"github.com/go-playground/webhooks/v6/azuredevops"
"github.com/go-playground/webhooks/v6/bitbucket"
bitbucketserver "github.com/go-playground/webhooks/v6/bitbucket-server"
Expand Down Expand Up @@ -390,11 +391,33 @@ func sourceRevisionHasChanged(source v1alpha1.ApplicationSource, revision string
targetRevisionHasPrefixList := []string{"refs/heads/", "refs/tags/"}
for _, prefix := range targetRevisionHasPrefixList {
if strings.HasPrefix(source.TargetRevision, prefix) {
return revision == targetRev
return compareRevisions(revision, targetRev)
}
}

return source.TargetRevision == revision
return compareRevisions(revision, source.TargetRevision)
}

func compareRevisions(revision string, targetRevision string) bool {
if revision == targetRevision {
return true
}

// If basic equality checking fails, it might be that the target revision is
// a semver version constraint
constraint, err := semver.NewConstraint(targetRevision)
if err != nil {
// The target revision is not a constraint
return false
}

version, err := semver.NewVersion(revision)
if err != nil {
// The new revision is not a valid semver version, so it can't match the constraint.
return false
}

return constraint.Check(version)
Copy link
Copy Markdown
Contributor Author

@eadred eadred Jan 23, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose in theory this logic could trigger an unnecessary sync if the new tag is not the latest tag that would match the constraint.

For example, if the constraint was "1.1.*", there was already a tag "1.1.5" which the application was already synced to, and somebody introduces (or moves) a tag "1.1.4". A sync would be triggered, but the outcome (as decided by resolveSemverRevision in util/git/client.go) would still be that the application would select the "1.1.5" revision.

However, I doubt this is a circumstance that would happen for any sensible SemVer tagging strategy.

}

func sourceUsesURL(source v1alpha1.ApplicationSource, webURL string, repoRegexp *regexp.Regexp) bool {
Expand Down
7 changes: 7 additions & 0 deletions util/webhook/webhook_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,8 +466,15 @@ func TestAppRevisionHasChanged(t *testing.T) {
{"dev target revision, dev, did not touch head", getSource("dev"), "dev", false, true},
{"refs/heads/dev target revision, master, touched head", getSource("refs/heads/dev"), "master", true, false},
{"refs/heads/dev target revision, dev, did not touch head", getSource("refs/heads/dev"), "dev", false, true},
{"refs/tags/dev target revision, dev, did not touch head", getSource("refs/tags/dev"), "dev", false, true},
{"env/test target revision, env/test, did not touch head", getSource("env/test"), "env/test", false, true},
{"refs/heads/env/test target revision, env/test, did not touch head", getSource("refs/heads/env/test"), "env/test", false, true},
{"refs/tags/env/test target revision, env/test, did not touch head", getSource("refs/tags/env/test"), "env/test", false, true},
{"three/part/rev target revision, rev, did not touch head", getSource("three/part/rev"), "rev", false, false},
{"1.* target revision (matching), 1.1.0, did not touch head", getSource("1.*"), "1.1.0", false, true},
{"refs/tags/1.* target revision (matching), 1.1.0, did not touch head", getSource("refs/tags/1.*"), "1.1.0", false, true},
{"1.* target revision (not matching), 2.0.0, did not touch head", getSource("1.*"), "2.0.0", false, false},
{"1.* target revision, dev (not semver), did not touch head", getSource("1.*"), "dev", false, false},
}

for _, tc := range testCases {
Expand Down