[#200] Add vcs/p4 implementation for Add(), Commit(), Push()

Author: mengdaming

src/vcs/cmd/command.go

@@ -53,6 +53,7 @@ func (sc *ShellCommand) GetFullPath() string {
 
 // Run calls the command with the provided parameters in a separate process and returns its output traces combined
 func (sc *ShellCommand) Run(params ...string) (output []byte, err error) {
+	//report.PostWarning("Command: ", sc.name, " ", append(sc.params, params...))
 	return sh.Command(sc.name, append(sc.params, params...)).CombinedOutput()
 }
 
@@ -68,6 +69,7 @@ func (sc *ShellCommand) Trace(params ...string) error {
 // RunAndPipe calls the command with the provided parameters in a separate process
 // and pipes its output to cmd. Returns cmd's output traces combined
 func (sc *ShellCommand) RunAndPipe(cmd *ShellCommand, params ...string) (output []byte, err error) {
+	//report.PostWarning("Command: ", sc.name, " ", append(sc.params, params...), " | ", cmd.name, " ", cmd.params)
 	return sh.NewSession().
 		Command(sc.name, append(sc.params, params...)).
 		Command(cmd.name, cmd.params).

src/vcs/cmd/shell.go

@@ -0,0 +1,37 @@
+/*
+Copyright (c) 2023 Murex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+package cmd
+
+import "golang.org/x/text/encoding/charmap"
+
+// ShellAttributes contain shell-specific attributes allowing to tune behavior
+// when interacting with a shell command
+type ShellAttributes struct {
+	Encoding *charmap.Charmap
+	EOL      string
+}
+
+// GetShellAttributes Returns shell-specific attributes
+func GetShellAttributes() ShellAttributes {
+	return osShellAttributes()
+}

src/vcs/cmd/shell_unix.go

@@ -0,0 +1,33 @@
+//go:build !windows
+
+/*
+Copyright (c) 2023 Murex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+package cmd
+
+// osShellAttributes returns shell attributes associated to the underlying operating system
+func osShellAttributes() ShellAttributes {
+	return ShellAttributes{
+		Encoding: nil,
+		EOL:      "\n",
+	}
+}

src/vcs/cmd/shell_unix_test.go

@@ -0,0 +1,40 @@
+//go:build !windows
+
+/*
+Copyright (c) 2023 Murex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+package cmd
+
+import (
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func Test_unix_shell_encoding(t *testing.T) {
+	// nil means that we use Go's default string encoding (UTF-8)
+	// e.g. no conversion is required
+	assert.Equal(t, nil, GetShellAttributes().Encoding)
+}
+
+func Test_unix_shell_end_of_line(t *testing.T) {
+	assert.Equal(t, "\n", GetShellAttributes().EOL)
+}

src/vcs/cmd/shell_windows.go

@@ -0,0 +1,33 @@
+/*
+Copyright (c) 2023 Murex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+package cmd
+
+import "golang.org/x/text/encoding/charmap"
+
+// osShellAttributes returns shell attributes associated to the underlying operating system
+func osShellAttributes() ShellAttributes {
+	return ShellAttributes{
+		Encoding: charmap.Windows1252,
+		EOL:      "\r\n",
+	}
+}

src/vcs/cmd/shell_windows_test.go

@@ -0,0 +1,39 @@
+/*
+Copyright (c) 2023 Murex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+package cmd
+
+import (
+	"github.com/stretchr/testify/assert"
+	"golang.org/x/text/encoding/charmap"
+	"testing"
+)
+
+func Test_windows_shell_encoding(t *testing.T) {
+	// Windows1252 works for Western character set. We may need a more sophisticated
+	// approach if we want to cover users with other character sets.
+	assert.Equal(t, charmap.Windows1252, GetShellAttributes().Encoding)
+}
+
+func Test_windows_shell_end_of_line(t *testing.T) {
+	assert.Equal(t, "\r\n", GetShellAttributes().EOL)
+}

src/vcs/p4/p4_command.go

@@ -29,8 +29,8 @@ import (
 	"strings"
 )
 
-func newP4Command() *cmd.ShellCommand {
-	return cmd.New("p4")
+func newP4Command(params ...string) *cmd.ShellCommand {
+	return cmd.New("p4", params...)
 }
 
 // IsP4CommandAvailable indicates if p4 command is available on local machine
@@ -82,3 +82,13 @@ func traceP4Command(params ...string) error {
 func runP4Command(params ...string) (output []byte, err error) {
 	return newP4Command().Run(params...)
 }
+
+// tracePipedP4Command calls p4 command, pipes it to pipedTo command, and reports its output traces
+func tracePipedP4Command(pipedTo *cmd.ShellCommand, params ...string) error {
+	return newP4Command().TraceAndPipe(pipedTo, params...)
+}
+
+// runPipedP4Command calls p4 command, pipes it to pipedTo command, and reports its output traces
+func runPipedP4Command(pipedTo *cmd.ShellCommand, params ...string) (output []byte, err error) {
+	return newP4Command().RunAndPipe(pipedTo, params...)
+}

src/vcs/p4/p4_command_test.go

@@ -24,55 +24,78 @@ package p4
 
 import (
 	"github.com/murex/tcr/report"
+	"github.com/murex/tcr/vcs/cmd"
 	"github.com/stretchr/testify/assert"
 	"os"
 	"strings"
 	"testing"
 )
 
-func skipOnGitHubActions(t *testing.T) {
+func skipWhenInGitHubActions(t *testing.T) {
+	t.Helper()
 	if os.Getenv("GITHUB_ACTIONS") == "true" {
 		t.Skip("skipped when on GitHub Actions (no p4 environment)")
 	}
 }
 
 func Test_is_p4_command_available(t *testing.T) {
-	skipOnGitHubActions(t)
+	skipWhenInGitHubActions(t)
 	assert.True(t, IsP4CommandAvailable())
 }
 
 func Test_get_p4_command_path(t *testing.T) {
-	skipOnGitHubActions(t)
+	skipWhenInGitHubActions(t)
 	assert.NotZero(t, GetP4CommandPath())
 }
 
 func Test_run_p4_command(t *testing.T) {
-	skipOnGitHubActions(t)
+	skipWhenInGitHubActions(t)
 	output, err := runP4Command("info")
 	assert.NoError(t, err)
 	assert.NotZero(t, output)
 }
 
 func Test_trace_p4_command(t *testing.T) {
-	skipOnGitHubActions(t)
+	skipWhenInGitHubActions(t)
 	sniffer := report.NewSniffer()
 	err := traceP4Command("info")
 	sniffer.Stop()
 	assert.NoError(t, err)
 	assert.NotZero(t, sniffer.GetMatchCount())
 }
 
+func Test_run_piped_p4_command(t *testing.T) {
+	skipWhenInGitHubActions(t)
+	output, err := runPipedP4Command(
+		cmd.New("grep", "Client name"),
+		"info")
+	assert.NoError(t, err)
+	assert.Contains(t, string(output), "Client name:")
+}
+
+func Test_trace_piped_p4_command(t *testing.T) {
+	skipWhenInGitHubActions(t)
+	sniffer := report.NewSniffer()
+	err := tracePipedP4Command(
+		cmd.New("grep", "Client name"),
+		"info")
+	sniffer.Stop()
+	assert.NoError(t, err)
+	assert.Equal(t, 1, sniffer.GetMatchCount())
+	assert.Contains(t, sniffer.GetAllMatches()[0].Text, "Client name:")
+}
+
 func Test_get_p4_username(t *testing.T) {
-	skipOnGitHubActions(t)
+	skipWhenInGitHubActions(t)
 	assert.NotZero(t, GetP4UserName())
 }
 
 func Test_get_p4_config_value_with_undefined_key(t *testing.T) {
-	skipOnGitHubActions(t)
+	skipWhenInGitHubActions(t)
 	assert.Equal(t, "not set", getP4ConfigValue("undefined-config-value"))
 }
 
 func Test_get_p4_command_version(t *testing.T) {
-	skipOnGitHubActions(t)
+	skipWhenInGitHubActions(t)
 	assert.True(t, strings.HasPrefix(GetP4CommandVersion(), "P4/"))
 }