Merge pull request #27 from is2ei/support-typetalk

Support Typetalk

.codecov.yml

@@ -7,3 +7,4 @@ ignore:
   - "main.go"
   - "notifier/github/github.go"
   - "notifier/slack/slack.go"
+  - "notifier/typetalk/typetalk.go"

README.md

@@ -23,6 +23,8 @@ You can do this by using this command.
 
 <img src="./misc/images/2.png" width="500">
 
+<img src="./misc/images/3.png" width="600">
+
 ## Installation
 
 Grab the binary from GitHub Releases (Recommended)
@@ -60,7 +62,7 @@ For `plan` command, you also need to specify `plan` as the argument of tfnotify.
 
 When running tfnotify, you can specify the configuration path via `--config` option (if it's omitted, it defaults to `{.,}tfnotify.y{,a}ml`).
 
-The example settings of GitHub, GitHub Enterprise and Slack are as follows. Incidentally, there is no need to replace TOKEN string such as `$GITHUB_TOKEN` with the actual token. Instead, it must be defined as environment variables in CI settings.
+The example settings of GitHub and GitHub Enterprise, Slack, [Typetalk](https://www.typetalk.com/) are as follows. Incidentally, there is no need to replace TOKEN string such as `$GITHUB_TOKEN` with the actual token. Instead, it must be defined as environment variables in CI settings.
 
 [template](https://golang.org/pkg/text/template/) of Go can be used for `template`. The templates can be used in `tfnotify.yaml` are as follows:
 
@@ -198,6 +200,32 @@ terraform:
 
 </details>
 
+<details>
+<summary>For Typetalk</summary>
+
+```yaml
+---
+ci: circleci
+notifier:
+  typetalk:
+    token: $TYPETALK_TOKEN
+    topic_id: $TYPETALK_TOPIC_ID
+terraform:
+  plan:
+    template: |
+      {{ .Message }}
+      {{if .Result}}
+      ```
+      {{ .Result }}
+      ```
+      {{end}}
+      ```
+      {{ .Body }}
+      ```
+```
+
+</details>
+
 ### Supported CI
 
 Currently, supported CI are here:

config/config.go

@@ -21,8 +21,9 @@ type Config struct {
 
 // Notifier is a notification notifier
 type Notifier struct {
-	Github GithubNotifier `yaml:"github"`
-	Slack  SlackNotifier  `yaml:"slack"`
+	Github   GithubNotifier   `yaml:"github"`
+	Slack    SlackNotifier    `yaml:"slack"`
+	Typetalk TypetalkNotifier `yaml:"typetalk"`
 }
 
 // GithubNotifier is a notifier for GitHub
@@ -45,6 +46,12 @@ type SlackNotifier struct {
 	Bot     string `yaml:"bot"`
 }
 
+// TypetalkNotifier is a notifier for Typetalk
+type TypetalkNotifier struct {
+	Token   string `yaml:"token"`
+	TopicID string `yaml:"topic_id"`
+}
+
 // Terraform represents terraform configurations
 type Terraform struct {
 	Default Default `yaml:"default"`
@@ -111,6 +118,11 @@ func (cfg *Config) Validation() error {
 			return fmt.Errorf("slack channel id is missing")
 		}
 	}
+	if cfg.isDefinedTypetalk() {
+		if cfg.Notifier.Typetalk.TopicID == "" {
+			return fmt.Errorf("Typetalk topic id is missing")
+		}
+	}
 	notifier := cfg.GetNotifierType()
 	if notifier == "" {
 		return fmt.Errorf("notifier is missing")
@@ -128,6 +140,11 @@ func (cfg *Config) isDefinedSlack() bool {
 	return cfg.Notifier.Slack != (SlackNotifier{})
 }
 
+func (cfg *Config) isDefinedTypetalk() bool {
+	// not empty
+	return cfg.Notifier.Typetalk != (TypetalkNotifier{})
+}
+
 // GetNotifierType return notifier type described in Config
 func (cfg *Config) GetNotifierType() string {
 	if cfg.isDefinedGithub() {
@@ -136,6 +153,9 @@ func (cfg *Config) GetNotifierType() string {
 	if cfg.isDefinedSlack() {
 		return "slack"
 	}
+	if cfg.isDefinedTypetalk() {
+		return "typetalk"
+	}
 	return ""
 }
 

config/config_test.go

@@ -37,6 +37,10 @@ func TestLoadFile(t *testing.T) {
 						Channel: "",
 						Bot:     "",
 					},
+					Typetalk: TypetalkNotifier{
+						Token:   "",
+						TopicID: "",
+					},
 				},
 				Terraform: Terraform{
 					Default: Default{
@@ -73,6 +77,10 @@ func TestLoadFile(t *testing.T) {
 						Channel: "",
 						Bot:     "",
 					},
+					Typetalk: TypetalkNotifier{
+						Token:   "",
+						TopicID: "",
+					},
 				},
 				Terraform: Terraform{
 					Default: Default{
@@ -186,6 +194,33 @@ notifier:
   slack:
     token: token
     channel: channel
+`),
+			expected: "",
+		},
+		{
+			contents: []byte(`
+ci: circleci
+notifier:
+  typetalk:
+`),
+			expected: "notifier is missing",
+		},
+		{
+			contents: []byte(`
+ci: circleci
+notifier:
+  typetalk:
+    token: token
+`),
+			expected: "Typetalk topic id is missing",
+		},
+		{
+			contents: []byte(`
+ci: circleci
+notifier:
+  typetalk:
+    token: token
+    topic_id: 12345
 `),
 			expected: "",
 		},
@@ -221,6 +256,10 @@ func TestGetNotifierType(t *testing.T) {
 			contents: []byte("repository:\n  owner: a\n  name: b\nci: circleci\nnotifier:\n  slack:\n    token: token\n"),
 			expected: "slack",
 		},
+		{
+			contents: []byte("repository:\n  owner: a\n  name: b\nci: circleci\nnotifier:\n  typetalk:\n    token: token\n"),
+			expected: "typetalk",
+		},
 	}
 	for _, testCase := range testCases {
 		cfg, err := helperLoadConfig(testCase.contents)

main.go

@@ -9,6 +9,7 @@ import (
 	"github.com/mercari/tfnotify/notifier"
 	"github.com/mercari/tfnotify/notifier/github"
 	"github.com/mercari/tfnotify/notifier/slack"
+	"github.com/mercari/tfnotify/notifier/typetalk"
 	"github.com/mercari/tfnotify/terraform"
 
 	"github.com/urfave/cli"
@@ -100,6 +101,20 @@ func (t *tfnotify) Run() error {
 			return err
 		}
 		notifier = client.Notify
+	case "typetalk":
+		client, err := typetalk.NewClient(typetalk.Config{
+			Token:    t.config.Notifier.Typetalk.Token,
+			TopicID:  t.config.Notifier.Typetalk.TopicID,
+			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 "":
 		return fmt.Errorf("notifier is missing")
 	default:

notifier/typetalk/client.go

@@ -0,0 +1,79 @@
+package typetalk
+
+import (
+	"errors"
+	"os"
+	"strconv"
+
+	"github.com/mercari/tfnotify/terraform"
+	typetalk "github.com/nulab/go-typetalk/typetalk/v1"
+)
+
+// EnvToken is Typetalk API Token
+const EnvToken = "TYPETALK_TOKEN"
+
+// EnvTopicID is Typetalk topic ID
+const EnvTopicID = "TYPETALK_TOPIC_ID"
+
+// Client represents Typetalk API client.
+type Client struct {
+	*typetalk.Client
+	Config Config
+	common service
+	Notify *NotifyService
+	API    API
+}
+
+// Config is a configuration for Typetalk Client
+type Config struct {
+	Token    string
+	Title    string
+	TopicID  string
+	Message  string
+	CI       string
+	Parser   terraform.Parser
+	Template terraform.Template
+}
+
+type service struct {
+	client *Client
+}
+
+// NewClient returns Client initialized with Config
+func NewClient(cfg Config) (*Client, error) {
+	token := os.ExpandEnv(cfg.Token)
+	if token == EnvToken {
+		token = os.Getenv(EnvToken)
+	}
+	if token == "" {
+		return &Client{}, errors.New("Typetalk token is missing")
+	}
+
+	topicIDString := os.ExpandEnv(cfg.TopicID)
+	if topicIDString == EnvTopicID {
+		topicIDString = os.Getenv(EnvTopicID)
+	}
+	if topicIDString == "" {
+		return &Client{}, errors.New("Typetalk topic ID is missing")
+	}
+
+	topicID, err := strconv.Atoi(topicIDString)
+	if err != nil {
+		return &Client{}, errors.New("Typetalk topic ID is not numeric value")
+	}
+
+	client := typetalk.NewClient(nil)
+	client.SetTypetalkToken(token)
+	c := &Client{
+		Config: cfg,
+		Client: client,
+	}
+	c.common.client = c
+	c.Notify = (*NotifyService)(&c.common)
+	c.API = &Typetalk{
+		Client:  client,
+		TopicID: topicID,
+	}
+
+	return c, nil
+}

notifier/typetalk/client_test.go

@@ -0,0 +1,73 @@
+package typetalk
+
+import (
+	"os"
+	"testing"
+)
+
+func TestNewClient(t *testing.T) {
+	typetalkToken := os.Getenv(EnvToken)
+	defer func() {
+		os.Setenv(EnvToken, typetalkToken)
+	}()
+	os.Setenv(EnvToken, "")
+
+	testCases := []struct {
+		config   Config
+		envToken string
+		expect   string
+	}{
+		{
+			// specify directly
+			config:   Config{Token: "abcdefg", TopicID: "12345"},
+			envToken: "",
+			expect:   "",
+		},
+		{
+			// specify via env but not to be set env (part 1)
+			config:   Config{Token: "TYPETALK_TOKEN", TopicID: "12345"},
+			envToken: "",
+			expect:   "Typetalk token is missing",
+		},
+		{
+			// specify via env (part 1)
+			config:   Config{Token: "TYPETALK_TOKEN", TopicID: "12345"},
+			envToken: "abcdefg",
+			expect:   "",
+		},
+		{
+			// specify via env but not to be set env (part 2)
+			config:   Config{Token: "$TYPETALK_TOKEN", TopicID: "12345"},
+			envToken: "",
+			expect:   "typetalk token is missing",
+		},
+		{
+			// specify via env (part 2)
+			config:   Config{Token: "$TYPETALK_TOKEN", TopicID: "12345"},
+			envToken: "abcdefg",
+			expect:   "",
+		},
+		{
+			// no specification (part 1)
+			config:   Config{TopicID: "12345"},
+			envToken: "",
+			expect:   "Typetalk token is missing",
+		},
+		{
+			// no specification (part 2)
+			config:   Config{TopicID: "12345"},
+			envToken: "abcdefg",
+			expect:   "Typetalk token is missing",
+		},
+	}
+	for _, testCase := range testCases {
+		os.Setenv(EnvToken, testCase.envToken)
+		_, err := NewClient(testCase.config)
+		if err == nil {
+			continue
+		}
+		if err.Error() != testCase.expect {
+			t.Errorf("got %q but want %q", err.Error(), testCase.expect)
+		}
+	}
+}