[#200] Move git auto-push checking under git environment checker

Author: mengdaming

src/checker/check.go

@@ -69,8 +69,8 @@ var checkEnv struct {
 	langErr       error
 	tchn          toolchain.TchnInterface
 	tchnErr       error
-	git           vcs.Interface
-	gitErr        error
+	vcs           vcs.Interface
+	vcsErr        error
 }
 
 // Run goes through all configuration, parameters and local environment to check
@@ -85,7 +85,6 @@ func Run(p params.Params) {
 		checkLanguage,
 		checkToolchain,
 		checkVCSEnvironment,
-		checkAutoPush,
 		checkCommitFailures,
 		checkPollingPeriod,
 		checkMobTimer,
@@ -131,7 +130,8 @@ func initCheckEnv(p params.Params) {
 	checkEnv.workDir = toolchain.GetWorkDir()
 
 	if checkEnv.sourceTreeErr == nil {
-		checkEnv.git, checkEnv.gitErr = git.New(checkEnv.sourceTree.GetBaseDir())
+		// TODO init with the right VCS instance
+		checkEnv.vcs, checkEnv.vcsErr = git.New(checkEnv.sourceTree.GetBaseDir())
 	}
 }
 
@@ -159,15 +159,15 @@ func checkpointsForList(headerMsg string, emptyMsg string, values []string) (cp
 	return cp
 }
 
-func okCheckPoint(a ...interface{}) CheckPoint {
+func okCheckPoint(a ...any) CheckPoint {
 	return CheckPoint{rc: CheckStatusOk, description: fmt.Sprint(a...)}
 }
 
-func warningCheckPoint(a ...interface{}) CheckPoint {
+func warningCheckPoint(a ...any) CheckPoint {
 	return CheckPoint{rc: CheckStatusWarning, description: fmt.Sprint(a...)}
 }
 
-func errorCheckPoint(a ...interface{}) CheckPoint {
+func errorCheckPoint(a ...any) CheckPoint {
 	return CheckPoint{rc: CheckStatusError, description: fmt.Sprint(a...)}
 }
 
@@ -187,15 +187,15 @@ func (cr *CheckResults) add(checkPoints []CheckPoint) {
 	cr.checkPoints = append(cr.checkPoints, checkPoints...)
 }
 
-func (cr *CheckResults) ok(a ...interface{}) {
+func (cr *CheckResults) ok(a ...any) {
 	cr.addCheckPoint(okCheckPoint(a...))
 }
 
-func (cr *CheckResults) warning(a ...interface{}) {
+func (cr *CheckResults) warning(a ...any) {
 	cr.addCheckPoint(warningCheckPoint(a...))
 }
 
-//func (cr *CheckResults) error(a ...interface{}) {
+//func (cr *CheckResults) error(a ...any) {
 //	cr.addCheckPoint(errorCheckPoint(a...))
 //}
 

src/checker/check_auto_push.go

@@ -27,11 +27,11 @@ import (
 )
 
 func checkCommitFailures(p params.Params) (cr *CheckResults) {
-	cr = NewCheckResults("VCS commit-failures")
+	cr = NewCheckResults("commit-failures")
 	if p.CommitFailures {
-		cr.ok("VCS commit-failures is turned on: test-breaking changes will be committed")
+		cr.ok("commit-failures is turned on: test-breaking changes will be committed")
 	} else {
-		cr.ok("VCS commit-failures is turned off: test-breaking changes will not be committed")
+		cr.ok("commit-failures is turned off: test-breaking changes will not be committed")
 	}
 	return cr
 }

src/checker/check_auto_push_test.go

@@ -27,12 +27,13 @@ import (
 	"github.com/murex/tcr/vcs/git"
 )
 
-func checkGitEnvironment(_ params.Params) (cr *CheckResults) {
+func checkGitEnvironment(p params.Params) (cr *CheckResults) {
 	cr = NewCheckResults("git environment")
 	cr.add(checkGitCommand())
 	cr.add(checkGitConfig())
 	cr.add(checkGitRepository())
 	cr.add(checkGitRemote())
+	cr.add(checkGitAutoPush(p))
 	return cr
 }
 
@@ -57,37 +58,46 @@ func checkGitRepository() (cp []CheckPoint) {
 		cp = append(cp, errorCheckPoint("cannot retrieve git repository information from base directory name"))
 		return cp
 	}
-	if checkEnv.gitErr != nil {
-		cp = append(cp, errorCheckPoint(checkEnv.gitErr))
+	if checkEnv.vcsErr != nil {
+		cp = append(cp, errorCheckPoint(checkEnv.vcsErr))
 		return cp
 	}
 
-	cp = append(cp, okCheckPoint("git repository root is ", checkEnv.git.GetRootDir()))
+	cp = append(cp, okCheckPoint("git repository root is ", checkEnv.vcs.GetRootDir()))
 
-	cp = append(cp, okCheckPoint("git working branch is ", checkEnv.git.GetWorkingBranch()))
-	if checkEnv.git.IsOnRootBranch() {
+	cp = append(cp, okCheckPoint("git working branch is ", checkEnv.vcs.GetWorkingBranch()))
+	if checkEnv.vcs.IsOnRootBranch() {
 		cp = append(cp, warningCheckPoint("running TCR from a root branch is not recommended"))
 	}
 	return cp
 }
 
 func checkGitRemote() (cp []CheckPoint) {
-	if checkEnv.git == nil {
+	if checkEnv.vcs == nil {
 		// If git is not properly initialized, no point in trying to go further
 		return cp
 	}
 
-	if !checkEnv.git.IsRemoteEnabled() {
+	if !checkEnv.vcs.IsRemoteEnabled() {
 		cp = append(cp, okCheckPoint("git remote is disabled: all operations will be done locally"))
 		return cp
 	}
 
-	cp = append(cp, okCheckPoint("git remote name is ", checkEnv.git.GetRemoteName()))
+	cp = append(cp, okCheckPoint("git remote name is ", checkEnv.vcs.GetRemoteName()))
 
-	if checkEnv.git.CheckRemoteAccess() {
+	if checkEnv.vcs.CheckRemoteAccess() {
 		cp = append(cp, okCheckPoint("git remote access seems to be working"))
 	} else {
 		cp = append(cp, errorCheckPoint("git remote access does not seem to be working"))
 	}
 	return cp
 }
+
+func checkGitAutoPush(p params.Params) (cp []CheckPoint) {
+	if p.AutoPush {
+		cp = append(cp, okCheckPoint("git auto-push is turned on: every commit will be pushed to origin"))
+	} else {
+		cp = append(cp, okCheckPoint("git auto-push is turned off: commits will only be applied locally"))
+	}
+	return cp
+}

src/checker/check_commit_failures.go

@@ -28,6 +28,28 @@ import (
 )
 
 func Test_check_git_returns_warning_with_brand_new_repo(t *testing.T) {
-	// Warning is triggered by default branch (master) being a root branch
+	// Warning is triggered by default if branch (master) being a root branch
 	assertWarning(t, checkGitEnvironment, *params.AParamSet())
 }
+
+func Test_check_git_auto_push(t *testing.T) {
+	tests := []struct {
+		desc     string
+		value    bool
+		expected CheckStatus
+	}{
+		{"enabled", true, CheckStatusOk},
+		{"disabled", false, CheckStatusOk},
+	}
+	for _, test := range tests {
+		t.Run(test.desc, func(t *testing.T) {
+			assertStatus(t, test.expected,
+				func(p params.Params) (cr *CheckResults) {
+					cr = NewCheckResults("git auto-push parameter")
+					cr.add(checkGitAutoPush(p))
+					return cr
+				},
+				*params.AParamSet(params.WithAutoPush(test.value)))
+		})
+	}
+}

src/checker/check_git.go

@@ -33,16 +33,16 @@ const (
 )
 
 func checkPollingPeriod(p params.Params) (cr *CheckResults) {
-	cr = NewCheckResults("VCS polling period")
-	cr.ok("VCS polling period is ", p.PollingPeriod.String())
+	cr = NewCheckResults("polling period")
+	cr.ok("polling period is ", p.PollingPeriod.String())
 	if p.PollingPeriod == 0 {
-		cr.warning("VCS code refresh for navigator is turned off")
+		cr.warning("code refresh (for navigator role) is turned off")
 	} else if p.PollingPeriod > pollingPeriodHighThreshold {
-		cr.warning("VCS polling period is very slow (above ", pollingPeriodHighThreshold, ")")
+		cr.warning("polling period is very slow (above ", pollingPeriodHighThreshold, ")")
 	} else if p.PollingPeriod < pollingPeriodLowThreshold {
-		cr.warning("VCS polling period is very fast (below ", pollingPeriodLowThreshold, ")")
+		cr.warning("polling period is very fast (below ", pollingPeriodLowThreshold, ")")
 	} else {
-		cr.ok("VCS polling period is in the recommended range")
+		cr.ok("polling period is in the recommended range")
 	}
 	return cr
 }

src/checker/check_git_test.go

@@ -51,7 +51,7 @@ func slowTestTag(t *testing.T) {
 func initTestCheckEnv(params params.Params) {
 	initCheckEnv(params)
 	// We replace git implementation with a fake so that we bypass real git access
-	checkEnv.git, checkEnv.gitErr = git.NewFake(git.FakeSettings{})
+	checkEnv.vcs, checkEnv.vcsErr = git.NewFake(git.FakeSettings{})
 }
 
 func assertStatus(t *testing.T, expected CheckStatus, checker func(params params.Params) (cr *CheckResults), params params.Params) {

src/checker/check_polling_period.go

@@ -24,14 +24,16 @@ package checker
 
 import (
 	"github.com/murex/tcr/params"
+	"github.com/murex/tcr/vcs/git"
+	"github.com/murex/tcr/vcs/p4"
 	"strings"
 )
 
 func checkVCSEnvironment(p params.Params) (cr *CheckResults) {
 	switch strings.ToLower(p.VCS) {
-	case "git":
+	case git.Name:
 		return checkGitEnvironment(p)
-	case "p4":
+	case p4.Name:
 		return checkP4Environment(p)
 	default:
 		return nil