feat: add pull request creation (#18)

* feat: add pull request creation

* fix naming, branch checkout logic and uncompression

* import shuffling

* add extra test to verify pull and CreatePullRequest are not called if digest is already defined

Author: Skarlso

apis/delivery/v1alpha1/condition_types.go

@@ -19,4 +19,7 @@ const (
 
 	// GitRepositoryPushFailedReason is used when the needed pushing to a git repository failed.
 	GitRepositoryPushFailedReason = "GitRepositoryPushFailed"
+
+	// CreatePullRequestFailedReason is used when creating a pull request failed.
+	CreatePullRequestFailedReason = "CreatePullRequestFailed"
 )

apis/delivery/v1alpha1/sync_types.go

@@ -16,21 +16,34 @@ type CommitTemplate struct {
 	Name    string `json:"name"`
 	Email   string `json:"email"`
 	Message string `json:"message"`
+
+	//+optional
+	TargetBranch string `json:"targetBranch,omitempty"`
+	//+optional
+	//+kubebuilder:default:=main
+	BaseBranch string `json:"baseBranch,omitempty"`
+}
+
+// PullRequestTemplate provides information for the created pull request.
+type PullRequestTemplate struct {
+	Title       string `json:"title,omitempty"`
+	Description string `json:"description,omitempty"`
+	Base        string `json:"base,omitempty"`
 }
 
 // SyncSpec defines the desired state of Sync
 type SyncSpec struct {
 	SnapshotRef    v1.LocalObjectReference `json:"snapshotRef"`
 	RepositoryRef  v1.LocalObjectReference `json:"repositoryRef"`
 	Interval       metav1.Duration         `json:"interval"`
-	CommitTemplate *CommitTemplate         `json:"commitTemplate"`
+	CommitTemplate CommitTemplate          `json:"commitTemplate"`
 	SubPath        string                  `json:"subPath"`
 	Prune          bool                    `json:"prune,omitempty"`
 
-	//+optional
-	Branch string `json:"branch,omitempty"`
 	//+optional
 	AutomaticPullRequestCreation bool `json:"automaticPullRequestCreation,omitempty"`
+	//+optional
+	PullRequestTemplate PullRequestTemplate `json:"pullRequestTemplate,omitempty"`
 }
 
 // SyncStatus defines the observed state of Sync

apis/delivery/v1alpha1/zz_generated.deepcopy.go

@@ -37,18 +37,21 @@ spec:
             properties:
               automaticPullRequestCreation:
                 type: boolean
-              branch:
-                type: string
               commitTemplate:
                 description: CommitTemplate defines the details of the commit to the
                   external repository.
                 properties:
+                  baseBranch:
+                    default: main
+                    type: string
                   email:
                     type: string
                   message:
                     type: string
                   name:
                     type: string
+                  targetBranch:
+                    type: string
                 required:
                 - email
                 - message
@@ -58,6 +61,17 @@ spec:
                 type: string
               prune:
                 type: boolean
+              pullRequestTemplate:
+                description: PullRequestTemplate provides information for the created
+                  pull request.
+                properties:
+                  base:
+                    type: string
+                  description:
+                    type: string
+                  title:
+                    type: string
+                type: object
               repositoryRef:
                 description: LocalObjectReference contains enough information to let
                   you locate the referenced object inside the same namespace.

config/crd/bases/delivery.ocm.software_syncs.yaml

@@ -8,6 +8,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"time"
 
 	"github.com/fluxcd/pkg/apis/meta"
 	"github.com/fluxcd/pkg/runtime/conditions"
@@ -18,22 +19,26 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/types"
 	ctrl "sigs.k8s.io/controller-runtime"
+	"sigs.k8s.io/controller-runtime/pkg/builder"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/log"
+	"sigs.k8s.io/controller-runtime/pkg/predicate"
 
 	ocmv1 "github.com/open-component-model/ocm-controller/api/v1alpha1"
 
 	"github.com/open-component-model/git-controller/apis/delivery/v1alpha1"
 	mpasv1alpha1 "github.com/open-component-model/git-controller/apis/mpas/v1alpha1"
-	providers "github.com/open-component-model/git-controller/pkg"
+	"github.com/open-component-model/git-controller/pkg"
+	"github.com/open-component-model/git-controller/pkg/providers"
 )
 
 // SyncReconciler reconciles a Sync object
 type SyncReconciler struct {
 	client.Client
 	Scheme *runtime.Scheme
 
-	Git providers.Git
+	Git      pkg.Git
+	Provider providers.Provider
 }
 
 //+kubebuilder:rbac:groups=delivery.ocm.software,resources=syncs,verbs=get;list;watch;create;update;patch;delete
@@ -53,7 +58,7 @@ func (r *SyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.
 	)
 
 	log := log.FromContext(ctx)
-	log.V(4).Info("starting reconcile loop for snapshot")
+
 	obj := &v1alpha1.Sync{}
 	if err := r.Get(ctx, req.NamespacedName, obj); err != nil {
 		if apierrors.IsNotFound(err) {
@@ -139,6 +144,8 @@ func (r *SyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.
 		return ctrl.Result{}, retErr
 	}
 
+	log.V(4).Info("found target snapshot")
+
 	repository := &mpasv1alpha1.Repository{}
 	if err := r.Get(ctx, types.NamespacedName{
 		Namespace: obj.Namespace,
@@ -150,6 +157,8 @@ func (r *SyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.
 		return ctrl.Result{}, retErr
 	}
 
+	log.V(4).Info("found target repository")
+
 	authSecret := &corev1.Secret{}
 	if err := r.Get(ctx, types.NamespacedName{
 		Namespace: obj.Namespace,
@@ -161,16 +170,35 @@ func (r *SyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.
 		return ctrl.Result{}, retErr
 	}
 
+	log.V(4).Info("found authentication secret")
+
+	baseBranch := obj.Spec.CommitTemplate.BaseBranch
+	if baseBranch == "" {
+		baseBranch = "main"
+	}
+	targetBranch := obj.Spec.CommitTemplate.TargetBranch
+	if targetBranch == "" && obj.Spec.AutomaticPullRequestCreation {
+		targetBranch = fmt.Sprintf("branch-%d", time.Now().Unix())
+	} else if targetBranch == "" && !obj.Spec.AutomaticPullRequestCreation {
+		retErr = fmt.Errorf("branch cannot be empty if automatic pull request creation is not enabled")
+		conditions.MarkFalse(obj, meta.ReadyCondition, v1alpha1.GitRepositoryPushFailedReason, retErr.Error())
+
+		return ctrl.Result{}, retErr
+	}
+
+	log.Info("preparing to push snapshot content", "base", baseBranch, "target", targetBranch)
+
 	// trim any trailing `/` and then just add.
 	log.V(4).Info("crafting artifact URL to download from", "url", snapshot.Status.RepositoryURL)
-	opts := &providers.PushOptions{
-		URL:      repository.GetRepositoryURL(),
-		Message:  obj.Spec.CommitTemplate.Message,
-		Name:     obj.Spec.CommitTemplate.Name,
-		Email:    obj.Spec.CommitTemplate.Email,
-		Snapshot: snapshot,
-		Branch:   obj.Spec.Branch,
-		SubPath:  obj.Spec.SubPath,
+	opts := &pkg.PushOptions{
+		URL:          repository.GetRepositoryURL(),
+		Message:      obj.Spec.CommitTemplate.Message,
+		Name:         obj.Spec.CommitTemplate.Name,
+		Email:        obj.Spec.CommitTemplate.Email,
+		Snapshot:     snapshot,
+		BaseBranch:   baseBranch,
+		TargetBranch: targetBranch,
+		SubPath:      obj.Spec.SubPath,
 	}
 
 	r.parseAuthSecret(authSecret, opts)
@@ -183,27 +211,42 @@ func (r *SyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.
 		return ctrl.Result{}, retErr
 	}
 
+	log.Info("target content pushed with digest", "base", baseBranch, "target", targetBranch, "digest", digest)
+
 	obj.Status.Digest = digest
 
+	if obj.Spec.AutomaticPullRequestCreation {
+		log.Info("automatic pull-request creation is enabled, preparing to create a pull request")
+
+		if err := r.Provider.CreatePullRequest(ctx, targetBranch, *obj, *repository); err != nil {
+			retErr = fmt.Errorf("failed to create pull request: %w", err)
+			conditions.MarkFalse(obj, meta.ReadyCondition, v1alpha1.CreatePullRequestFailedReason, retErr.Error())
+
+			return ctrl.Result{}, retErr
+		}
+	}
+
 	// Remove any stale Ready condition, most likely False, set above. Its value
 	// is derived from the overall result of the reconciliation in the deferred
 	// block at the very end.
 	conditions.Delete(obj, meta.ReadyCondition)
 
+	log.Info("successfully reconciled sync object")
+
 	return result, retErr
 }
 
 // SetupWithManager sets up the controller with the Manager.
 func (r *SyncReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	return ctrl.NewControllerManagedBy(mgr).
-		For(&v1alpha1.Sync{}).
+		For(&v1alpha1.Sync{}, builder.WithPredicates(predicate.GenerationChangedPredicate{})).
 		Complete(r)
 }
 
-func (r *SyncReconciler) parseAuthSecret(secret *corev1.Secret, opts *providers.PushOptions) {
+func (r *SyncReconciler) parseAuthSecret(secret *corev1.Secret, opts *pkg.PushOptions) {
 	if _, ok := secret.Data["identity"]; ok {
-		opts.Auth = &providers.Auth{
-			SSH: &providers.SSH{
+		opts.Auth = &pkg.Auth{
+			SSH: &pkg.SSH{
 				PemBytes: secret.Data["identity"],
 				User:     string(secret.Data["username"]),
 				Password: string(secret.Data["password"]),
@@ -212,8 +255,8 @@ func (r *SyncReconciler) parseAuthSecret(secret *corev1.Secret, opts *providers.
 		return
 	}
 	// default to basic auth.
-	opts.Auth = &providers.Auth{
-		BasicAuth: &providers.BasicAuth{
+	opts.Auth = &pkg.Auth{
+		BasicAuth: &pkg.BasicAuth{
 			Username: string(secret.Data["username"]),
 			Password: string(secret.Data["password"]),
 		},