forked from GoogleContainerTools/kpt-config-sync
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
test: add a test to confirm the git-sync not pulling latest issue
`git-sync` v4.1.0 couldn't pull the latest commit from a branch when the branch has multiple remotes and the branch in different remotes are out of sync. This commit adds a test to confirm the behavior. A subsequent commit will update git-sync to v4.2.0 to fix this issue.
- Loading branch information
Showing
2 changed files
with
90 additions
and
5 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| // Copyright 2024 Google LLC | ||
| // | ||
| // 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 e2e | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| corev1 "k8s.io/api/core/v1" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| "kpt.dev/configsync/e2e/nomostest" | ||
| "kpt.dev/configsync/e2e/nomostest/gitproviders" | ||
| nomostesting "kpt.dev/configsync/e2e/nomostest/testing" | ||
| "kpt.dev/configsync/pkg/api/configmanagement" | ||
| "kpt.dev/configsync/pkg/api/configsync" | ||
| "kpt.dev/configsync/pkg/testing/fake" | ||
| ) | ||
|
|
||
| func TestMultipleRemoteBranchesOutOfSync(t *testing.T) { | ||
| nt := nomostest.New(t, nomostesting.ACMController) | ||
|
|
||
| rs := fake.RootSyncObjectV1Beta1(configsync.RootSyncName) | ||
| if err := nt.KubeClient.Get(configsync.RootSyncName, configmanagement.ControllerNamespace, rs); err != nil { | ||
| nt.T.Fatal(err) | ||
| } | ||
| initialSyncedCommit := rs.Status.LastSyncedCommit | ||
|
|
||
| nt.T.Log("Create an extra remote tracking branch") | ||
| nt.Must(nt.RootRepos[configsync.RootSyncName].Push("HEAD:refs/remotes/upstream/main")) | ||
| nt.T.Cleanup(func() { | ||
| // Delete the remote tracking branch in the end so other subsequent tests | ||
| // can pull from the latest commit, instead of the HEAD of the remote. | ||
| nt.Must(nt.RootRepos[configsync.RootSyncName].Push(":refs/remotes/upstream/main")) | ||
| }) | ||
|
|
||
| nt.T.Logf("Update the remote main branch by adding a test namespace") | ||
| nt.Must(nt.RootRepos[configsync.RootSyncName].Add("acme/namespaces/hello/ns.yaml", fake.NamespaceObject("hello"))) | ||
| nt.Must(nt.RootRepos[configsync.RootSyncName].CommitAndPush("add Namespace")) | ||
|
|
||
| nt.T.Logf("Mitigation: set spec.git.branch to HEAD to pull the latest commit") | ||
| nomostest.SetGitBranch(nt, configsync.RootSyncName, "HEAD") | ||
| // WatchForAllSyncs validates RootSync's lastSyncedCommit is updated to the | ||
| // local HEAD with the DefaultRootSha1Fn function. | ||
| if err := nt.WatchForAllSyncs(); err != nil { | ||
| nt.T.Fatal(err) | ||
| } | ||
| if err := nt.Validate("hello", "", &corev1.Namespace{}); err != nil { | ||
| nt.T.Fatal(err) | ||
| } | ||
|
|
||
| // Apply the mitigation first to validate Config Sync couldn't pull the latest commit. | ||
| nt.T.Logf("Verify the issue exist with the default branch and revision") | ||
| nomostest.SetGitBranch(nt, configsync.RootSyncName, gitproviders.MainBranch) | ||
| if err := nt.WatchForAllSyncs(nomostest.WithRootSha1Func( | ||
| // DefaultRootSha1Fn returns the hash with `git rev-parse HEAD`, which is | ||
| // different from `git ls-remote ...` | ||
| // So, overwrite the root hash with the initial lastSyncedCommit. | ||
| func(_ *nomostest.NT, _ types.NamespacedName) (string, error) { | ||
| return initialSyncedCommit, nil | ||
| })); err != nil { | ||
| nt.T.Fatal(err) | ||
| } | ||
| if err := nt.ValidateNotFound("hello", "", &corev1.Namespace{}); err != nil { | ||
| nt.T.Fatal(err) | ||
| } | ||
| } |