fix: Enable PR label updates alongside file output for plan operations (#1758)

* fix: Enable PR label updates alongside file output for plan operations

* [autofix.ci] apply automated fixes

* refactor: replace interface{} with any

* refactor: make updateGitHubLabels private

* refactor: rename a method

* fix: fix log

* refactor: repalce type any with a concrete type

* refactor: simplify code

* refactor: simplify code

* refactor: remove NotifyService.updateLabels

* fix: update labels even though OutputFile is empty

* fix: include error messages about labels in output file

* fix: fix debug log

---------

Co-authored-by: Shunsuke Suzuki <[email protected]>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Shunsuke Suzuki <[email protected]>

Author: 3 people

pkg/controller/controller.go

@@ -131,25 +131,6 @@ func (c *Controller) getNotifier(ctx context.Context) (notifier.Notifier, error)
 		}
 		labels = a
 	}
-	// Write output to file instead of github comment
-	if c.Config.Output != "" {
-		client, err := localfile.NewClient(&localfile.Config{
-			OutputFile:         c.Config.Output,
-			Parser:             c.Parser,
-			UseRawOutput:       c.Config.Terraform.UseRawOutput,
-			CI:                 c.Config.CI.Link,
-			Template:           c.Template,
-			ParseErrorTemplate: c.ParseErrorTemplate,
-			Vars:               c.Config.Vars,
-			EmbeddedVarNames:   c.Config.EmbeddedVarNames,
-			Templates:          c.Config.Templates,
-			Masks:              c.Config.Masks,
-		})
-		if err != nil {
-			return nil, err
-		}
-		return client.Notify, nil
-	}
 	client, err := github.NewClient(ctx, &github.Config{
 		BaseURL:         c.Config.GHEBaseURL,
 		GraphQLEndpoint: c.Config.GHEGraphQLEndpoint,
@@ -176,5 +157,25 @@ func (c *Controller) getNotifier(ctx context.Context) (notifier.Notifier, error)
 	if err != nil {
 		return nil, err
 	}
+	// Write output to file instead of github comment
+	if c.Config.Output != "" {
+		client, err := localfile.NewClient(&localfile.Config{
+			OutputFile:         c.Config.Output,
+			Parser:             c.Parser,
+			UseRawOutput:       c.Config.Terraform.UseRawOutput,
+			CI:                 c.Config.CI.Link,
+			Template:           c.Template,
+			ParseErrorTemplate: c.ParseErrorTemplate,
+			Vars:               c.Config.Vars,
+			EmbeddedVarNames:   c.Config.EmbeddedVarNames,
+			Templates:          c.Config.Templates,
+			Masks:              c.Config.Masks,
+			DisableLabel:       c.Config.Terraform.Plan.DisableLabel,
+		}, client.Notify)
+		if err != nil {
+			return nil, err
+		}
+		return client.Notify, nil
+	}
 	return client.Notify, nil
 }

pkg/notifier/github/label.go

@@ -9,7 +9,7 @@ import (
 	"github.com/suzuki-shunsuke/tfcmt/v4/pkg/terraform"
 )
 
-func (g *NotifyService) updateLabels(ctx context.Context, result terraform.ParseResult) []string { //nolint:cyclop
+func (g *NotifyService) UpdateLabels(ctx context.Context, result terraform.ParseResult) []string { //nolint:cyclop
 	cfg := g.client.Config
 	var (
 		labelToAdd string

pkg/notifier/github/plan.go

@@ -36,7 +36,7 @@ func (g *NotifyService) Plan(ctx context.Context, param *notifier.ParamExec) err
 	}
 
 	if cfg.PR.IsNumber() && cfg.ResultLabels.HasAnyLabelDefined() {
-		errMsgs = append(errMsgs, g.updateLabels(ctx, result)...)
+		errMsgs = append(errMsgs, g.UpdateLabels(ctx, result)...)
 	}
 
 	if cfg.IgnoreWarning {

pkg/notifier/localfile/client.go

@@ -1,7 +1,10 @@
 package localfile
 
 import (
+	"context"
+
 	"github.com/suzuki-shunsuke/tfcmt/v4/pkg/config"
+	"github.com/suzuki-shunsuke/tfcmt/v4/pkg/notifier/github"
 	"github.com/suzuki-shunsuke/tfcmt/v4/pkg/terraform"
 )
 
@@ -13,8 +16,9 @@ type Client struct {
 
 	common service
 
-	Notify *NotifyService
-	Output *OutputService
+	Notify  *NotifyService
+	Output  *OutputService
+	labeler Labeler
 }
 
 // Config is a configuration for local file
@@ -30,16 +34,34 @@ type Config struct {
 	CI                 string
 	UseRawOutput       bool
 	Masks              []*config.Mask
+
+	// For labeling
+	DisableLabel bool
+}
+
+type GitHubLabelConfig struct {
+	BaseURL         string
+	GraphQLEndpoint string
+	Owner           string
+	Repo            string
+	PRNumber        int
+	Revision        string
+	Labels          github.ResultLabels
 }
 
 type service struct {
 	client *Client
 }
 
+type Labeler interface {
+	UpdateLabels(ctx context.Context, result terraform.ParseResult) []string
+}
+
 // NewClient returns Client initialized with Config
-func NewClient(cfg *Config) (*Client, error) {
+func NewClient(cfg *Config, labeler Labeler) (*Client, error) {
 	c := &Client{
-		Config: cfg,
+		Config:  cfg,
+		labeler: labeler,
 	}
 
 	c.common.client = c

pkg/notifier/localfile/plan.go

@@ -11,7 +11,7 @@ import (
 )
 
 // Plan posts comment optimized for notifications
-func (g *NotifyService) Plan(_ context.Context, param *notifier.ParamExec) error {
+func (g *NotifyService) Plan(ctx context.Context, param *notifier.ParamExec) error {
 	cfg := g.client.Config
 	parser := g.client.Config.Parser
 	template := g.client.Config.Template
@@ -29,6 +29,14 @@ func (g *NotifyService) Plan(_ context.Context, param *notifier.ParamExec) error
 		}
 	}
 
+	logE := logrus.WithFields(logrus.Fields{
+		"program": "tfcmt",
+	})
+	if !cfg.DisableLabel {
+		logE.Debugf("updating labels")
+		errMsgs = append(errMsgs, g.client.labeler.UpdateLabels(ctx, result)...)
+	}
+
 	template.SetValue(terraform.CommonTemplate{
 		Result:                 result.Result,
 		ChangedResult:          result.ChangedResult,
@@ -57,15 +65,12 @@ func (g *NotifyService) Plan(_ context.Context, param *notifier.ParamExec) error
 		return err
 	}
 
-	logE := logrus.WithFields(logrus.Fields{
-		"program": "tfcmt",
-	})
-
 	body = mask.Mask(body, g.client.Config.Masks)
 
 	logE.Debug("write a plan output to a file")
 	if err := g.client.Output.WriteToFile(body, cfg.OutputFile); err != nil {
 		return fmt.Errorf("write a plan output to a file: %w", err)
 	}
+
 	return nil
 }