Use sourcev1.GitRepositoryRef

This changes the API so that the checkout field has a ref, the same as
GItRepository. This means you can check out a branch or a tag or a
particular commit. Most of these won't work unless you supply a branch
to push to as well.

An addtional change is that you can leave out the checkout altogether,
and the ref will default to that given in the GitRepository, or its
default. In the latter case, again you will need to provide a push
branch.

Signed-off-by: Michael Bridgen <[email protected]>

Author: squaremo

api/go.mod

@@ -4,6 +4,7 @@ go 1.15
 
 require (
 	github.com/fluxcd/pkg/apis/meta v0.8.0
+	github.com/fluxcd/source-controller/api v0.10.0
 	k8s.io/apimachinery v0.20.2
 	sigs.k8s.io/controller-runtime v0.8.3
 )

api/go.sum

@@ -90,6 +90,8 @@ github.com/evanphx/json-patch v4.9.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLi
 github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
 github.com/fluxcd/pkg/apis/meta v0.8.0 h1:wqWpUsxhKHB1ZztcvOz+vnyhdKW9cWmjFp8Vci/XOdk=
 github.com/fluxcd/pkg/apis/meta v0.8.0/go.mod h1:yHuY8kyGHYz22I0jQzqMMGCcHViuzC/WPdo9Gisk8Po=
+github.com/fluxcd/source-controller/api v0.10.0 h1:Mu4cAXtZ7yq/rIrab81q1jbbhWwUxxAZ2R5bZ1m8AxE=
+github.com/fluxcd/source-controller/api v0.10.0/go.mod h1:Vuw+7UqEUUOdkKBfTUPHwaQgbn6LL2FwqPDx2UAk7NE=
 github.com/form3tech-oss/jwt-go v3.2.2+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k=
 github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
 github.com/fsnotify/fsnotify v1.4.9 h1:hsms1Qyu0jgnwNXIxa+/V/PDsU6CfLf6CNO8H7IWoS4=

api/v1alpha2/git.go

@@ -18,31 +18,32 @@ package v1alpha2
 
 import (
 	"github.com/fluxcd/pkg/apis/meta"
+	sourcev1 "github.com/fluxcd/source-controller/api/v1beta1"
 )
 
 type GitSpec struct {
 	// Checkout gives the parameters for cloning the git repository,
-	// ready to make changes.
-	// +required
-	Checkout GitCheckoutSpec `json:"checkout"`
+	// ready to make changes. If not present, the `spec.ref` field from the
+	// referenced `GitRepository` or its default will be used.
+	// +optional
+	Checkout *GitCheckoutSpec `json:"checkout,omitempty"`
 
 	// Commit specifies how to commit to the git repository.
 	// +required
 	Commit CommitSpec `json:"commit"`
 
 	// Push specifies how and where to push commits made by the
 	// automation. If missing, commits are pushed (back) to
-	// `.spec.checkout.branch`.
+	// `.spec.checkout.branch` or its default.
 	// +optional
 	Push *PushSpec `json:"push,omitempty"`
 }
 
 type GitCheckoutSpec struct {
-	// Ref gives the branch to clone from the git repository. If
-	// `.spec.push` is not supplied, commits will also be pushed to
-	// this branch.
+	// Reference gives a branch, tag or commit to clone from the Git
+	// repository.
 	// +required
-	Branch string `json:"branch"`
+	Reference sourcev1.GitRepositoryRef `json:"ref"`
 }
 
 // CommitSpec specifies how to commit changes to the git repository

api/v1alpha2/zz_generated.deepcopy.go

@@ -279,15 +279,33 @@ spec:
                 properties:
                   checkout:
                     description: Checkout gives the parameters for cloning the git
-                      repository, ready to make changes.
+                      repository, ready to make changes. If not present, the `spec.ref`
+                      field from the referenced `GitRepository` or its default will
+                      be used.
                     properties:
-                      branch:
-                        description: Ref gives the branch to clone from the git repository.
-                          If `.spec.push` is not supplied, commits will also be pushed
-                          to this branch.
-                        type: string
+                      ref:
+                        description: Reference gives a branch, tag or commit to clone
+                          from the Git repository.
+                        properties:
+                          branch:
+                            default: master
+                            description: The Git branch to checkout, defaults to master.
+                            type: string
+                          commit:
+                            description: The Git commit SHA to checkout, if specified
+                              Tag filters will be ignored.
+                            type: string
+                          semver:
+                            description: The Git tag semver expression, takes precedence
+                              over Tag.
+                            type: string
+                          tag:
+                            description: The Git tag to checkout, takes precedence
+                              over Branch.
+                            type: string
+                        type: object
                     required:
-                    - branch
+                    - ref
                     type: object
                   commit:
                     description: Commit specifies how to commit to the git repository.
@@ -335,7 +353,7 @@ spec:
                   push:
                     description: Push specifies how and where to push commits made
                       by the automation. If missing, commits are pushed (back) to
-                      `.spec.checkout.branch`.
+                      `.spec.checkout.branch` or its default.
                     properties:
                       branch:
                         description: Branch specifies that commits should be pushed
@@ -346,7 +364,6 @@ spec:
                     - branch
                     type: object
                 required:
-                - checkout
                 - commit
                 type: object
               interval:

config/crd/bases/image.toolkit.fluxcd.io_imageupdateautomations.yaml

@@ -179,6 +179,27 @@ func (r *ImageUpdateAutomationReconciler) Reconcile(ctx context.Context, req ctr
 
 	log.V(debug).Info("found git repository", "gitrepository", originName)
 
+	// validate the git spec and default any values needed later, before proceeding
+	var ref *sourcev1.GitRepositoryRef
+	if gitSpec.Checkout != nil {
+		ref = &gitSpec.Checkout.Reference
+	} else if r := origin.Spec.Reference; r != nil {
+		ref = r
+	} // else remain as `nil`, which is an acceptable value for cloneInto, later.
+
+	var pushBranch string
+	if gitSpec.Push != nil {
+		pushBranch = gitSpec.Push.Branch
+	} else {
+		// Here's where it gets constrained. If there's no push branch
+		// given, then the checkout ref must include a branch, and
+		// that can be used.
+		if ref.Branch == "" {
+			failWithError(fmt.Errorf("Push branch not given explicitly, and cannot be inferred from .spec.git.checkout.ref or GitRepository .spec.ref"))
+		}
+		pushBranch = ref.Branch
+	}
+
 	tmp, err := ioutil.TempDir("", fmt.Sprintf("%s-%s", originName.Namespace, originName.Name))
 	if err != nil {
 		return failWithError(err)
@@ -193,15 +214,14 @@ func (r *ImageUpdateAutomationReconciler) Reconcile(ctx context.Context, req ctr
 	}
 
 	var repo *gogit.Repository
-	if repo, err = cloneInto(ctx, access, gitSpec.Checkout.Branch, tmp, origin.Spec.GitImplementation); err != nil {
+	if repo, err = cloneInto(ctx, access, ref, tmp, origin.Spec.GitImplementation); err != nil {
 		return failWithError(err)
 	}
 
 	// When there's a push spec, the pushed-to branch is where commits
 	// shall be made
 
 	if gitSpec.Push != nil {
-		pushBranch := gitSpec.Push.Branch
 		if err := fetch(ctx, tmp, repo, pushBranch, access, origin.Spec.GitImplementation); err != nil && err != errRemoteBranchMissing {
 			return failWithError(err)
 		}
@@ -210,7 +230,7 @@ func (r *ImageUpdateAutomationReconciler) Reconcile(ctx context.Context, req ctr
 		}
 	}
 
-	log.V(debug).Info("cloned git repository", "gitrepository", originName, "branch", gitSpec.Checkout.Branch, "working", tmp)
+	log.V(debug).Info("cloned git repository", "gitrepository", originName, "ref", ref, "working", tmp)
 
 	manifestsPath := tmp
 	if auto.Spec.Update.Path != "" {
@@ -287,10 +307,6 @@ func (r *ImageUpdateAutomationReconciler) Reconcile(ctx context.Context, req ctr
 			return failWithError(err)
 		}
 	} else {
-		pushBranch := gitSpec.Checkout.Branch
-		if gitSpec.Push != nil {
-			pushBranch = gitSpec.Push.Branch
-		}
 		if err := push(ctx, tmp, repo, pushBranch, access, origin.Spec.GitImplementation); err != nil {
 			return failWithError(err)
 		}
@@ -451,14 +467,12 @@ func (r repoAccess) remoteCallbacks() libgit2.RemoteCallbacks {
 	}
 }
 
-// cloneInto clones the upstream repository at the `branch` given,
-// using the git library indicated by `impl`. It returns a
-// `*gogit.Repository` regardless of the git library, since that is
-// used for committing changes.
-func cloneInto(ctx context.Context, access repoAccess, branch, path, impl string) (*gogit.Repository, error) {
-	checkoutStrat, err := gitstrat.CheckoutStrategyForRef(&sourcev1.GitRepositoryRef{
-		Branch: branch,
-	}, impl)
+// cloneInto clones the upstream repository at the `ref` given (which
+// can be `nil`), using the git library indicated by `impl`. It
+// returns a `*gogit.Repository` regardless of the git library, since
+// that is used for committing changes.
+func cloneInto(ctx context.Context, access repoAccess, ref *sourcev1.GitRepositoryRef, path, impl string) (*gogit.Repository, error) {
+	checkoutStrat, err := gitstrat.CheckoutStrategyForRef(ref, impl)
 	if err == nil {
 		_, _, err = checkoutStrat.Checkout(ctx, path, access.url, access.auth)
 	}

controllers/imageupdateautomation_controller.go

@@ -242,8 +242,10 @@ Images:
 						Name: gitRepoKey.Name,
 					},
 					GitSpec: &imagev1.GitSpec{
-						Checkout: imagev1.GitCheckoutSpec{
-							Branch: branch,
+						Checkout: &imagev1.GitCheckoutSpec{
+							Reference: sourcev1.GitRepositoryRef{
+								Branch: branch,
+							},
 						},
 						Commit: imagev1.CommitSpec{
 							MessageTemplate: commitTemplate,
@@ -384,8 +386,10 @@ Images:
 						Name: gitRepoKey.Name,
 					},
 					GitSpec: &imagev1.GitSpec{
-						Checkout: imagev1.GitCheckoutSpec{
-							Branch: branch,
+						Checkout: &imagev1.GitCheckoutSpec{
+							Reference: sourcev1.GitRepositoryRef{
+								Branch: branch,
+							},
 						},
 						Commit: imagev1.CommitSpec{
 							Author: imagev1.CommitUser{
@@ -529,8 +533,10 @@ Images:
 					},
 					Interval: metav1.Duration{Duration: 2 * time.Hour}, // this is to ensure any subsequent run should be outside the scope of the testing
 					GitSpec: &imagev1.GitSpec{
-						Checkout: imagev1.GitCheckoutSpec{
-							Branch: branch,
+						Checkout: &imagev1.GitCheckoutSpec{
+							Reference: sourcev1.GitRepositoryRef{
+								Branch: branch,
+							},
 						},
 						Commit: imagev1.CommitSpec{
 							SigningKey: &imagev1.SigningKey{
@@ -728,8 +734,10 @@ Images:
 							},
 							Interval: metav1.Duration{Duration: 2 * time.Hour},
 							GitSpec: &imagev1.GitSpec{
-								Checkout: imagev1.GitCheckoutSpec{
-									Branch: branch,
+								Checkout: &imagev1.GitCheckoutSpec{
+									Reference: sourcev1.GitRepositoryRef{
+										Branch: branch,
+									},
 								},
 								Commit: imagev1.CommitSpec{
 									Author: imagev1.CommitUser{
@@ -820,8 +828,10 @@ Images:
 								Strategy: imagev1.UpdateStrategySetters,
 							},
 							GitSpec: &imagev1.GitSpec{
-								Checkout: imagev1.GitCheckoutSpec{
-									Branch: branch,
+								Checkout: &imagev1.GitCheckoutSpec{
+									Reference: sourcev1.GitRepositoryRef{
+										Branch: branch,
+									},
 								},
 								Commit: imagev1.CommitSpec{
 									Author: imagev1.CommitUser{
@@ -938,8 +948,10 @@ Images:
 					},
 					Interval: metav1.Duration{Duration: 2 * time.Hour}, // this is to ensure any subsequent run should be outside the scope of the testing
 					GitSpec: &imagev1.GitSpec{
-						Checkout: imagev1.GitCheckoutSpec{
-							Branch: branch,
+						Checkout: &imagev1.GitCheckoutSpec{
+							Reference: sourcev1.GitRepositoryRef{
+								Branch: branch,
+							},
 						},
 						// leave Update field out
 						Commit: imagev1.CommitSpec{