Merge pull request cli#852 from vilmibm/spinnertest

Nate Smith · web-flow · commit 876ca320bcaa · 2020-04-29T16:45:18.000-05:00
totally inelegant approach to hopefully stopping flakey tests
diff --git a/command/repo.go b/command/repo.go
@@ -379,11 +379,11 @@ func repoFork(cmd *cobra.Command, args []string) error {
 	loading := utils.Gray("Forking ") + utils.Bold(utils.Gray(ghrepo.FullName(repoToFork))) + utils.Gray("...")
 	s.Suffix = " " + loading
 	s.FinalMSG = utils.Gray(fmt.Sprintf("- %s\n", loading))
-	s.Start()
+	utils.StartSpinner(s)
 
 	forkedRepo, err := api.ForkRepo(apiClient, repoToFork)
 	if err != nil {
-		s.Stop()
+		utils.StopSpinner(s)
 		return fmt.Errorf("failed to fork: %w", err)
 	}
 
diff --git a/command/repo_test.go b/command/repo_test.go
@@ -11,12 +11,24 @@ import (
 	"testing"
 	"time"
 
+	"github.com/briandowns/spinner"
+
 	"github.com/cli/cli/context"
 	"github.com/cli/cli/internal/run"
 	"github.com/cli/cli/test"
+	"github.com/cli/cli/utils"
 )
 
+func stubSpinner() {
+	// not bothering with teardown since we never want spinners when doing tests
+	utils.StartSpinner = func(_ *spinner.Spinner) {
+	}
+	utils.StopSpinner = func(_ *spinner.Spinner) {
+	}
+}
+
 func TestRepoFork_already_forked(t *testing.T) {
+	stubSpinner()
 	initContext = func() context.Context {
 		ctx := context.NewBlank()
 		ctx.SetBaseRepo("OWNER/REPO")
@@ -42,6 +54,7 @@ func TestRepoFork_already_forked(t *testing.T) {
 }
 
 func TestRepoFork_reuseRemote(t *testing.T) {
+	stubSpinner()
 	initContext = func() context.Context {
 		ctx := context.NewBlank()
 		ctx.SetBaseRepo("OWNER/REPO")
@@ -77,6 +90,7 @@ func stubSince(d time.Duration) func() {
 }
 
 func TestRepoFork_in_parent(t *testing.T) {
+	stubSpinner()
 	initBlankContext("", "OWNER/REPO", "master")
 	defer stubSince(2 * time.Second)()
 	http := initFakeHTTP()
@@ -98,6 +112,7 @@ func TestRepoFork_in_parent(t *testing.T) {
 }
 
 func TestRepoFork_outside(t *testing.T) {
+	stubSpinner()
 	tests := []struct {
 		name string
 		args string
@@ -134,6 +149,7 @@ func TestRepoFork_outside(t *testing.T) {
 }
 
 func TestRepoFork_in_parent_yes(t *testing.T) {
+	stubSpinner()
 	initBlankContext("", "OWNER/REPO", "master")
 	defer stubSince(2 * time.Second)()
 	http := initFakeHTTP()
@@ -168,6 +184,7 @@ func TestRepoFork_in_parent_yes(t *testing.T) {
 }
 
 func TestRepoFork_outside_yes(t *testing.T) {
+	stubSpinner()
 	defer stubSince(2 * time.Second)()
 	http := initFakeHTTP()
 	defer http.StubWithFixture(200, "forkResult.json")()
@@ -194,6 +211,7 @@ func TestRepoFork_outside_yes(t *testing.T) {
 }
 
 func TestRepoFork_outside_survey_yes(t *testing.T) {
+	stubSpinner()
 	defer stubSince(2 * time.Second)()
 	http := initFakeHTTP()
 	defer http.StubWithFixture(200, "forkResult.json")()
@@ -227,6 +245,7 @@ func TestRepoFork_outside_survey_yes(t *testing.T) {
 }
 
 func TestRepoFork_outside_survey_no(t *testing.T) {
+	stubSpinner()
 	defer stubSince(2 * time.Second)()
 	http := initFakeHTTP()
 	defer http.StubWithFixture(200, "forkResult.json")()
@@ -261,6 +280,7 @@ func TestRepoFork_outside_survey_no(t *testing.T) {
 }
 
 func TestRepoFork_in_parent_survey_yes(t *testing.T) {
+	stubSpinner()
 	initBlankContext("", "OWNER/REPO", "master")
 	defer stubSince(2 * time.Second)()
 	http := initFakeHTTP()
@@ -303,6 +323,7 @@ func TestRepoFork_in_parent_survey_yes(t *testing.T) {
 }
 
 func TestRepoFork_in_parent_survey_no(t *testing.T) {
+	stubSpinner()
 	initBlankContext("", "OWNER/REPO", "master")
 	defer stubSince(2 * time.Second)()
 	http := initFakeHTTP()
diff --git a/utils/utils.go b/utils/utils.go
@@ -74,6 +74,16 @@ func Humanize(s string) string {
 	return strings.Map(h, s)
 }
 
+// We do this so we can stub out the spinner in tests -- it made things really flakey. this is not
+// an elegant solution.
+var StartSpinner = func(s *spinner.Spinner) {
+	s.Start()
+}
+
+var StopSpinner = func(s *spinner.Spinner) {
+	s.Stop()
+}
+
 func Spinner(w io.Writer) *spinner.Spinner {
 	return spinner.New(spinner.CharSets[11], 400*time.Millisecond, spinner.WithWriter(w))
 }
