refactor: print struct and func name

Signed-off-by: Chen Keinan <hen.keinan@gmail.com>

Author: chen-keinan

cmd/gen-docs/main.go

@@ -102,7 +102,7 @@ func run(args []string) error {
 	buildVersion := strings.TrimSpace(version.Version)
 	viper := viper.GetViper()
 	c := config.New(viper)
-	f := factory.New(clientFactory, askProvider, s, buildVersion, c, servicemessages.NewProvider(servicemessages.NewPrinter(os.Stdout, os.Stderr)))
+	f := factory.New(clientFactory, askProvider, s, buildVersion, c, servicemessages.NewProvider(servicemessages.NewOutputPrinter(os.Stdout, os.Stderr)))
 
 	cmd := root.NewCmdRoot(f, clientFactory, askProvider)
 	cmd.DisableAutoGenTag = true

cmd/octopus/main.go

@@ -69,7 +69,7 @@ func main() {
 	terminalOut := terminal.NewAnsiStdout(os.Stdout)
 	terminalErr := terminal.NewAnsiStderr(os.Stderr)
 
-	serviceMessageProvider := servicemessages.NewProvider(servicemessages.NewPrinter(terminalOut, terminalErr))
+	serviceMessageProvider := servicemessages.NewProvider(servicemessages.NewOutputPrinter(terminalOut, terminalErr))
 	f := factory.New(clientFactory, askProvider, s, buildVersion, c, serviceMessageProvider)
 
 	cmd := root.NewCmdRoot(f, clientFactory, askProvider)

pkg/servicemessages/provider.go

@@ -14,10 +14,10 @@ type Provider interface {
 }
 
 type provider struct {
-	printer *Printer
+	printer *OutputPrinter
 }
 
-func NewProvider(printer *Printer) Provider {
+func NewProvider(printer *OutputPrinter) Provider {
 	return &provider{
 		printer: printer,
 	}
@@ -37,32 +37,32 @@ func (p *provider) ServiceMessage(messageName string, values any) {
 
 	switch t := values.(type) {
 	case string:
-		p.printer.Println(fmt.Sprintf("##teamcity[%s %s]\n", messageName, t))
+		p.printer.Info(fmt.Sprintf("##teamcity[%s %s]\n", messageName, t))
 	case map[string]string:
 		for key, value := range t {
-			p.printer.Println(fmt.Sprintf("##teamcity[%s %s=%s]\n", messageName, key, value))
+			p.printer.Info(fmt.Sprintf("##teamcity[%s %s=%s]\n", messageName, key, value))
 		}
 	default:
 		p.printer.Error("Unsupported service message value type")
 	}
 }
 
-type Printer struct {
+type OutputPrinter struct {
 	Out io.Writer
 	Err io.Writer
 }
 
-func NewPrinter(out io.Writer, err io.Writer) *Printer {
-	return &Printer{
+func NewOutputPrinter(out io.Writer, err io.Writer) *OutputPrinter {
+	return &OutputPrinter{
 		Out: out,
 		Err: err,
 	}
 }
 
-func (p *Printer) Println(msg string) {
+func (p *OutputPrinter) Info(msg string) {
 	fmt.Fprint(p.Out, msg)
 }
 
-func (p *Printer) Error(msg string) {
+func (p *OutputPrinter) Error(msg string) {
 	fmt.Fprint(p.Err, msg)
 }

pkg/servicemessages/provider_test.go

@@ -21,25 +21,18 @@ func TestServiceMessage(t *testing.T) {
 		want            string
 		wantErr         string
 	}{
-		{"service message is not set", false, false, "testMessage", "key1", "value1", &bytes.Buffer{}, &bytes.Buffer{}, "", ""},
-		{"service message enabled non string value with teamcity", true, true, "testMessage", "key1", map[string]string{"key": "value"}, &bytes.Buffer{}, &bytes.Buffer{}, "##teamcity[testMessage key=value]\n", ""},
-		{"service message enabled without teamcity", true, false, "testMessage", "key1", "value1", &bytes.Buffer{}, &bytes.Buffer{}, "", "service messages are only supported in TeamCity builds"},
-		{"service message enabled string value with teamcity", true, true, "testMessage", "key1", "value", &bytes.Buffer{}, &bytes.Buffer{}, "##teamcity[testMessage value]\n", ""},
-		{"service message enabled unsupported value with teamcity", true, true, "testMessage", "key1", []string{"dsdsd"}, &bytes.Buffer{}, &bytes.Buffer{}, "", "Unsupported service message value type"},
+		{"service message flag is not enabled", false, false, "testMessage", "key1", "value1", &bytes.Buffer{}, &bytes.Buffer{}, "", ""},
+		{"service message enabled teamcity envvar and map value", true, true, "testMessage", "key1", map[string]string{"key": "value"}, &bytes.Buffer{}, &bytes.Buffer{}, "##teamcity[testMessage key=value]\n", ""},
+		{"service message enabled without teamcity envvar", true, false, "testMessage", "key1", "value1", &bytes.Buffer{}, &bytes.Buffer{}, "", "service messages are only supported in TeamCity builds"},
+		{"service message enabled teamcity envvar and string value", true, true, "testMessage", "key1", "value", &bytes.Buffer{}, &bytes.Buffer{}, "##teamcity[testMessage value]\n", ""},
+		{"service message enabled teamcity envvar and unsupported value", true, true, "testMessage", "key1", []string{"dsdsd"}, &bytes.Buffer{}, &bytes.Buffer{}, "", "Unsupported service message value type"},
 	}
 
 	for _, tt := range tests {
-		viper.Reset()
-		viper.Set(constants.FlagEnableServiceMessages, tt.servicemessages)
-		if tt.teamCityEnv {
-			t.Setenv("TEAMCITY_VERSION", "2021.1")
-		} else {
-			t.Setenv("TEAMCITY_VERSION", "")
-		}
+		setupArgs(t, constants.FlagEnableServiceMessages, tt.servicemessages)
+		setupEnvVar(t, "TEAMCITY_VERSION", "2021.1", tt.teamCityEnv)
 		t.Run(tt.name, func(t *testing.T) {
-			serviceMessageProvider := NewProvider(NewPrinter(tt.stdout, tt.stderr))
-			serviceMessageProvider.ServiceMessage(tt.messsageName, tt.value)
-
+			NewProvider(NewOutputPrinter(tt.stdout, tt.stderr)).ServiceMessage(tt.messsageName, tt.value)
 			if tt.want != "" {
 				got := tt.stdout.String()
 				if got != tt.want {
@@ -55,3 +48,16 @@ func TestServiceMessage(t *testing.T) {
 		})
 	}
 }
+
+func setupArgs(t *testing.T, key string, value bool) {
+	viper.Reset()
+	viper.Set(constants.FlagEnableServiceMessages, value)
+}
+
+func setupEnvVar(t *testing.T, key, value string, set bool) {
+	if set {
+		t.Setenv(key, value)
+	} else {
+		t.Setenv(key, "")
+	}
+}