added adopt or fail options for existing repositories

Author: Skarlso

apis/mpas/v1alpha1/repository_types.go

@@ -20,17 +20,31 @@ type Credentials struct {
 	SecretRef SecretRef `json:"secretRef"`
 }
 
+// ExistingRepositoryPolicy defines what to do in case a requested repository already exists.
+type ExistingRepositoryPolicy string
+
+var (
+	// ExistingRepositoryPolicyAdopt will use the repository if it exists.
+	ExistingRepositoryPolicyAdopt ExistingRepositoryPolicy = "adopt"
+	// ExistingRepositoryPolicyFail will fail if the requested repository already exists.
+	ExistingRepositoryPolicyFail ExistingRepositoryPolicy = "fail"
+)
+
 // RepositorySpec defines the desired state of Repository
 type RepositorySpec struct {
-	Provider       string      `json:"provider"`
-	Owner          string      `json:"owner"`
-	RepositoryName string      `json:"repositoryName"`
-	Credentials    Credentials `json:"credentials"`
+	//+required
+	Provider string `json:"provider"`
+	//+required
+	Owner string `json:"owner"`
+	//+required
+	RepositoryName string `json:"repositoryName"`
+	//+required
+	Credentials Credentials `json:"credentials"`
 
 	//+optional
 	Interval metav1.Duration `json:"interval,omitempty"`
 	//+optional
-	//+kubebuilder:default:=internal
+	//+kubebuilder:default:=private
 	Visibility string `json:"visibility,omitempty"`
 	//+kubebuilder:default:=true
 	IsOrganization bool `json:"isOrganization,omitempty"`
@@ -41,6 +55,10 @@ type RepositorySpec struct {
 	//+optional
 	//+kubebuilder:default:=true
 	AutomaticPullRequestCreation bool `json:"automaticPullRequestCreation,omitempty"`
+	//+optional
+	//+kubebuilder:default:=adopt
+	//+kubebuilder:validation:Enum=adopt;fail
+	ExistingRepositoryPolicy ExistingRepositoryPolicy `json:"existingRepositoryPolicy,omitempty"`
 }
 
 // RepositoryStatus defines the observed state of Repository

config/crd/bases/mpas.ocm.software_repositories.yaml

@@ -56,6 +56,14 @@ spec:
                 type: object
               domain:
                 type: string
+              existingRepositoryPolicy:
+                default: adopt
+                description: ExistingRepositoryPolicy defines what to do in case a
+                  requested repository already exists.
+                enum:
+                - adopt
+                - fail
+                type: string
               interval:
                 type: string
               isOrganization:
@@ -72,7 +80,7 @@ spec:
               repositoryName:
                 type: string
               visibility:
-                default: internal
+                default: private
                 type: string
             required:
             - credentials

config/samples/mpas_v1alpha1_repository.yaml

@@ -6,7 +6,6 @@ spec:
   credentials:
     secretRef:
       name: github-creds
-  interval: 10m
   owner: Skarlso
   provider: github
   repositoryName: new-repository-1

pkg/providers/github/github.go

@@ -103,43 +103,79 @@ func (c *Client) constructAuthenticationOption(ctx context.Context, obj mpasv1al
 func (c *Client) createOrganizationRepository(ctx context.Context, gc gitprovider.Client, domain string, visibility gitprovider.RepositoryVisibility, spec mpasv1alpha1.RepositorySpec) error {
 	logger := log.FromContext(ctx)
 
-	repo, err := gc.OrgRepositories().Create(ctx, gitprovider.OrgRepositoryRef{
+	ref := gitprovider.OrgRepositoryRef{
 		OrganizationRef: gitprovider.OrganizationRef{
 			Domain:       domain,
 			Organization: spec.Owner,
 		},
 		RepositoryName: spec.RepositoryName,
-	}, gitprovider.RepositoryInfo{
+	}
+	info := gitprovider.RepositoryInfo{
 		DefaultBranch: gitprovider.StringVar("main"),
 		Visibility:    &visibility,
-	})
-	if err != nil {
-		return fmt.Errorf("failed to create repository: %w", err)
 	}
 
-	logger.Info("organization repository successfully created", "name", repo.Repository().String())
+	switch spec.ExistingRepositoryPolicy {
+	case mpasv1alpha1.ExistingRepositoryPolicyFail:
+		if _, err := gc.OrgRepositories().Create(ctx, ref, info); err != nil {
+			return fmt.Errorf("failed to create repository: %w", err)
+		}
+
+		logger.Info("successfully created organization repository", "domain", domain, "repository", spec.RepositoryName)
+	case mpasv1alpha1.ExistingRepositoryPolicyAdopt:
+		_, created, err := gc.OrgRepositories().Reconcile(ctx, ref, info)
+		if err != nil {
+			return fmt.Errorf("failed to reconcile repository: %w", err)
+		}
+
+		if !created {
+			logger.Info("using existing repository", "domain", domain, "repository", spec.RepositoryName)
+		} else {
+			logger.Info("successfully created organization repository", "domain", domain, "repository", spec.RepositoryName)
+		}
+	default:
+		return fmt.Errorf("unknown repository policy '%s'", spec.ExistingRepositoryPolicy)
+	}
 
 	return nil
 }
 
 func (c *Client) createUserRepository(ctx context.Context, gc gitprovider.Client, domain string, visibility gitprovider.RepositoryVisibility, spec mpasv1alpha1.RepositorySpec) error {
 	logger := log.FromContext(ctx)
 
-	repo, err := gc.UserRepositories().Create(ctx, gitprovider.UserRepositoryRef{
+	ref := gitprovider.UserRepositoryRef{
 		UserRef: gitprovider.UserRef{
 			Domain:    domain,
 			UserLogin: spec.Owner,
 		},
 		RepositoryName: spec.RepositoryName,
-	}, gitprovider.RepositoryInfo{
+	}
+	info := gitprovider.RepositoryInfo{
 		DefaultBranch: gitprovider.StringVar("main"),
 		Visibility:    &visibility,
-	})
-	if err != nil {
-		return fmt.Errorf("failed to create repository: %w", err)
 	}
 
-	logger.Info("user repository successfully created", "name", repo.Repository().String())
+	switch spec.ExistingRepositoryPolicy {
+	case mpasv1alpha1.ExistingRepositoryPolicyFail:
+		if _, err := gc.UserRepositories().Create(ctx, ref, info); err != nil {
+			return fmt.Errorf("failed to create repository: %w", err)
+		}
+
+		logger.Info("successfully created user repository", "domain", domain, "repository", spec.RepositoryName)
+	case mpasv1alpha1.ExistingRepositoryPolicyAdopt:
+		_, created, err := gc.UserRepositories().Reconcile(ctx, ref, info)
+		if err != nil {
+			return fmt.Errorf("failed to reconcile repository: %w", err)
+		}
+
+		if !created {
+			logger.Info("using existing repository", "domain", domain, "repository", spec.RepositoryName)
+		} else {
+			logger.Info("successfully created user repository", "domain", domain, "repository", spec.RepositoryName)
+		}
+	default:
+		return fmt.Errorf("unknown repository policy '%s'", spec.ExistingRepositoryPolicy)
+	}
 
 	return nil
 }