feat: add pull request creation

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

@@ -18,6 +18,13 @@ type CommitTemplate struct {
 	Message string `json:"message"`
 }
 
+// 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"`
@@ -31,6 +38,8 @@ type SyncSpec struct {
 	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

@@ -58,6 +58,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,10 +8,12 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"time"
 
 	"github.com/fluxcd/pkg/apis/meta"
 	"github.com/fluxcd/pkg/runtime/conditions"
 	"github.com/fluxcd/pkg/runtime/patch"
+	"github.com/open-component-model/git-controller/pkg/providers"
 	corev1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -25,15 +27,16 @@ import (
 
 	"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"
 )
 
 // 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
@@ -161,15 +164,25 @@ func (r *SyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.
 		return ctrl.Result{}, retErr
 	}
 
+	branch := obj.Spec.Branch
+	if branch == "" && obj.Spec.AutomaticPullRequestCreation {
+		branch = fmt.Sprintf("branch-%d", time.Now().Unix())
+	} else if branch == "" && !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
+	}
+
 	// trim any trailing `/` and then just add.
 	log.V(4).Info("crafting artifact URL to download from", "url", snapshot.Status.RepositoryURL)
-	opts := &providers.PushOptions{
+	opts := &pkg.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,
+		Branch:   branch,
 		SubPath:  obj.Spec.SubPath,
 	}
 
@@ -185,6 +198,15 @@ func (r *SyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.
 
 	obj.Status.Digest = digest
 
+	if obj.Spec.AutomaticPullRequestCreation {
+		if err := r.Provider.CreatePullRequest(ctx, branch, *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.
@@ -200,10 +222,10 @@ func (r *SyncReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		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 +234,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"]),
 		},

controllers/delivery/sync_controller.go

@@ -7,8 +7,10 @@ package gitea
 import (
 	"context"
 	"fmt"
+	"time"
 
 	"code.gitea.io/sdk/gitea"
+	deliveryv1alpha1 "github.com/open-component-model/git-controller/apis/delivery/v1alpha1"
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/types"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -90,6 +92,66 @@ func (c *Client) CreateRepository(ctx context.Context, obj mpasv1alpha1.Reposito
 	return nil
 }
 
-func (c *Client) CreatePullRequest(ctx context.Context, owner, repo, title, branch, description string) error {
+func (c *Client) CreatePullRequest(ctx context.Context, sync deliveryv1alpha1.Sync, repository mpasv1alpha1.Repository) error {
+	if repository.Spec.Provider != providerType {
+		if c.next == nil {
+			return fmt.Errorf("can't handle provider type '%s' and no next provider is configured", repository.Spec.Provider)
+		}
+
+		return c.next.CreatePullRequest(ctx, sync, repository)
+	}
+
+	secret := &v1.Secret{}
+	if err := c.client.Get(ctx, types.NamespacedName{
+		Name:      repository.Spec.Credentials.SecretRef.Name,
+		Namespace: repository.Namespace,
+	}, secret); err != nil {
+		return fmt.Errorf("failed to get secret: %w", err)
+	}
+
+	token, ok := secret.Data[tokenKey]
+	if !ok {
+		return fmt.Errorf("token '%s' not found in secret", tokenKey)
+	}
+
+	domain := defaultDomain
+	if repository.Spec.Domain != "" {
+		domain = repository.Spec.Domain
+	}
+
+	client, err := gitea.NewClient(domain, gitea.SetToken(string(token)))
+	if err != nil {
+		return fmt.Errorf("failed to create gitea client: %w", err)
+	}
+
+	var (
+		title       = providers.DefaultTitle
+		base        = providers.DefaultBaseBranch
+		description = providers.DefaultDescription
+	)
+
+	if sync.Spec.PullRequestTemplate.Title != "" {
+		title = sync.Spec.PullRequestTemplate.Title
+	}
+
+	if sync.Spec.PullRequestTemplate.Base != "" {
+		base = sync.Spec.PullRequestTemplate.Base
+	}
+
+	if sync.Spec.PullRequestTemplate.Description != "" {
+		description = sync.Spec.PullRequestTemplate.Description
+	}
+
+	branch := fmt.Sprintf("branch-%d", time.Now().Unix())
+
+	if _, _, err := client.CreatePullRequest(repository.Spec.Owner, repository.Spec.RepositoryName, gitea.CreatePullRequestOption{
+		Head:  branch,
+		Base:  base,
+		Title: title,
+		Body:  description,
+	}); err != nil {
+		return fmt.Errorf("failed to create pull request: %w", err)
+	}
+
 	return nil
 }

pkg/providers/gitea/gitea.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/fluxcd/go-git-providers/github"
 	"github.com/fluxcd/go-git-providers/gitprovider"
+	deliveryv1alpha1 "github.com/open-component-model/git-controller/apis/delivery/v1alpha1"
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/types"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -91,6 +92,33 @@ func (c *Client) constructAuthenticationOption(ctx context.Context, obj mpasv1al
 	return gitprovider.WithOAuth2Token(string(token)), nil
 }
 
-func (c *Client) CreatePullRequest(ctx context.Context, owner, repo, title, branch, description string) error {
-	return nil
+func (c *Client) CreatePullRequest(ctx context.Context, sync deliveryv1alpha1.Sync, repository mpasv1alpha1.Repository) error {
+	if repository.Spec.Provider != providerType {
+		if c.next == nil {
+			return fmt.Errorf("can't handle provider type '%s' and no next provider is configured", repository.Spec.Provider)
+		}
+
+		return c.next.CreatePullRequest(ctx, sync, repository)
+	}
+
+	authenticationOption, err := c.constructAuthenticationOption(ctx, repository)
+	if err != nil {
+		return err
+	}
+
+	domain := defaultDomain
+	if repository.Spec.Domain != "" {
+		domain = repository.Spec.Domain
+	}
+
+	gc, err := github.NewClient(authenticationOption, gitprovider.WithDomain(domain))
+	if err != nil {
+		return fmt.Errorf("failed to create github client: %w", err)
+	}
+
+	if repository.Spec.IsOrganization {
+		return gogit.CreateOrganizationPullRequest(ctx, gc, domain, sync.Spec.PullRequestTemplate, repository.Spec)
+	}
+
+	return gogit.CreateUserPullRequest(ctx, gc, domain, sync.Spec.PullRequestTemplate, repository.Spec)
 }

pkg/providers/github/github.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/fluxcd/go-git-providers/gitlab"
 	"github.com/fluxcd/go-git-providers/gitprovider"
+	deliveryv1alpha1 "github.com/open-component-model/git-controller/apis/delivery/v1alpha1"
 	v1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/types"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -75,7 +76,7 @@ func (c *Client) CreateRepository(ctx context.Context, obj mpasv1alpha1.Reposito
 
 	gc, err := gitlab.NewClient(string(token), tokenType, gitprovider.WithDomain(domain))
 	if err != nil {
-		return fmt.Errorf("failed to create github client: %w", err)
+		return fmt.Errorf("failed to create gitlab client: %w", err)
 	}
 
 	if obj.Spec.IsOrganization {
@@ -85,6 +86,41 @@ func (c *Client) CreateRepository(ctx context.Context, obj mpasv1alpha1.Reposito
 	return gogit.CreateUserRepository(ctx, gc, domain, obj.Spec)
 }
 
-func (c *Client) CreatePullRequest(ctx context.Context, owner, repo, title, branch, description string) error {
-	return nil
+func (c *Client) CreatePullRequest(ctx context.Context, branch string, sync deliveryv1alpha1.Sync, repository mpasv1alpha1.Repository) error {
+	if repository.Spec.Provider != providerType {
+		if c.next == nil {
+			return fmt.Errorf("can't handle provider type '%s' and no next provider is configured", repository.Spec.Provider)
+		}
+
+		return c.next.CreatePullRequest(ctx, branch, sync, repository)
+	}
+
+	secret := &v1.Secret{}
+	if err := c.client.Get(ctx, types.NamespacedName{
+		Name:      repository.Spec.Credentials.SecretRef.Name,
+		Namespace: sync.Namespace,
+	}, secret); err != nil {
+		return fmt.Errorf("failed to get secret: %w", err)
+	}
+
+	token, ok := secret.Data[tokenKey]
+	if !ok {
+		return fmt.Errorf("token '%s' not found in secret", tokenKey)
+	}
+
+	domain := defaultDomain
+	if repository.Spec.Domain != "" {
+		domain = repository.Spec.Domain
+	}
+
+	gc, err := gitlab.NewClient(string(token), tokenType, gitprovider.WithDomain(domain))
+	if err != nil {
+		return fmt.Errorf("failed to create gitlab client: %w", err)
+	}
+
+	if repository.Spec.IsOrganization {
+		return gogit.CreateOrganizationPullRequest(ctx, gc, domain, branch, sync.Spec.PullRequestTemplate, repository.Spec)
+	}
+
+	return gogit.CreateUserPullRequest(ctx, gc, domain, branch, sync.Spec.PullRequestTemplate, repository.Spec)
 }