Merge pull request #38 from kterada0509/feature/add-support-for-gitlab

Add support for gitlab and gitlab-ci

Author: b4b4r07

Gopkg.lock

@@ -173,6 +173,54 @@ terraform:
 
 </details>
 
+<details>
+<summary>For GitLab</summary>
+
+```yaml
+---
+ci: gitlabci
+notifier:
+  gitlab:
+    token: $GITLAB_TOKEN
+    base_url: $GITLAB_BASE_URL
+    repository:
+      owner: "mercari"
+      name: "tfnotify"
+terraform:
+  fmt:
+    template: |
+      {{ .Title }}
+
+      {{ .Message }}
+
+      {{ .Result }}
+
+      {{ .Body }}
+  plan:
+    template: |
+      {{ .Title }} <sup>[CI link]( {{ .Link }} )</sup>
+      {{ .Message }}
+      {{if .Result}}
+      <pre><code> {{ .Result }}
+      </pre></code>
+      {{end}}
+      <details><summary>Details (Click me)</summary>
+      <pre><code> {{ .Body }}
+      </pre></code></details>
+  apply:
+    template: |
+      {{ .Title }}
+      {{ .Message }}
+      {{if .Result}}
+      <pre><code> {{ .Result }}
+      </pre></code>
+      {{end}}
+      <details><summary>Details (Click me)</summary>
+      <pre><code> {{ .Body }}
+      </pre></code></details>
+```
+</details>
+
 <details>
 <summary>For Slack</summary>
 
@@ -236,6 +284,7 @@ Currently, supported CI are here:
 - TeamCity
 - Drone
 - Jenkins
+- GitLab CI
 
 ### Private Repository Considerations
 GitHub private repositories require the `repo` and `write:discussion` permissions.

README.md

@@ -101,3 +101,23 @@ func jenkins() (ci CI, err error) {
 	}
 	return ci, err
 }
+
+func gitlabci() (ci CI, err error) {
+	ci.PR.Number = 0
+	ci.PR.Revision = os.Getenv("CI_COMMIT_SHA")
+	ci.URL = os.Getenv("CI_JOB_URL")
+	pr := os.Getenv("CI_MERGE_REQUEST_IID")
+	if pr == "" {
+		refPath := os.Getenv("CI_MERGE_REQUEST_REF_PATH")
+		rep := regexp.MustCompile(`refs/merge-requests/\d*/head`)
+		if rep.MatchString(refPath) {
+			strLen := strings.Split(refPath, "/")
+			pr = strLen[2]
+		}
+	}
+	if pr == "" {
+		return ci, nil
+	}
+	ci.PR.Number, err = strconv.Atoi(pr)
+	return ci, err
+}

ci.go

@@ -536,3 +536,89 @@ func TestJenkins(t *testing.T) {
 		}
 	}
 }
+
+func TestGitLabCI(t *testing.T) {
+	envs := []string{
+		"CI_COMMIT_SHA",
+		"CI_JOB_URL",
+		"CI_MERGE_REQUEST_IID",
+		"CI_MERGE_REQUEST_REF_PATH",
+	}
+	saveEnvs := make(map[string]string)
+	for _, key := range envs {
+		saveEnvs[key] = os.Getenv(key)
+		os.Unsetenv(key)
+	}
+	defer func() {
+		for key, value := range saveEnvs {
+			os.Setenv(key, value)
+		}
+	}()
+
+	// https://docs.gitlab.com/ee/ci/variables/README.html
+	testCases := []struct {
+		fn func()
+		ci CI
+		ok bool
+	}{
+		{
+			fn: func() {
+				os.Setenv("CI_COMMIT_SHA", "abcdefg")
+				os.Setenv("CI_JOB_URL", "https://gitlab.com/owner/repo/-/jobs/111111111")
+				os.Setenv("CI_MERGE_REQUEST_IID", "1")
+				os.Setenv("CI_MERGE_REQUEST_REF_PATH", "refs/merge-requests/1/head")
+			},
+			ci: CI{
+				PR: PullRequest{
+					Revision: "abcdefg",
+					Number:   1,
+				},
+				URL: "https://gitlab.com/owner/repo/-/jobs/111111111",
+			},
+			ok: true,
+		},
+		{
+			fn: func() {
+				os.Setenv("CI_COMMIT_SHA", "hijklmn")
+				os.Setenv("CI_JOB_URL", "https://gitlab.com/owner/repo/-/jobs/222222222")
+				os.Setenv("CI_MERGE_REQUEST_REF_PATH", "refs/merge-requests/123/head")
+				os.Unsetenv("CI_MERGE_REQUEST_IID")
+			},
+			ci: CI{
+				PR: PullRequest{
+					Revision: "hijklmn",
+					Number:   123,
+				},
+				URL: "https://gitlab.com/owner/repo/-/jobs/222222222",
+			},
+			ok: true,
+		},
+		{
+			fn: func() {
+				os.Setenv("CI_COMMIT_SHA", "hijklmn")
+				os.Setenv("CI_JOB_URL", "https://gitlab.com/owner/repo/-/jobs/333333333")
+				os.Unsetenv("CI_MERGE_REQUEST_IID")
+				os.Unsetenv("CI_MERGE_REQUEST_REF_PATH")
+			},
+			ci: CI{
+				PR: PullRequest{
+					Revision: "hijklmn",
+					Number:   0,
+				},
+				URL: "https://gitlab.com/owner/repo/-/jobs/333333333",
+			},
+			ok: true,
+		},
+	}
+
+	for _, testCase := range testCases {
+		testCase.fn()
+		ci, err := gitlabci()
+		if !reflect.DeepEqual(ci, testCase.ci) {
+			t.Errorf("got %q but want %q", ci, testCase.ci)
+		}
+		if (err == nil) != testCase.ok {
+			t.Errorf("got error %q", err)
+		}
+	}
+}

ci_test.go

@@ -22,6 +22,7 @@ type Config struct {
 // Notifier is a notification notifier
 type Notifier struct {
 	Github   GithubNotifier   `yaml:"github"`
+	Gitlab   GitlabNotifier   `yaml:"gitlab"`
 	Slack    SlackNotifier    `yaml:"slack"`
 	Typetalk TypetalkNotifier `yaml:"typetalk"`
 }
@@ -33,6 +34,13 @@ type GithubNotifier struct {
 	Repository Repository `yaml:"repository"`
 }
 
+// GitlabNotifier is a notifier for GitLab
+type GitlabNotifier struct {
+	Token      string     `yaml:"token"`
+	BaseURL    string     `yaml:"base_url"`
+	Repository Repository `yaml:"repository"`
+}
+
 // Repository represents a GitHub repository
 type Repository struct {
 	Owner string `yaml:"owner"`
@@ -98,6 +106,8 @@ func (cfg *Config) Validation() error {
 		return errors.New("ci: need to be set")
 	case "circleci", "circle-ci":
 		// ok pattern
+	case "gitlabci", "gitlab-ci":
+		// ok pattern
 	case "travis", "travisci", "travis-ci":
 		// ok pattern
 	case "codebuild":
@@ -119,6 +129,14 @@ func (cfg *Config) Validation() error {
 			return fmt.Errorf("repository name is missing")
 		}
 	}
+	if cfg.isDefinedGitlab() {
+		if cfg.Notifier.Gitlab.Repository.Owner == "" {
+			return fmt.Errorf("repository owner is missing")
+		}
+		if cfg.Notifier.Gitlab.Repository.Name == "" {
+			return fmt.Errorf("repository name is missing")
+		}
+	}
 	if cfg.isDefinedSlack() {
 		if cfg.Notifier.Slack.Channel == "" {
 			return fmt.Errorf("slack channel id is missing")
@@ -141,6 +159,11 @@ func (cfg *Config) isDefinedGithub() bool {
 	return cfg.Notifier.Github != (GithubNotifier{})
 }
 
+func (cfg *Config) isDefinedGitlab() bool {
+	// not empty
+	return cfg.Notifier.Gitlab != (GitlabNotifier{})
+}
+
 func (cfg *Config) isDefinedSlack() bool {
 	// not empty
 	return cfg.Notifier.Slack != (SlackNotifier{})
@@ -156,6 +179,9 @@ func (cfg *Config) GetNotifierType() string {
 	if cfg.isDefinedGithub() {
 		return "github"
 	}
+	if cfg.isDefinedGitlab() {
+		return "gitlab"
+	}
 	if cfg.isDefinedSlack() {
 		return "slack"
 	}

config/config.go

@@ -151,6 +151,10 @@ func TestValidation(t *testing.T) {
 			contents: []byte("ci: jenkins\n"),
 			expected: "notifier is missing",
 		},
+		{
+			contents: []byte("ci: gitlabci\n"),
+			expected: "notifier is missing",
+		},
 		{
 			contents: []byte("ci: circleci\nnotifier:\n  github:\n"),
 			expected: "notifier is missing",
@@ -220,6 +224,47 @@ notifier:
 		{
 			contents: []byte(`
 ci: circleci
+notifier:
+  typetalk:
+    token: token
+    topic_id: 12345
+`),
+			expected: "",
+		},
+		{
+			contents: []byte(`
+ci: gitlabci
+notifier:
+  gitlab:
+    token: token
+    repository:
+      owner: owner
+`),
+			expected: "repository name is missing",
+		},
+		{
+			contents: []byte(`
+ci: gitlabci
+notifier:
+  slack:
+`),
+			expected: "notifier is missing",
+		},
+		{
+			contents: []byte(`
+ci: gitlabci
+notifier:
+  gitlab:
+    token: token
+    repository:
+      owner: owner
+      name: name
+`),
+			expected: "",
+		},
+		{
+			contents: []byte(`
+ci: gitlabci
 notifier:
   typetalk:
     token: token
@@ -272,6 +317,10 @@ func TestGetNotifierType(t *testing.T) {
 			contents: []byte("repository:\n  owner: a\n  name: b\nci: circleci\nnotifier:\n  typetalk:\n    token: token\n"),
 			expected: "typetalk",
 		},
+		{
+			contents: []byte("repository:\n  owner: a\n  name: b\nci: gitlabci\nnotifier:\n  gitlab:\n    token: token\n"),
+			expected: "gitlab",
+		},
 	}
 	for _, testCase := range testCases {
 		cfg, err := helperLoadConfig(testCase.contents)

config/config_test.go

@@ -8,6 +8,7 @@ import (
 	"github.com/mercari/tfnotify/config"
 	"github.com/mercari/tfnotify/notifier"
 	"github.com/mercari/tfnotify/notifier/github"
+	"github.com/mercari/tfnotify/notifier/gitlab"
 	"github.com/mercari/tfnotify/notifier/slack"
 	"github.com/mercari/tfnotify/notifier/typetalk"
 	"github.com/mercari/tfnotify/terraform"
@@ -68,6 +69,11 @@ func (t *tfnotify) Run() error {
 		if err != nil {
 			return err
 		}
+	case "gitlabci", "gitlab-ci":
+		ci, err = gitlabci()
+		if err != nil {
+			return err
+		}
 	case "":
 		return fmt.Errorf("CI service: required (e.g. circleci)")
 	default:
@@ -101,6 +107,26 @@ func (t *tfnotify) Run() error {
 			return err
 		}
 		notifier = client.Notify
+	case "gitlab":
+		client, err := gitlab.NewClient(gitlab.Config{
+			Token:     t.config.Notifier.Gitlab.Token,
+			BaseURL:   t.config.Notifier.Gitlab.BaseURL,
+			NameSpace: t.config.Notifier.Gitlab.Repository.Owner,
+			Project:   t.config.Notifier.Gitlab.Repository.Name,
+			MR: gitlab.MergeRequest{
+				Revision: ci.PR.Revision,
+				Number:   ci.PR.Number,
+				Title:    t.context.String("title"),
+				Message:  t.context.String("message"),
+			},
+			CI:       ci.URL,
+			Parser:   t.parser,
+			Template: t.template,
+		})
+		if err != nil {
+			return err
+		}
+		notifier = client.Notify
 	case "slack":
 		client, err := slack.NewClient(slack.Config{
 			Token:    t.config.Notifier.Slack.Token,