🍱 [minor] Publish merge request report to Gitlab (#119)

* feat: mr report to Gitlab (#118)

* add gitlab token to samsahai cmd args

* feat: add new crd and gitlab test publish

* allow read gitlabToken from k8s secret

* test: add util gitlab_test.go

* test: add samsahai gitlab report reporter_test.go

* update crd template

* update crd example

* format lint

* make swag

Author: cjtim

api/v1/config_types.go

@@ -207,6 +207,8 @@ type ConfigReporter struct {
 	// +optional
 	Github *ReporterGithub `json:"github,omitempty"`
 	// +optional
+	Gitlab *ReporterGitlab `json:"gitlab,omitempty"`
+	// +optional
 	Rest *ReporterRest `json:"rest,omitempty"`
 	// +optional
 	Shell *ReporterShell `json:"cmd,omitempty"`
@@ -307,6 +309,17 @@ type ReporterGithub struct {
 	BaseURL string `json:"baseURL,omitempty"`
 }
 
+// ReporterGitlab defines a configuration of gitlab reporter
+// supports pull request queue reporter type only
+type ReporterGitlab struct {
+	// Enabled represents an enabled flag
+	// +optional
+	Enabled bool `json:"enabled"`
+	// BaseURL represents a gitlab base url e.g., https://gitlab.com
+	// +optional
+	BaseURL string `json:"baseURL,omitempty"`
+}
+
 // ReporterRest defines a configuration of http rest
 type ReporterRest struct {
 	// +optional

api/v1/team_types.go

@@ -72,6 +72,10 @@ type Credential struct {
 	// Github
 	// +optional
 	Github *TokenCredential `json:"github,omitempty"`
+
+	// Gitlab
+	// +optional
+	Gitlab *TokenCredential `json:"gitlab,omitempty"`
 }
 
 type UsernamePasswordCredential struct {

cmd/samsahai/main.go

@@ -141,6 +141,7 @@ func startCtrlCmd() *cobra.Command {
 				// TODO: move to credential
 				TeamcityURL: viper.GetString(s2h.VKTeamcityURL),
 				GithubURL:   viper.GetString(s2h.VKGithubURL),
+				GitlabURL:   viper.GetString(s2h.VKGitlabURL),
 				SamsahaiURL: fmt.Sprintf("%s://%s.%s:%s",
 					viper.GetString(s2h.VKS2HServiceScheme),
 					viper.GetString(s2h.VKS2HServiceName),
@@ -262,6 +263,8 @@ func startCtrlCmd() *cobra.Command {
 	cmd.Flags().String(s2h.VKS2HServiceName, "samsahai", "Service name for connecting to Samsahai.")
 	cmd.Flags().String(s2h.VKS2HExternalURL, "http://localhost:8080", "External url for Samsahai.")
 	cmd.Flags().String(s2h.VKGithubToken, "", "Github access token for publishing commit status into github.")
+	cmd.Flags().String(s2h.VKGitlabToken, "", "Gitlab access token for publishing commit status into gitlab.")
+	cmd.Flags().String(s2h.VKGitlabURL, "", "Gitlab base URL used for initializing Gitlab reporter.")
 	cmd.Flags().String(s2h.VKGithubURL, "", "Github base URL used for initializing Github reporter.")
 	cmd.Flags().String(s2h.VKTeamcityURL, "",
 		"Teamcity base URL used for initializing Teamcity test runner.")

config/chart/samsahai/values.yaml

@@ -27,6 +27,7 @@ fileConfigs:
   s2hImage: '{{ .Values.image.repository }}:{{ .Values.image.tag }}'
   clusterDomain: "cluster.local"
   githubURL: "https://github.com"
+  gitlabURL: "https://gitlab.com"
 
   # cpu/memory of cronjobs for sending new component webhook
   checkerResources:

config/crds/env.samsahai.io_configs.yaml

@@ -519,6 +519,16 @@ spec:
                         description: Enabled represents an enabled flag
                         type: boolean
                     type: object
+                  gitlab:
+                    description: ReporterGitlab defines a configuration of gitlab reporter supports pull request queue reporter type only
+                    properties:
+                      baseURL:
+                        description: BaseURL represents a gitlab base url e.g., https://gitlab.com
+                        type: string
+                      enabled:
+                        description: Enabled represents an enabled flag
+                        type: boolean
+                    type: object
                   msTeams:
                     description: ReporterMSTeams defines a configuration of Microsoft Teams
                     properties:
@@ -1284,6 +1294,16 @@ spec:
                             description: Enabled represents an enabled flag
                             type: boolean
                         type: object
+                      gitlab:
+                        description: ReporterGitlab defines a configuration of gitlab reporter supports pull request queue reporter type only
+                        properties:
+                          baseURL:
+                            description: BaseURL represents a gitlab base url e.g., https://gitlab.com
+                            type: string
+                          enabled:
+                            description: Enabled represents an enabled flag
+                            type: boolean
+                        type: object
                       msTeams:
                         description: ReporterMSTeams defines a configuration of Microsoft Teams
                         properties:

config/crds/env.samsahai.io_teams.yaml

@@ -35,6 +35,27 @@ spec:
               credential:
                 description: Credential
                 properties:
+                  gitlab:
+                    description: Gitlab
+                    properties:
+                      token:
+                        description: SecretKeySelector selects a key of a Secret.
+                        properties:
+                          key:
+                            description: The key of the secret to select from.  Must be a valid secret key.
+                            type: string
+                          name:
+                            description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+                            type: string
+                          optional:
+                            description: Specify whether the Secret or its key must be defined
+                            type: boolean
+                        required:
+                          - key
+                        type: object
+                    required:
+                      - token
+                    type: object
                   github:
                     description: Github
                     properties:
@@ -290,6 +311,27 @@ spec:
                   credential:
                     description: Credential
                     properties:
+                      gitlab:
+                        description: Gitlab
+                        properties:
+                          token:
+                            description: SecretKeySelector selects a key of a Secret.
+                            properties:
+                              key:
+                                description: The key of the secret to select from.  Must be a valid secret key.
+                                type: string
+                              name:
+                                description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?'
+                                type: string
+                              optional:
+                                description: Specify whether the Secret or its key must be defined
+                                type: boolean
+                            required:
+                              - key
+                            type: object
+                        required:
+                          - token
+                        type: object
                       github:
                         description: Github
                         properties:

docs/docs.go

@@ -1,6 +1,6 @@
 // GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
 // This file was generated by swaggo/swag at
-// 2021-10-18 13:50:22.115873 +0700 +07 m=+0.245617719
+// 2021-11-09 15:17:03.538962 +0700 +07 m=+0.185377644
 
 package docs
 
@@ -1315,6 +1315,11 @@ var doc = `{
                     "type": "object",
                     "$ref": "#/definitions/v1.ReporterGithub"
                 },
+                "gitlab": {
+                    "description": "+optional",
+                    "type": "object",
+                    "$ref": "#/definitions/v1.ReporterGitlab"
+                },
                 "msTeams": {
                     "description": "+optional",
                     "type": "object",
@@ -1468,6 +1473,11 @@ var doc = `{
                     "type": "object",
                     "$ref": "#/definitions/v1.TokenCredential"
                 },
+                "gitlab": {
+                    "description": "Gitlab\n+optional",
+                    "type": "object",
+                    "$ref": "#/definitions/v1.TokenCredential"
+                },
                 "secretName": {
                     "description": "SecretName",
                     "type": "string"
@@ -1873,7 +1883,7 @@ var doc = `{
             "type": "object",
             "properties": {
                 "criteria": {
-                    "description": "Criteria tells how does the duration apply, default is ` + "`" + `both` + "`" + `.\n+optional",
+                    "description": "Criteria tells how does the duration apply, default is ` + "`" + `failure` + "`" + `.\n+optional",
                     "type": "string"
                 },
                 "duration": {
@@ -2156,6 +2166,19 @@ var doc = `{
                 }
             }
         },
+        "v1.ReporterGitlab": {
+            "type": "object",
+            "properties": {
+                "baseURL": {
+                    "description": "BaseURL represents a gitlab base url e.g., https://gitlab.com\n+optional",
+                    "type": "string"
+                },
+                "enabled": {
+                    "description": "Enabled represents an enabled flag\n+optional",
+                    "type": "boolean"
+                }
+            }
+        },
         "v1.ReporterMSTeams": {
             "type": "object",
             "properties": {

docs/swagger.json

@@ -1294,6 +1294,11 @@
                     "type": "object",
                     "$ref": "#/definitions/v1.ReporterGithub"
                 },
+                "gitlab": {
+                    "description": "+optional",
+                    "type": "object",
+                    "$ref": "#/definitions/v1.ReporterGitlab"
+                },
                 "msTeams": {
                     "description": "+optional",
                     "type": "object",
@@ -1447,6 +1452,11 @@
                     "type": "object",
                     "$ref": "#/definitions/v1.TokenCredential"
                 },
+                "gitlab": {
+                    "description": "Gitlab\n+optional",
+                    "type": "object",
+                    "$ref": "#/definitions/v1.TokenCredential"
+                },
                 "secretName": {
                     "description": "SecretName",
                     "type": "string"
@@ -1852,7 +1862,7 @@
             "type": "object",
             "properties": {
                 "criteria": {
-                    "description": "Criteria tells how does the duration apply, default is `both`.\n+optional",
+                    "description": "Criteria tells how does the duration apply, default is `failure`.\n+optional",
                     "type": "string"
                 },
                 "duration": {
@@ -2135,6 +2145,19 @@
                 }
             }
         },
+        "v1.ReporterGitlab": {
+            "type": "object",
+            "properties": {
+                "baseURL": {
+                    "description": "BaseURL represents a gitlab base url e.g., https://gitlab.com\n+optional",
+                    "type": "string"
+                },
+                "enabled": {
+                    "description": "Enabled represents an enabled flag\n+optional",
+                    "type": "boolean"
+                }
+            }
+        },
         "v1.ReporterMSTeams": {
             "type": "object",
             "properties": {

docs/swagger.yaml

@@ -396,6 +396,10 @@ definitions:
         $ref: '#/definitions/v1.ReporterGithub'
         description: +optional
         type: object
+      gitlab:
+        $ref: '#/definitions/v1.ReporterGitlab'
+        description: +optional
+        type: object
       msTeams:
         $ref: '#/definitions/v1.ReporterMSTeams'
         description: +optional
@@ -536,6 +540,12 @@ definitions:
           Github
           +optional
         type: object
+      gitlab:
+        $ref: '#/definitions/v1.TokenCredential'
+        description: |-
+          Gitlab
+          +optional
+        type: object
       secretName:
         description: SecretName
         type: string
@@ -893,7 +903,7 @@ definitions:
     properties:
       criteria:
         description: |-
-          Criteria tells how does the duration apply, default is `both`.
+          Criteria tells how does the duration apply, default is `failure`.
           +optional
         type: string
       duration:
@@ -1125,6 +1135,19 @@ definitions:
           +optional
         type: boolean
     type: object
+  v1.ReporterGitlab:
+    properties:
+      baseURL:
+        description: |-
+          BaseURL represents a gitlab base url e.g., https://gitlab.com
+          +optional
+        type: string
+      enabled:
+        description: |-
+          Enabled represents an enabled flag
+          +optional
+        type: boolean
+    type: object
   v1.ReporterMSTeams:
     properties:
       componentUpgrade:

examples/starter/crds/config.yaml

@@ -376,6 +376,15 @@ spec:
       # github base url
       baseURL: https://github.com
 
+    # publishing commit status into Gitlab repository for a given commit SHA
+    gitlab:
+      # enabled flag of Gitlab reporter
+      # commit status will not be published if enabled is false
+      enabled: true
+
+      # gitlab base url
+      baseURL: https://gitlab.com
+
     # sending notification via slack
     slack:
       # if you would like to specify your channel
@@ -458,7 +467,7 @@ spec:
       # check supported value format from
       # https://raw.githubusercontent.com/agoda-com/samsahai/master/internal/reporter.go#ActivePromotionReporter
       activePromotion:
-        command: ["/bin/sh", "-c"]
+        command: [ "/bin/sh", "-c" ]
         args:
           - |
             echo "active promotion result: {{ .Result }} of {{ .TeamName }}"
@@ -467,7 +476,7 @@ spec:
       # check support values format from
       # https://raw.githubusercontent.com/agoda-com/samsahai/master/internal/reporter.go#ComponentUpgradeReporter
       componentUpgrade:
-        command: ["/bin/sh", "-c"]
+        command: [ "/bin/sh", "-c" ]
         args:
           - |
             echo "queue name: {{ .Name }} of {{ .TeamName }}"
@@ -476,7 +485,7 @@ spec:
       # check support values format from
       # https://raw.githubusercontent.com/agoda-com/samsahai/master/internal/reporter.go#ImageMissingReporter
       imageMissing:
-        command: ["/bin/sh", "-c"]
+        command: [ "/bin/sh", "-c" ]
         args:
           - |
             echo "image missing: {{ .Repository }}:{{ .Tag }}, component: {{ .ComponentName }}"
@@ -485,7 +494,7 @@ spec:
       # check support values format from
       # https://raw.githubusercontent.com/agoda-com/samsahai/master/internal/reporter.go#ComponentUpgradeReporter
       pullRequestQueue:
-        command: ["/bin/sh", "-c"]
+        command: [ "/bin/sh", "-c" ]
         args:
           - |
             echo "pr queue name: {{ .Name }} of {{ .TeamName }}"
@@ -494,7 +503,7 @@ spec:
       # check support values format from
       # https://raw.githubusercontent.com/agoda-com/samsahai/master/internal/reporter.go#PullRequestTriggerReporter
       pullRequestTrigger:
-        command: ["/bin/sh", "-c"]
+        command: [ "/bin/sh", "-c" ]
         args:
           - |
             "echo pull request trigger of {{ .PRNumber }}: {{ .Result }}"