feat: create a status check and store the generated pr id (#43)

* feat: store the generated pr id and git repository value

* create a pull request status check

* Update pkg/providers/github/github.go

Co-authored-by: Piaras Hoban <[email protected]>

---------

Co-authored-by: Piaras Hoban <[email protected]>

Author: Skarlso

apis/delivery/v1alpha1/sync_types.go

@@ -58,6 +58,9 @@ type SyncStatus struct {
 	// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.conditions[?(@.type==\"Ready\")].status",description=""
 	// +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.conditions[?(@.type==\"Ready\")].message",description=""
 	Conditions []metav1.Condition `json:"conditions,omitempty"`
+
+	// +optional
+	PullRequestID int `json:"pullRequestID,omitempty"`
 }
 
 // GetConditions returns the conditions of the ComponentVersion.

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

@@ -182,6 +182,8 @@ spec:
                 description: ObservedGeneration is the last reconciled generation.
                 format: int64
                 type: integer
+              pullRequestID:
+                type: integer
             type: object
         type: object
     served: true

controllers/delivery/sync_controller.go

@@ -13,17 +13,14 @@ import (
 	"github.com/fluxcd/pkg/apis/meta"
 	"github.com/fluxcd/pkg/runtime/conditions"
 	"github.com/fluxcd/pkg/runtime/patch"
-	sourcebeta2 "github.com/fluxcd/source-controller/api/v1beta2"
 	corev1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/types"
-	"k8s.io/utils/pointer"
 	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/controller/controllerutil"
 	"sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/predicate"
 
@@ -223,20 +220,15 @@ func (r *SyncReconciler) Reconcile(ctx context.Context, req ctrl.Request) (resul
 	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 {
+		id, err := r.Provider.CreatePullRequest(ctx, targetBranch, *obj, *repository)
+		if err != nil {
 			err = fmt.Errorf("failed to create pull request: %w", err)
 			conditions.MarkFalse(obj, meta.ReadyCondition, v1alpha1.CreatePullRequestFailedReason, err.Error())
 
 			return ctrl.Result{}, err
 		}
 
-		// Create GitRepository to track values file changes.
-		if err := r.createValueFileGitRepository(ctx, *obj, *repository, targetBranch); err != nil {
-			err = fmt.Errorf("failed to create value tracking git repository object: %w", err)
-			conditions.MarkFalse(obj, meta.ReadyCondition, v1alpha1.GitRepositoryCreateFailedReason, err.Error())
-
-			return ctrl.Result{}, err
-		}
+		obj.Status.PullRequestID = id
 	}
 
 	// Remove any stale Ready condition, most likely False, set above. Its value
@@ -275,47 +267,3 @@ func (r *SyncReconciler) parseAuthSecret(secret *corev1.Secret, opts *pkg.PushOp
 		},
 	}
 }
-
-// createValueFileGitRepository creates a GitRepository that tracks changes on a branch.
-func (r *SyncReconciler) createValueFileGitRepository(ctx context.Context, sync v1alpha1.Sync, repository mpasv1alpha1.Repository, branch string) error {
-	owners := sync.GetOwnerReferences()
-	if len(owners) != 1 {
-		return fmt.Errorf("expected exactly one owner, got: %d", len(owners))
-	}
-
-	repo := &sourcebeta2.GitRepository{
-		ObjectMeta: metav1.ObjectMeta{
-			Name:      repository.Name + "values-repo",
-			Namespace: repository.Namespace,
-		},
-		Spec: sourcebeta2.GitRepositorySpec{
-			URL: repository.GetRepositoryURL(),
-			SecretRef: &meta.LocalObjectReference{
-				Name: repository.Spec.Credentials.SecretRef.Name,
-			},
-			Interval: metav1.Duration{Duration: 5 * time.Second},
-			Reference: &sourcebeta2.GitRepositoryRef{
-				Branch: branch,
-			},
-			Ignore: pointer.String(fmt.Sprintf(`# exclude all
-/*
-# include values.yaml
-!./products/%s/values.yaml
-`, owners[0].Name)),
-		},
-	}
-
-	if _, err := controllerutil.CreateOrUpdate(ctx, r.Client, repo, func() error {
-		if repo.ObjectMeta.CreationTimestamp.IsZero() {
-			if err := controllerutil.SetOwnerReference(&repository, repo, r.Scheme); err != nil {
-				return fmt.Errorf("failed to set owner to git repository object: %w", err)
-			}
-		}
-
-		return nil
-	}); err != nil {
-		return fmt.Errorf("failed to create git repository: %w", err)
-	}
-
-	return nil
-}

go.mod

@@ -19,7 +19,6 @@ require (
 	k8s.io/api v0.26.2
 	k8s.io/apimachinery v0.26.2
 	k8s.io/client-go v0.26.2
-	k8s.io/utils v0.0.0-20230220204549-a5ecb0141aa5
 	sigs.k8s.io/controller-runtime v0.14.4
 )
 
@@ -175,6 +174,7 @@ require (
 	k8s.io/component-base v0.26.2 // indirect
 	k8s.io/klog/v2 v2.90.0 // indirect
 	k8s.io/kube-openapi v0.0.0-20230228151317-19cbebb19cb7 // indirect
+	k8s.io/utils v0.0.0-20230220204549-a5ecb0141aa5 // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.2.3 // indirect
 	sigs.k8s.io/yaml v1.3.0 // indirect

pkg/providers/fakes/fake_provider.go

@@ -18,6 +18,7 @@ type Provider struct {
 	CreateRepositoryCalledWith  map[int][]any
 	CreateRepositoryCallCount   int
 	CreatePullRequestErr        error
+	CreatePullRequestID         int
 	CreatePullRequestCalledWith map[int][]any
 	CreatePullRequestCallCount  int
 }
@@ -34,14 +35,14 @@ func (p *Provider) CreateRepository(ctx context.Context, obj mpasv1alpha1.Reposi
 	return p.CreateRepositoryErr
 }
 
-func (p *Provider) CreatePullRequest(ctx context.Context, branch string, sync deliveryv1alpha1.Sync, repository mpasv1alpha1.Repository) error {
+func (p *Provider) CreatePullRequest(ctx context.Context, branch string, sync deliveryv1alpha1.Sync, repository mpasv1alpha1.Repository) (int, error) {
 	if p.CreatePullRequestCalledWith == nil {
 		p.CreatePullRequestCalledWith = make(map[int][]any)
 	}
 	p.CreatePullRequestCalledWith[p.CreatePullRequestCallCount] = append(p.CreatePullRequestCalledWith[p.CreatePullRequestCallCount], branch, sync, repository)
 	p.CreatePullRequestCallCount++
 
-	return p.CreatePullRequestErr
+	return p.CreatePullRequestID, p.CreatePullRequestErr
 }
 
 func (p *Provider) CreatePullRequestCallArgsForNumber(i int) ([]any, error) {

pkg/providers/gitea/gitea.go

@@ -143,10 +143,10 @@ func (f *fileCommitter) commitFile(client *gitea.Client, obj mpasv1alpha1.Reposi
 	}
 }
 
-func (c *Client) CreatePullRequest(ctx context.Context, branch string, sync deliveryv1alpha1.Sync, repository mpasv1alpha1.Repository) error {
+func (c *Client) CreatePullRequest(ctx context.Context, branch string, sync deliveryv1alpha1.Sync, repository mpasv1alpha1.Repository) (int, 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 -1, 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)
@@ -157,12 +157,12 @@ func (c *Client) CreatePullRequest(ctx context.Context, branch string, sync deli
 		Name:      repository.Spec.Credentials.SecretRef.Name,
 		Namespace: repository.Namespace,
 	}, secret); err != nil {
-		return fmt.Errorf("failed to get secret: %w", err)
+		return -1, 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)
+		return -1, fmt.Errorf("token '%s' not found in secret", tokenKey)
 	}
 
 	domain := defaultDomain
@@ -172,7 +172,7 @@ func (c *Client) CreatePullRequest(ctx context.Context, branch string, sync deli
 
 	client, err := gitea.NewClient(domain, gitea.SetToken(string(token)))
 	if err != nil {
-		return fmt.Errorf("failed to create gitea client: %w", err)
+		return -1, fmt.Errorf("failed to create gitea client: %w", err)
 	}
 
 	var (
@@ -193,16 +193,17 @@ func (c *Client) CreatePullRequest(ctx context.Context, branch string, sync deli
 		description = sync.Spec.PullRequestTemplate.Description
 	}
 
-	if _, _, err := client.CreatePullRequest(repository.Spec.Owner, repository.GetName(), gitea.CreatePullRequestOption{
+	pr, _, err := client.CreatePullRequest(repository.Spec.Owner, repository.GetName(), gitea.CreatePullRequestOption{
 		Head:  branch,
 		Base:  base,
 		Title: title,
 		Body:  description,
-	}); err != nil {
-		return fmt.Errorf("failed to create pull request: %w", err)
+	})
+	if err != nil {
+		return -1, fmt.Errorf("failed to create pull request: %w", err)
 	}
 
-	return nil
+	return int(pr.ID), nil
 }
 
 func (c *Client) CreateBranchProtection(ctx context.Context, obj mpasv1alpha1.Repository) error {

pkg/providers/github/github.go

@@ -130,18 +130,18 @@ func (c *Client) retrieveAccessToken(ctx context.Context, obj mpasv1alpha1.Repos
 	return token, nil
 }
 
-func (c *Client) CreatePullRequest(ctx context.Context, branch string, sync deliveryv1alpha1.Sync, repository mpasv1alpha1.Repository) error {
+func (c *Client) CreatePullRequest(ctx context.Context, branch string, sync deliveryv1alpha1.Sync, repository mpasv1alpha1.Repository) (int, 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 -1, 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)
 	}
 
 	authenticationOption, err := c.constructAuthenticationOption(ctx, repository)
 	if err != nil {
-		return err
+		return -1, err
 	}
 
 	domain := defaultDomain
@@ -151,12 +151,54 @@ func (c *Client) CreatePullRequest(ctx context.Context, branch string, sync deli
 
 	gc, err := github.NewClient(authenticationOption, gitprovider.WithDomain(domain))
 	if err != nil {
-		return fmt.Errorf("failed to create github client: %w", err)
+		return -1, fmt.Errorf("failed to create github client: %w", err)
 	}
 
+	var (
+		id                    int
+		createPullRequestFunc = gogit.CreateUserPullRequest
+	)
+
 	if repository.Spec.IsOrganization {
-		return gogit.CreateOrganizationPullRequest(ctx, gc, domain, branch, sync.Spec.PullRequestTemplate, repository)
+		createPullRequestFunc = gogit.CreateOrganizationPullRequest
+	}
+
+	if id, err = createPullRequestFunc(ctx, gc, domain, branch, sync.Spec.PullRequestTemplate, repository); err != nil {
+		return 0, fmt.Errorf("failed to create pull request: %w", err)
+	}
+
+	if err := c.createCheckRun(ctx, repository, id); err != nil {
+		return 0, fmt.Errorf("failed to create check run: %w", err)
+	}
+
+	return id, nil
+}
+
+func (c *Client) createCheckRun(ctx context.Context, repository mpasv1alpha1.Repository, prID int) error {
+	token, err := c.retrieveAccessToken(ctx, repository)
+	if err != nil {
+		return fmt.Errorf("failed to retrieve token: %w", err)
 	}
 
-	return gogit.CreateUserPullRequest(ctx, gc, domain, branch, sync.Spec.PullRequestTemplate, repository)
+	ts := oauth2.StaticTokenSource(&oauth2.Token{AccessToken: string(token)})
+	tc := oauth2.NewClient(context.Background(), ts)
+
+	g := ggithub.NewClient(tc)
+	//
+	pr, _, err := g.PullRequests.Get(ctx, repository.Spec.Owner, repository.Name, prID)
+	if err != nil {
+		return fmt.Errorf("failed to find PR: %w", err)
+	}
+
+	_, _, err = g.Repositories.CreateStatus(ctx, repository.Spec.Owner, repository.Name, *pr.Head.SHA, &ggithub.RepoStatus{
+		State:       ggithub.String("pending"),
+		Description: ggithub.String("MPAS Validation Check"),
+		Context:     ggithub.String(statusCheckName),
+	})
+
+	if err != nil {
+		return fmt.Errorf("failed to create status for pr: %w", err)
+	}
+
+	return nil
 }

pkg/providers/gitlab/gitlab.go

@@ -86,10 +86,10 @@ func (c *Client) CreateRepository(ctx context.Context, obj mpasv1alpha1.Reposito
 	return gogit.CreateUserRepository(ctx, gc, domain, obj)
 }
 
-func (c *Client) CreatePullRequest(ctx context.Context, branch string, sync deliveryv1alpha1.Sync, repository mpasv1alpha1.Repository) error {
+func (c *Client) CreatePullRequest(ctx context.Context, branch string, sync deliveryv1alpha1.Sync, repository mpasv1alpha1.Repository) (int, 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 -1, 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)
@@ -100,12 +100,12 @@ func (c *Client) CreatePullRequest(ctx context.Context, branch string, sync deli
 		Name:      repository.Spec.Credentials.SecretRef.Name,
 		Namespace: sync.Namespace,
 	}, secret); err != nil {
-		return fmt.Errorf("failed to get secret: %w", err)
+		return -1, 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)
+		return -1, fmt.Errorf("token '%s' not found in secret", tokenKey)
 	}
 
 	domain := defaultDomain
@@ -115,7 +115,7 @@ func (c *Client) CreatePullRequest(ctx context.Context, branch string, sync deli
 
 	gc, err := gitlab.NewClient(string(token), tokenType, gitprovider.WithDomain(domain))
 	if err != nil {
-		return fmt.Errorf("failed to create gitlab client: %w", err)
+		return -1, fmt.Errorf("failed to create gitlab client: %w", err)
 	}
 
 	if repository.Spec.IsOrganization {

pkg/providers/gogit/gogit.go

@@ -157,7 +157,7 @@ func CreateUserRepository(ctx context.Context, gc gitprovider.Client, domain str
 }
 
 // CreateOrganizationPullRequest creates a pull-request for an organization owned repository.
-func CreateOrganizationPullRequest(ctx context.Context, gc gitprovider.Client, domain, branch string, spec deliveryv1alpha1.PullRequestTemplate, repository mpasv1alpha1.Repository) error {
+func CreateOrganizationPullRequest(ctx context.Context, gc gitprovider.Client, domain, branch string, spec deliveryv1alpha1.PullRequestTemplate, repository mpasv1alpha1.Repository) (int, error) {
 	// find the repository
 	repo, err := gc.OrgRepositories().Get(ctx, gitprovider.OrgRepositoryRef{
 		OrganizationRef: gitprovider.OrganizationRef{
@@ -167,7 +167,7 @@ func CreateOrganizationPullRequest(ctx context.Context, gc gitprovider.Client, d
 		RepositoryName: repository.GetName(),
 	})
 	if err != nil {
-		return fmt.Errorf("failed to find organization repository: %w", err)
+		return -1, fmt.Errorf("failed to find organization repository: %w", err)
 	}
 
 	var (
@@ -190,17 +190,17 @@ func CreateOrganizationPullRequest(ctx context.Context, gc gitprovider.Client, d
 
 	pr, err := repo.PullRequests().Create(ctx, title, branch, base, description)
 	if err != nil {
-		return fmt.Errorf("failed to create pull request: %w", err)
+		return -1, fmt.Errorf("failed to create pull request: %w", err)
 	}
 
 	logger := log.FromContext(ctx)
 	logger.Info("created pull request for organization repository", "organization", repository.Spec.Owner, "pull-request", pr.Get().Number)
 
-	return nil
+	return pr.Get().Number, nil
 }
 
 // CreateUserPullRequest creates a pull-request for a user owned repository.
-func CreateUserPullRequest(ctx context.Context, gc gitprovider.Client, domain, branch string, spec deliveryv1alpha1.PullRequestTemplate, repository mpasv1alpha1.Repository) error {
+func CreateUserPullRequest(ctx context.Context, gc gitprovider.Client, domain, branch string, spec deliveryv1alpha1.PullRequestTemplate, repository mpasv1alpha1.Repository) (int, error) {
 	// find the repository
 	repo, err := gc.UserRepositories().Get(ctx, gitprovider.UserRepositoryRef{
 		UserRef: gitprovider.UserRef{
@@ -210,7 +210,7 @@ func CreateUserPullRequest(ctx context.Context, gc gitprovider.Client, domain, b
 		RepositoryName: repository.GetName(),
 	})
 	if err != nil {
-		return fmt.Errorf("failed to find user repository: %w", err)
+		return -1, fmt.Errorf("failed to find user repository: %w", err)
 	}
 
 	var (
@@ -233,13 +233,13 @@ func CreateUserPullRequest(ctx context.Context, gc gitprovider.Client, domain, b
 
 	pr, err := repo.PullRequests().Create(ctx, title, branch, base, description)
 	if err != nil {
-		return fmt.Errorf("failed to create pull request: %w", err)
+		return -1, fmt.Errorf("failed to create pull request: %w", err)
 	}
 
 	logger := log.FromContext(ctx)
 	logger.Info("created pull request for user repository", "user", repository.Spec.Owner, "pull-request", pr.Get().Number)
 
-	return nil
+	return pr.Get().Number, nil
 }
 
 // Repositories groups together a common functionality of both repository types.

pkg/providers/providers.go

@@ -23,6 +23,6 @@ var NotSupportedError = errors.New("functionality not supported by provider")
 // Provider adds the ability to create repositories and pull requests.
 type Provider interface {
 	CreateRepository(ctx context.Context, obj mpasv1alpha1.Repository) error
-	CreatePullRequest(ctx context.Context, branch string, sync deliveryv1alpha1.Sync, repository mpasv1alpha1.Repository) error
+	CreatePullRequest(ctx context.Context, branch string, sync deliveryv1alpha1.Sync, repository mpasv1alpha1.Repository) (int, error)
 	CreateBranchProtection(ctx context.Context, obj mpasv1alpha1.Repository) error
 }