add unit tests and testing instructions

Author: David Cavazos

.github/workflows/samples-tools/README.md

@@ -45,6 +45,15 @@ We can run it in a subshell using parentheses to keep our working directory from
 (cd .github/workflows/samples-tools && go build -o /tmp/tools ./cmd/*)
 ```
 
+## Running the tools unit tests
+
+To the tools tests, we must change to the directory where the tools package is defined.
+We can run it in a subshell using parentheses to keep our working directory from changing.
+
+```sh
+(cd .github/workflows/samples-tools && go test ./test)
+```
+
 ## Finding affected packages
 
 > This must run at the repository root directory.

.github/workflows/samples-tools/cmd/main.go

@@ -99,12 +99,13 @@ func affectedCmd(configFile string, diffsFile string) {
 		log.Fatalf("❌ error loading the config file: %v\n%v\n", configFile, err)
 	}
 
-	diffs, err := readDiffs(diffsFile)
+	diffsBytes, err := os.ReadFile(diffsFile)
 	if err != nil {
 		log.Fatalf("❌ error getting the diffs: %v\n%v\n", diffsFile, err)
 	}
+	diffs := strings.Split(string(diffsBytes), "\n")
 
-	packages, err := affected(config, diffs)
+	packages, err := utils.Affected(config, diffs)
 	if err != nil {
 		log.Fatalf("❌ error finding the affected packages.\n%v\n", err)
 	}
@@ -136,7 +137,7 @@ func runAllCmd(configFile string, script string) {
 	}
 
 	maxGoroutines := 16
-	failed := runAll(packages, script, maxGoroutines)
+	failed := utils.RunAll(packages, script, maxGoroutines)
 
 	fmt.Printf(strings.Repeat("-", 80) + "\n")
 	fmt.Printf("Total tests: %v\n", len(packages))

…/workflows/samples-tools/cmd/affected.go …lows/samples-tools/pkg/utils/affected.go.github/workflows/samples-tools/cmd/affected.go renamed to .github/workflows/samples-tools/pkg/utils/affected.go .github/workflows/samples-tools/cmd/affected.go renamed to .github/workflows/samples-tools/pkg/utils/affected.go

@@ -14,17 +14,21 @@
  limitations under the License.
 */
 
-package main
+package utils
 
 import (
-	"os"
 	"slices"
-	"strings"
-
-	"samples-tools/pkg/utils"
 )
 
-func affected(config utils.Config, diffs []string) ([]string, error) {
+func Affected(config Config, diffs []string) ([]string, error) {
+	changed := Changed(config, diffs)
+	if slices.Contains(changed, ".") {
+		return FindAllPackages(".", config)
+	}
+	return changed, nil
+}
+
+func Changed(config Config, diffs []string) []string {
 	changedUnique := make(map[string]bool)
 	for _, diff := range diffs {
 		if !config.Matches(diff) {
@@ -37,21 +41,13 @@ func affected(config utils.Config, diffs []string) ([]string, error) {
 		changedUnique[pkg] = true
 	}
 
+	if len(changedUnique) == 0 {
+		return []string{"."}
+	}
+
 	changed := make([]string, 0, len(changedUnique))
 	for pkg := range changedUnique {
 		changed = append(changed, pkg)
 	}
-
-	if slices.Contains(changed, ".") {
-		return utils.FindAllPackages(".", config)
-	}
-	return changed, nil
-}
-
-func readDiffs(path string) ([]string, error) {
-	bytes, err := os.ReadFile(path)
-	if err != nil {
-		return []string{}, err
-	}
-	return strings.Split(string(bytes), "\n"), nil
+	return changed
 }

.github/workflows/samples-tools/pkg/utils/config.go

@@ -39,35 +39,47 @@ type Config struct {
 	ExcludePackages []string `json:"exclude-packages"`
 }
 
-var multiLineCommentsRegex = regexp.MustCompile(`(?s)\s*/\*.*?\*/\s*`)
+var multiLineCommentsRegex = regexp.MustCompile(`(?s)\s*/\*.*?\*/`)
 var singleLineCommentsRegex = regexp.MustCompile(`\s*//.*\s*`)
 
-// LoadConfig loads the config from the given path.
-func LoadConfig(path string) (Config, error) {
-	bytes, err := os.ReadFile(path)
+// SaveConfig saves the config to the given file.
+func SaveConfig(config Config, file *os.File) error {
+	bytes, err := json.MarshalIndent(config, "", "  ")
 	if err != nil {
-		return Config{}, err
+		return err
 	}
-	config, err := parseConfig(bytes)
+	_, err = file.Write(bytes)
 	if err != nil {
-		return Config{}, err
+		return err
 	}
-	return config, nil
+	return nil
 }
 
-// parseConfig parses the config from the given source.
-func parseConfig(source []byte) (Config, error) {
-	var config Config
-	err := json.Unmarshal(StripComments(source), &config)
+// LoadConfig loads the config from the given path.
+func LoadConfig(path string) (Config, error) {
+	config := Config{}
+
+	// Read the JSONC file.
+	sourceJsonc, err := os.ReadFile(path)
 	if err != nil {
-		return Config{}, err
+		return config, err
 	}
+
+	// Strip the comments and load the JSON.
+	sourceJson := StripComments(sourceJsonc)
+	err = json.Unmarshal(sourceJson, &config)
+	if err != nil {
+		return config, err
+	}
+
+	// Set default values if they are not set.
 	if config.PackageFile == nil {
 		return config, errors.New("package-file is required")
 	}
 	if config.Match == nil {
 		config.Match = []string{"*"}
 	}
+
 	return config, nil
 }
 
@@ -77,8 +89,8 @@ func StripComments(src []byte) []byte {
 	return singleLineCommentsRegex.ReplaceAll(src, []byte{})
 }
 
-// match returns true if the path matches any of the patterns.
-func match(patterns []string, path string) bool {
+// Match returns true if the path matches any of the patterns.
+func Match(patterns []string, path string) bool {
 	filename := filepath.Base(path)
 	for _, pattern := range patterns {
 		if match, _ := filepath.Match(pattern, filename); match {
@@ -93,7 +105,7 @@ func match(patterns []string, path string) bool {
 
 // Matches returns true if the path matches the config.
 func (c Config) Matches(path string) bool {
-	return match(c.Match, path) && !match(c.Ignore, path)
+	return Match(c.Match, path) && !Match(c.Ignore, path)
 }
 
 // IsPackageDir returns true if the path is a package directory.

…ub/workflows/samples-tools/cmd/runAll.go …kflows/samples-tools/pkg/utils/runAll.go.github/workflows/samples-tools/cmd/runAll.go renamed to .github/workflows/samples-tools/pkg/utils/runAll.go .github/workflows/samples-tools/cmd/runAll.go renamed to .github/workflows/samples-tools/pkg/utils/runAll.go

@@ -14,7 +14,7 @@
  limitations under the License.
 */
 
-package main
+package utils
 
 import (
 	"fmt"
@@ -24,8 +24,8 @@ import (
 	"sync/atomic"
 )
 
-// runAll runs all the commands in parallel.
-func runAll(packages []string, script string, maxGoroutines int) int64 {
+// RunAll runs all the commands in parallel.
+func RunAll(packages []string, script string, maxGoroutines int) int64 {
 	var failures int64
 	guard := make(chan struct{}, maxGoroutines)
 	for _, pkg := range packages {

.github/workflows/samples-tools/test/affected_test.go

@@ -0,0 +1,43 @@
+package test
+
+import (
+	"path/filepath"
+	"samples-tools/pkg/utils"
+	"testing"
+)
+
+func TestChangedRoot(t *testing.T) {
+	config := utils.Config{PackageFile: []string{"package.json"}}
+	diffs := []string{
+		filepath.Join("testdata", "file.txt"),
+	}
+	got := utils.Changed(config, diffs)
+	expected := []string{"."}
+	equals(t, expected, got)
+}
+
+func TestChangedPackage(t *testing.T) {
+	config := utils.Config{
+		PackageFile: []string{"package.json"},
+		Match:       []string{"*"},
+	}
+	diffs := []string{
+		filepath.Join("testdata", "my-package", "file.txt"),
+	}
+	got := utils.Changed(config, diffs)
+	expected := []string{"testdata/my-package"}
+	equals(t, expected, got)
+}
+
+func TestChangedSubpackage(t *testing.T) {
+	config := utils.Config{
+		PackageFile: []string{"package.json"},
+		Match:       []string{"*"},
+	}
+	diffs := []string{
+		filepath.Join("testdata", "my-package", "subpackage", "file.txt"),
+	}
+	got := utils.Changed(config, diffs)
+	expected := []string{"testdata/my-package/subpackage"}
+	equals(t, expected, got)
+}

.github/workflows/samples-tools/test/config_test.go

@@ -0,0 +1,98 @@
+package test
+
+import (
+	"os"
+	"path/filepath"
+	"samples-tools/pkg/utils"
+	"testing"
+)
+
+func TestLoadConfigEmpty(t *testing.T) {
+	path := filepath.Join("testdata", "config", "empty.json")
+	_, err := utils.LoadConfig(path)
+	expectError(t, err)
+}
+
+func TestLoadConfigDefaultValues(t *testing.T) {
+	path := filepath.Join("testdata", "config", "default-values.json")
+	config, err := utils.LoadConfig(path)
+	ok(t, err)
+	expected := utils.Config{
+		PackageFile: []string{"package.json"},
+		Match:       []string{"*"},
+	}
+	equals(t, expected, config)
+}
+
+func TestLoadConfigComments(t *testing.T) {
+	path := filepath.Join("testdata", "config", "comments.jsonc")
+	config, err := utils.LoadConfig(path)
+	ok(t, err)
+	expected := utils.Config{
+		PackageFile: []string{"package.json"},
+		Match:       []string{"*"},
+	}
+	equals(t, expected, config)
+}
+
+func TestSaveLoadConfig(t *testing.T) {
+	file, err := os.CreateTemp("", "config-*.json")
+	ok(t, err)
+	defer os.Remove(file.Name())
+
+	config := utils.Config{
+		PackageFile:     []string{"package.json"},
+		Ignore:          []string{"node_modules/", "*.md"},
+		Match:           []string{"*.js"},
+		ExcludePackages: []string{"excluded"},
+	}
+	err = utils.SaveConfig(config, file)
+	ok(t, err)
+
+	loadedConfig, err := utils.LoadConfig(file.Name())
+	ok(t, err)
+
+	equals(t, config, loadedConfig)
+}
+
+func TestMatchNoPatterns(t *testing.T) {
+	patterns := []string{}
+	path := "path/to/file.js"
+	assert(t, !utils.Match(patterns, path), "match(%v, %v) = false")
+}
+
+func TestMatchFilePattern(t *testing.T) {
+	patterns := []string{"*.js"}
+	path := "path/to/file.js"
+	assert(t, utils.Match(patterns, path), "match(%v, %v) = true")
+}
+
+func TestMatchFilePath(t *testing.T) {
+	patterns := []string{"path/to/"}
+	path := "path/to/file.js"
+	assert(t, utils.Match(patterns, path), "match(%v, %v) = true")
+}
+
+func TestIsPackageDirNotExists(t *testing.T) {
+	config := utils.Config{PackageFile: []string{"package.json"}}
+	dir := "path-does-not-exist"
+	assert(t, !config.IsPackageDir(dir), "config.IsPackageDir(%v) = false")
+}
+
+func TestIsPackageDirExists(t *testing.T) {
+	config := utils.Config{PackageFile: []string{"package.json"}}
+	dir := filepath.Join("testdata", "my-package")
+	assert(t, config.IsPackageDir(dir), "config.IsPackageDir(%v) = true")
+}
+
+func TestFindPackageRoot(t *testing.T) {
+	config := utils.Config{PackageFile: []string{"package.json"}}
+	path := filepath.Join("testdata", "my-file.txt")
+	equals(t, ".", config.FindPackage(path))
+}
+
+func TestFindPackageSubpackage(t *testing.T) {
+	config := utils.Config{PackageFile: []string{"package.json"}}
+	path := filepath.Join("testdata", "my-package", "subpackage", "my-file.txt")
+	equals(t, "testdata/my-package/subpackage", config.FindPackage(path))
+}

.github/workflows/samples-tools/test/testdata/config/comments.jsonc

@@ -0,0 +1,8 @@
+/*
+ * Multi-line
+ * comment
+ */
+{
+  // Single line comment.
+  "package-file": /* inline comment */ ["package.json"]
+}

.github/workflows/samples-tools/test/testdata/config/default-values.json

@@ -0,0 +1,3 @@
+{
+  "package-file": ["package.json"]
+}

.github/workflows/samples-tools/test/testdata/config/empty.json

@@ -0,0 +1 @@
+{}