Updated go test script and refactored collection package. (#781)

**Added:**

- `run-go-tests.sh`: Added check and cleanup for `go.mod` and `go.sum` before running tests.
- `Cmd` struct in `sysutils.go`: Added a mutex for thread-safe output handling.

**Changed:**

- Renamed package `slices` to `collection` for better clarity.
- Updated import paths in `slices_test.go` to reflect the new package name.
- Refactored `sysutils_test.go` to use pointer for `Cmd` struct.
- Cleaned up dependencies in `go.mod` and `go.sum` by removing unused ones.

**Removed:**

- Unused dependencies from `go.mod` and `go.sum` files.

.hooks/run-go-tests.sh

@@ -27,6 +27,21 @@ run_tests() {
     echo "tail -f ${LOGFILE}" | tee -a "$LOGFILE"
     echo "Running tests..." | tee -a "$LOGFILE"
 
+    # Check if go.mod and go.sum exist
+    if [[ -f "go.mod" && -f "go.sum" ]]; then
+        # Check if `go mod tidy` is necessary
+        MOD_TMP=$(mktemp)
+        SUM_TMP=$(mktemp)
+        cp go.mod "$MOD_TMP"
+        cp go.sum "$SUM_TMP"
+        go mod tidy
+        if ! cmp -s go.mod "$MOD_TMP" || ! cmp -s go.sum "$SUM_TMP"; then
+            echo "Running 'go mod tidy' to clean up module dependencies..." | tee -a "$LOGFILE"
+            go mod tidy 2>&1 | tee -a "$LOGFILE"
+        fi
+        rm "$MOD_TMP" "$SUM_TMP"
+    fi
+
     if [[ "${TESTS_TO_RUN}" == 'coverage' ]]; then
         go test -v -race -failfast -tags=integration -coverprofile="${coverage_file}" ./... 2>&1 | tee -a "$LOGFILE"
     elif [[ "${TESTS_TO_RUN}" == 'all' ]]; then

collection/README.md

@@ -1,7 +1,7 @@
-# goutils/v2/slices
+# goutils/v2/collection
 
-The `slices` package is a collection of utility functions
-designed to simplify common slices tasks.
+The `collection` package is a collection of utility functions
+designed to simplify common collection tasks.
 
 ---
 
@@ -39,11 +39,11 @@ bool: true if the value is present in the slice, false otherwise.
 
 ## Installation
 
-To use the goutils/v2/slices package, you first need to install it.
+To use the goutils/v2/collection package, you first need to install it.
 Follow the steps below to install via go get.
 
 ```bash
-go get github.com/l50/goutils/v2/slices
+go get github.com/l50/goutils/v2/collection
 ```
 
 ---
@@ -54,15 +54,15 @@ After installation, you can import the package in your Go project
 using the following import statement:
 
 ```go
-import "github.com/l50/goutils/v2/slices"
+import "github.com/l50/goutils/v2/collection"
 ```
 
 ---
 
 ## Tests
 
 To ensure the package is working correctly, run the following
-command to execute the tests for `goutils/v2/slices`:
+command to execute the tests for `goutils/v2/collection`:
 
 ```bash
 go test -v

collection/slices.go

@@ -1,4 +1,4 @@
-package slices
+package collection
 
 // Contains checks if a value is present in a slice.
 //

collection/slices_test.go

@@ -1,8 +1,9 @@
-package slices_test
+package collection_test
 
 import (
-	"slices"
 	"testing"
+
+	"github.com/l50/goutils/v2/collection"
 )
 
 func TestContains(t *testing.T) {
@@ -46,7 +47,7 @@ func TestContains(t *testing.T) {
 
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
-			got := slices.Contains(tc.slice, tc.value)
+			got := collection.Contains(tc.slice, tc.value)
 			if got != tc.want {
 				t.Errorf("Contains(%v, %v) = %v; want %v", tc.slice,
 					tc.value, got, tc.want)

go.mod

@@ -29,7 +29,6 @@ require (
 require (
 	github.com/AdaLogics/go-fuzz-headers v0.0.0-20230811130428-ced1acdcaa24 // indirect
 	github.com/MakeNowJust/heredoc v1.0.0 // indirect
-	github.com/MakeNowJust/heredoc/v2 v2.0.1 // indirect
 	github.com/Masterminds/goutils v1.1.1 // indirect
 	github.com/Masterminds/semver/v3 v3.2.1 // indirect
 	github.com/Masterminds/sprig/v3 v3.2.3 // indirect
@@ -77,7 +76,6 @@ require (
 	github.com/xlab/treeprint v1.2.0 // indirect
 	go.starlark.net v0.0.0-20240411212711-9b43f0afd521 // indirect
 	gopkg.in/evanphx/json-patch.v4 v4.12.0 // indirect
-	gopkg.in/evanphx/json-patch.v5 v5.9.0 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 	gotest.tools/v3 v3.5.1 // indirect

sys/sysutils.go

@@ -13,6 +13,7 @@ import (
 	"path/filepath"
 	"runtime"
 	"strings"
+	"sync"
 	"syscall"
 	"time"
 
@@ -45,6 +46,7 @@ type Cmd struct {
 	Dir           string
 	Timeout       time.Duration
 	OutputHandler func(string)
+	mu            sync.Mutex
 }
 
 // Signal represents a signal that can be sent to a process.
@@ -579,7 +581,9 @@ func (c *Cmd) handleOutput(reader io.Reader, outputBuf *bytes.Buffer) {
 	scanner := bufio.NewScanner(reader)
 	for scanner.Scan() {
 		line := scanner.Text()
+		c.mu.Lock()
 		c.OutputHandler(line)
 		outputBuf.WriteString(line + "\n")
+		c.mu.Unlock()
 	}
 }

sys/sysutils_test.go

@@ -944,13 +944,13 @@ func TestRunCmd(t *testing.T) {
 
 	testCases := []struct {
 		name           string
-		cmd            sys.Cmd
+		cmd            *sys.Cmd
 		expectedOutput string
 		expectError    bool
 	}{
 		{
 			name: "Successful Command Execution with Default Output Handler",
-			cmd: sys.Cmd{
+			cmd: &sys.Cmd{
 				CmdString:     "echo",
 				Args:          []string{"hello"},
 				Timeout:       0,
@@ -961,7 +961,7 @@ func TestRunCmd(t *testing.T) {
 		},
 		{
 			name: "Successful Command Execution with Log Output Handler",
-			cmd: sys.Cmd{
+			cmd: &sys.Cmd{
 				CmdString:     "echo",
 				Args:          []string{"hello"},
 				Timeout:       0,
@@ -972,7 +972,7 @@ func TestRunCmd(t *testing.T) {
 		},
 		{
 			name: "Invalid Command",
-			cmd: sys.Cmd{
+			cmd: &sys.Cmd{
 				CmdString:     "invalidcommand",
 				Args:          []string{},
 				Timeout:       0,
@@ -983,7 +983,7 @@ func TestRunCmd(t *testing.T) {
 		},
 		{
 			name: "Command with Timeout",
-			cmd: sys.Cmd{
+			cmd: &sys.Cmd{
 				CmdString:     "sleep",
 				Args:          []string{"1"},
 				Timeout:       500 * time.Millisecond,
@@ -998,7 +998,7 @@ func TestRunCmd(t *testing.T) {
 		t.Run(tc.name, func(t *testing.T) {
 			loggedOutput = ""
 			output, err := tc.cmd.RunCmd()
-			if (err != nil) != (tc.expectError) {
+			if (err != nil) != tc.expectError {
 				t.Errorf("Test '%s' failed: expected error: %v, got: %v",
 					tc.name, tc.expectError, err)
 			}