Skip to content
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

fix: handle annotated git tags correctly in repo server cache #21771

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

aali309
Copy link
Contributor

@aali309 aali309 commented Feb 4, 2025

When using annotated git tags with auto-sync enabled but self-heal disabled, manual changes were getting reverted. This was happening because the repo server cache wasn't handling annotated tags correctly.

Fixes: #21548

See #20082 for detailed description of what caused the regression, but TL;DR: this behaviour is currently present in v2.11.x, v2.12.x, v2.13.x and current master

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • [x ] I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

Copy link

bunnyshell bot commented Feb 4, 2025

🔴 Preview Environment stopped on Bunnyshell

See: Environment Details | Pipeline Logs

Available commands (reply to this comment):

  • 🔵 /bns:start to start the environment
  • 🚀 /bns:deploy to redeploy the environment
  • /bns:delete to remove the environment

Copy link

codecov bot commented Feb 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.72%. Comparing base (feb7097) to head (d44ccca).

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #21771      +/-   ##
==========================================
+ Coverage   55.71%   55.72%   +0.01%     
==========================================
  Files         341      341              
  Lines       57002    57006       +4     
==========================================
+ Hits        31756    31764       +8     
+ Misses      22601    22599       -2     
+ Partials     2645     2643       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@aali309 aali309 force-pushed the self_heal branch 2 times, most recently from 964f4f8 to 3e5b8c9 Compare February 7, 2025 16:34
@aali309 aali309 marked this pull request as ready for review February 7, 2025 16:35
@aali309 aali309 requested a review from a team as a code owner February 7, 2025 16:35
@aali309 aali309 force-pushed the self_heal branch 5 times, most recently from 519e768 to 20430c0 Compare February 13, 2025 00:16
assert.Equal(t, tagRef.Name(), resolvedRef.Name())
}

func resolveTagReference(tagRef *plumbing.Reference, commitHash plumbing.Hash) *plumbing.Reference {
Copy link
Contributor

@anandf anandf Feb 14, 2025

Choose a reason for hiding this comment

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

De we need this separate test helper method ? All it does is wrap a function call.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This can be removed.

image: quay.io/argoprojlabs/argocd-e2e-container:0.1
ports:
- containerPort: 80
- name: nginx
Copy link
Contributor

Choose a reason for hiding this comment

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

this formatting change may not be required.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, this is default Cursor app behaviour!

@@ -90,3 +98,79 @@ func TestGitSemverResolutionUsingConstraintWithLeadingZero(t *testing.T) {
Expect(SyncStatusIs(SyncStatusCodeSynced)).
Expect(Pod(func(p corev1.Pod) bool { return strings.HasPrefix(p.Name, "new-app") }))
}

func TestAnnotatedTagInStatusSyncRevision(t *testing.T) {
Copy link
Member

Choose a reason for hiding this comment

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

  • Your E2E tests are not currently correctly testing the failing case, AFAICT.
  • Notice that if you comment out your fix in this PR (e.g. you remove the changes in workaround.go), that those E2E tests still pass.
    • Since the fix has been removed, obviously the tests should fail. If they don't, that means the tests aren't testing what we think they are.
    • The tests in my original E2E test branch do not exhibit this behaviour, if you want to use those as originally constructed.

Signed-off-by: Atif Ali <[email protected]>

added e2e test

Signed-off-by: Atif Ali <[email protected]>

updated e2e tests

Signed-off-by: Atif Ali <[email protected]>

add unit test and linter fix

Signed-off-by: Atif Ali <[email protected]>
…t fetched

Signed-off-by: Atif Ali <[email protected]>

added tests

Signed-off-by: Atif Ali <[email protected]>
Signed-off-by: Atif Ali <[email protected]>
Signed-off-by: Atif Ali <[email protected]>
Signed-off-by: Atif Ali <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Regression: Application targetting an annotated tag will self heal, even when self-healing is disabled.
3 participants