From 681ddd5db0d60ccdca768492141d8a34ca978675 Mon Sep 17 00:00:00 2001 From: Michael Bridgen Date: Wed, 31 Mar 2021 09:41:28 +0100 Subject: [PATCH] Test RecurseSubmodules This commit adds a test specifically for RecurseSubmodules. It takes a bit more preparation, since it needs a repo using submodules to start with. go-git doesn't appear to support adding submodules programmatically, so the preparation is done in part by execing `git`. Signed-off-by: Michael Bridgen --- controllers/gitrepository_controller_test.go | 142 ++++++++++++++++++- controllers/suite_test.go | 7 +- 2 files changed, 144 insertions(+), 5 deletions(-) diff --git a/controllers/gitrepository_controller_test.go b/controllers/gitrepository_controller_test.go index 38343e62..411a2bb2 100644 --- a/controllers/gitrepository_controller_test.go +++ b/controllers/gitrepository_controller_test.go @@ -20,10 +20,13 @@ import ( "context" "crypto/tls" "fmt" + "io/ioutil" "net/http" "net/url" "os" + "os/exec" "path" + "path/filepath" "strings" "time" @@ -42,9 +45,10 @@ import ( metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/types" - "github.com/fluxcd/pkg/gittestserver" - "github.com/fluxcd/pkg/apis/meta" + "github.com/fluxcd/pkg/gittestserver" + "github.com/fluxcd/pkg/untar" + sourcev1 "github.com/fluxcd/source-controller/api/v1beta1" ) @@ -136,8 +140,6 @@ var _ = Describe("GitRepositoryReconciler", func() { }}) Expect(err).NotTo(HaveOccurred()) - gitrepo.Worktree() - for _, ref := range t.createRefs { hRef := plumbing.NewHashReference(plumbing.ReferenceName(ref), commit) err = gitrepo.Storer.SetReference(hRef) @@ -410,5 +412,137 @@ var _ = Describe("GitRepositoryReconciler", func() { gitImplementation: sourcev1.GoGitImplementation, }), ) + + Context("recurse submodules", func() { + It("downloads submodules when asked", func() { + Expect(gitServer.StartHTTP()).To(Succeed()) + defer gitServer.StopHTTP() + + u, err := url.Parse(gitServer.HTTPAddress()) + Expect(err).NotTo(HaveOccurred()) + + subRepoURL := *u + subRepoURL.Path = path.Join(u.Path, fmt.Sprintf("subrepository-%s.git", randStringRunes(5))) + + // create the git repo to use as a submodule + fs := memfs.New() + subRepo, err := git.Init(memory.NewStorage(), fs) + Expect(err).NotTo(HaveOccurred()) + + wt, err := subRepo.Worktree() + Expect(err).NotTo(HaveOccurred()) + + ff, _ := fs.Create("fixture") + _ = ff.Close() + _, err = wt.Add(fs.Join("fixture")) + Expect(err).NotTo(HaveOccurred()) + + _, err = wt.Commit("Sample", &git.CommitOptions{Author: &object.Signature{ + Name: "John Doe", + Email: "john@example.com", + When: time.Now(), + }}) + Expect(err).NotTo(HaveOccurred()) + + remote, err := subRepo.CreateRemote(&config.RemoteConfig{ + Name: "origin", + URLs: []string{subRepoURL.String()}, + }) + Expect(err).NotTo(HaveOccurred()) + + err = remote.Push(&git.PushOptions{ + RefSpecs: []config.RefSpec{"refs/heads/*:refs/heads/*", "refs/tags/*:refs/tags/*"}, + }) + Expect(err).NotTo(HaveOccurred()) + + // this one is linked to a real directory, so that I can + // exec `git submodule add` later + tmp, err := ioutil.TempDir("", "flux-test") + Expect(err).NotTo(HaveOccurred()) + defer os.RemoveAll(tmp) + + repoDir := filepath.Join(tmp, "git") + repo, err := git.PlainInit(repoDir, false) + Expect(err).NotTo(HaveOccurred()) + + wt, err = repo.Worktree() + Expect(err).NotTo(HaveOccurred()) + _, err = wt.Commit("Initial revision", &git.CommitOptions{ + Author: &object.Signature{ + Name: "John Doe", + Email: "john@example.com", + When: time.Now(), + }}) + Expect(err).NotTo(HaveOccurred()) + + submodAdd := exec.Command("git", "submodule", "add", "-b", "master", subRepoURL.String(), "sub") + submodAdd.Dir = repoDir + out, err := submodAdd.CombinedOutput() + os.Stdout.Write(out) + Expect(err).NotTo(HaveOccurred()) + + _, err = wt.Commit("Add submodule", &git.CommitOptions{ + Author: &object.Signature{ + Name: "John Doe", + Email: "john@example.com", + When: time.Now(), + }}) + Expect(err).NotTo(HaveOccurred()) + + mainRepoURL := *u + mainRepoURL.Path = path.Join(u.Path, fmt.Sprintf("repository-%s.git", randStringRunes(5))) + remote, err = repo.CreateRemote(&config.RemoteConfig{ + Name: "origin", + URLs: []string{mainRepoURL.String()}, + }) + Expect(err).NotTo(HaveOccurred()) + + err = remote.Push(&git.PushOptions{ + RefSpecs: []config.RefSpec{"refs/heads/*:refs/heads/*", "refs/tags/*:refs/tags/*"}, + }) + Expect(err).NotTo(HaveOccurred()) + + key := types.NamespacedName{ + Name: fmt.Sprintf("git-ref-test-%s", randStringRunes(5)), + Namespace: namespace.Name, + } + created := &sourcev1.GitRepository{ + ObjectMeta: metav1.ObjectMeta{ + Name: key.Name, + Namespace: key.Namespace, + }, + Spec: sourcev1.GitRepositorySpec{ + URL: mainRepoURL.String(), + Interval: metav1.Duration{Duration: indexInterval}, + Reference: &sourcev1.GitRepositoryRef{Branch: "master"}, + GitImplementation: sourcev1.GoGitImplementation, // only works with go-git + RecurseSubmodules: true, + }, + } + Expect(k8sClient.Create(context.Background(), created)).Should(Succeed()) + defer k8sClient.Delete(context.Background(), created) + + got := &sourcev1.GitRepository{} + Eventually(func() bool { + _ = k8sClient.Get(context.Background(), key, got) + for _, c := range got.Status.Conditions { + if c.Reason == sourcev1.GitOperationSucceedReason { + return true + } + } + return false + }, timeout, interval).Should(BeTrue()) + + // check that the downloaded artifact includes the + // file from the submodule + res, err := http.Get(got.Status.URL) + Expect(err).NotTo(HaveOccurred()) + Expect(res.StatusCode).To(Equal(http.StatusOK)) + + _, err = untar.Untar(res.Body, filepath.Join(tmp, "tar")) + Expect(err).NotTo(HaveOccurred()) + Expect(filepath.Join(tmp, "tar", "sub", "fixture")).To(BeAnExistingFile()) + }) + }) }) }) diff --git a/controllers/suite_test.go b/controllers/suite_test.go index 8bba7889..0dd4351a 100644 --- a/controllers/suite_test.go +++ b/controllers/suite_test.go @@ -19,6 +19,7 @@ package controllers import ( "io/ioutil" "math/rand" + "net/http" "os" "path/filepath" "testing" @@ -99,8 +100,12 @@ var _ = BeforeSuite(func(done Done) { tmpStoragePath, err := ioutil.TempDir("", "source-controller-storage-") Expect(err).NotTo(HaveOccurred(), "failed to create tmp storage dir") - storage, err = NewStorage(tmpStoragePath, "localhost", time.Second*30) + storage, err = NewStorage(tmpStoragePath, "localhost:5050", time.Second*30) Expect(err).NotTo(HaveOccurred(), "failed to create tmp storage") + // serve artifacts from the filesystem, as done in main.go + fs := http.FileServer(http.Dir(tmpStoragePath)) + http.Handle("/", fs) + go http.ListenAndServe(":5050", nil) k8sManager, err = ctrl.NewManager(cfg, ctrl.Options{ Scheme: scheme.Scheme,