mirror of
https://github.com/google/adk-docs.git
synced 2026-09-14 16:16:59 +08:00
Ivan Cheung
4f74c1c091
* Added pr checks and regression test code * Added github workflows and go.mod/go.sum * Added comments to files_to_test.txt * Moved check_go_snippets.sh * Fixed issues with workflows * Removed unneeded workflow * Revert bad change * Added runner tests * Added README * refactor(go-snippets): Unify Go module structure and dynamically update ADK dependency Consolidate all Go snippet module dependencies to a single file located at . This simplifies dependency management and ensures consistent versions across all Go examples. Update Usage: tools/go-snippets/runner.sh <build|run> [file1 file2 ...] to dynamically fetch the latest module () before running any builds or tests. This ensures that PR and regression checks always validate against the most recent ADK release, preventing outdated dependency issues. Address breaking changes in by removing the initialization from , which is no longer available. Cleaned up extraneous and files from subdirectories within , as well as the unused file. * feat(go-snippets): Reinforce strict `files_to_test.txt` adherence Reverts previous attempts to infer Go snippet dependencies and clarifies the strict testing model. - **`runner.sh`**: Restores `find_snippet_line` to rely on exact substring matching of changed files within `files_to_test.txt` lines. Adds `go get` exit code check. - **`tools/go-snippets/README.md`**: Adds "Understanding the Test Runner" section detailing `files_to_test.txt` adherence, multi-file `package main` requirements, and `_test.go` file handling. - **`runner_test.sh`**: Adds `test_find_snippet_line_multi_file_match` to verify correct behavior for multi-file snippets listed on a single line. --------- Co-authored-by: ivanmkc <ivanmkc@google.com>
61 lines
2.4 KiB
Bash
Executable File
61 lines
2.4 KiB
Bash
Executable File
#!/bin/bash
|
|
# Copyright 2025 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
|
|
#
|
|
# http://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.
|
|
|
|
# This script ensures that every .go file within the Go snippets directory
|
|
# is referenced in the files_to_test.txt file. This prevents new snippets
|
|
# from being added without being included in the regression test suite.
|
|
|
|
# --- Configuration ---
|
|
RED='\033[0;31m'
|
|
NC='\033[0m' # No Color
|
|
EXIT_CODE=0
|
|
SNIPPETS_FILE="tools/go-snippets/files_to_test.txt"
|
|
|
|
# --- Logic ---
|
|
echo "Checking for Go files that are not registered in ${SNIPPETS_FILE}..."
|
|
|
|
# Find all .go files in the snippets directory, excluding _test.go files.
|
|
all_go_files=$(find examples/go -type f -name "*.go" ! -name "*_test.go" | sed 's|examples/go/||' | sort)
|
|
|
|
# Extract all .go file paths from the snippets file, ignoring comments and arguments.
|
|
referenced_files=$(grep -v '^\s*#' "${SNIPPETS_FILE}" | grep -o '[a-zA-Z0-9/._-]*\.go' | sort | uniq)
|
|
|
|
# Compare the list of all .go files with the list of referenced files.
|
|
unreferenced_files=$(comm -23 <(echo "${all_go_files}") <(echo "${referenced_files}"))
|
|
|
|
if [[ -n "${unreferenced_files}" ]]; then
|
|
echo -e "${RED}Error: The following Go files were found but are not referenced in ${SNIPPETS_FILE}:${NC}"
|
|
# Indent the list of files for readability.
|
|
echo "${unreferenced_files}" | sed 's/^/ /'
|
|
echo
|
|
echo "Please add them to ${SNIPPETS_FILE} to include them in the regression tests."
|
|
EXIT_CODE=1
|
|
else
|
|
echo "All Go files are correctly referenced in the snippets file."
|
|
fi
|
|
|
|
# Check for files in the list that don't exist on disk
|
|
dangling_references=$(comm -23 <(echo "${referenced_files}") <(echo "${all_go_files}"))
|
|
|
|
if [[ -n "${dangling_references}" ]]; then
|
|
echo -e "${RED}Error: The following files are referenced in ${SNIPPETS_FILE} but do not exist:${NC}"
|
|
echo "${dangling_references}" | sed 's/^/ /'
|
|
echo
|
|
echo "Please remove them from ${SNIPPETS_FILE}."
|
|
EXIT_CODE=1
|
|
fi
|
|
|
|
exit ${EXIT_CODE}
|