Merge pull request #99 from htnosm/add-raw-output-to-slack

Add use_raw_output option to slack
mercari · Dec 14, 2022 · ddb68ef · ddb68ef
2 parents e60974f + ab7648b
commit ddb68ef
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -338,6 +338,22 @@ terraform:
       ```
 ```
 
+Sometimes you may want not to HTML-escape Terraform command outputs.
+For example, when you use code block to print command output, it's better to use raw characters instead of character references (e.g. `-/+` -> `-/&#43;`, `"` -> `&#34;`).
+
+You can disable HTML escape by adding `use_raw_output: true` configuration.
+With this configuration, Terraform doesn't HTML-escape any Terraform output.
+
+~~~yaml
+---
+# ...
+terraform:
+  use_raw_output: true
+  # ...
+  plan:
+  # ...
+~~~
+
 </details>
 
 <details>

diff --git a/main.go b/main.go
@@ -153,14 +153,15 @@ func (t *tfnotify) Run() error {
 		notifier = client.Notify
 	case "slack":
 		client, err := slack.NewClient(slack.Config{
-			Token:    t.config.Notifier.Slack.Token,
-			Channel:  t.config.Notifier.Slack.Channel,
-			Botname:  t.config.Notifier.Slack.Bot,
-			Title:    t.context.String("title"),
-			Message:  t.context.String("message"),
-			CI:       ci.URL,
-			Parser:   t.parser,
-			Template: t.template,
+			Token:        t.config.Notifier.Slack.Token,
+			Channel:      t.config.Notifier.Slack.Channel,
+			Botname:      t.config.Notifier.Slack.Bot,
+			Title:        t.context.String("title"),
+			Message:      t.context.String("message"),
+			CI:           ci.URL,
+			Parser:       t.parser,
+			UseRawOutput: t.config.Terraform.UseRawOutput,
+			Template:     t.template,
 		})
 		if err != nil {
 			return err

diff --git a/notifier/slack/client.go b/notifier/slack/client.go
@@ -33,14 +33,15 @@ type Client struct {
 
 // Config is a configuration for Slack client
 type Config struct {
-	Token    string
-	Channel  string
-	Botname  string
-	Title    string
-	Message  string
-	CI       string
-	Parser   terraform.Parser
-	Template terraform.Template
+	Token        string
+	Channel      string
+	Botname      string
+	Title        string
+	Message      string
+	CI           string
+	Parser       terraform.Parser
+	UseRawOutput bool
+	Template     terraform.Template
 }
 
 type service struct {

diff --git a/notifier/slack/notify.go b/notifier/slack/notify.go
@@ -39,11 +39,12 @@ func (s *NotifyService) Notify(body string) (exit int, err error) {
 	}
 
 	template.SetValue(terraform.CommonTemplate{
-		Title:   cfg.Title,
-		Message: cfg.Message,
-		Result:  result.Result,
-		Body:    body,
-		Link:    cfg.CI,
+		Title:        cfg.Title,
+		Message:      cfg.Message,
+		Result:       result.Result,
+		Body:         body,
+		UseRawOutput: cfg.UseRawOutput,
+		Link:         cfg.CI,
 	})
 	text, err := template.Execute()
 	if err != nil {