Pass context to libgit2.RemoteCallbacks

Pass cancellable context to libgit2.RemoteCallbacks to be able to cancel
the remote operations when the context is cancelled.
For git clone, fetch and push, a context is created with the timeout of
the target GitRepository.

Signed-off-by: Sunny <[email protected]>

api/go.mod

@@ -4,7 +4,7 @@ go 1.16
 
 require (
  github.com/fluxcd/pkg/apis/meta v0.10.0
- github.com/fluxcd/source-controller/api v0.17.0
+ github.com/fluxcd/source-controller/api v0.17.2
  k8s.io/apimachinery v0.21.3
  sigs.k8s.io/controller-runtime v0.9.5
 )

api/go.sum

@@ -93,8 +93,8 @@ github.com/evanphx/json-patch v4.11.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQL
 github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
 github.com/fluxcd/pkg/apis/meta v0.10.0 h1:N7wVGHC1cyPdT87hrDC7UwCwRwnZdQM46PBSLjG2rlE=
 github.com/fluxcd/pkg/apis/meta v0.10.0/go.mod h1:CW9X9ijMTpNe7BwnokiUOrLl/h13miwVr/3abEQLbKE=
-github.com/fluxcd/source-controller/api v0.17.0 h1:skXx2H5SeziUTwJrp9MPJNwTtYTctJMQ7ZIJfLmg9b0=
-github.com/fluxcd/source-controller/api v0.17.0/go.mod h1:guUCCapjzE2kocwFreQTM/IGvtAglIJc4L97mokairo=
+github.com/fluxcd/source-controller/api v0.17.2 h1:noePJGsevuvxWols6ErbowujuAHGWb/ZO8irtRHcVAc=
+github.com/fluxcd/source-controller/api v0.17.2/go.mod h1:guUCCapjzE2kocwFreQTM/IGvtAglIJc4L97mokairo=
 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=

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

@@ -220,7 +220,6 @@ spec:
  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:
@@ -427,7 +426,6 @@ spec:
  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:

controllers/imageupdateautomation_controller.go

@@ -227,16 +227,22 @@ func (r *ImageUpdateAutomationReconciler) Reconcile(ctx context.Context, req ctr
  return failWithError(err)
  }
 
+ // Use the git operations timeout for the repo.
+ cloneCtx, cancel := context.WithTimeout(ctx, origin.Spec.Timeout.Duration)
+ defer cancel()
  var repo *gogit.Repository
- if repo, err = cloneInto(ctx, access, ref, tmp); err != nil {
+ if repo, err = cloneInto(cloneCtx, access, ref, tmp); 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 {
- if err := fetch(ctx, tmp, pushBranch, access); err != nil && err != errRemoteBranchMissing {
+ // Use the git operations timeout for the repo.
+ fetchCtx, cancel := context.WithTimeout(ctx, origin.Spec.Timeout.Duration)
+ defer cancel()
+ if err := fetch(fetchCtx, tmp, pushBranch, access); err != nil && err != errRemoteBranchMissing {
  return failWithError(err)
  }
  if err = switchBranch(repo, pushBranch); err != nil {
@@ -320,7 +326,10 @@ func (r *ImageUpdateAutomationReconciler) Reconcile(ctx context.Context, req ctr
  return failWithError(err)
  }
  } else {
- if err := push(ctx, tmp, pushBranch, access); err != nil {
+ // Use the git operations timeout for the repo.
+ pushCtx, cancel := context.WithTimeout(ctx, origin.Spec.Timeout.Duration)
+ defer cancel()
+ if err := push(pushCtx, tmp, pushBranch, access); err != nil {
  return failWithError(err)
  }
 
@@ -475,8 +484,8 @@ func (r *ImageUpdateAutomationReconciler) getRepoAccess(ctx context.Context, rep
  return access, nil
 }
 
-func (r repoAccess) remoteCallbacks() libgit2.RemoteCallbacks {
- return gitlibgit2.RemoteCallbacks(r.auth)
+func (r repoAccess) remoteCallbacks(ctx context.Context) libgit2.RemoteCallbacks {
+ return gitlibgit2.RemoteCallbacks(ctx, r.auth)
 }
 
 // cloneInto clones the upstream repository at the `ref` given (which
@@ -637,7 +646,7 @@ func fetch(ctx context.Context, path string, branch string, access repoAccess) e
  err = origin.Fetch(
  []string{refspec},
  &libgit2.FetchOptions{
- RemoteCallbacks: access.remoteCallbacks(),
+ RemoteCallbacks: access.remoteCallbacks(ctx),
  }, "",
  )
  if err != nil && libgit2.IsErrorCode(err, libgit2.ErrorCodeNotFound) {
@@ -662,7 +671,7 @@ func push(ctx context.Context, path, branch string, access repoAccess) error {
  }
  defer origin.Free()
 
- callbacks := access.remoteCallbacks()
+ callbacks := access.remoteCallbacks(ctx)
 
  // calling repo.Push will succeed even if a reference update is
  // rejected; to detect this case, this callback is supplied.

go.mod

@@ -12,12 +12,12 @@ require (
  // If you bump this, change REFLECTOR_VER in the Makefile to match
  github.com/fluxcd/image-reflector-controller/api v0.12.0
  github.com/fluxcd/pkg/apis/meta v0.10.1
- github.com/fluxcd/pkg/gittestserver v0.4.1
+ github.com/fluxcd/pkg/gittestserver v0.4.2
  github.com/fluxcd/pkg/runtime v0.12.1
  github.com/fluxcd/pkg/ssh v0.1.0
  // If you bump this, change SOURCE_VER in the Makefile to match
- github.com/fluxcd/source-controller v0.17.0
- github.com/fluxcd/source-controller/api v0.17.0
+ github.com/fluxcd/source-controller v0.17.2
+ github.com/fluxcd/source-controller/api v0.17.2
  github.com/go-git/go-billy/v5 v5.3.1
  github.com/go-git/go-git/v5 v5.4.2
  github.com/go-logr/logr v0.4.0

go.sum

@@ -351,8 +351,8 @@ github.com/fluxcd/image-reflector-controller/api v0.12.0/go.mod h1:lgQHGFz29OHmD
 github.com/fluxcd/pkg/apis/meta v0.10.0/go.mod h1:CW9X9ijMTpNe7BwnokiUOrLl/h13miwVr/3abEQLbKE=
 github.com/fluxcd/pkg/apis/meta v0.10.1 h1:zISenRlqNG7WK8TP3HxZTvv+1Z7JZOUIQvZrOr6pQ2w=
 github.com/fluxcd/pkg/apis/meta v0.10.1/go.mod h1:yUblM2vg+X8TE3A2VvJfdhkGmg+uqBlSPkLk7dxi0UM=
-github.com/fluxcd/pkg/gittestserver v0.4.1 h1:knghRrVEEPnpO0VJYjoz0H2YMc4fnKAVt5hDGsB1IHc=
-github.com/fluxcd/pkg/gittestserver v0.4.1/go.mod h1:hUPx21fe/6oox336Wih/XF1fnmzLmptNMOvATbTZXNY=
+github.com/fluxcd/pkg/gittestserver v0.4.2 h1:XqoiemTnnUNldnOw8N7OTdalu2iZp1FTRhp9uUauDJQ=
+github.com/fluxcd/pkg/gittestserver v0.4.2/go.mod h1:hUPx21fe/6oox336Wih/XF1fnmzLmptNMOvATbTZXNY=
 github.com/fluxcd/pkg/gitutil v0.1.0 h1:VO3kJY/CKOCO4ysDNqfdpTg04icAKBOSb3lbR5uE/IE=
 github.com/fluxcd/pkg/gitutil v0.1.0/go.mod h1:Ybz50Ck5gkcnvF0TagaMwtlRy3X3wXuiri1HVsK5id4=
 github.com/fluxcd/pkg/helmtestserver v0.2.0/go.mod h1:Yie8n7xuu5Nvf1Q7302LKsubJhWpwzCaK0rLJvmF7aI=
@@ -366,10 +366,10 @@ github.com/fluxcd/pkg/testserver v0.1.0/go.mod h1:fvt8BHhXw6c1+CLw1QFZxcQprlcXzs
 github.com/fluxcd/pkg/untar v0.1.0/go.mod h1:aGswNyzB1mlz/T/kpOS58mITBMxMKc9tlJBH037A2HY=
 github.com/fluxcd/pkg/version v0.1.0 h1:v+SmCanmCB5Tj2Cx9TXlj+kNRfPGbAvirkeqsp7ZEAQ=
 github.com/fluxcd/pkg/version v0.1.0/go.mod h1:V7Z/w8dxLQzv0FHqa5ox5TeyOd2zOd49EeuWFgnwyj4=
-github.com/fluxcd/source-controller v0.17.0 h1:NXemBcfzZzv3OiT5mjK2vynKl0Ni1IPY5PJAsZChOfs=
-github.com/fluxcd/source-controller v0.17.0/go.mod h1:0vG0i0o33aviv369fHguCyG3O9nyoLFVcKNDvWl75P0=
-github.com/fluxcd/source-controller/api v0.17.0 h1:skXx2H5SeziUTwJrp9MPJNwTtYTctJMQ7ZIJfLmg9b0=
-github.com/fluxcd/source-controller/api v0.17.0/go.mod h1:guUCCapjzE2kocwFreQTM/IGvtAglIJc4L97mokairo=
+github.com/fluxcd/source-controller v0.17.2 h1:lPnZxXX0CshkDVHfZxz1GWu98TLrcRuk3X3f544pMjs=
+github.com/fluxcd/source-controller v0.17.2/go.mod h1:nEaHFlXAVbv/gNo1kWWF52y8J922MIQQUYXD/azF6f8=
+github.com/fluxcd/source-controller/api v0.17.2 h1:noePJGsevuvxWols6ErbowujuAHGWb/ZO8irtRHcVAc=
+github.com/fluxcd/source-controller/api v0.17.2/go.mod h1:guUCCapjzE2kocwFreQTM/IGvtAglIJc4L97mokairo=
 github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc=
 github.com/form3tech-oss/jwt-go v3.2.2+incompatible/go.mod h1:pbq4aXjuKjdthFRnoDwaVPLA+WlJuPGy+QneDUgJi2k=
 github.com/franela/goblin v0.0.0-20200105215937-c9ffbefa60db/go.mod h1:7dvUGVsVBjqR7JHJk0brhHOZYGmfBYOrK0ZhYMEtBr4=