[#200] Add methods Name() and SessionInfo() to vcs interface

- evolving towards a more generic VCS interface

Author: mengdaming

src/cli/terminal_ui.go

@@ -274,12 +274,10 @@ func (term *TerminalUI) ShowSessionInfo() {
 	term.ReportInfo(false, "Language=", info.LanguageName, ", Toolchain=", info.ToolchainName)
 
 	autoPush := "disabled"
-	if info.AutoPush {
+	if info.GitAutoPush {
 		autoPush = "enabled"
 	}
-	term.ReportInfo(false,
-		"Running on branch \"", info.BranchName,
-		"\" with auto-push ", autoPush)
+	term.ReportInfo(false, "Running on ", info.VCSSessionSummary, " with auto-push ", autoPush)
 }
 
 // Confirm asks the user for confirmation

src/cli/terminal_ui_test.go

@@ -471,7 +471,7 @@ func Test_show_session_info(t *testing.T) {
 	expected := asCyanTraceWithSeparatorLine("Base Directory: fake") +
 		asCyanTrace("Work Directory: fake") +
 		asCyanTrace("Language=fake, Toolchain=fake") +
-		asCyanTrace("Running on branch \"fake\" with auto-push disabled")
+		asCyanTrace("Running on VCS session \"fake\" with auto-push disabled")
 
 	assert.Equal(t, expected, capturer.CaptureStdout(func() {
 		term, _, _ := terminalSetup(*params.AParamSet())

src/engine/session_info.go

@@ -24,11 +24,12 @@ package engine
 
 // SessionInfo contains TCR session information. Used mainly to exchange information between TCR engine and UI
 type SessionInfo struct {
-	BaseDir       string
-	WorkDir       string
-	LanguageName  string
-	ToolchainName string
-	AutoPush      bool
-	CommitOnFail  bool
-	BranchName    string
+	BaseDir           string
+	WorkDir           string
+	LanguageName      string
+	ToolchainName     string
+	VCSName           string
+	VCSSessionSummary string
+	CommitOnFail      bool
+	GitAutoPush       bool
 }

src/engine/tcr.go

@@ -181,7 +181,7 @@ func (*TCREngine) RunCheck(p params.Params) {
 // PrintLog prints the TCR VCS commit history
 func (tcr *TCREngine) PrintLog(p params.Params) {
 	tcrLogs := tcr.queryVCSLogs(p)
-	report.PostInfo("Printing TCR log for branch ", tcr.vcs.GetWorkingBranch())
+	report.PostInfo("Printing TCR log for ", tcr.vcs.SessionSummary())
 	for _, log := range tcrLogs {
 		report.PostTitle("commit:    ", log.Hash)
 		report.PostInfo("timestamp: ", log.Timestamp)
@@ -194,7 +194,7 @@ func (tcr *TCREngine) PrintLog(p params.Params) {
 // PrintStats prints the TCR execution stats
 func (tcr *TCREngine) PrintStats(p params.Params) {
 	tcrLogs := tcr.queryVCSLogs(p)
-	stats.Print(tcr.vcs.GetWorkingBranch(), tcrLogsToEvents(tcrLogs))
+	stats.Print(tcr.vcs.SessionSummary(), tcrLogsToEvents(tcrLogs))
 }
 
 func tcrLogsToEvents(tcrLogs vcs.LogItems) (tcrEvents events.TcrEvents) {
@@ -214,7 +214,7 @@ func (tcr *TCREngine) queryVCSLogs(p params.Params) vcs.LogItems {
 		report.PostError(err)
 	}
 	if len(logs) == 0 {
-		report.PostWarning("no TCR commit found in branch ", tcr.vcs.GetWorkingBranch(), "'s history")
+		report.PostWarning("no TCR commit found in ", tcr.vcs.SessionSummary(), "'s history")
 	}
 	return logs
 }
@@ -252,9 +252,9 @@ func (tcr *TCREngine) initVCS(vcsName string) {
 
 	var err error
 	switch strings.ToLower(vcsName) {
-	case "git":
+	case git.Name:
 		tcr.vcs, err = git.New(tcr.sourceTree.GetBaseDir())
-	case "p4", "perforce":
+	case p4.Name:
 		tcr.vcs, err = p4.New(tcr.sourceTree.GetBaseDir())
 	default:
 		tcr.handleError(fmt.Errorf("VCS not supported: %s", vcsName), true, status.ConfigError)
@@ -277,7 +277,7 @@ func (tcr *TCREngine) setVCS(vcsInterface vcs.Interface) {
 func (tcr *TCREngine) warnIfOnRootBranch(interactive bool) {
 	if tcr.vcs.IsOnRootBranch() {
 		message := "Running " + settings.ApplicationName +
-			" on branch \"" + tcr.vcs.GetWorkingBranch() + "\" is not recommended"
+			" on " + tcr.vcs.SessionSummary() + " is not recommended"
 		if interactive {
 			if !tcr.ui.Confirm(message, false) {
 				tcr.Quit()
@@ -457,7 +457,7 @@ func (tcr *TCREngine) test() (result toolchain.TestCommandResult) {
 }
 
 func (tcr *TCREngine) commit(event events.TCREvent) {
-	report.PostInfo("Committing changes on branch ", tcr.vcs.GetWorkingBranch())
+	report.PostInfo("Committing changes on ", tcr.vcs.SessionSummary())
 	var err error
 	err = tcr.vcs.Add()
 	tcr.handleError(err, false, status.VCSError)
@@ -550,13 +550,14 @@ func (tcr *TCREngine) revertFile(file string) error {
 // Used mainly by the user interface packages to retrieve and display this information
 func (tcr *TCREngine) GetSessionInfo() SessionInfo {
 	return SessionInfo{
-		BaseDir:       tcr.sourceTree.GetBaseDir(),
-		WorkDir:       toolchain.GetWorkDir(),
-		LanguageName:  tcr.language.GetName(),
-		ToolchainName: tcr.toolchain.GetName(),
-		AutoPush:      tcr.vcs.IsPushEnabled(),
-		CommitOnFail:  tcr.commitOnFail,
-		BranchName:    tcr.vcs.GetWorkingBranch(),
+		BaseDir:           tcr.sourceTree.GetBaseDir(),
+		WorkDir:           toolchain.GetWorkDir(),
+		LanguageName:      tcr.language.GetName(),
+		ToolchainName:     tcr.toolchain.GetName(),
+		VCSName:           tcr.vcs.Name(),
+		VCSSessionSummary: tcr.vcs.SessionSummary(),
+		GitAutoPush:       tcr.vcs.IsPushEnabled(),
+		CommitOnFail:      tcr.commitOnFail,
 	}
 }
 

src/engine/tcr_test.go

@@ -439,7 +439,7 @@ func Test_set_auto_push(t *testing.T) {
 		t.Run(tt.desc, func(t *testing.T) {
 			tcr, _ = initTCREngineWithFakes(nil, nil, nil, nil)
 			tcr.SetAutoPush(tt.state)
-			assert.Equal(t, tt.state, tcr.GetSessionInfo().AutoPush)
+			assert.Equal(t, tt.state, tcr.GetSessionInfo().GitAutoPush)
 		})
 	}
 }
@@ -497,23 +497,24 @@ func Test_vcs_push_highlights_errors(t *testing.T) {
 func Test_toggle_auto_push(t *testing.T) {
 	tcr, _ := initTCREngineWithFakes(nil, nil, nil, nil)
 	tcr.SetAutoPush(false)
-	assert.Equal(t, false, tcr.GetSessionInfo().AutoPush)
+	assert.Equal(t, false, tcr.GetSessionInfo().GitAutoPush)
 	tcr.ToggleAutoPush()
-	assert.Equal(t, true, tcr.GetSessionInfo().AutoPush)
+	assert.Equal(t, true, tcr.GetSessionInfo().GitAutoPush)
 	tcr.ToggleAutoPush()
-	assert.Equal(t, false, tcr.GetSessionInfo().AutoPush)
+	assert.Equal(t, false, tcr.GetSessionInfo().GitAutoPush)
 }
 
 func Test_get_session_info(t *testing.T) {
 	tcr, _ := initTCREngineWithFakes(nil, nil, nil, nil)
 	currentDir, _ := os.Getwd()
 	expected := SessionInfo{
-		BaseDir:       currentDir,
-		WorkDir:       currentDir,
-		LanguageName:  "fake-language",
-		ToolchainName: "fake-toolchain",
-		AutoPush:      false,
-		BranchName:    "master",
+		BaseDir:           currentDir,
+		WorkDir:           currentDir,
+		LanguageName:      "fake-language",
+		ToolchainName:     "fake-toolchain",
+		VCSName:           "fake-vcs",
+		VCSSessionSummary: "VCS session \"fake\"",
+		GitAutoPush:       false,
 	}
 	assert.Equal(t, expected, tcr.GetSessionInfo())
 }
@@ -637,7 +638,7 @@ func Test_tcr_print_log(t *testing.T) {
 		{
 			desc: "warning when no record found",
 			filter: func(msg report.Message) bool {
-				return msg.Type.Severity == report.Warning && strings.Index(msg.Text, "no TCR commit found in branch") == 0
+				return msg.Type.Severity == report.Warning && strings.Index(msg.Text, "no TCR commit found in ") == 0
 			},
 			logItems:        nil,
 			expectedMatches: 1,

src/engine/tcr_test_fake.go

@@ -65,13 +65,14 @@ func NewFakeTCREngine() *FakeTCREngine {
 	return &FakeTCREngine{
 		returnCode: 0,
 		info: &SessionInfo{
-			BaseDir:       "fake",
-			WorkDir:       "fake",
-			LanguageName:  "fake",
-			ToolchainName: "fake",
-			AutoPush:      false,
-			CommitOnFail:  false,
-			BranchName:    "fake",
+			BaseDir:           "fake",
+			WorkDir:           "fake",
+			LanguageName:      "fake",
+			ToolchainName:     "fake",
+			VCSName:           "fake",
+			VCSSessionSummary: "VCS session \"fake\"",
+			GitAutoPush:       false,
+			CommitOnFail:      false,
 		},
 	}
 }

src/vcs/git/git_impl.go

@@ -40,6 +40,9 @@ import (
 	"strings"
 )
 
+// Name provides the name for this VCS implementation
+const Name = "git"
+
 // DefaultRemoteName is the alias used by default for the git remote repository
 const DefaultRemoteName = "origin"
 
@@ -93,6 +96,16 @@ func newGitImpl(initRepo func(string) (*git.Repository, billy.Filesystem, error)
 	return &g, err
 }
 
+// Name returns VCS name
+func (*gitImpl) Name() string {
+	return Name
+}
+
+// SessionSummary provides a short description related to current VCS session summary
+func (g *gitImpl) SessionSummary() string {
+	return fmt.Sprintf("%s branch \"%s\"", g.Name(), g.GetWorkingBranch())
+}
+
 // plainOpen is the regular function used to open a repository
 func plainOpen(dir string) (*git.Repository, billy.Filesystem, error) {
 	repo, err := git.PlainOpenWithOptions(dir, &git.PlainOpenOptions{

src/vcs/git/git_impl_test.go

@@ -40,6 +40,16 @@ func slowTestTag(t *testing.T) {
 	}
 }
 
+func Test_get_vcs_name(t *testing.T) {
+	g, _ := newGitImpl(inMemoryRepoInit, "")
+	assert.Equal(t, "git", g.Name())
+}
+
+func Test_get_vcs_session_summary(t *testing.T) {
+	g, _ := newGitImpl(inMemoryRepoInit, "")
+	assert.Equal(t, "git branch \"master\"", g.SessionSummary())
+}
+
 func Test_git_auto_push_is_disabled_default(t *testing.T) {
 	g, _ := newGitImpl(inMemoryRepoInit, "")
 	assert.Zero(t, g.IsPushEnabled())
@@ -61,6 +71,7 @@ func Test_init_fails_when_working_dir_is_not_in_a_git_repo(t *testing.T) {
 
 func Test_can_retrieve_working_branch_on_in_memory_repo(t *testing.T) {
 	g, _ := newGitImpl(inMemoryRepoInit, "")
+	// go-git's in memory repository default branch is "master"
 	assert.Equal(t, "master", g.GetWorkingBranch())
 }
 

src/vcs/git/git_test_fake.go

@@ -102,6 +102,14 @@ func NewFake(settings FakeSettings) (*Fake, error) {
 	return &Fake{impl: impl, settings: settings}, err
 }
 
+func (gf *Fake) Name() string {
+	return "fake-vcs"
+}
+
+func (gf *Fake) SessionSummary() string {
+	return "VCS session \"fake\""
+}
+
 // GetLastCommand returns the last command called
 func (gf *Fake) GetLastCommand() Command {
 	return gf.lastCommand

src/vcs/p4/p4_impl.go

@@ -39,6 +39,9 @@ import (
 	"strings"
 )
 
+// Name provides the name for this VCS implementation
+const Name = "p4"
+
 // p4Impl provides the implementation of the Perforce interface
 type p4Impl struct {
 	baseDir              string
@@ -68,7 +71,7 @@ func newP4Impl(initDepotFs func() afero.Fs, dir string, testFlag bool) (*p4Impl,
 
 	if testFlag {
 		// For test purpose only: tests should run and pass without having p4 installed and with no p4 server available
-		p.clientName = ""
+		p.clientName = "test"
 		p.rootDir = dir
 	} else {
 		p.clientName = GetP4ClientName()
@@ -85,6 +88,16 @@ func newP4Impl(initDepotFs func() afero.Fs, dir string, testFlag bool) (*p4Impl,
 	return &p, nil
 }
 
+// Name returns VCS name
+func (*p4Impl) Name() string {
+	return Name
+}
+
+// SessionSummary provides a short description related to current VCS session summary
+func (p *p4Impl) SessionSummary() string {
+	return fmt.Sprintf("%s client \"%s\"", p.Name(), p.clientName)
+}
+
 // plainOpen is the regular function used to open a p4 depot
 func plainOpen() afero.Fs {
 	return afero.NewOsFs()

src/vcs/p4/p4_impl_test.go

@@ -33,6 +33,16 @@ import (
 	"testing"
 )
 
+func Test_get_vcs_name(t *testing.T) {
+	p, _ := newP4Impl(inMemoryDepotInit, "", true)
+	assert.Equal(t, "p4", p.Name())
+}
+
+func Test_get_vcs_session_summary(t *testing.T) {
+	p, _ := newP4Impl(inMemoryDepotInit, "", true)
+	assert.Equal(t, "p4 client \"test\"", p.SessionSummary())
+}
+
 func Test_p4_auto_push_is_always_enabled(t *testing.T) {
 	p, _ := newP4Impl(inMemoryDepotInit, "", true)
 	assert.True(t, p.IsPushEnabled())

src/vcs/vcs.go

@@ -30,6 +30,8 @@ const (
 // Interface provides the interface that a VCS implementation must satisfy for TCR engine to be
 // able to interact with it
 type Interface interface {
+	Name() string
+	SessionSummary() string
 	GetRootDir() string
 	GetRemoteName() string
 	GetWorkingBranch() string