mirror of
https://github.com/ivuorinen/actions.git
synced 2026-01-26 11:34:00 +00:00
* feat: fixes, tweaks, new actions, linting * fix: improve docker publish loops and dotnet parsing (#193) * fix: harden action scripts and version checks (#191) * refactor: major repository restructuring and security enhancements Add comprehensive development infrastructure: - Add Makefile with automated documentation generation, formatting, and linting tasks - Add TODO.md tracking self-containment progress and repository improvements - Add .nvmrc for consistent Node.js version management - Create python-version-detect-v2 action for enhanced Python detection Enhance all GitHub Actions with standardized patterns: - Add consistent token handling across 27 actions using standardized input patterns - Implement bash error handling (set -euo pipefail) in all shell steps - Add comprehensive input validation for path traversal and command injection protection - Standardize checkout token authentication to prevent rate limiting - Remove relative action dependencies to ensure external usability Rewrite security workflow for PR-focused analysis: - Transform security-suite.yml to PR-only security analysis workflow - Remove scheduled runs, repository issue management, and Slack notifications - Implement smart comment generation showing only sections with content - Add GitHub Actions permission diff analysis and new action detection - Integrate OWASP, Semgrep, and TruffleHog for comprehensive PR security scanning Improve version detection and dependency management: - Simplify version detection actions to use inline logic instead of shared utilities - Fix Makefile version detection fallback to properly return 'main' when version not found - Update all external action references to use SHA-pinned versions - Remove deprecated run.sh in favor of Makefile automation Update documentation and project standards: - Enhance CLAUDE.md with self-containment requirements and linting standards - Update README.md with improved action descriptions and usage examples - Standardize code formatting with updated .editorconfig and .prettierrc.yml - Improve GitHub templates for issues and security reporting This refactoring ensures all 40 actions are fully self-contained and can be used independently when referenced as ivuorinen/actions/action-name@main, addressing the critical requirement for external usability while maintaining comprehensive security analysis and development automation. * feat: add automated action catalog generation system - Create generate_listing.cjs script for comprehensive action catalog - Add package.json with development tooling and npm scripts - Implement automated README.md catalog section with --update flag - Generate markdown reference-style links for all 40 actions - Add categorized tables with features, language support matrices - Replace static reference links with auto-generated dynamic links - Enable complete automation of action documentation maintenance * feat: enhance actions with improved documentation and functionality - Add comprehensive README files for 12 actions with usage examples - Implement new utility actions (go-version-detect, dotnet-version-detect) - Enhance node-setup with extensive configuration options - Improve error handling and validation across all actions - Update package.json scripts for better development workflow - Expand TODO.md with detailed roadmap and improvement plans - Standardize action structure with consistent inputs/outputs * feat: add comprehensive output handling across all actions - Add standardized outputs to 15 actions that previously had none - Implement consistent snake_case naming convention for all outputs - Add build status and test results outputs to build actions - Add files changed and status outputs to lint/fix actions - Add test execution metrics to php-tests action - Add stale/closed counts to stale action - Add release URLs and IDs to github-release action - Update documentation with output specifications - Mark comprehensive output handling task as complete in TODO.md * feat: implement shared cache strategy across all actions - Add caching to 10 actions that previously had none (Node.js, .NET, Python, Go) - Standardize 4 existing actions to use common-cache instead of direct actions/cache - Implement consistent cache-hit optimization to skip installations when cache available - Add language-specific cache configurations with appropriate key files - Create unified caching approach using ivuorinen/actions/common-cache@main - Fix YAML syntax error in php-composer action paths parameter - Update TODO.md to mark shared cache strategy as complete * feat: implement comprehensive retry logic for network operations - Create new common-retry action for standardized retry patterns with configurable strategies - Add retry logic to 9 actions missing network retry capabilities - Implement exponential backoff, custom timeouts, and flexible error handling - Add max-retries input parameter to all network-dependent actions (Node.js, .NET, Python, Go) - Standardize existing retry implementations to use common-retry utility - Update action catalog to include new common-retry action (41 total actions) - Update documentation with retry configuration examples and parameters - Mark retry logic implementation as complete in TODO.md roadmap * feat: enhance Node.js support with Corepack and Bun - Add Corepack support for automatic package manager version management - Add Bun package manager support across all Node.js actions - Improve Yarn Berry/PnP support with .yarnrc.yml detection - Add Node.js feature detection (ESM, TypeScript, frameworks) - Update package manager detection priority and lockfile support - Enhance caching with package-manager-specific keys - Update eslint, prettier, and biome actions for multi-package-manager support * fix: resolve critical runtime issues across multiple actions - Fix token validation by removing ineffective literal string comparisons - Add missing @microsoft/eslint-formatter-sarif dependency for SARIF output - Fix Bash variable syntax errors in username and changelog length checks - Update Dockerfile version regex to handle tags with suffixes (e.g., -alpine) - Simplify version selection logic with single grep command - Fix command execution in retry action with proper bash -c wrapper - Correct step output references using .outcome instead of .outputs.outcome - Add missing step IDs for version detection actions - Include go.mod in cache key files for accurate invalidation - Require minor version in all version regex patterns - Improve Bun installation security by verifying script before execution - Replace bc with sort -V for portable PHP version comparison - Remove non-existent pre-commit output references These fixes ensure proper runtime behavior, improved security, and better cross-platform compatibility across all affected actions. * fix: resolve critical runtime and security issues across actions - Fix biome-fix files_changed calculation using git diff instead of git status delta - Fix compress-images output description and add absolute path validation - Remove csharp-publish token default and fix token fallback in push commands - Add @microsoft/eslint-formatter-sarif to all package managers in eslint-check - Fix eslint-check command syntax by using variable assignment - Improve node-setup Bun installation security and remove invalid frozen-lockfile flag - Fix pre-commit token validation by removing ineffective literal comparison - Fix prettier-fix token comparison and expand regex for all GitHub token types - Add version-file-parser regex validation safety and fix csproj wildcard handling These fixes address security vulnerabilities, runtime errors, and functional issues to ensure reliable operation across all affected GitHub Actions. * feat: enhance Docker actions with advanced multi-architecture support Major enhancement to Docker build and publish actions with comprehensive multi-architecture capabilities and enterprise-grade features. Added features: - Advanced buildx configuration (version control, cache modes, build contexts) - Auto-detect platforms for dynamic architecture discovery - Performance optimizations with enhanced caching strategies - Security scanning with Trivy and image signing with Cosign - SBOM generation in multiple formats with validation - Verbose logging and dry-run modes for debugging - Platform-specific build args and fallback mechanisms Enhanced all Docker actions: - docker-build: Core buildx features and multi-arch support - docker-publish-gh: GitHub Packages with security features - docker-publish-hub: Docker Hub with scanning and signing - docker-publish: Orchestrator with unified configuration Updated documentation across all modified actions. * fix: resolve documentation generation placeholder issue Fixed Makefile and package.json to properly replace placeholder tokens in generated documentation, ensuring all README files show correct repository paths instead of ***PROJECT***@***VERSION***. * chore: simplify github token validation * chore(lint): optional yamlfmt, config and fixes * feat: use relative `uses` names * feat: comprehensive testing infrastructure and Python validation system - Migrate from tests/ to _tests/ directory structure with ShellSpec framework - Add comprehensive validation system with Python-based input validation - Implement dual testing approach (ShellSpec + pytest) for complete coverage - Add modern Python tooling (uv, ruff, pytest-cov) and dependencies - Create centralized validation rules with automatic generation system - Update project configuration and build system for new architecture - Enhance documentation to reflect current testing capabilities This establishes a robust foundation for action validation and testing with extensive coverage across all GitHub Actions in the repository. * chore: remove Dockerfile for now * chore: code review fixes * feat: comprehensive GitHub Actions restructuring and tooling improvements This commit represents a major restructuring of the GitHub Actions monorepo with improved tooling, testing infrastructure, and comprehensive PR #186 review implementation. ## Major Changes ### 🔧 Development Tooling & Configuration - **Shellcheck integration**: Exclude shellspec test files from linting - Updated .pre-commit-config.yaml to exclude _tests/*.sh from shellcheck/shfmt - Modified Makefile shellcheck pattern to skip shellspec files - Updated CLAUDE.md documentation with proper exclusion syntax - **Testing infrastructure**: Enhanced Python validation framework - Fixed nested if statements and boolean parameter issues in validation.py - Improved code quality with explicit keyword arguments - All pre-commit hooks now passing ### 🏗️ Project Structure & Documentation - **Added Serena AI integration** with comprehensive project memories: - Project overview, structure, and technical stack documentation - Code style conventions and completion requirements - Comprehensive PR #186 review analysis and implementation tracking - **Enhanced configuration**: Updated .gitignore, .yamlfmt.yml, pyproject.toml - **Improved testing**: Added integration workflows and enhanced test specs ### 🚀 GitHub Actions Improvements (30+ actions updated) - **Centralized validation**: Updated 41 validation rule files - **Enhanced actions**: Improvements across all action categories: - Setup actions (node-setup, version detectors) - Utility actions (version-file-parser, version-validator) - Linting actions (biome, eslint, terraform-lint-fix major refactor) - Build/publish actions (docker-build, npm-publish, csharp-*) - Repository management actions ### 📝 Documentation Updates - **README consistency**: Updated version references across action READMEs - **Enhanced documentation**: Improved action descriptions and usage examples - **CLAUDE.md**: Updated with current tooling and best practices ## Technical Improvements - **Security enhancements**: Input validation and sanitization improvements - **Performance optimizations**: Streamlined action logic and dependencies - **Cross-platform compatibility**: Better Windows/macOS/Linux support - **Error handling**: Improved error reporting and user feedback ## Files Changed - 100 files changed - 13 new Serena memory files documenting project state - 41 validation rules updated for consistency - 30+ GitHub Actions and READMEs improved - Core tooling configuration enhanced * feat: comprehensive GitHub Actions improvements and PR review fixes Major Infrastructure Improvements: - Add comprehensive testing framework with 17+ ShellSpec validation tests - Implement Docker-based testing tools with automated test runner - Add CodeRabbit configuration for automated code reviews - Restructure documentation and memory management system - Update validation rules for 25+ actions with enhanced input validation - Modernize CI/CD workflows and testing infrastructure Critical PR Review Fixes (All Issues Resolved): - Fix double caching in node-setup (eliminate redundant cache operations) - Optimize shell pipeline in version-file-parser (single awk vs complex pipeline) - Fix GitHub expression interpolation in prettier-check cache keys - Resolve terraform command order issue (validation after setup) - Add missing flake8-sarif dependency for Python SARIF output - Fix environment variable scope in pr-lint (export to GITHUB_ENV) Performance & Reliability: - Eliminate duplicate cache operations saving CI time - Improve shell script efficiency with optimized parsing - Fix command execution dependencies preventing runtime failures - Ensure proper dependency installation for all linting tools - Resolve workflow conditional logic issues Security & Quality: - All input validation rules updated with latest security patterns - Cross-platform compatibility improvements maintained - Comprehensive error handling and retry logic preserved - Modern development tooling and best practices adopted This commit addresses 100% of actionable feedback from PR review analysis, implements comprehensive testing infrastructure, and maintains high code quality standards across all 41 GitHub Actions. * feat: enhance expression handling and version parsing - Fix node-setup force-version expression logic for proper empty string handling - Improve version-file-parser with secure regex validation and enhanced Python detection - Add CodeRabbit configuration for CalVer versioning and README review guidance * feat(validate-inputs): implement modular validation system - Add modular validator architecture with specialized validators - Implement base validator classes for different input types - Add validators: boolean, docker, file, network, numeric, security, token, version - Add convention mapper for automatic input validation - Add comprehensive documentation for the validation system - Implement PCRE regex support and injection protection * feat(validate-inputs): add validation rules for all actions - Add YAML validation rules for 42 GitHub Actions - Auto-generated rules with convention mappings - Include metadata for validation coverage and quality indicators - Mark rules as auto-generated to prevent manual edits * test(validate-inputs): add comprehensive test suite for validators - Add unit tests for all validator modules - Add integration tests for the validation system - Add fixtures for version test data - Test coverage for boolean, docker, file, network, numeric, security, token, and version validators - Add tests for convention mapper and registry * feat(tools): add validation scripts and utilities - Add update-validators.py script for auto-generating rules - Add benchmark-validator.py for performance testing - Add debug-validator.py for troubleshooting - Add generate-tests.py for test generation - Add check-rules-not-manually-edited.sh for CI validation - Add fix-local-action-refs.py tool for fixing action references * feat(actions): add CustomValidator.py files for specialized validation - Add custom validators for actions requiring special validation logic - Implement validators for docker, go, node, npm, php, python, terraform actions - Add specialized validation for compress-images, common-cache, common-file-check - Implement version detection validators with language-specific logic - Add validation for build arguments, architectures, and version formats * test: update ShellSpec test framework for Python validation - Update all validation.spec.sh files to use Python validator - Add shared validation_core.py for common test utilities - Remove obsolete bash validation helpers - Update test output expectations for Python validator format - Add codeql-analysis test suite - Refactor framework utilities for Python integration - Remove deprecated test files * feat(actions): update action.yml files to use validate-inputs - Replace inline bash validation with validate-inputs action - Standardize validation across all 42 actions - Add new codeql-analysis action - Update action metadata and branding - Add validation step as first step in composite actions - Maintain backward compatibility with existing inputs/outputs * ci: update GitHub workflows for enhanced security and testing - Add new codeql-new.yml workflow - Update security scanning workflows - Enhance dependency review configuration - Update test-actions workflow for new validation system - Improve workflow permissions and security settings - Update action versions to latest SHA-pinned releases * build: update build configuration and dependencies - Update Makefile with new validation targets - Add Python dependencies in pyproject.toml - Update npm dependencies and scripts - Enhance Docker testing tools configuration - Add targets for validator updates and local ref fixes - Configure uv for Python package management * chore: update linting and documentation configuration - Update EditorConfig settings for consistent formatting - Enhance pre-commit hooks configuration - Update prettier and yamllint ignore patterns - Update gitleaks security scanning rules - Update CodeRabbit review configuration - Update CLAUDE.md with latest project standards and rules * docs: update Serena memory files and project metadata - Remove obsolete PR-186 memory files - Update project overview with current architecture - Update project structure documentation - Add quality standards and communication guidelines - Add modular validator architecture documentation - Add shellspec testing framework documentation - Update project.yml with latest configuration * feat: moved rules.yml to same folder as action, fixes * fix(validators): correct token patterns and fix validator bugs - Fix GitHub classic PAT pattern: ghp_ + 36 chars = 40 total - Fix GitHub fine-grained PAT pattern: github_pat_ + 71 chars = 82 total - Initialize result variable in convention_mapper to prevent UnboundLocalError - Fix empty URL validation in network validator to return error - Add GitHub expression check to docker architectures validator - Update docker-build CustomValidator parallel-builds max to 16 * test(validators): fix test fixtures and expectations - Fix token lengths in test data: github_pat 71 chars, ghp/gho 36 chars - Update integration tests with correct token lengths - Fix file validator test to expect absolute paths rejected for security - Rename TestGenerator import to avoid pytest collection warning - Update custom validator tests with correct input names - Change docker-build tests: platforms->architectures, tags->tag - Update docker-publish tests to match new registry enum validation * test(shellspec): fix token lengths in test helpers and specs - Fix default token lengths in spec_helper.sh to use correct 40-char format - Update csharp-publish default tokens in 4 locations - Update codeql-analysis default tokens in 2 locations - Fix codeql-analysis test tokens to correct lengths (40 and 82 chars) - Fix npm-publish fine-grained token test to use 82-char format * feat(actions): add permissions documentation and environment variable usage - Add permissions comments to all action.yml files documenting required GitHub permissions - Convert direct input usage to environment variables in shell steps for security - Add validation steps with proper error handling - Update input descriptions and add security notes where applicable - Ensure all actions follow consistent patterns for input validation * chore(workflows): update GitHub Actions workflow versions - Update workflow action versions to latest - Improve workflow consistency and maintainability * docs(security): add comprehensive security policy - Document security features and best practices - Add vulnerability reporting process - Include audit history and security testing information * docs(memory): add GitHub workflow reference documentation - Add GitHub Actions workflow commands reference - Add GitHub workflow expressions guide - Add secure workflow usage patterns and best practices * chore: token optimization, code style conventions * chore: cr fixes * fix: trivy reported Dockerfile problems * fix(security): more security fixes * chore: dockerfile and make targets for publishing * fix(ci): add creds to test-actions workflow * fix: security fix and checkout step to codeql-new * chore: test fixes * fix(security): codeql detected issues * chore: code review fixes, ReDos protection * style: apply MegaLinter fixes * fix(ci): missing packages read permission * fix(ci): add missing working directory setting * chore: linting, add validation-regex to use regex_pattern * chore: code review fixes * chore(deps): update actions * fix(security): codeql fixes * chore(cr): apply cr comments * chore: improve POSIX compatibility * chore(cr): apply cr comments * fix: codeql warning in Dockerfile, build failures * chore(cr): apply cr comments * fix: docker-testing-tools/Dockerfile * chore(cr): apply cr comments * fix(docker): update testing-tools image for GitHub Actions compatibility * chore(cr): apply cr comments * feat: add more tests, fix issues * chore: fix codeql issues, update actions * chore(cr): apply cr comments * fix: integration tests * chore: deduplication and fixes * style: apply MegaLinter fixes * chore(cr): apply cr comments * feat: dry-run mode for generate-tests * fix(ci): kcov installation * chore(cr): apply cr comments * chore(cr): apply cr comments * chore(cr): apply cr comments * chore(cr): apply cr comments, simplify action testing, use uv * fix: run-tests.sh action counting * chore(cr): apply cr comments * chore(cr): apply cr comments
580 lines
20 KiB
Bash
Executable File
580 lines
20 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# ShellSpec spec helper for GitHub Actions Testing Framework
|
|
# This file is automatically loaded by ShellSpec for all tests
|
|
|
|
set -euo pipefail
|
|
|
|
# Get the project root directory (where .shellspec is located)
|
|
PROJECT_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
|
|
|
# Test framework directories
|
|
TEST_ROOT="${PROJECT_ROOT}/_tests"
|
|
FRAMEWORK_DIR="${TEST_ROOT}/framework"
|
|
FIXTURES_DIR="${FRAMEWORK_DIR}/fixtures"
|
|
MOCKS_DIR="${FRAMEWORK_DIR}/mocks"
|
|
|
|
# Export directories for use by test cases
|
|
export FIXTURES_DIR MOCKS_DIR
|
|
# Only create TEMP_DIR if not already set (framework setup.sh will create it)
|
|
if [ -z "${TEMP_DIR:-}" ]; then
|
|
TEMP_DIR=$(mktemp -d) || exit 1
|
|
fi
|
|
|
|
# Load framework utilities
|
|
# shellcheck source=_tests/framework/setup.sh
|
|
source "${FRAMEWORK_DIR}/setup.sh"
|
|
# shellcheck source=_tests/framework/utils.sh
|
|
source "${FRAMEWORK_DIR}/utils.sh"
|
|
|
|
# Initialize testing framework
|
|
init_testing_framework
|
|
|
|
# ShellSpec specific setup
|
|
spec_helper_configure() {
|
|
# Configure ShellSpec behavior
|
|
|
|
# Set up environment variables for tests
|
|
export GITHUB_ACTIONS=true
|
|
export GITHUB_WORKSPACE="${PROJECT_ROOT}"
|
|
export GITHUB_REPOSITORY="ivuorinen/actions"
|
|
export GITHUB_SHA="test-sha"
|
|
export GITHUB_REF="refs/heads/main"
|
|
export GITHUB_TOKEN="test-token"
|
|
|
|
# Temporary directory already created by mktemp above
|
|
|
|
# Set up default GITHUB_OUTPUT if not already set
|
|
if [[ -z ${GITHUB_OUTPUT:-} ]]; then
|
|
export GITHUB_OUTPUT="${TEMP_DIR}/default-github-output"
|
|
touch "$GITHUB_OUTPUT"
|
|
fi
|
|
|
|
# Quiet logging during ShellSpec runs to avoid output interference
|
|
if [[ -z ${SHELLSPEC_VERSION:-} ]]; then
|
|
log_info "ShellSpec helper configured - framework loaded"
|
|
fi
|
|
}
|
|
|
|
# Run configuration
|
|
spec_helper_configure
|
|
|
|
# Helper functions specifically for ShellSpec tests
|
|
|
|
# Set up default input values for testing a single input
|
|
# This prevents validation failures when testing one input at a time
|
|
setup_default_inputs() {
|
|
local action_name="$1"
|
|
local input_name="$2"
|
|
|
|
case "$action_name" in
|
|
"github-release")
|
|
[[ "$input_name" != "version" ]] && export INPUT_VERSION="1.0.0"
|
|
;;
|
|
"docker-build" | "docker-publish" | "docker-publish-gh" | "docker-publish-hub")
|
|
[[ "$input_name" != "image-name" ]] && export INPUT_IMAGE_NAME="test-image"
|
|
[[ "$input_name" != "tag" ]] && export INPUT_TAG="latest"
|
|
[[ "$action_name" == "docker-publish" && "$input_name" != "registry" ]] && export INPUT_REGISTRY="dockerhub"
|
|
;;
|
|
"npm-publish")
|
|
[[ "$input_name" != "npm_token" ]] && export INPUT_NPM_TOKEN="ghp_123456789012345678901234567890123456"
|
|
;;
|
|
"csharp-publish")
|
|
[[ "$input_name" != "token" ]] && export INPUT_TOKEN="ghp_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
|
|
[[ "$input_name" != "version" ]] && export INPUT_VERSION="1.0.0"
|
|
[[ "$input_name" != "namespace" ]] && export INPUT_NAMESPACE="test-namespace"
|
|
;;
|
|
"php-composer")
|
|
[[ "$input_name" != "php" ]] && export INPUT_PHP="8.1"
|
|
;;
|
|
"php-tests" | "php-laravel-phpunit")
|
|
[[ "$input_name" != "php-version" ]] && export INPUT_PHP_VERSION="8.1"
|
|
;;
|
|
"go-build" | "go-lint")
|
|
[[ "$input_name" != "go-version" ]] && export INPUT_GO_VERSION="1.21"
|
|
;;
|
|
"common-cache")
|
|
[[ "$input_name" != "type" ]] && export INPUT_TYPE="npm"
|
|
[[ "$input_name" != "paths" ]] && export INPUT_PATHS="node_modules"
|
|
;;
|
|
"common-retry")
|
|
[[ "$input_name" != "command" ]] && export INPUT_COMMAND="echo test"
|
|
;;
|
|
"dotnet-version-detect")
|
|
[[ "$input_name" != "default-version" ]] && export INPUT_DEFAULT_VERSION="8.0"
|
|
;;
|
|
"python-version-detect" | "python-version-detect-v2")
|
|
[[ "$input_name" != "default-version" ]] && export INPUT_DEFAULT_VERSION="3.11"
|
|
;;
|
|
"php-version-detect")
|
|
[[ "$input_name" != "default-version" ]] && export INPUT_DEFAULT_VERSION="8.1"
|
|
;;
|
|
"go-version-detect")
|
|
[[ "$input_name" != "default-version" ]] && export INPUT_DEFAULT_VERSION="1.22"
|
|
;;
|
|
"validate-inputs")
|
|
[[ "$input_name" != "action-type" && "$input_name" != "action" && "$input_name" != "rules-file" && "$input_name" != "fail-on-error" ]] && export INPUT_ACTION_TYPE="test-action"
|
|
;;
|
|
"version-file-parser")
|
|
[[ "$input_name" != "language" ]] && export INPUT_LANGUAGE="node"
|
|
[[ "$input_name" != "tool-versions-key" ]] && export INPUT_TOOL_VERSIONS_KEY="nodejs"
|
|
[[ "$input_name" != "dockerfile-image" ]] && export INPUT_DOCKERFILE_IMAGE="node"
|
|
;;
|
|
"codeql-analysis")
|
|
[[ "$input_name" != "language" ]] && export INPUT_LANGUAGE="javascript"
|
|
[[ "$input_name" != "token" ]] && export INPUT_TOKEN="ghp_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
|
|
;;
|
|
"version-validator")
|
|
[[ "$input_name" != "version" ]] && export INPUT_VERSION="1.0.0"
|
|
;;
|
|
"release-monthly")
|
|
[[ "$input_name" != "token" ]] && export INPUT_TOKEN="ghp_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
|
|
;;
|
|
esac
|
|
}
|
|
|
|
# Clean up default input values after testing
|
|
cleanup_default_inputs() {
|
|
local action_name="$1"
|
|
local input_name="$2"
|
|
|
|
case "$action_name" in
|
|
"github-release")
|
|
[[ "$input_name" != "version" ]] && unset INPUT_VERSION
|
|
;;
|
|
"docker-build" | "docker-publish" | "docker-publish-gh" | "docker-publish-hub")
|
|
[[ "$input_name" != "image-name" ]] && unset INPUT_IMAGE_NAME
|
|
[[ "$input_name" != "tag" ]] && unset INPUT_TAG
|
|
[[ "$action_name" == "docker-publish" && "$input_name" != "registry" ]] && unset INPUT_REGISTRY
|
|
;;
|
|
"npm-publish")
|
|
[[ "$input_name" != "npm_token" ]] && unset INPUT_NPM_TOKEN
|
|
;;
|
|
"csharp-publish")
|
|
[[ "$input_name" != "token" ]] && unset INPUT_TOKEN
|
|
[[ "$input_name" != "version" ]] && unset INPUT_VERSION
|
|
[[ "$input_name" != "namespace" ]] && unset INPUT_NAMESPACE
|
|
;;
|
|
"php-composer")
|
|
[[ "$input_name" != "php" ]] && unset INPUT_PHP
|
|
;;
|
|
"php-tests" | "php-laravel-phpunit")
|
|
[[ "$input_name" != "php-version" ]] && unset INPUT_PHP_VERSION
|
|
;;
|
|
"go-build" | "go-lint")
|
|
[[ "$input_name" != "go-version" ]] && unset INPUT_GO_VERSION
|
|
;;
|
|
"common-cache")
|
|
[[ "$input_name" != "type" ]] && unset INPUT_TYPE
|
|
[[ "$input_name" != "paths" ]] && unset INPUT_PATHS
|
|
;;
|
|
"common-retry")
|
|
[[ "$input_name" != "command" ]] && unset INPUT_COMMAND
|
|
;;
|
|
"dotnet-version-detect")
|
|
[[ "$input_name" != "default-version" ]] && unset INPUT_DEFAULT_VERSION
|
|
;;
|
|
"python-version-detect" | "python-version-detect-v2")
|
|
[[ "$input_name" != "default-version" ]] && unset INPUT_DEFAULT_VERSION
|
|
;;
|
|
"php-version-detect")
|
|
[[ "$input_name" != "default-version" ]] && unset INPUT_DEFAULT_VERSION
|
|
;;
|
|
"go-version-detect")
|
|
[[ "$input_name" != "default-version" ]] && unset INPUT_DEFAULT_VERSION
|
|
;;
|
|
"validate-inputs")
|
|
[[ "$input_name" != "action-type" && "$input_name" != "action" && "$input_name" != "rules-file" && "$input_name" != "fail-on-error" ]] && unset INPUT_ACTION_TYPE
|
|
;;
|
|
"version-file-parser")
|
|
[[ "$input_name" != "language" ]] && unset INPUT_LANGUAGE
|
|
[[ "$input_name" != "tool-versions-key" ]] && unset INPUT_TOOL_VERSIONS_KEY
|
|
[[ "$input_name" != "dockerfile-image" ]] && unset INPUT_DOCKERFILE_IMAGE
|
|
;;
|
|
"codeql-analysis")
|
|
[[ "$input_name" != "language" ]] && unset INPUT_LANGUAGE
|
|
[[ "$input_name" != "token" ]] && unset INPUT_TOKEN
|
|
;;
|
|
"version-validator")
|
|
[[ "$input_name" != "version" ]] && unset INPUT_VERSION
|
|
;;
|
|
"release-monthly")
|
|
[[ "$input_name" != "token" ]] && unset INPUT_TOKEN
|
|
;;
|
|
esac
|
|
}
|
|
|
|
# Enhanced test validation for ShellSpec
|
|
shellspec_validate_action_output() {
|
|
local expected_key="$1"
|
|
local expected_value="$2"
|
|
local output_file="${3:-$GITHUB_OUTPUT}"
|
|
|
|
if [[ ! -f $output_file ]]; then
|
|
echo "Output file not found: $output_file" >&2
|
|
return 1
|
|
fi
|
|
|
|
if grep -Fq "${expected_key}=${expected_value}" "$output_file"; then
|
|
return 0
|
|
else
|
|
echo "Expected output not found: $expected_key=$expected_value" >&2
|
|
echo "Actual outputs:" >&2
|
|
cat "$output_file" >&2
|
|
return 1
|
|
fi
|
|
}
|
|
|
|
# Mock action execution for ShellSpec tests
|
|
shellspec_mock_action_run() {
|
|
local action_dir="$1"
|
|
shift
|
|
|
|
# Set up inputs as environment variables
|
|
while [[ $# -gt 1 ]]; do
|
|
local key="$1"
|
|
local value="$2"
|
|
# Convert dashes to underscores for environment variable names
|
|
local env_key="${key//-/_}"
|
|
export "INPUT_$(echo "$env_key" | tr '[:lower:]' '[:upper:]')"="$value"
|
|
shift 2
|
|
done
|
|
|
|
# For testing, we'll simulate action outputs based on the action type
|
|
local action_name
|
|
action_name=$(basename "$action_dir")
|
|
|
|
case "$action_name" in
|
|
"version-file-parser")
|
|
echo "detected-version=1.0.0" >>"$GITHUB_OUTPUT"
|
|
echo "package-manager=npm" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"node-setup")
|
|
echo "node-version=18.0.0" >>"$GITHUB_OUTPUT"
|
|
echo "package-manager=npm" >>"$GITHUB_OUTPUT"
|
|
echo "cache-hit=false" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"docker-build")
|
|
echo "image-digest=sha256:abc123" >>"$GITHUB_OUTPUT"
|
|
echo "build-time=45" >>"$GITHUB_OUTPUT"
|
|
echo "platforms=linux/amd64" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"common-cache")
|
|
echo "cache-hit=true" >>"$GITHUB_OUTPUT"
|
|
echo "cache-key=Linux-npm-abc123" >>"$GITHUB_OUTPUT"
|
|
echo "cache-paths=node_modules" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"common-file-check")
|
|
echo "found=true" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"common-retry")
|
|
echo "success=true" >>"$GITHUB_OUTPUT"
|
|
echo "attempts=1" >>"$GITHUB_OUTPUT"
|
|
echo "exit-code=0" >>"$GITHUB_OUTPUT"
|
|
echo "duration=5" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"compress-images")
|
|
echo "images_compressed=true" >>"$GITHUB_OUTPUT"
|
|
printf "compression_report=## Compression Results\n- 3 images compressed\n- 25%% size reduction\n" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"csharp-build")
|
|
echo "build_status=success" >>"$GITHUB_OUTPUT"
|
|
echo "test_status=success" >>"$GITHUB_OUTPUT"
|
|
echo "dotnet_version=7.0" >>"$GITHUB_OUTPUT"
|
|
echo "artifacts_path=**/bin/Release/**/*" >>"$GITHUB_OUTPUT"
|
|
echo "test_results_path=**/*.trx" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"csharp-lint-check")
|
|
echo "lint_status=success" >>"$GITHUB_OUTPUT"
|
|
echo "errors_count=0" >>"$GITHUB_OUTPUT"
|
|
echo "warnings_count=0" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"csharp-publish")
|
|
echo "publish_status=success" >>"$GITHUB_OUTPUT"
|
|
echo "package_version=1.2.3" >>"$GITHUB_OUTPUT"
|
|
echo "package_url=https://github.com/ivuorinen/packages/nuget" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"docker-publish")
|
|
echo "registry=github,dockerhub" >>"$GITHUB_OUTPUT"
|
|
echo "tags=latest,v1.2.3" >>"$GITHUB_OUTPUT"
|
|
echo "build-time=120" >>"$GITHUB_OUTPUT"
|
|
echo 'platform-matrix={"linux/amd64":"success","linux/arm64":"success"}' >>"$GITHUB_OUTPUT"
|
|
echo 'scan-results={"vulnerabilities":0}' >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"docker-publish-gh")
|
|
echo "image-name=ghcr.io/ivuorinen/test" >>"$GITHUB_OUTPUT"
|
|
echo "digest=sha256:abc123def456" >>"$GITHUB_OUTPUT"
|
|
echo "tags=ghcr.io/ivuorinen/test:latest,ghcr.io/ivuorinen/test:v1.2.3" >>"$GITHUB_OUTPUT"
|
|
echo "provenance=true" >>"$GITHUB_OUTPUT"
|
|
echo "sbom=ghcr.io/ivuorinen/test.sbom" >>"$GITHUB_OUTPUT"
|
|
echo 'scan-results={"vulnerabilities":0,"critical":0}' >>"$GITHUB_OUTPUT"
|
|
echo 'platform-matrix={"linux/amd64":"success","linux/arm64":"success"}' >>"$GITHUB_OUTPUT"
|
|
echo "build-time=180" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"docker-publish-hub")
|
|
echo "image-name=ivuorinen/test-app" >>"$GITHUB_OUTPUT"
|
|
echo "digest=sha256:hub123def456" >>"$GITHUB_OUTPUT"
|
|
echo "tags=ivuorinen/test-app:latest,ivuorinen/test-app:v1.2.3" >>"$GITHUB_OUTPUT"
|
|
echo "repo-url=https://hub.docker.com/r/ivuorinen/test-app" >>"$GITHUB_OUTPUT"
|
|
echo 'scan-results={"vulnerabilities":2,"critical":0}' >>"$GITHUB_OUTPUT"
|
|
echo 'platform-matrix={"linux/amd64":"success","linux/arm64":"success"}' >>"$GITHUB_OUTPUT"
|
|
echo "build-time=240" >>"$GITHUB_OUTPUT"
|
|
echo "signature=signed" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"dotnet-version-detect")
|
|
echo "dotnet-version=7.0.403" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"eslint-check")
|
|
echo "error-count=0" >>"$GITHUB_OUTPUT"
|
|
echo "warning-count=3" >>"$GITHUB_OUTPUT"
|
|
echo "sarif-file=reports/eslint.sarif" >>"$GITHUB_OUTPUT"
|
|
echo "files-checked=15" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"eslint-fix")
|
|
echo "fixed-count=5" >>"$GITHUB_OUTPUT"
|
|
echo "files-fixed=3" >>"$GITHUB_OUTPUT"
|
|
echo "error-count=0" >>"$GITHUB_OUTPUT"
|
|
echo "warning-count=0" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"github-release")
|
|
echo "release-id=123456789" >>"$GITHUB_OUTPUT"
|
|
echo "release-url=https://github.com/ivuorinen/test/releases/tag/v1.2.3" >>"$GITHUB_OUTPUT"
|
|
echo "asset-urls=https://github.com/ivuorinen/test/releases/download/v1.2.3/app.tar.gz" >>"$GITHUB_OUTPUT"
|
|
echo "tag-name=v1.2.3" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"go-build")
|
|
echo "build_status=success" >>"$GITHUB_OUTPUT"
|
|
echo "test_status=success" >>"$GITHUB_OUTPUT"
|
|
echo "go_version=1.21.5" >>"$GITHUB_OUTPUT"
|
|
echo "binary_path=./bin" >>"$GITHUB_OUTPUT"
|
|
echo "coverage_path=coverage.out" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"go-lint")
|
|
echo "lint_status=success" >>"$GITHUB_OUTPUT"
|
|
echo "issues_count=0" >>"$GITHUB_OUTPUT"
|
|
echo "files_checked=25" >>"$GITHUB_OUTPUT"
|
|
echo "golangci_version=1.55.2" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"go-version-detect")
|
|
echo "go-version=1.21" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"npm-publish")
|
|
echo "publish-status=success" >>"$GITHUB_OUTPUT"
|
|
echo "package-version=1.2.3" >>"$GITHUB_OUTPUT"
|
|
echo "registry-url=https://registry.npmjs.org" >>"$GITHUB_OUTPUT"
|
|
echo "package-url=https://www.npmjs.com/package/test-package" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
"php-composer")
|
|
echo "composer-version=2.6.5" >>"$GITHUB_OUTPUT"
|
|
echo "install-status=success" >>"$GITHUB_OUTPUT"
|
|
echo "dependencies-count=15" >>"$GITHUB_OUTPUT"
|
|
echo "php-version=8.2.0" >>"$GITHUB_OUTPUT"
|
|
echo "lock-file-updated=false" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
*)
|
|
# Generic mock outputs
|
|
echo "status=success" >>"$GITHUB_OUTPUT"
|
|
;;
|
|
esac
|
|
}
|
|
|
|
# Use centralized Python validation system for input validation testing
|
|
shellspec_test_input_validation() {
|
|
local action_dir="$1"
|
|
local input_name="$2"
|
|
local test_value="$3"
|
|
local expected_result="${4:-success}"
|
|
|
|
# Get the action name from the directory
|
|
local action_name
|
|
action_name=$(basename "$action_dir")
|
|
|
|
# Set up environment for Python validation
|
|
local temp_output_file
|
|
temp_output_file=$(mktemp)
|
|
|
|
# Capture original INPUT_ACTION_TYPE state to restore after test
|
|
local original_action_type_set=false
|
|
local original_action_type_value=""
|
|
if [[ -n "${INPUT_ACTION_TYPE+x}" ]]; then
|
|
original_action_type_set=true
|
|
original_action_type_value="$INPUT_ACTION_TYPE"
|
|
fi
|
|
|
|
# Set environment variables for the validation script
|
|
# Only set INPUT_ACTION_TYPE if we're not testing the action input
|
|
if [[ "$input_name" != "action" ]]; then
|
|
export INPUT_ACTION_TYPE="$action_name"
|
|
fi
|
|
|
|
# Set default values for commonly required inputs to avoid validation failures
|
|
# when testing only one input at a time
|
|
setup_default_inputs "$action_name" "$input_name"
|
|
|
|
# Convert input name to uppercase and replace dashes with underscores
|
|
local input_var_name
|
|
input_var_name="INPUT_${input_name//-/_}"
|
|
input_var_name="$(echo "$input_var_name" | tr '[:lower:]' '[:upper:]')"
|
|
export "$input_var_name"="$test_value"
|
|
export GITHUB_OUTPUT="$temp_output_file"
|
|
|
|
# Run the Python validation script and capture exit code
|
|
local exit_code
|
|
if python3 "${PROJECT_ROOT}/validate-inputs/validator.py" >/dev/null 2>&1; then
|
|
exit_code=0
|
|
else
|
|
exit_code=1
|
|
fi
|
|
|
|
# Determine the actual result based on exit code
|
|
local actual_result
|
|
if [[ $exit_code -eq 0 ]]; then
|
|
actual_result="success"
|
|
else
|
|
actual_result="failure"
|
|
fi
|
|
|
|
# Clean up
|
|
rm -f "$temp_output_file" 2>/dev/null || true
|
|
unset "$input_var_name"
|
|
|
|
# Clean up default inputs
|
|
cleanup_default_inputs "$action_name" "$input_name"
|
|
|
|
# Restore original INPUT_ACTION_TYPE state
|
|
if [[ "$original_action_type_set" == "true" ]]; then
|
|
export INPUT_ACTION_TYPE="$original_action_type_value"
|
|
else
|
|
unset INPUT_ACTION_TYPE
|
|
fi
|
|
|
|
# Return based on expected result
|
|
if [[ $actual_result == "$expected_result" ]]; then
|
|
return 0
|
|
else
|
|
return 1
|
|
fi
|
|
}
|
|
|
|
# Test environment setup that works with ShellSpec
|
|
shellspec_setup_test_env() {
|
|
local test_name="${1:-shellspec-test}"
|
|
|
|
# Create unique temporary directory for this test
|
|
export SHELLSPEC_TEST_TEMP_DIR="${TEMP_DIR}/${test_name}-$$"
|
|
mkdir -p "$SHELLSPEC_TEST_TEMP_DIR"
|
|
|
|
# Create fake GitHub workspace
|
|
export SHELLSPEC_TEST_WORKSPACE="${SHELLSPEC_TEST_TEMP_DIR}/workspace"
|
|
mkdir -p "$SHELLSPEC_TEST_WORKSPACE"
|
|
|
|
# Setup fake GitHub outputs
|
|
export GITHUB_OUTPUT="${SHELLSPEC_TEST_TEMP_DIR}/github-output"
|
|
export GITHUB_ENV="${SHELLSPEC_TEST_TEMP_DIR}/github-env"
|
|
export GITHUB_PATH="${SHELLSPEC_TEST_TEMP_DIR}/github-path"
|
|
export GITHUB_STEP_SUMMARY="${SHELLSPEC_TEST_TEMP_DIR}/github-step-summary"
|
|
|
|
# Initialize output files
|
|
touch "$GITHUB_OUTPUT" "$GITHUB_ENV" "$GITHUB_PATH" "$GITHUB_STEP_SUMMARY"
|
|
|
|
# Change to test workspace
|
|
cd "$SHELLSPEC_TEST_WORKSPACE"
|
|
}
|
|
|
|
# Test environment cleanup for ShellSpec
|
|
shellspec_cleanup_test_env() {
|
|
local test_name="${1:-shellspec-test}"
|
|
|
|
if [[ -n ${SHELLSPEC_TEST_TEMP_DIR:-} && -d $SHELLSPEC_TEST_TEMP_DIR ]]; then
|
|
rm -rf "$SHELLSPEC_TEST_TEMP_DIR"
|
|
fi
|
|
|
|
# Return to project root
|
|
cd "$PROJECT_ROOT"
|
|
}
|
|
|
|
# Export functions for use in specs
|
|
export -f shellspec_validate_action_output shellspec_mock_action_run
|
|
export -f shellspec_setup_test_env shellspec_cleanup_test_env shellspec_test_input_validation
|
|
|
|
# Create alias for backward compatibility (override framework version)
|
|
test_input_validation() {
|
|
shellspec_test_input_validation "$@"
|
|
}
|
|
|
|
# Export all framework functions for backward compatibility
|
|
export -f setup_test_env cleanup_test_env create_mock_repo
|
|
export -f create_mock_node_repo
|
|
export -f validate_action_output check_required_tools
|
|
export -f log_info log_success log_warning log_error
|
|
export -f validate_action_yml get_action_inputs get_action_outputs get_action_name
|
|
export -f test_action_outputs test_external_usage test_input_validation
|
|
|
|
# Quiet wrapper for validate_action_yml in tests
|
|
validate_action_yml_quiet() {
|
|
validate_action_yml "$1" "true"
|
|
}
|
|
|
|
# =============================================================================
|
|
# VALIDATION TEST HELPERS
|
|
# =============================================================================
|
|
# Note: These helpers return validation results but cannot use ShellSpec commands
|
|
# They must be called from within ShellSpec It blocks
|
|
|
|
# Modern Python-based validation function for direct testing
|
|
validate_input_python() {
|
|
local action_type="$1"
|
|
local input_name="$2"
|
|
local input_value="$3"
|
|
|
|
# Set up environment variables for Python validator
|
|
export INPUT_ACTION_TYPE="$action_type"
|
|
export VALIDATOR_QUIET="1" # Suppress success messages for tests
|
|
|
|
# Set default values for commonly required inputs to avoid validation failures
|
|
# when testing only one input at a time
|
|
setup_default_inputs "$action_type" "$input_name"
|
|
|
|
# Set the target input
|
|
local input_var_name="INPUT_${input_name//-/_}"
|
|
input_var_name="$(echo "$input_var_name" | tr '[:lower:]' '[:upper:]')"
|
|
export "$input_var_name"="$input_value"
|
|
|
|
# Set up GitHub output file
|
|
local temp_output
|
|
temp_output=$(mktemp)
|
|
export GITHUB_OUTPUT="$temp_output"
|
|
|
|
# Call Python validator directly
|
|
|
|
if [[ "${SHELLSPEC_DEBUG:-}" == "1" ]]; then
|
|
echo "DEBUG: Testing $action_type $input_name=$input_value"
|
|
echo "DEBUG: Environment variables:"
|
|
env | grep "^INPUT_" | sort
|
|
fi
|
|
|
|
# Run validator and output everything to stdout for ShellSpec
|
|
uv run "${PROJECT_ROOT}/validate-inputs/validator.py" 2>&1
|
|
local exit_code=$?
|
|
|
|
# Clean up target input
|
|
unset INPUT_ACTION_TYPE "$input_var_name" GITHUB_OUTPUT VALIDATOR_QUIET
|
|
rm -f "$temp_output" 2>/dev/null || true
|
|
|
|
# Clean up default inputs
|
|
cleanup_default_inputs "$action_type" "$input_name"
|
|
|
|
# Return the exit code for ShellSpec to check
|
|
return $exit_code
|
|
}
|
|
|
|
# Export all new simplified helpers (functions are moved above)
|
|
export -f validate_action_yml_quiet validate_input_python
|
|
|
|
# Removed EXIT trap setup to avoid conflicts with ShellSpec
|
|
# ShellSpec handles its own cleanup, and our framework cleanup is handled in setup.sh
|
|
|
|
# Quiet logging during ShellSpec runs
|
|
if [[ -z ${SHELLSPEC_VERSION:-} ]]; then
|
|
log_success "ShellSpec spec helper loaded successfully"
|
|
fi
|