fake command runner

Author: David Gamero

cmd/setup-gh.go

@@ -31,8 +31,8 @@ application and service principle, and will configure that application to trust
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := cmd.Context()
 
+			gh := providers.NewGhClient()
 			providers.EnsureAzCli()
-			providers.EnsureGhCli()
 
 			azCred, err := cred.GetCred()
 			if err != nil {
@@ -44,14 +44,14 @@ application and service principle, and will configure that application to trust
 			}
 			sc.AzClient = az
 
-			err = fillSetUpConfig(sc)
+			err = fillSetUpConfig(sc, gh)
 			if err != nil {
 				return fmt.Errorf("filling setup config: %w", err)
 			}
 
 			s := spinner.CreateSpinner("--> Setting up Github OIDC...")
 			s.Start()
-			err = runProviderSetUp(ctx, sc, s)
+			err = runProviderSetUp(ctx, sc, s, gh)
 			s.Stop()
 			if err != nil {
 				return err
@@ -73,7 +73,7 @@ application and service principle, and will configure that application to trust
 	return cmd
 }
 
-func fillSetUpConfig(sc *providers.SetUpCmd) error {
+func fillSetUpConfig(sc *providers.SetUpCmd, gh providers.GhClient) error {
 	if sc.TenantId == "" {
 		tenandId, err := providers.PromptTenantId(sc.AzClient, context.Background())
 		if err != nil {
@@ -130,7 +130,7 @@ func fillSetUpConfig(sc *providers.SetUpCmd) error {
 	}
 
 	if sc.Repo == "" {
-		repo, err := PromptGitHubRepoWithOwner()
+		repo, err := PromptGitHubRepoWithOwner(gh)
 		if err != nil {
 			return fmt.Errorf("prompting github repo: %w", err)
 		}
@@ -140,11 +140,11 @@ func fillSetUpConfig(sc *providers.SetUpCmd) error {
 	return nil
 }
 
-func runProviderSetUp(ctx context.Context, sc *providers.SetUpCmd, s spinner.Spinner) error {
+func runProviderSetUp(ctx context.Context, sc *providers.SetUpCmd, s spinner.Spinner, gh providers.GhClient) error {
 	provider := strings.ToLower(sc.Provider)
 	if provider == "azure" {
 		// call azure provider logic
-		return providers.InitiateAzureOIDCFlow(ctx, sc, s)
+		return providers.InitiateAzureOIDCFlow(ctx, sc, s, gh)
 
 	} else {
 		// call logic for user-submitted provider
@@ -192,7 +192,7 @@ func PromptAppName(az providers.AzClientInterface, defaultAppName string) (strin
 func getSubscriptionID() string {
 	validate := func(input string) error {
 		if input == "" {
-			return errors.New("Invalid subscription id")
+			return errors.New("invalid subscription id")
 		}
 		return nil
 	}
@@ -231,8 +231,8 @@ func PromptResourceGroup(az providers.AzClientInterface, subscriptionID string)
 	return rg, nil
 }
 
-func PromptGitHubRepoWithOwner() (string, error) {
-	defaultRepoNameWithOwner, err := providers.GetRepoNameWithOwner()
+func PromptGitHubRepoWithOwner(gh providers.GhClient) (string, error) {
+	defaultRepoNameWithOwner, err := gh.GetRepoNameWithOwner()
 	if err != nil {
 		return "", err
 	}
@@ -254,14 +254,14 @@ func PromptGitHubRepoWithOwner() (string, error) {
 	}
 
 	log.Debug("Validating github repo...")
-	if err := providers.IsValidGhRepo(repo); err != nil {
+	if err := gh.IsValidGhRepo(repo); err != nil {
 		confirmMissingRepoPrompt := promptui.Prompt{
 			Label:     "Unable to confirm this repo exists. Do you want to proceed anyway?",
 			IsConfirm: true,
 		}
 		_, err := confirmMissingRepoPrompt.Run()
 		if err != nil {
-			return PromptGitHubRepoWithOwner()
+			return PromptGitHubRepoWithOwner(gh)
 		}
 	} else {
 		log.Debugf("Github repo %q is valid", repo)

cmd/setup-gh_test.go

@@ -21,9 +21,10 @@ func TestSetUpConfig(t *testing.T) {
 	mockSetUpCmd.TenantId = "123456789"
 	s := spinner.CreateSpinner("--> Setting up Github OIDC...")
 
-	fillSetUpConfig(mockSetUpCmd)
+	gh := &providers.GhCliClient{}
+	fillSetUpConfig(mockSetUpCmd, gh)
 
-	err := runProviderSetUp(ctx, mockSetUpCmd, s)
+	err := runProviderSetUp(ctx, mockSetUpCmd, s, gh)
 
 	assert.True(t, err == nil)
 }

pkg/providers/azure.go

@@ -32,21 +32,20 @@ type SetUpCmd struct {
 
 const AZURE_CONTRIBUTOR_ROLE_ID = "b24988ac-6180-42a0-ab88-20f7382dd24c"
 
-func InitiateAzureOIDCFlow(ctx context.Context, sc *SetUpCmd, s spinner.Spinner) error {
+func InitiateAzureOIDCFlow(ctx context.Context, sc *SetUpCmd, s spinner.Spinner, gh GhClient) error {
 	log.Debug("Commencing github connection with azure...")
 
-	EnsureGhCliInstalled()
-	EnsureGhCliLoggedIn()
 	s.Start()
 
-	if err := sc.ValidateSetUpConfig(); err != nil {
+	if err := sc.ValidateSetUpConfig(gh); err != nil {
 		return err
 	}
 
-	if AzAppExists(sc.AppName) {
-		return errors.New("app already exists")
-	} else if err := sc.createAzApp(); err != nil {
-		return err
+	if !AzAppExists(sc.AppName) {
+		err := sc.createAzApp()
+		if err != nil {
+			return err
+		}
 	}
 
 	if err := sc.CreateServicePrincipal(); err != nil {
@@ -126,7 +125,7 @@ func (sc *SetUpCmd) createAzApp() error {
 }
 
 func (sc *SetUpCmd) CreateServicePrincipal() error {
-	log.Debug("Creating Azure service principal...")
+	log.Debug("creating Azure service principal...")
 	start := time.Now()
 	log.Debug(start)
 
@@ -138,7 +137,7 @@ func (sc *SetUpCmd) CreateServicePrincipal() error {
 			return err
 		}
 
-		log.Debug("Checking sp was created...")
+		log.Debug("checking sp was created...")
 		if sc.ServicePrincipalExists() {
 			log.Debug("Service principal created successfully!")
 			end := time.Since(start)
@@ -184,13 +183,13 @@ func PromptTenantId(azc AzClientInterface, ctx context.Context) (string, error)
 		return selectedTenant, nil
 	}
 	if len(tenants) > 1 {
-		prompts.Select[armsubscription.TenantIDDescription]("{{.TenantID}}", tenants, &prompts.SelectOpt[armsubscription.TenantIDDescription]{})
+		prompts.Select[armsubscription.TenantIDDescription]("Select the tenant you want to use", tenants, &prompts.SelectOpt[armsubscription.TenantIDDescription]{})
 	}
 
 	return selectedTenant, nil
 }
 
-func (sc *SetUpCmd) ValidateSetUpConfig() error {
+func (sc *SetUpCmd) ValidateSetUpConfig(gh GhClient) error {
 	log.Debug("Checking that provided information is valid...")
 
 	if err := IsSubscriptionIdValid(sc.SubscriptionID); err != nil {
@@ -205,7 +204,7 @@ func (sc *SetUpCmd) ValidateSetUpConfig() error {
 		return errors.New("invalid app name")
 	}
 
-	if err := IsValidGhRepo(sc.Repo); err != nil {
+	if err := gh.IsValidGhRepo(sc.Repo); err != nil {
 		return err
 	}
 

pkg/providers/commandrunner.go

@@ -11,6 +11,7 @@ type CommandRunner interface {
 }
 
 type DefaultCommandRunner struct{}
+var _ CommandRunner = &DefaultCommandRunner{}
 
 func (d *DefaultCommandRunner) RunCommand(args ...string) (string, error) {
 	cmd := exec.Command(args[0], args[1:]...)
@@ -22,6 +23,7 @@ type FakeCommandRunner struct {
 	Output string
 	ErrStr string
 }
+var _ CommandRunner = &FakeCommandRunner{}
 
 func (f *FakeCommandRunner) RunCommand(args ...string) (string, error) {
 	if f.ErrStr != "" {

pkg/providers/ghcli.go

@@ -2,8 +2,6 @@ package providers
 
 import (
 	"fmt"
-	"os"
-	"os/exec"
 	"strings"
 
 	log "github.com/sirupsen/logrus"
@@ -15,45 +13,60 @@ type SubLabel struct {
 }
 
 // EnsureGhCliInstalled ensures that the Github CLI is installed and the user is logged in
-func EnsureGhCli() {
-	EnsureGhCliInstalled()
+func (gh GhCliClient) EnsureGhCli() {
+	gh.EnsureGhCliInstalled()
+	gh.EnsureGhCliLoggedIn()
+}
+
+type GhClient interface {
+	EnsureGhCli()
 	EnsureGhCliLoggedIn()
+	IsLoggedInToGh() bool
+	LogInToGh() error
+	IsValidGhRepo(repo string) error
+	GetRepoNameWithOwner() (string, error)
 }
 
-type GhClient struct {
+var _ GhClient = &GhCliClient{}
+
+type GhCliClient struct {
 	CommandRunner CommandRunner
 }
 
-func NewGhClient() *GhClient {
-	return &GhClient{
+func NewGhClient() *GhCliClient {
+	gh := &GhCliClient{
 		CommandRunner: &DefaultCommandRunner{},
 	}
+	gh.EnsureGhCli()
+	return gh
 }
 
-func EnsureGhCliInstalled() {
+func (gh GhCliClient) exec(args ...string) (string, error) {
+	return gh.CommandRunner.RunCommand(args...)
+}
+
+func (gh GhCliClient) EnsureGhCliInstalled() {
 	log.Debug("Checking that github cli is installed...")
-	ghCmd := exec.Command("gh")
-	_, err := ghCmd.CombinedOutput()
+	_, err := gh.exec("gh")
 	if err != nil {
 		log.Fatal("Error: The github cli is required to complete this process. Find installation instructions at this link: https://github.com/cli/cli#installation")
 	}
 
 	log.Debug("Github cli found!")
 }
 
-func EnsureGhCliLoggedIn() {
-	EnsureGhCliInstalled()
-	if !IsLoggedInToGh() {
-		if err := LogInToGh(); err != nil {
+func (gh GhCliClient) EnsureGhCliLoggedIn() {
+	gh.EnsureGhCliInstalled()
+	if !gh.IsLoggedInToGh() {
+		if err := gh.LogInToGh(); err != nil {
 			log.Fatal("Error: unable to log in to github")
 		}
 	}
 }
 
-func IsLoggedInToGh() bool {
+func (gh GhCliClient) IsLoggedInToGh() bool {
 	log.Debug("Checking that user is logged in to github...")
-	ghCmd := exec.Command("gh", "auth", "status")
-	out, err := ghCmd.CombinedOutput()
+	out, err := gh.exec("gh", "auth", "status")
 	if err != nil {
 		fmt.Printf(string(out))
 		return false
@@ -64,43 +77,33 @@ func IsLoggedInToGh() bool {
 
 }
 
-func LogInToGh() error {
+func (gh GhCliClient) LogInToGh() error {
 	log.Debug("Logging user in to github...")
-	ghCmd := exec.Command("gh", "auth", "login")
-	ghCmd.Stdin = os.Stdin
-	ghCmd.Stdout = os.Stdout
-	ghCmd.Stderr = os.Stderr
-	err := ghCmd.Run()
+	_, err := gh.exec("gh", "auth", "login")
 	if err != nil {
 		return err
 	}
 
 	return nil
 }
 
-func IsValidGhRepo(repo string) error {
-	listReposCmd := exec.Command("gh", "repo", "view", repo)
-	_, err := listReposCmd.CombinedOutput()
+func (gh GhCliClient) IsValidGhRepo(repo string) error {
+	_, err := gh.exec("gh", "repo", "view", repo)
 	if err != nil {
 		log.Debug("Github repo " + repo + "not found")
 		return err
 	}
 	return nil
 }
 
-func GetRepoNameWithOwner() (string, error) {
+func (gh GhCliClient) GetRepoNameWithOwner() (string, error) {
 	repoNameWithOwner := ""
-	GetRepoNameWithOwnerCmd := exec.Command("gh", "repo", "view", "--json", "nameWithOwner", "-q", ".nameWithOwner")
-	out, err := GetRepoNameWithOwnerCmd.CombinedOutput()
+	out, err := gh.exec("gh", "repo", "view", "--json", "nameWithOwner", "-q", ".nameWithOwner")
 	if err != nil {
 		log.Fatal("getting github repo name with owner")
 		return repoNameWithOwner, err
 	}
-	if out == nil {
-		log.Fatal("github repo name nil from cli")
-		return repoNameWithOwner, fmt.Errorf("github repo name with owner not found")
-	}
-	if len(out) == 0 {
+	if out == "" {
 		log.Fatal("github repo name empty from gh cli")
 		return repoNameWithOwner, fmt.Errorf("github repo name empty from gh cli")
 	}

pkg/providers/ghcli_test.go

@@ -5,5 +5,11 @@ import (
 )
 
 func TestHasGhCli(t *testing.T) {
-	EnsureGhCliInstalled()
+	cr := &FakeCommandRunner{
+		Output: "gh version 1.0.0",
+	}
+	gh := &GhCliClient{
+		CommandRunner: cr,
+	}
+	gh.EnsureGhCliInstalled()
 }