feat: testing isolation

.github/cloud-samples-tools/.gitignore

@@ -0,0 +1,25 @@
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# env file
+.env

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

@@ -0,0 +1,89 @@
+# Cloud Samples tools
+
+This is a collection of tools used for Cloud Samples maintenance and infrastructure.
+
+## Config files
+
+For this tools, we refer to a **package** as an isolated directory, which contains a "package file".
+For example, `package.json` in Node.js, `requirements.txt` in Python, `go.mod` in Go, or `pom.xml` in Java.
+
+Each language has different configurations.
+We define them in config files in the repository, this way the tooling keeps language agnostic and each repository can have different configurations.
+
+The config file can be a `.json` file, or a `.jsonc` (JSON with comments) file.
+For `.jsonc` files, it supports both `// single line comments` and `/* multi-line comments */`.
+
+For example:
+
+```jsonc
+{
+  // The package file where the tests should be run (required).
+  "package-file": "package.json",
+
+  // Match diffs only on .js and .ts files
+  // Defaults to match all files.
+  "match": ["*.js", "*.ts"],
+
+  // Ignore diffs on the README, text files, and anything under node_modules/.
+  // Defaults to not ignore anything.
+  "ignore": ["README.md", "*.txt", "node_modules/"],
+
+  // Skip these packages, these could be handled by a different config.
+  // Defaults to not exclude anything.
+  "exclude-packages": ["path/to/slow-to-test", "special-config-package"],
+}
+```
+
+For more information, see [`pkg/utils/config.go`](pkg/utils/config.go).
+
+## Building
+
+To build the tools, 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 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.
+
+First, generate a file with all the diffs.
+This file should be one file per line.
+
+You can use `git diff` to test on files that have changed in your branch.
+You can also create the file manually if you want to test something without commiting changes to your branch.
+
+```sh
+git --no-pager diff --name-only HEAD origin/main | tee /tmp/diffs.txt
+```
+
+Now we can check which packages have been affected.
+We pass the config file and the diffs file as positional arguments.
+
+```sh
+/tmp/tools affected .github/config/nodejs.jsonc /tmp/diffs.txt
+```
+
+## Running on all packages
+
+> This must run at the repository root directory.
+
+We pass the config file and a bash script to run as positional arguments.
+The script must receive a single positional argument in `$1` as the package name.
+For example, the script should be called like `bash path/to/my-script.sh path/to/package`.
+
+```sh
+# To run all the Node.js tests.
+/tmp/tools run-all ./github/config/nodejs.jsonc ./github/scripts/nodejs-test.sh
+```

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

@@ -0,0 +1,149 @@
+/*
+ Copyright 2024 Google LLC
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+package main
+
+import (
+	"cloud-samples-tools/pkg/utils"
+	"encoding/json"
+	"fmt"
+	"log"
+	"os"
+	"strings"
+)
+
+func main() {
+	command := ""
+	if len(os.Args) > 1 {
+		command = os.Args[1]
+	} else {
+		fmt.Fprintf(os.Stderr, "❌ no command specified\n")
+		printUsage(os.Stderr)
+		os.Exit(1)
+	}
+
+	switch command {
+	case "affected":
+		configFile := ""
+		if len(os.Args) > 2 {
+			configFile = os.Args[2]
+		} else {
+			fmt.Fprintf(os.Stderr, "❌ no config file specified\n")
+			printUsage(os.Stderr)
+			os.Exit(1)
+		}
+
+		diffsFile := ""
+		if len(os.Args) > 3 {
+			diffsFile = os.Args[3]
+		} else {
+			fmt.Fprintf(os.Stderr, "❌ no diffs file specified\n")
+			printUsage(os.Stderr)
+			os.Exit(1)
+		}
+
+		affectedCmd(configFile, diffsFile)
+
+	case "run-all":
+		configFile := ""
+		if len(os.Args) > 2 {
+			configFile = os.Args[2]
+		} else {
+			fmt.Fprintf(os.Stderr, "❌ no config file specified\n")
+			printUsage(os.Stderr)
+			os.Exit(1)
+		}
+
+		script := ""
+		if len(os.Args) > 3 {
+			script = os.Args[3]
+		} else {
+			fmt.Fprintf(os.Stderr, "❌ no script file specified\n")
+			printUsage(os.Stderr)
+			os.Exit(1)
+		}
+
+		runAllCmd(configFile, script)
+
+	default:
+		fmt.Fprintf(os.Stderr, "❌ unknown command: %s\n", command)
+		printUsage(os.Stderr)
+		os.Exit(1)
+	}
+}
+
+func printUsage(f *os.File) {
+	fmt.Fprintf(f, "usage: tools <command> ...\n")
+	fmt.Fprintf(f, "\n")
+	fmt.Fprintf(f, "commands:\n")
+	fmt.Fprintf(f, "  affected path/to/config.jsonc path/to/diffs.txt\n")
+	fmt.Fprintf(f, "  run-all path/to/config.jsonc path/to/script.sh\n")
+}
+
+func affectedCmd(configFile string, diffsFile string) {
+	config, err := utils.LoadConfig(configFile)
+	if err != nil {
+		log.Fatalf("❌ error loading the config file: %v\n%v\n", configFile, err)
+	}
+
+	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 := utils.Affected(config, diffs)
+	if err != nil {
+		log.Fatalf("❌ error finding the affected packages.\n%v\n", err)
+	}
+	if len(packages) > 256 {
+		log.Fatalf(
+			"❌ Error: GitHub Actions only supports up to 256 packages, got %v packages, for more details see:\n%v\n",
+			len(packages),
+			"https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/running-variations-of-jobs-in-a-workflow",
+		)
+	}
+
+	packagesJson, err := json.Marshal(packages)
+	if err != nil {
+		log.Fatalf("❌ error marshaling packages to JSON.\n%v\n", err)
+	}
+
+	fmt.Println(string(packagesJson))
+}
+
+func runAllCmd(configFile string, script string) {
+	config, err := utils.LoadConfig(configFile)
+	if err != nil {
+		log.Fatalf("❌ error loading the config file: %v\n%v\n", configFile, err)
+	}
+
+	packages, err := utils.FindAllPackages(".", config)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "❌ error finding packages.\n%v\n", err)
+	}
+
+	maxGoroutines := 16
+	failed := utils.RunAll(packages, script, maxGoroutines)
+
+	fmt.Printf(strings.Repeat("-", 80) + "\n")
+	fmt.Printf("Total tests: %v\n", len(packages))
+	fmt.Printf("Failed tests: %v\n", failed)
+
+	if failed > 0 {
+		log.Fatalf("❌ some tests failed, exit with code 1.")
+	}
+}

.github/cloud-samples-tools/go.mod

@@ -0,0 +1,3 @@
+module cloud-samples-tools
+
+go 1.22.0

.github/cloud-samples-tools/pkg/utils/affected.go

@@ -0,0 +1,53 @@
+/*
+ Copyright 2024 Google LLC
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+package utils
+
+import (
+	"slices"
+)
+
+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) {
+			continue
+		}
+		pkg := config.FindPackage(diff)
+		if slices.Contains(config.ExcludePackages, pkg) {
+			continue
+		}
+		changedUnique[pkg] = true
+	}
+
+	if len(changedUnique) == 0 {
+		return []string{"."}
+	}
+
+	changed := make([]string, 0, len(changedUnique))
+	for pkg := range changedUnique {
+		changed = append(changed, pkg)
+	}
+	return changed
+}