GoogleCloudPlatform
diff --git a/‎.github/cloud-samples-tools/.gitignore‎
Lines changed: 25 additions & 0 deletions b/‎.github/cloud-samples-tools/.gitignore‎
Lines changed: 25 additions & 0 deletions
diff --git a/‎.github/cloud-samples-tools/README.md‎
Lines changed: 80 additions & 0 deletions b/‎.github/cloud-samples-tools/README.md‎
Lines changed: 80 additions & 0 deletions
diff --git a/‎.github/cloud-samples-tools/cmd/main.go‎
Lines changed: 96 additions & 0 deletions b/‎.github/cloud-samples-tools/cmd/main.go‎
Lines changed: 96 additions & 0 deletions
diff --git a/‎.github/cloud-samples-tools/go.mod‎
Lines changed: 3 additions & 0 deletions b/‎.github/cloud-samples-tools/go.mod‎
Lines changed: 3 additions & 0 deletions
diff --git a/‎.github/cloud-samples-tools/pkg/config/config.go‎
Lines changed: 190 additions & 0 deletions b/‎.github/cloud-samples-tools/pkg/config/config.go‎
Lines changed: 190 additions & 0 deletions
@@ -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
@@ -0,0 +1,80 @@
+# Cloud Samples tools
+
+This is a collection of tools used for Cloud Samples maintenance and infrastructure.
+
+This tool has one function:
+
+- `affected` finds the affected packages given a list of diffs.
+
+## 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 ./...)
+```
+
+## 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
+```
@@ -0,0 +1,96 @@
+/*
+ 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 (
+	c "cloud-samples-tools/pkg/config"
+	"encoding/json"
+	"flag"
+	"fmt"
+	"log"
+	"os"
+	"strings"
+)
+
+var usage = `usage: tools <command> ...
+
+commands:
+  affected path/to/config.jsonc path/to/diffs.txt
+  run-all path/to/config.jsonc path/to/script.sh
+`
+
+// Entry point to validate command line arguments.
+func main() {
+	flag.Parse()
+
+	command := flag.Arg(0)
+	if command == "" {
+		log.Fatalln("❌ no command specified\n", usage)
+	}
+
+	switch command {
+	case "affected":
+		configFile := flag.Arg(1)
+		if configFile == "" {
+			log.Fatalln("❌ no config file specified\n", usage)
+		}
+
+		diffsFile := flag.Arg(2)
+		if diffsFile == "" {
+			log.Fatalln("❌ no diffs file specified\n", usage)
+		}
+
+		affectedCmd(configFile, diffsFile)
+
+	default:
+		log.Fatalln("❌ unknown command: ", command, "\n", usage)
+	}
+}
+
+// affected command entry point to validate inputs.
+func affectedCmd(configFile string, diffsFile string) {
+	config, err := c.LoadConfig(configFile)
+	if err != nil {
+		log.Fatalln("❌ error loading the config file: ", configFile, "\n", err)
+	}
+
+	diffsBytes, err := os.ReadFile(diffsFile)
+	if err != nil {
+		log.Fatalln("❌ error getting the diffs: ", diffsFile, "\n", err)
+	}
+	diffs := strings.Split(string(diffsBytes), "\n")
+
+	packages, err := config.Affected(diffs)
+	if err != nil {
+		log.Fatalln("❌ error finding the affected packages.\n", err)
+	}
+	if len(packages) > 256 {
+		log.Fatalln(
+			"❌ Error: GitHub Actions only supports up to 256 packages, got ",
+			len(packages),
+			" packages, for more details see:\n",
+			"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.Fatalln("❌ error marshaling packages to JSON.\n", err)
+	}
+
+	fmt.Println(string(packagesJson))
+}
@@ -0,0 +1,3 @@
+module cloud-samples-tools
+
+go 1.22.0
@@ -0,0 +1,190 @@
+/*
+ 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 config
+
+import (
+	"encoding/json"
+	"errors"
+	"io/fs"
+	"os"
+	"path/filepath"
+	"regexp"
+	"slices"
+	"strings"
+)
+
+type Config struct {
+	// Filename to look for the root of a package.
+	PackageFile []string `json:"package-file"`
+
+	// Pattern to match filenames or directories.
+	Match []string `json:"match"`
+
+	// Pattern to ignore filenames or directories.
+	Ignore []string `json:"ignore"`
+
+	// Packages to always exclude.
+	ExcludePackages []string `json:"exclude-packages"`
+}
+
+var multiLineCommentsRegex = regexp.MustCompile(`(?s)\s*/\*.*?\*/`)
+var singleLineCommentsRegex = regexp.MustCompile(`\s*//.*\s*`)
+
+// Saves the config to the given file.
+func (c *Config) Save(file *os.File) error {
+	bytes, err := json.MarshalIndent(c, "", "  ")
+	if err != nil {
+		return err
+	}
+	_, err = file.Write(bytes)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+// LoadConfig loads the config from the given path.
+func LoadConfig(path string) (*Config, error) {
+	// Read the JSONC file.
+	sourceJsonc, err := os.ReadFile(path)
+	if err != nil {
+		return nil, err
+	}
+
+	// Strip the comments and load the JSON.
+	sourceJson := multiLineCommentsRegex.ReplaceAll(sourceJsonc, []byte{})
+	sourceJson = singleLineCommentsRegex.ReplaceAll(sourceJson, []byte{})
+
+	var config Config
+	err = json.Unmarshal(sourceJson, &config)
+	if err != nil {
+		return nil, err
+	}
+
+	// Set default values if they are not set.
+	if config.PackageFile == nil {
+		return nil, errors.New("package-file is required")
+	}
+	if config.Match == nil {
+		config.Match = []string{"*"}
+	}
+
+	return &config, nil
+}
+
+// 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 {
+			return true
+		}
+		if strings.Contains(path, pattern) {
+			return true
+		}
+	}
+	return false
+}
+
+// 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)
+}
+
+// IsPackageDir returns true if the path is a package directory.
+func (c *Config) IsPackageDir(dir string) bool {
+	for _, filename := range c.PackageFile {
+		packageFile := filepath.Join(dir, filename)
+		if fileExists(packageFile) {
+			return true
+		}
+	}
+	return false
+}
+
+// FindPackage returns the package name for the given path.
+func (c *Config) FindPackage(path string) string {
+	dir := filepath.Dir(path)
+	if dir == "." || c.IsPackageDir(dir) {
+		return dir
+	}
+	return c.FindPackage(dir)
+}
+
+// FindAllPackages finds all the packages in the given root directory.
+func (c *Config) FindAllPackages(root string) ([]string, error) {
+	var packages []string
+	err := fs.WalkDir(os.DirFS(root), ".",
+		func(path string, d os.DirEntry, err error) error {
+			if err != nil {
+				return err
+			}
+			if path == "." {
+				return nil
+			}
+			if slices.Contains(c.ExcludePackages, path) {
+				return nil
+			}
+			if d.IsDir() && c.Matches(path) && c.IsPackageDir(path) {
+				packages = append(packages, path)
+				return nil
+			}
+			return nil
+		})
+	if err != nil {
+		return []string{}, err
+	}
+	return packages, nil
+}
+
+// Affected returns the packages that have been affected from diffs.
+// If there are diffs on at leat one global file affecting all packages,
+// then this returns all packages matched by the config.
+func (c *Config) Affected(diffs []string) ([]string, error) {
+	changed := c.Changed(diffs)
+	if slices.Contains(changed, ".") {
+		return c.FindAllPackages(".")
+	}
+	return changed, nil
+}
+
+// Changed returns the packages that have changed.
+// It only returns packages that are matched by the config,
+// and are not excluded by the config.
+func (c *Config) Changed(diffs []string) []string {
+	changedUnique := make(map[string]bool)
+	for _, diff := range diffs {
+		if !c.Matches(diff) {
+			continue
+		}
+		pkg := c.FindPackage(diff)
+		if slices.Contains(c.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
+}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module cloud-samples-tools`
	`2`	`+`
	`3`	`+go 1.22.0`