feat: add gitlab support (#205)

* feat: add gitlab support

Signed-off-by: Robin Lieb <[email protected]>

* fix: implement initial code review remarks

Signed-off-by: Robin Lieb <[email protected]>

* test: fix tests

Signed-off-by: Robin Lieb <[email protected]>

* fix: code review remarks

Signed-off-by: Robin Lieb <[email protected]>

* Apply suggestions from code review

Co-authored-by: Michael Crenshaw <[email protected]>
Signed-off-by: Robin Lieb <[email protected]>

* feat: log gitlab rate limits only when available

Signed-off-by: Robin Lieb <[email protected]>

---------

Signed-off-by: Robin Lieb <[email protected]>
Co-authored-by: Michael Crenshaw <[email protected]>
Co-authored-by: Zach Aller <[email protected]>

Author: 3 people

api/v1alpha1/common_types.go

@@ -4,6 +4,10 @@ type GitHub struct {
 	Domain string `json:"domain,omitempty"`
 }
 
+type GitLab struct {
+	Domain string `json:"domain,omitempty"`
+}
+
 type Fake struct {
 	Domain string `json:"domain,omitempty"`
 }
@@ -12,3 +16,30 @@ type ObjectReference struct {
 	// +kubebuilder:validation:Required
 	Name string `json:"name"`
 }
+
+type GitHubRepo struct {
+	// +kubebuilder:validation:Required
+	Owner string `json:"owner"`
+	// +kubebuilder:validation:Required
+	Name string `json:"name"`
+}
+
+type GitLabRepo struct {
+	// User, group or group with subgroup (e.g. group/subgroup).
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:Pattern=^[a-zA-Z0-9_\-\/.]+$
+	Namespace string `json:"namespace"`
+	// Project slug of the repository.
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:Pattern=^[a-zA-Z0-9_\-\/.]+$
+	Name string `json:"name"`
+	// +kubebuilder:validation:Required
+	ProjectID int `json:"projectId"`
+}
+
+type FakeRepo struct {
+	// +kubebuilder:validation:Required
+	Owner string `json:"owner"`
+	// +kubebuilder:validation:Required
+	Name string `json:"name"`
+}

api/v1alpha1/gitrepository_types.go

@@ -25,10 +25,9 @@ import (
 
 // GitRepositorySpec defines the desired state of GitRepository
 type GitRepositorySpec struct {
-	// +kubebuilder:validation:Required
-	Owner string `json:"owner"`
-	// +kubebuilder:validation:Required
-	Name string `json:"name"`
+	GitHub *GitHubRepo `json:"github,omitempty"`
+	GitLab *GitLabRepo `json:"gitlab,omitempty"`
+	Fake   *FakeRepo   `json:"fake,omitempty"`
 	// +kubebuilder:validation:Required
 	ScmProviderRef ObjectReference `json:"scmProviderRef"`
 }

api/v1alpha1/scmprovider_types.go

@@ -35,6 +35,9 @@ type ScmProviderSpec struct {
 	// GitHub required configuration for GitHub as the SCM provider
 	GitHub *GitHub `json:"github,omitempty"`
 
+	// GitLab required configuration for GitLab as the SCM provider
+	GitLab *GitLab `json:"gitlab,omitempty"`
+
 	// Fake required configuration for Fake as the SCM provider
 	Fake *Fake `json:"fake,omitempty"`
 }

api/v1alpha1/zz_generated.deepcopy.go

@@ -1,7 +1,7 @@
 # Getting Started
 
 This guide will help you get started installing and setting up the GitOps Promoter. We currently only support
-GitHub and GitHub Enterprise as the SCM providers. We would welcome any contributions to add support for other
+GitHub, GitHub Enterprise and GitLab as the SCM providers. We would welcome any contributions to add support for other
 providers.
 
 ## Requirements
@@ -86,8 +86,9 @@ kind: GitRepository
 metadata:
   name: <git-repository-ref-name>
 spec:
-  name: <repo-name>
-  owner: <github-org-username>
+  github:
+    name: <repo-name>
+    owner: <github-org-username>
   scmProviderRef:
     name: <your-scmprovider-name> # The secret that contains the GitHub App configuration
 ```
@@ -97,6 +98,46 @@ spec:
     The GitRepository and ScmProvider also need to be installed to the same namespace that you plan on creating PromotionStrategy 
     resources in, and it also needs to be in the same namespace of the secret it references.
 
+## GitLab Configuration
+
+To configure the GitOps Promoter with GitLab, you will need to create a GitLab Access Token under the "Developer" role with `api` and `write_repository` scopes and configure the necessary resources to allow the promoter to interact with your repository. This Access Token should be used in a secret as follows:
+
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: <your-secret-name>
+type: Opaque
+stringData:
+  token: <your-access-token>
+```
+
+We also need a GitRepository and ScmProvider, which is are custom resources that represents a git repository and a provider. 
+Here is an example of both resources:
+
+```yaml
+apiVersion: promoter.argoproj.io/v1alpha1
+kind: ScmProvider
+metadata:
+  name: <your-scmprovider-name>
+spec:
+  secretRef:
+    name: <your-secret-name>
+  gitlab: {}
+---
+apiVersion: promoter.argoproj.io/v1alpha1
+kind: GitRepository
+metadata:
+  name: <git-repository-ref-name>
+spec:
+  gitlab:
+    name: <repo-name>
+    namespace: <user-or-group-with-subgroups>
+    projectId: <project-id>
+  scmProviderRef:
+    name: <your-scmprovider-name> # The secret that contains the GitLab Access Token
+```
+
 ## Promotion Strategy
 
 The PromotionStrategy resource is the main resource that you will use to configure the promotion of your application to different environments.