be explicit with cases, update readme and comments

README.md

@@ -155,7 +155,7 @@ terraform:
   # ...
 ```
 
-You can also let tfnotify add a label to PRs whose `terraform plan` output result in no change to the current infrastructure. Currently, this feature is for Github labels only.
+You can also let tfnotify add a label to PRs depending on the `terraform plan` output result. Currently, this feature is for Github labels only.
 
 ```yaml
 ---
@@ -174,8 +174,14 @@ terraform:
 
       <pre><code>{{ .Body }}
       </pre></code></details>
+    when_add_or_update:
+      label: "add-or-update"
+    when_destroy:
+      label: "destroy"
     when_no_changes:
       label: "no-changes"
+    when_plan_error:
+      label: "error"
   # ...
 ```
 

config/config.go

@@ -81,15 +81,15 @@ type Fmt struct {
 
 // Plan is a terraform plan config
 type Plan struct {
-	Template      string        `yaml:"template"`
-	WhenChanges   WhenChanges   `yaml:"when_changes,omitempty"`
-	WhenDestroy   WhenDestroy   `yaml:"when_destroy,omitempty"`
-	WhenError     WhenError     `yaml:"when_error,omitempty"`
-	WhenNoChanges WhenNoChanges `yaml:"when_no_changes,omitempty"`
+	Template        string          `yaml:"template"`
+	WhenAddOrUpdate WhenAddOrUpdate `yaml:"when_add_or_update,omitempty"`
+	WhenDestroy     WhenDestroy     `yaml:"when_destroy,omitempty"`
+	WhenNoChanges   WhenNoChanges   `yaml:"when_no_changes,omitempty"`
+	WhenPlanError   WhenPlanError   `yaml:"when_plan_error,omitempty"`
 }
 
-// WhenChanges is a configuration to notify the plan result contains new or updated in place resources
-type WhenChanges struct {
+// WhenAddOrUpdate is a configuration to notify the plan result contains new or updated in place resources
+type WhenAddOrUpdate struct {
 	Label string `yaml:"label,omitempty"`
 }
 
@@ -99,13 +99,13 @@ type WhenDestroy struct {
 	Template string `yaml:"template,omitempty"`
 }
 
-// WhenError is a configuration to notify the plan result contains new or updated in place resources
-type WhenError struct {
+// WhenNoChange is a configuration to add a label when the plan result contains no change
+type WhenNoChanges struct {
 	Label string `yaml:"label,omitempty"`
 }
 
-// WhenNoChange is a configuration to add a label when the plan result contains no change
-type WhenNoChanges struct {
+// WhenPlanError is a configuration to notify the plan result returns an error
+type WhenPlanError struct {
 	Label string `yaml:"label,omitempty"`
 }
 

config/config_test.go

@@ -93,14 +93,14 @@ func TestLoadFile(t *testing.T) {
 					},
 					Plan: Plan{
 						Template: "{{ .Title }}\n{{ .Message }}\n{{if .Result}}\n<pre><code>{{ .Result }}\n</pre></code>\n{{end}}\n<details><summary>Details (Click me)</summary>\n\n<pre><code>{{ .Body }}\n</pre></code></details>\n",
-						WhenChanges: WhenChanges{
-							Label: "changes",
+						WhenAddOrUpdate: WhenAddOrUpdate{
+							Label: "add-or-update",
 						},
 						WhenDestroy: WhenDestroy{
 							Label:    "destroy",
 							Template: "## :warning: WARNING: Resource Deletion will happen :warning:\n\nThis plan contains **resource deletion**. Please check the plan result very carefully!\n",
 						},
-						WhenError: WhenError{
+						WhenPlanError: WhenPlanError{
 							Label: "error",
 						},
 						WhenNoChanges: WhenNoChanges{

example-with-destroy-and-result-labels.tfnotify.yaml

@@ -18,15 +18,15 @@ terraform:
 
       <pre><code>{{ .Body }}
       </pre></code></details>
-    when_changes:
-      label: "changes"
+    when_add_or_update:
+      label: "add-or-update"
     when_destroy:
       label: "destroy"
       template: |
         ## :warning: WARNING: Resource Deletion will happen :warning:
 
         This plan contains **resource deletion**. Please check the plan result very carefully!
-    when_error:
-      label: "error"
     when_no_changes:
       label: "no-changes"
+    when_plan_error:
+      label: "error"

main.go

@@ -116,10 +116,10 @@ func (t *tfnotify) Run() error {
 			DestroyWarningTemplate: t.destroyWarningTemplate,
 			WarnDestroy:            t.warnDestroy,
 			ResultLabels: github.ResultLabels{
-				ChangesLabel:   t.config.Terraform.Plan.WhenChanges.Label,
-				DestroyLabel:   t.config.Terraform.Plan.WhenDestroy.Label,
-				ErrorLabel:     t.config.Terraform.Plan.WhenError.Label,
-				NoChangesLabel: t.config.Terraform.Plan.WhenNoChanges.Label,
+				AddOrUpdateLabel: t.config.Terraform.Plan.WhenAddOrUpdate.Label,
+				DestroyLabel:     t.config.Terraform.Plan.WhenDestroy.Label,
+				NoChangesLabel:   t.config.Terraform.Plan.WhenNoChanges.Label,
+				PlanErrorLabel:   t.config.Terraform.Plan.WhenPlanError.Label,
 			},
 		})
 		if err != nil {

notifier/github/client.go

@@ -120,23 +120,23 @@ func (pr *PullRequest) IsNumber() bool {
 
 // ResultLabels represents the labels to add to the PR depending on the plan result
 type ResultLabels struct {
-	ChangesLabel   string
-	DestroyLabel   string
-	ErrorLabel     string
-	NoChangesLabel string
+	AddOrUpdateLabel string
+	DestroyLabel     string
+	NoChangesLabel   string
+	PlanErrorLabel   string
 }
 
 // HasAnyLabelDefined returns true if any of the internal labels are set
 func (r *ResultLabels) HasAnyLabelDefined() bool {
-	return r.ChangesLabel != "" || r.DestroyLabel != "" || r.ErrorLabel != "" || r.NoChangesLabel != ""
+	return r.AddOrUpdateLabel != "" || r.DestroyLabel != "" || r.NoChangesLabel != "" || r.PlanErrorLabel != ""
 }
 
 // IsResultLabel returns true if a label matches any of the internal labels
 func (r *ResultLabels) IsResultLabel(label string) bool {
 	switch label {
 	case "":
 		return false
-	case r.ChangesLabel, r.DestroyLabel, r.ErrorLabel, r.NoChangesLabel:
+	case r.AddOrUpdateLabel, r.DestroyLabel, r.NoChangesLabel, r.PlanErrorLabel:
 		return true
 	default:
 		return false

notifier/github/client_test.go

@@ -187,28 +187,28 @@ func TestHasAnyLabelDefined(t *testing.T) {
 	}{
 		{
 			rl: ResultLabels{
-				ChangesLabel:   "changes",
-				DestroyLabel:   "destroy",
-				ErrorLabel:     "error",
-				NoChangesLabel: "no-changes",
+				AddOrUpdateLabel: "add-or-update",
+				DestroyLabel:     "destroy",
+				NoChangesLabel:   "no-changes",
+				PlanErrorLabel:   "error",
 			},
 			want: true,
 		},
 		{
 			rl: ResultLabels{
-				ChangesLabel:   "changes",
-				DestroyLabel:   "destroy",
-				ErrorLabel:     "error",
-				NoChangesLabel: "",
+				AddOrUpdateLabel: "add-or-update",
+				DestroyLabel:     "destroy",
+				NoChangesLabel:   "",
+				PlanErrorLabel:   "error",
 			},
 			want: true,
 		},
 		{
 			rl: ResultLabels{
-				ChangesLabel:   "",
-				DestroyLabel:   "",
-				ErrorLabel:     "",
-				NoChangesLabel: "",
+				AddOrUpdateLabel: "",
+				DestroyLabel:     "",
+				NoChangesLabel:   "",
+				PlanErrorLabel:   "",
 			},
 			want: false,
 		},
@@ -228,40 +228,40 @@ func TestIsResultLabels(t *testing.T) {
 	}{
 		{
 			rl: ResultLabels{
-				ChangesLabel:   "changes",
-				DestroyLabel:   "destroy",
-				ErrorLabel:     "error",
-				NoChangesLabel: "no-changes",
+				AddOrUpdateLabel: "add-or-update",
+				DestroyLabel:     "destroy",
+				NoChangesLabel:   "no-changes",
+				PlanErrorLabel:   "error",
 			},
-			label: "changes",
+			label: "add-or-update",
 			want:  true,
 		},
 		{
 			rl: ResultLabels{
-				ChangesLabel:   "changes",
-				DestroyLabel:   "destroy",
-				ErrorLabel:     "error",
-				NoChangesLabel: "no-changes",
+				AddOrUpdateLabel: "add-or-update",
+				DestroyLabel:     "destroy",
+				NoChangesLabel:   "no-changes",
+				PlanErrorLabel:   "error",
 			},
 			label: "my-label",
 			want:  false,
 		},
 		{
 			rl: ResultLabels{
-				ChangesLabel:   "changes",
-				DestroyLabel:   "destroy",
-				ErrorLabel:     "error",
-				NoChangesLabel: "no-changes",
+				AddOrUpdateLabel: "add-or-update",
+				DestroyLabel:     "destroy",
+				NoChangesLabel:   "no-changes",
+				PlanErrorLabel:   "error",
 			},
 			label: "",
 			want:  false,
 		},
 		{
 			rl: ResultLabels{
-				ChangesLabel:   "",
-				DestroyLabel:   "",
-				ErrorLabel:     "",
-				NoChangesLabel: "no-changes",
+				AddOrUpdateLabel: "",
+				DestroyLabel:     "",
+				NoChangesLabel:   "no-changes",
+				PlanErrorLabel:   "",
 			},
 			label: "",
 			want:  false,

notifier/github/notify.go

@@ -39,14 +39,14 @@ func (g *NotifyService) Notify(body string) (exit int, err error) {
 			}
 			var labelToAdd string
 
-			if result.HasChanges {
-				labelToAdd = cfg.ResultLabels.ChangesLabel
+			if result.HasAddOrUpdate {
+				labelToAdd = cfg.ResultLabels.AddOrUpdateLabel
 			} else if result.HasDestroy {
 				labelToAdd = cfg.ResultLabels.DestroyLabel
-			} else if result.HasPlanError {
-				labelToAdd = cfg.ResultLabels.ErrorLabel
 			} else if result.HasNoChanges {
 				labelToAdd = cfg.ResultLabels.NoChangesLabel
+			} else if result.HasPlanError {
+				labelToAdd = cfg.ResultLabels.PlanErrorLabel
 			}
 
 			if labelToAdd != "" {

notifier/github/notify_test.go

@@ -139,10 +139,10 @@ func TestNotifyNotify(t *testing.T) {
 				Parser:   terraform.NewPlanParser(),
 				Template: terraform.NewPlanTemplate(terraform.DefaultPlanTemplate),
 				ResultLabels: ResultLabels{
-					ChangesLabel:   "changes",
-					DestroyLabel:   "destroy",
-					ErrorLabel:     "error",
-					NoChangesLabel: "no-changes",
+					AddOrUpdateLabel: "add-or-update",
+					DestroyLabel:     "destroy",
+					NoChangesLabel:   "no-changes",
+					PlanErrorLabel:   "error",
 				},
 			},
 			body:     "No changes. Infrastructure is up-to-date.",

terraform/parser.go

@@ -13,13 +13,13 @@ type Parser interface {
 
 // ParseResult represents the result of parsed terraform execution
 type ParseResult struct {
-	Result       string
-	HasChanges   bool
-	HasDestroy   bool
-	HasPlanError bool
-	HasNoChanges bool
-	ExitCode     int
-	Error        error
+	Result         string
+	HasAddOrUpdate bool
+	HasDestroy     bool
+	HasNoChanges   bool
+	HasPlanError   bool
+	ExitCode       int
+	Error          error
 }
 
 // DefaultParser is a parser for terraform commands
@@ -130,16 +130,16 @@ func (p *PlanParser) Parse(body string) ParseResult {
 
 	hasDestroy := p.HasDestroy.MatchString(line)
 	hasNoChanges := p.HasNoChanges.MatchString(line)
-	hasChanges := !hasNoChanges && !hasDestroy && !hasPlanError
+	HasAddOrUpdate := !hasNoChanges && !hasDestroy && !hasPlanError
 
 	return ParseResult{
-		Result:       result,
-		HasChanges:   hasChanges,
-		HasDestroy:   hasDestroy,
-		HasPlanError: hasPlanError,
-		HasNoChanges: hasNoChanges,
-		ExitCode:     exitCode,
-		Error:        nil,
+		Result:         result,
+		HasAddOrUpdate: HasAddOrUpdate,
+		HasDestroy:     hasDestroy,
+		HasNoChanges:   hasNoChanges,
+		HasPlanError:   hasPlanError,
+		ExitCode:       exitCode,
+		Error:          nil,
 	}
 }