Merge pull request #683 from sm43/remove-fmt-printf

Replace fmt.Print with cobra stdoutwriter

Author: chmouel

pkg/cli/webhook/github.go

@@ -9,6 +9,7 @@ import (
 
 	"github.com/AlecAivazis/survey/v2"
 	"github.com/google/go-github/v43/github"
+	"github.com/openshift-pipelines/pipelines-as-code/pkg/cli"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/cli/prompt"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/formatting"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/provider"
@@ -19,6 +20,7 @@ const apiPublicURL = "https://api.github.com/"
 
 type gitHubConfig struct {
 	Client              *github.Client
+	IOStream            *cli.IOStreams
 	controllerURL       string
 	repoOwner           string
 	repoName            string
@@ -74,8 +76,7 @@ func (gh *gitHubConfig) askGHWebhookConfig(repoURL, controllerURL, apiURL string
 	// confirm whether to use the detected url
 	if gh.controllerURL != "" {
 		var answer bool
-		// nolint
-		fmt.Printf("👀 I have detected a controller url: %s", gh.controllerURL)
+		fmt.Fprintf(gh.IOStream.Out, "👀 I have detected a controller url: %s", gh.controllerURL)
 		err := prompt.SurveyAskOne(&survey.Confirm{
 			Message: "Do you want me to use it?",
 			Default: true,
@@ -102,10 +103,8 @@ func (gh *gitHubConfig) askGHWebhookConfig(repoURL, controllerURL, apiURL string
 		return err
 	}
 
-	// nolint:forbidigo
-	fmt.Println("ℹ ️You now need to create a GitHub personal token with scopes  `public_repo` & `admin:repo_hook`")
-	// nolint:forbidigo
-	fmt.Println("ℹ ️Go to this URL to generate a new token https://github.com/settings/tokens/new, see https://is.gd/G5gBFI for documentation ")
+	fmt.Fprintln(gh.IOStream.Out, "ℹ ️You now need to create a GitHub personal token with scopes  `public_repo` & `admin:repo_hook`")
+	fmt.Fprintln(gh.IOStream.Out, "ℹ ️Go to this URL to generate a new token https://github.com/settings/tokens/new, see https://is.gd/G5gBFI for documentation ")
 	if err := prompt.SurveyAskOne(&survey.Password{
 		Message: "Please enter the GitHub access token: ",
 	}, &gh.personalAccessToken, survey.WithValidator(survey.Required)); err != nil {
@@ -162,8 +161,7 @@ func (gh *gitHubConfig) create(ctx context.Context) error {
 			gh.repoOwner, gh.repoName, res.Response.StatusCode, payload)
 	}
 
-	// nolint:forbidigo
-	fmt.Printf("✓ Webhook has been created on repository %v/%v\n", gh.repoOwner, gh.repoName)
+	fmt.Fprintf(gh.IOStream.Out, "✓ Webhook has been created on repository %v/%v\n", gh.repoOwner, gh.repoName)
 	return nil
 }
 

pkg/cli/webhook/github_test.go

@@ -5,13 +5,16 @@ import (
 	"net/http"
 	"testing"
 
+	"github.com/openshift-pipelines/pipelines-as-code/pkg/cli"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/cli/prompt"
 	ghtesthelper "github.com/openshift-pipelines/pipelines-as-code/pkg/test/github"
 	"gotest.tools/v3/assert"
 	rtesting "knative.dev/pkg/reconciler/testing"
 )
 
 func TestAskGHWebhookConfig(t *testing.T) {
+	// nolint
+	io, _, _, _ := cli.IOTest()
 	tests := []struct {
 		name          string
 		wantErrStr    string
@@ -56,7 +59,7 @@ func TestAskGHWebhookConfig(t *testing.T) {
 			if tt.askStubs != nil {
 				tt.askStubs(as)
 			}
-			gh := gitHubConfig{}
+			gh := gitHubConfig{IOStream: io}
 			err := gh.askGHWebhookConfig(tt.repoURL, tt.controllerURL, "")
 			if tt.wantErrStr != "" {
 				assert.Equal(t, err.Error(), tt.wantErrStr)
@@ -70,6 +73,8 @@ func TestAskGHWebhookConfig(t *testing.T) {
 func TestCreate(t *testing.T) {
 	fakeclient, mux, _, teardown := ghtesthelper.SetupGH()
 	defer teardown()
+	// nolint
+	io, _, _, _ := cli.IOTest()
 
 	// webhook created for repo pac/valid
 	mux.HandleFunc("/repos/pac/valid/hooks", func(w http.ResponseWriter, r *http.Request) {
@@ -105,6 +110,7 @@ func TestCreate(t *testing.T) {
 		t.Run(tt.name, func(t *testing.T) {
 			ctx, _ := rtesting.SetupFakeContext(t)
 			gh := gitHubConfig{
+				IOStream:  io,
 				Client:    fakeclient,
 				repoOwner: tt.repoOwner,
 				repoName:  tt.repoName,

pkg/cli/webhook/gitlab.go

@@ -7,13 +7,15 @@ import (
 	"net/http"
 
 	"github.com/AlecAivazis/survey/v2"
+	"github.com/openshift-pipelines/pipelines-as-code/pkg/cli"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/cli/prompt"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/provider"
 	"github.com/xanzy/go-gitlab"
 )
 
 type gitLabConfig struct {
 	Client              *gitlab.Client
+	IOStream            *cli.IOStreams
 	controllerURL       string
 	projectID           string
 	webhookSecret       string
@@ -53,8 +55,7 @@ func (gl *gitLabConfig) askGLWebhookConfig(controllerURL, apiURL string) error {
 	// confirm whether to use the detected url
 	if gl.controllerURL != "" {
 		var answer bool
-		// nolint
-		fmt.Printf("👀 I have detected a controller url: %s", gl.controllerURL)
+		fmt.Fprintf(gl.IOStream.Out, "👀 I have detected a controller url: %s", gl.controllerURL)
 		err := prompt.SurveyAskOne(&survey.Confirm{
 			Message: "Do you want me to use it?",
 			Default: true,
@@ -81,10 +82,8 @@ func (gl *gitLabConfig) askGLWebhookConfig(controllerURL, apiURL string) error {
 		return err
 	}
 
-	// nolint:forbidigo
-	fmt.Println("ℹ ️You now need to create a GitLab personal access token with `api` scope")
-	// nolint:forbidigo
-	fmt.Println("ℹ ️Go to this URL to generate one https://gitlab.com/-/profile/personal_access_tokens, see https://is.gd/rOEo9B for documentation ")
+	fmt.Fprintln(gl.IOStream.Out, "ℹ ️You now need to create a GitLab personal access token with `api` scope")
+	fmt.Fprintln(gl.IOStream.Out, "ℹ ️Go to this URL to generate one https://gitlab.com/-/profile/personal_access_tokens, see https://is.gd/rOEo9B for documentation ")
 	if err := prompt.SurveyAskOne(&survey.Password{
 		Message: "Please enter the GitLab access token: ",
 	}, &gl.personalAccessToken, survey.WithValidator(survey.Required)); err != nil {
@@ -133,8 +132,7 @@ func (gl *gitLabConfig) create() error {
 			resp.Response.StatusCode, payload)
 	}
 
-	// nolint:forbidigo
-	fmt.Printf("✓ Webhook has been created on your repository\n")
+	fmt.Fprintln(gl.IOStream.Out, "✓ Webhook has been created on your repository")
 	return nil
 }
 

pkg/cli/webhook/gitlab_test.go

@@ -5,13 +5,16 @@ import (
 	"net/http"
 	"testing"
 
+	"github.com/openshift-pipelines/pipelines-as-code/pkg/cli"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/cli/prompt"
 	thelp "github.com/openshift-pipelines/pipelines-as-code/pkg/provider/gitlab/test"
 	"gotest.tools/v3/assert"
 	rtesting "knative.dev/pkg/reconciler/testing"
 )
 
 func TestAskGLWebhookConfig(t *testing.T) {
+	// nolint
+	io, _, _, _ := cli.IOTest()
 	tests := []struct {
 		name          string
 		wantErrStr    string
@@ -48,7 +51,7 @@ func TestAskGLWebhookConfig(t *testing.T) {
 			if tt.askStubs != nil {
 				tt.askStubs(as)
 			}
-			gl := gitLabConfig{}
+			gl := gitLabConfig{IOStream: io}
 			err := gl.askGLWebhookConfig(tt.controllerURL, "")
 			if tt.wantErrStr != "" {
 				assert.Equal(t, err.Error(), tt.wantErrStr)
@@ -63,6 +66,8 @@ func TestGLCreate(t *testing.T) {
 	ctx, _ := rtesting.SetupFakeContext(t)
 	fakeclient, mux, teardown := thelp.Setup(ctx, t)
 	defer teardown()
+	// nolint
+	io, _, _, _ := cli.IOTest()
 
 	// webhook created
 	mux.HandleFunc("/projects/11/hooks", func(w http.ResponseWriter, r *http.Request) {
@@ -96,6 +101,7 @@ func TestGLCreate(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			gl := gitLabConfig{
+				IOStream:  io,
 				Client:    fakeclient,
 				projectID: tt.projectID,
 			}

pkg/cli/webhook/secret.go

@@ -12,11 +12,6 @@ import (
 const (
 	providerTokenKey = "provider.token"
 	webhookSecretKey = "webhook.secret"
-
-	// nolint
-	githubWebhookSecretName = "github-webhook-secret"
-	// nolint
-	gitlabWebhookSecretName = "gitlab-webhook-secret"
 )
 
 func (w *Options) createWebhookSecret(ctx context.Context, response *response) error {
@@ -33,8 +28,7 @@ func (w *Options) createWebhookSecret(ctx context.Context, response *response) e
 		return err
 	}
 
-	// nolint:forbidigo
-	fmt.Printf("🔑 Webhook Secret %s has been created in the %s namespace\n", w.RepositoryName, w.RepositoryNamespace)
+	fmt.Fprintf(w.IOStreams.Out, "🔑 Webhook Secret %s has been created in the %s namespace.", w.RepositoryName, w.RepositoryNamespace)
 	return nil
 }
 
@@ -68,7 +62,6 @@ func (w *Options) updateRepositoryCR(ctx context.Context, res *response) error {
 		return err
 	}
 
-	// nolint:forbidigo
-	fmt.Printf("🔑 Repository CR %s has been updated with webhook secret in the %s namespace\n", w.RepositoryName, w.RepositoryNamespace)
+	fmt.Fprintf(w.IOStreams.Out, "🔑 Repository CR %s has been updated with webhook secret in the %s namespace\n", w.RepositoryName, w.RepositoryNamespace)
 	return nil
 }

pkg/cli/webhook/webhook.go

@@ -6,6 +6,7 @@ import (
 	"strings"
 
 	"github.com/AlecAivazis/survey/v2"
+	"github.com/openshift-pipelines/pipelines-as-code/pkg/cli"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/cli/info"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/cli/prompt"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/cmd/tknpac/bootstrap"
@@ -20,6 +21,7 @@ type Interface interface {
 
 type Options struct {
 	Run                 *params.Run
+	IOStreams           *cli.IOStreams
 	PACNamespace        string
 	ControllerURL       string
 	RepositoryURL       string
@@ -53,12 +55,11 @@ func (w *Options) Install(ctx context.Context) error {
 	}
 
 	// figure out which git provider from the Repo URL
-	webhookProvider := detectProvider(w.RepositoryURL)
+	webhookProvider := detectProvider(w.RepositoryURL, w.IOStreams)
 
 	if !w.GitHubWebhook && webhookProvider != nil {
 		if webhookProvider.GetName() == provider.ProviderGitHubWebhook && pacInfo.Provider == provider.ProviderGitHubApp {
-			// nolint
-			fmt.Printf("✓ Skips configuring GitHub Webhook as GitHub App is already configured." +
+			fmt.Fprintln(w.IOStreams.Out, "✓ Skips configuring GitHub Webhook as GitHub App is already configured."+
 				" Please pass --github-webhook flag to still configure it")
 			return nil
 		}
@@ -81,7 +82,7 @@ func (w *Options) Install(ctx context.Context) error {
 	}
 
 	if webhookProvider == nil {
-		if webhookProvider, err = askProvider(); webhookProvider == nil || err != nil {
+		if webhookProvider, err = askProvider(w.IOStreams); webhookProvider == nil || err != nil {
 			return err
 		}
 	}
@@ -111,7 +112,7 @@ func (w *Options) Install(ctx context.Context) error {
 	return w.updateRepositoryCR(ctx, response)
 }
 
-func askProvider() (Interface, error) {
+func askProvider(ioStreams *cli.IOStreams) (Interface, error) {
 	var answer string
 	if err := survey.AskOne(&survey.Select{
 		Message: "Please select the provider you wish to configure with your repository:",
@@ -121,18 +122,18 @@ func askProvider() (Interface, error) {
 	}
 
 	if answer == "GitHub" {
-		return &gitHubConfig{Hosted: true}, nil
+		return &gitHubConfig{Hosted: true, IOStream: ioStreams}, nil
 	} else if answer == "GitLab" {
-		return &gitLabConfig{Hosted: true}, nil
+		return &gitLabConfig{Hosted: true, IOStream: ioStreams}, nil
 	}
 	return nil, nil
 }
 
-func detectProvider(url string) Interface {
+func detectProvider(url string, ioStreams *cli.IOStreams) Interface {
 	if strings.Contains(url, "https://github.com") {
-		return &gitHubConfig{}
+		return &gitHubConfig{IOStream: ioStreams}
 	} else if strings.Contains(url, "https://gitlab.com") {
-		return &gitLabConfig{}
+		return &gitLabConfig{IOStream: ioStreams}
 	}
 	return nil
 }

pkg/cmd/tknpac/bootstrap/bootstrap.go

@@ -61,8 +61,7 @@ const successTmpl = `
 
 func install(ctx context.Context, run *params.Run, opts *bootstrapOpts) error {
 	if !opts.forceInstall {
-		// nolint:forbidigo
-		fmt.Println("🏃 Checking if Pipelines as Code is installed.")
+		fmt.Fprintln(opts.ioStreams.Out, "🏃 Checking if Pipelines as Code is installed.")
 	}
 	tektonInstalled, err := checkPipelinesInstalled(run)
 	if err != nil {
@@ -82,8 +81,7 @@ func install(ctx context.Context, run *params.Run, opts *bootstrapOpts) error {
 	}
 
 	if !opts.forceInstall && err == nil {
-		// nolint:forbidigo
-		fmt.Println("👌 Pipelines as Code is already installed.")
+		fmt.Fprintln(opts.ioStreams.Out, "👌 Pipelines as Code is already installed.")
 	} else if err := installPac(ctx, run, opts); err != nil {
 		return err
 	}
@@ -143,8 +141,7 @@ func Command(run *params.Run, ioStreams *cli.IOStreams) *cobra.Command {
 
 			if !opts.forceGitHubApp {
 				if pacInfo.Provider == provider.ProviderGitHubApp {
-					// nolint
-					fmt.Printf("👌 Skips bootstrapping GitHub App, as one is already configured. Please pass --force-configure to override existing\n")
+					fmt.Fprintln(opts.ioStreams.Out, "👌 Skips bootstrapping GitHub App, as one is already configured. Please pass --force-configure to override existing")
 					return nil
 				}
 			}
@@ -202,13 +199,12 @@ func GithubApp(run *params.Run, ioStreams *cli.IOStreams) *cobra.Command {
 
 			if !opts.forceGitHubApp {
 				if pacInfo.Provider == provider.ProviderGitHubApp {
-					// nolint
-					fmt.Printf("👌 Skips bootstrapping GitHub App, as one is already configured. Please pass --force-configure to override existing\n")
+					fmt.Fprintln(opts.ioStreams.Out, "👌 Skips bootstrapping GitHub App, as one is already configured. Please pass --force-configure to override existing")
 					return nil
 				}
 			}
 
-			if b, _ := askYN(false, "", "Are you using GitHub Enterprise?"); b {
+			if b, _ := askYN(false, "", "Are you using GitHub Enterprise?", opts.ioStreams.Out); b {
 				opts.providerType = "github-enterprise-app"
 			}
 

pkg/cmd/tknpac/bootstrap/install.go

@@ -72,7 +72,7 @@ func installPac(ctx context.Context, run *params.Run, opts *bootstrapOpts) error
 	if !opts.forceInstall {
 		doinstall, err := askYN(true,
 			fmt.Sprintf("🕵️ Pipelines as Code doesn't seems to be installed in %s namespace", opts.targetNamespace),
-			fmt.Sprintf("Do you want me to install Pipelines as Code %s?", latestVersion))
+			fmt.Sprintf("Do you want me to install Pipelines as Code %s?", latestVersion), opts.ioStreams.Out)
 		if err != nil {
 			return err
 		}
@@ -85,7 +85,6 @@ func installPac(ctx context.Context, run *params.Run, opts *bootstrapOpts) error
 		return err
 	}
 
-	// nolint:forbidigo
-	fmt.Printf("✓ Pipelines-as-Code %s has been installed\n", latestVersion)
+	fmt.Fprintf(opts.ioStreams.Out, "✓ Pipelines-as-Code %s has been installed\n", latestVersion)
 	return nil
 }

pkg/cmd/tknpac/bootstrap/kubestuff.go

@@ -33,9 +33,7 @@ func createPacSecret(ctx context.Context, run *params.Run, opts *bootstrapOpts,
 		return err
 	}
 
-	// nolint:forbidigo
-	fmt.Printf("🔑 Secret %s has been created in the %s namespace\n", secretName, opts.targetNamespace)
-
+	fmt.Fprintf(opts.ioStreams.Out, "🔑 Secret %s has been created in the %s namespace\n", secretName, opts.targetNamespace)
 	return nil
 }
 

pkg/cmd/tknpac/bootstrap/questions.go

@@ -2,6 +2,7 @@ package bootstrap
 
 import (
 	"fmt"
+	"io"
 	"strings"
 
 	"github.com/AlecAivazis/survey/v2"
@@ -10,11 +11,10 @@ import (
 
 const defaultPublicGithub = "https://github.com"
 
-func askYN(deflt bool, title, question string) (bool, error) {
+func askYN(deflt bool, title, question string, writer io.Writer) (bool, error) {
 	var answer bool
-	// nolint:forbidigo
 	if title != "" {
-		fmt.Printf("%s\n", title)
+		fmt.Fprintf(writer, "%s\n", title)
 	}
 	err := prompt.SurveyAskOne(&survey.Confirm{
 		Message: question,
@@ -63,7 +63,7 @@ func askQuestions(opts *bootstrapOpts) error {
 	if opts.RouteName != "" {
 		answer, err := askYN(true,
 			fmt.Sprintf("👀 I have detected an OpenShift Route on: %s", opts.RouteName),
-			"Do you want me to use it?")
+			"Do you want me to use it?", opts.ioStreams.Out)
 		if err != nil {
 			return err
 		}