mirror of
https://github.com/ivuorinen/actions.git
synced 2026-01-26 11:34:00 +00:00
feat: simplify actions (#353)
* feat: first pass simplification
* refactor: simplify actions repository structure
Major simplification reducing actions from 44 to 30:
Consolidations:
- Merge biome-check + biome-fix → biome-lint (mode: check/fix)
- Merge eslint-check + eslint-fix → eslint-lint (mode: check/fix)
- Merge prettier-check + prettier-fix → prettier-lint (mode: check/fix)
- Merge 5 version-detect actions → language-version-detect (language param)
Removals:
- common-file-check, common-retry (better served by external tools)
- docker-publish-gh, docker-publish-hub (consolidated into docker-publish)
- github-release (redundant with existing tooling)
- set-git-config (no longer needed)
- version-validator (functionality moved to language-version-detect)
Fixes:
- Rewrite docker-publish to use official Docker actions directly
- Update validate-inputs example (eslint-fix → eslint-lint)
- Update tests and documentation for new structure
Result: ~6,000 lines removed, cleaner action catalog, maintained functionality.
* refactor: complete action simplification and cleanup
Remove deprecated actions and update remaining actions:
Removed:
- common-file-check, common-retry: utility actions
- docker-publish-gh, docker-publish-hub: replaced by docker-publish wrapper
- github-release, version-validator, set-git-config: no longer needed
- Various version-detect actions: replaced by language-version-detect
Updated:
- docker-publish: rewrite as simple wrapper using official Docker actions
- validate-inputs: update example (eslint-fix → eslint-lint)
- Multiple actions: update configurations and remove deprecated dependencies
- Tests: update integration/unit tests for new structure
- Documentation: update README, remove test for deleted actions
Configuration updates:
- Linter configs, ignore files for new structure
- Makefile, pyproject.toml updates
* fix: enforce POSIX compliance in GitHub workflows
Convert all workflow shell scripts to POSIX-compliant sh:
Critical fixes:
- Replace bash with sh in all shell declarations
- Replace [[ with [ for test conditions
- Replace == with = for string comparisons
- Replace set -euo pipefail with set -eu
- Split compound AND conditions into separate [ ] tests
Files updated:
- .github/workflows/test-actions.yml (7 shell declarations, 10 test operators)
- .github/workflows/security-suite.yml (set -eu)
- .github/workflows/action-security.yml (2 shell declarations)
- .github/workflows/pr-lint.yml (3 shell declarations)
- .github/workflows/issue-stats.yml (1 shell declaration)
Ensures compatibility with minimal sh implementations and aligns with
CLAUDE.md standards requiring POSIX shell compliance across all scripts.
All tests pass: 764 pytest tests, 100% coverage.
* fix: add missing permissions for private repository support
Add critical permissions to pr-lint workflow for private repositories:
Workflow-level permissions:
+ packages: read - Access private npm/PyPI/Composer packages
Job-level permissions:
+ packages: read - Access private packages during dependency installation
+ checks: write - Create and update check runs
Fixes failures when:
- Installing private npm packages from GitHub Packages
- Installing private Composer dependencies
- Installing private Python packages
- Creating status checks with github-script
Valid permission scopes per actionlint:
actions, attestations, checks, contents, deployments, discussions,
id-token, issues, models, packages, pages, pull-requests,
repository-projects, security-events, statuses
Note: "workflows" and "metadata" are NOT valid permission scopes
(they are PAT-only scopes or auto-granted respectively).
* docs: update readmes
* fix: replace bash-specific 'source' with POSIX '.' command
Replace all occurrences of 'source' with '.' (dot) for POSIX compliance:
Changes in python-lint-fix/action.yml:
- Line 165: source .venv/bin/activate → . .venv/bin/activate
- Line 179: source .venv/bin/activate → . .venv/bin/activate
- Line 211: source .venv/bin/activate → . .venv/bin/activate
Also fixed bash-specific test operator:
- Line 192: [[ "$FAIL_ON_ERROR" == "true" ]] → [ "$FAIL_ON_ERROR" = "true" ]
The 'source' command is bash-specific. POSIX sh uses '.' (dot) to source files.
Both commands have identical functionality but '.' is portable across all
POSIX-compliant shells.
* security: fix code injection vulnerability in docker-publish
Fix CodeQL code injection warning (CWE-094, CWE-095, CWE-116):
Issue: inputs.context was used directly in GitHub Actions expression
without sanitization at line 194, allowing potential code injection
by external users.
Fix: Use environment variable indirection to prevent expression injection:
- Added env.BUILD_CONTEXT to capture inputs.context
- Changed context parameter to use ${{ env.BUILD_CONTEXT }}
Environment variables are evaluated after expression compilation,
preventing malicious code execution during workflow parsing.
Security Impact: Medium severity (CVSS 5.0)
Identified by: GitHub Advanced Security (CodeQL)
Reference: https://github.com/ivuorinen/actions/pull/353#pullrequestreview-3481935924
* security: prevent credential persistence in pr-lint checkout
Add persist-credentials: false to checkout step to mitigate untrusted
checkout vulnerability. This prevents GITHUB_TOKEN from being accessible
to potentially malicious PR code.
Fixes: CodeQL finding CWE-829 (untrusted checkout on privileged workflow)
* fix: prevent security bot from overwriting unrelated comments
Replace broad string matching with unique HTML comment marker for
identifying bot-generated comments. Previously, any comment containing
'Security Analysis' or '🔐 GitHub Actions Permissions' would be
overwritten, causing data loss.
Changes:
- Add unique marker: <!-- security-analysis-bot-comment -->
- Prepend marker to generated comment body
- Update comment identification to use marker only
- Add defensive null check for comment.body
This fixes critical data loss bug where user comments could be
permanently overwritten by the security analysis bot.
Follows same proven pattern as test-actions.yml coverage comments.
* improve: show concise permissions diff instead of full blocks
Replace verbose full-block permissions diff with line-by-line changes.
Now shows only added/removed permissions, making output much more
readable.
Changes:
- Parse permissions into individual lines
- Compare old vs new to identify actual changes
- Show only removed (-) and added (+) lines in diff
- Collapse unchanged permissions into details section (≤3 items)
- Show count summary for many unchanged permissions (>3 items)
Example output:
Before: 30+ lines showing entire permissions block
After: 3-5 lines showing only what changed
This addresses user feedback that permissions changes were too verbose.
* security: add input validation and trust model documentation
Add comprehensive security validation for docker-publish action to prevent
code injection attacks (CWE-094, CWE-116).
Changes:
- Add validation for context input (reject absolute paths, warn on URLs)
- Add validation for dockerfile input (reject absolute/URL paths)
- Document security trust model in README
- Add best practices for secure usage
- Explain validation rules and threat model
Prevents malicious actors from:
- Building from arbitrary file system locations
- Fetching Dockerfiles from untrusted remote sources
- Executing code injection through build context manipulation
Addresses: CodeRabbit review comments #2541434325, #2541549615
Fixes: GitHub Advanced Security code injection findings
* security: replace unmaintained nick-fields/retry with step-security/retry
Replace nick-fields/retry with step-security/retry across all 4 actions:
- csharp-build/action.yml
- php-composer/action.yml
- go-build/action.yml
- ansible-lint-fix/action.yml
The nick-fields/retry action has security vulnerabilities and low maintenance.
step-security/retry is a drop-in replacement with full API compatibility.
All inputs (timeout_minutes, max_attempts, command, retry_wait_seconds) are
compatible. Using SHA-pinned version for security.
Addresses CodeRabbit review comment #2541549598
* test: add is_input_required() helper function
Add helper function to check if an action input is required, reducing
duplication across test suites.
The function:
- Takes action_file and input_name as parameters
- Uses validation_core.py to query the 'required' property
- Returns 0 (success) if input is required
- Returns 1 (failure) if input is optional
This DRY improvement addresses CodeRabbit review comment #2541549572
* feat: add mode validation convention mapping
Add "mode" to the validation conventions mapping for lint actions
(eslint-lint, biome-lint, prettier-lint).
Note: The update-validators script doesn't currently recognize "string"
as a validator type, so mode validation coverage remains at 93%. The
actions already have inline validation for mode (check|fix), so this is
primarily for improving coverage metrics.
Addresses part of CodeRabbit review comment #2541549570
(validation coverage improvement)
* docs: fix CLAUDE.md action counts and add missing action
- Update action count from 31 to 29 (line 42)
- Add missing 'action-versioning' to Utilities category (line 74)
Addresses CodeRabbit review comments #2541553130 and #2541553110
* docs: add security considerations to docker-publish
Add security documentation to both action.yml header and README.md:
- Trust model explanation
- Input validation details for context and dockerfile
- Attack prevention information
- Best practices for secure usage
The documentation was previously removed when README was autogenerated.
Now documented in both places to ensure it persists.
* fix: correct step ID reference in docker-build
Fix incorrect step ID reference in platforms output:
- Changed steps.platforms.outputs.built to steps.detect-platforms.outputs.platforms
- The step is actually named 'detect-platforms' not 'platforms'
- Ensures output correctly references the detect-platforms step defined at line 188
* fix: ensure docker-build platforms output is always available
Make detect-platforms step unconditional to fix broken output contract.
The platforms output (line 123) references steps.detect-platforms.outputs.platforms,
but the step only ran when auto-detect-platforms was true (default: false).
This caused undefined output in most cases.
Changes:
- Remove 'if' condition from detect-platforms step
- Step now always runs and always produces platforms output
- When auto-detect is false: outputs configured architectures
- When auto-detect is true: outputs detected platforms or falls back to architectures
- Add '|| true' to grep to prevent errors when no platforms detected
Fixes CodeRabbit review comment #2541824904
* security: remove env var indirection in docker-publish BUILD_CONTEXT
Remove BUILD_CONTEXT env var indirection to address GitHub Advanced Security alert.
The inputs.context is validated at lines 137-147 (rejects absolute paths, warns on URLs)
before being used, so the env var indirection is unnecessary and triggers false positive
code injection warnings.
Changes:
- Remove BUILD_CONTEXT env var (line 254)
- Use inputs.context directly (line 256 → 254)
- Input validation remains in place (lines 137-147)
Fixes GitHub Advanced Security code injection alerts (comments #2541405269, #2541522320)
* feat: implement mode_enum validator for lint actions
Add mode_enum validator to validate mode inputs in linting actions.
Changes to conventions.py:
- Add 'mode_enum' to exact_matches mapping (line 215)
- Add 'mode_enum' to PHP-specific validators list (line 560)
- Implement _validate_mode_enum() method (lines 642-660)
- Validates mode values against ['check', 'fix']
- Returns clear error messages for invalid values
Updated rules.yml files:
- biome-lint: Add mode: mode_enum convention
- eslint-lint: Add mode: mode_enum convention
- prettier-lint: Add mode: mode_enum convention
- All rules.yml: Fix YAML formatting with yamlfmt
This addresses PR #353 comment #2541522326 which reported that mode validation
was being skipped due to unrecognized 'string' type, reducing coverage to 93%.
Tested with biome-lint action - correctly rejects invalid values and accepts
valid 'check' and 'fix' values.
* docs: update action count from 29 to 30 in CLAUDE.md
Update two references to action count in CLAUDE.md:
- Line 42: repository_overview memory description
- Line 74: Repository Structure section header
The repository has 30 actions total (29 listed + validate-inputs).
Addresses PR #353 comment #2541549588.
* docs: use pinned version ref in language-version-detect README
Change usage example from @main to @v2025 for security best practices.
Using pinned version refs (instead of @main) ensures:
- Predictable behavior across workflow runs
- Protection against breaking changes
- Better security through immutable references
Follows repository convention documented in main README and CLAUDE.md.
Addresses PR #353 comment #2541549588.
* refactor: remove deprecated add-snippets input from codeql-analysis
Remove add-snippets input which has been deprecated by GitHub's CodeQL action
and no longer has any effect.
Changes:
- Remove add-snippets input definition (lines 93-96)
- Remove reference in init step (line 129)
- Remove reference in analyze step (line 211)
- Regenerate README and rules.yml
This is a non-breaking change since:
- Default was 'false' (minimal usage expected)
- GitHub's action already ignores this parameter
- Aligns with recent repository simplification efforts
* feat: add mode_enum validator and update rules
Add mode_enum validator support for lint actions and regenerate all validation rules:
Validator Changes:
- Add mode_enum to action_overrides for biome-lint, eslint-lint, prettier-lint
- Remove deprecated add-snippets from codeql-analysis overrides
Rules Updates:
- All 29 action rules.yml files regenerated with consistent YAML formatting
- biome-lint, eslint-lint, prettier-lint now validate mode input (check/fix)
- Improved coverage for lint actions (79% → 83% for biome, 93% for eslint, 79% for prettier)
Documentation:
- Fix language-version-detect README to use @v2025 (not @main)
- Remove outdated docker-publish security docs (now handled by official actions)
This completes PR #353 review feedback implementation.
* fix: replace bash-specific $'\n' with POSIX-compliant printf
Replace non-POSIX $'\n' syntax in tag building loop with printf-based
approach that works in any POSIX shell.
Changed:
- Line 216: tags="${tags}"$'\n'"${image}:${tag}"
+ Line 216: tags="$(printf '%s\n%s' "$tags" "${image}:${tag}")"
This ensures docker-publish/action.yml runs correctly on systems using
/bin/sh instead of bash.
This commit is contained in:
GitHub
@@ -8,56 +8,56 @@ Centralized Python-based input validation for GitHub Actions with PCRE regex sup
|
||||
|
||||
### Inputs
|
||||
|
||||
| name | description | required | default |
|
||||
|---------------------|------------------------------------------------------------------------------------|----------|---------|
|
||||
| `action` | <p>Action name to validate (alias for action-type)</p> | `false` | `""` |
|
||||
| `action-type` | <p>Type of action to validate (e.g., csharp-publish, docker-build, eslint-fix)</p> | `false` | `""` |
|
||||
| `rules-file` | <p>Path to validation rules file</p> | `false` | `""` |
|
||||
| `fail-on-error` | <p>Whether to fail on validation errors</p> | `false` | `true` |
|
||||
| `token` | <p>GitHub token for authentication</p> | `false` | `""` |
|
||||
| `namespace` | <p>Namespace/username for validation</p> | `false` | `""` |
|
||||
| `email` | <p>Email address for validation</p> | `false` | `""` |
|
||||
| `username` | <p>Username for validation</p> | `false` | `""` |
|
||||
| `dotnet-version` | <p>.NET version string</p> | `false` | `""` |
|
||||
| `terraform-version` | <p>Terraform version string</p> | `false` | `""` |
|
||||
| `tflint-version` | <p>TFLint version string</p> | `false` | `""` |
|
||||
| `node-version` | <p>Node.js version string</p> | `false` | `""` |
|
||||
| `force-version` | <p>Force version override</p> | `false` | `""` |
|
||||
| `default-version` | <p>Default version fallback</p> | `false` | `""` |
|
||||
| `image-name` | <p>Docker image name</p> | `false` | `""` |
|
||||
| `tag` | <p>Docker image tag</p> | `false` | `""` |
|
||||
| `architectures` | <p>Target architectures</p> | `false` | `""` |
|
||||
| `dockerfile` | <p>Dockerfile path</p> | `false` | `""` |
|
||||
| `context` | <p>Docker build context</p> | `false` | `""` |
|
||||
| `build-args` | <p>Docker build arguments</p> | `false` | `""` |
|
||||
| `buildx-version` | <p>Docker Buildx version</p> | `false` | `""` |
|
||||
| `max-retries` | <p>Maximum retry attempts</p> | `false` | `""` |
|
||||
| `image-quality` | <p>Image quality percentage</p> | `false` | `""` |
|
||||
| `png-quality` | <p>PNG quality percentage</p> | `false` | `""` |
|
||||
| `parallel-builds` | <p>Number of parallel builds</p> | `false` | `""` |
|
||||
| `days-before-stale` | <p>Number of days before marking as stale</p> | `false` | `""` |
|
||||
| `days-before-close` | <p>Number of days before closing stale items</p> | `false` | `""` |
|
||||
| `pre-commit-config` | <p>Pre-commit configuration file path</p> | `false` | `""` |
|
||||
| `base-branch` | <p>Base branch name</p> | `false` | `""` |
|
||||
| `dry-run` | <p>Dry run mode</p> | `false` | `""` |
|
||||
| `is_fiximus` | <p>Use Fiximus bot</p> | `false` | `""` |
|
||||
| `prefix` | <p>Release tag prefix</p> | `false` | `""` |
|
||||
| `language` | <p>Language to analyze (for CodeQL)</p> | `false` | `""` |
|
||||
| `queries` | <p>CodeQL queries to run</p> | `false` | `""` |
|
||||
| `packs` | <p>CodeQL query packs</p> | `false` | `""` |
|
||||
| `config-file` | <p>CodeQL configuration file path</p> | `false` | `""` |
|
||||
| `config` | <p>CodeQL configuration YAML string</p> | `false` | `""` |
|
||||
| `build-mode` | <p>Build mode for compiled languages</p> | `false` | `""` |
|
||||
| `source-root` | <p>Source code root directory</p> | `false` | `""` |
|
||||
| `category` | <p>Analysis category</p> | `false` | `""` |
|
||||
| `checkout-ref` | <p>Git reference to checkout</p> | `false` | `""` |
|
||||
| `working-directory` | <p>Working directory for analysis</p> | `false` | `""` |
|
||||
| `upload-results` | <p>Upload results to GitHub Security</p> | `false` | `""` |
|
||||
| `ram` | <p>Memory in MB for CodeQL</p> | `false` | `""` |
|
||||
| `threads` | <p>Number of threads for CodeQL</p> | `false` | `""` |
|
||||
| `output` | <p>Output path for SARIF results</p> | `false` | `""` |
|
||||
| `skip-queries` | <p>Skip running queries</p> | `false` | `""` |
|
||||
| `add-snippets` | <p>Add code snippets to SARIF</p> | `false` | `""` |
|
||||
| name | description | required | default |
|
||||
|---------------------|-------------------------------------------------------------------------------------|----------|---------|
|
||||
| `action` | <p>Action name to validate (alias for action-type)</p> | `false` | `""` |
|
||||
| `action-type` | <p>Type of action to validate (e.g., csharp-publish, docker-build, eslint-lint)</p> | `false` | `""` |
|
||||
| `rules-file` | <p>Path to validation rules file</p> | `false` | `""` |
|
||||
| `fail-on-error` | <p>Whether to fail on validation errors</p> | `false` | `true` |
|
||||
| `token` | <p>GitHub token for authentication</p> | `false` | `""` |
|
||||
| `namespace` | <p>Namespace/username for validation</p> | `false` | `""` |
|
||||
| `email` | <p>Email address for validation</p> | `false` | `""` |
|
||||
| `username` | <p>Username for validation</p> | `false` | `""` |
|
||||
| `dotnet-version` | <p>.NET version string</p> | `false` | `""` |
|
||||
| `terraform-version` | <p>Terraform version string</p> | `false` | `""` |
|
||||
| `tflint-version` | <p>TFLint version string</p> | `false` | `""` |
|
||||
| `node-version` | <p>Node.js version string</p> | `false` | `""` |
|
||||
| `force-version` | <p>Force version override</p> | `false` | `""` |
|
||||
| `default-version` | <p>Default version fallback</p> | `false` | `""` |
|
||||
| `image-name` | <p>Docker image name</p> | `false` | `""` |
|
||||
| `tag` | <p>Docker image tag</p> | `false` | `""` |
|
||||
| `architectures` | <p>Target architectures</p> | `false` | `""` |
|
||||
| `dockerfile` | <p>Dockerfile path</p> | `false` | `""` |
|
||||
| `context` | <p>Docker build context</p> | `false` | `""` |
|
||||
| `build-args` | <p>Docker build arguments</p> | `false` | `""` |
|
||||
| `buildx-version` | <p>Docker Buildx version</p> | `false` | `""` |
|
||||
| `max-retries` | <p>Maximum retry attempts</p> | `false` | `""` |
|
||||
| `image-quality` | <p>Image quality percentage</p> | `false` | `""` |
|
||||
| `png-quality` | <p>PNG quality percentage</p> | `false` | `""` |
|
||||
| `parallel-builds` | <p>Number of parallel builds</p> | `false` | `""` |
|
||||
| `days-before-stale` | <p>Number of days before marking as stale</p> | `false` | `""` |
|
||||
| `days-before-close` | <p>Number of days before closing stale items</p> | `false` | `""` |
|
||||
| `pre-commit-config` | <p>Pre-commit configuration file path</p> | `false` | `""` |
|
||||
| `base-branch` | <p>Base branch name</p> | `false` | `""` |
|
||||
| `dry-run` | <p>Dry run mode</p> | `false` | `""` |
|
||||
| `is_fiximus` | <p>Use Fiximus bot</p> | `false` | `""` |
|
||||
| `prefix` | <p>Release tag prefix</p> | `false` | `""` |
|
||||
| `language` | <p>Language to analyze (for CodeQL)</p> | `false` | `""` |
|
||||
| `queries` | <p>CodeQL queries to run</p> | `false` | `""` |
|
||||
| `packs` | <p>CodeQL query packs</p> | `false` | `""` |
|
||||
| `config-file` | <p>CodeQL configuration file path</p> | `false` | `""` |
|
||||
| `config` | <p>CodeQL configuration YAML string</p> | `false` | `""` |
|
||||
| `build-mode` | <p>Build mode for compiled languages</p> | `false` | `""` |
|
||||
| `source-root` | <p>Source code root directory</p> | `false` | `""` |
|
||||
| `category` | <p>Analysis category</p> | `false` | `""` |
|
||||
| `checkout-ref` | <p>Git reference to checkout</p> | `false` | `""` |
|
||||
| `working-directory` | <p>Working directory for analysis</p> | `false` | `""` |
|
||||
| `upload-results` | <p>Upload results to GitHub Security</p> | `false` | `""` |
|
||||
| `ram` | <p>Memory in MB for CodeQL</p> | `false` | `""` |
|
||||
| `threads` | <p>Number of threads for CodeQL</p> | `false` | `""` |
|
||||
| `output` | <p>Output path for SARIF results</p> | `false` | `""` |
|
||||
| `skip-queries` | <p>Skip running queries</p> | `false` | `""` |
|
||||
| `add-snippets` | <p>Add code snippets to SARIF</p> | `false` | `""` |
|
||||
|
||||
### Outputs
|
||||
|
||||
@@ -85,7 +85,7 @@ This action is a `composite` action.
|
||||
# Default: ""
|
||||
|
||||
action-type:
|
||||
# Type of action to validate (e.g., csharp-publish, docker-build, eslint-fix)
|
||||
# Type of action to validate (e.g., csharp-publish, docker-build, eslint-lint)
|
||||
#
|
||||
# Required: false
|
||||
# Default: ""
|
||||
|
||||
@@ -15,7 +15,7 @@ inputs:
|
||||
description: 'Action name to validate (alias for action-type)'
|
||||
required: false
|
||||
action-type:
|
||||
description: 'Type of action to validate (e.g., csharp-publish, docker-build, eslint-fix)'
|
||||
description: 'Type of action to validate (e.g., csharp-publish, docker-build, eslint-lint)'
|
||||
required: false
|
||||
rules-file:
|
||||
description: 'Path to validation rules file'
|
||||
|
||||
@@ -354,7 +354,15 @@ class ValidationRuleGenerator:
|
||||
"threads": "numeric_range_1_128",
|
||||
"output": "file_path",
|
||||
"skip-queries": "boolean",
|
||||
"add-snippets": "boolean",
|
||||
},
|
||||
"biome-lint": {
|
||||
"mode": "mode_enum",
|
||||
},
|
||||
"eslint-lint": {
|
||||
"mode": "mode_enum",
|
||||
},
|
||||
"prettier-lint": {
|
||||
"mode": "mode_enum",
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
@@ -52,9 +52,9 @@ class TestValidatorIntegration:
|
||||
def test_validator_script_success(self):
|
||||
"""Test validator script execution with valid inputs."""
|
||||
env_vars = {
|
||||
"INPUT_ACTION_TYPE": "github-release",
|
||||
"INPUT_VERSION": "1.2.3",
|
||||
"INPUT_CHANGELOG": "Release notes",
|
||||
"INPUT_ACTION_TYPE": "release-monthly",
|
||||
"INPUT_TOKEN": "github_pat_" + "a" * 71,
|
||||
"INPUT_PREFIX": "v",
|
||||
}
|
||||
|
||||
result = self.run_validator(env_vars)
|
||||
@@ -65,9 +65,9 @@ class TestValidatorIntegration:
|
||||
def test_validator_script_failure(self):
|
||||
"""Test validator script execution with invalid inputs."""
|
||||
env_vars = {
|
||||
"INPUT_ACTION_TYPE": "github-release",
|
||||
"INPUT_VERSION": "invalid-version",
|
||||
"INPUT_CHANGELOG": "Release notes",
|
||||
"INPUT_ACTION_TYPE": "release-monthly",
|
||||
"INPUT_TOKEN": "invalid-token",
|
||||
"INPUT_PREFIX": "v",
|
||||
}
|
||||
|
||||
result = self.run_validator(env_vars)
|
||||
@@ -78,22 +78,21 @@ class TestValidatorIntegration:
|
||||
def test_validator_script_missing_required(self):
|
||||
"""Test validator script with missing required inputs."""
|
||||
env_vars = {
|
||||
"INPUT_ACTION_TYPE": "github-release",
|
||||
# Missing required INPUT_VERSION
|
||||
"INPUT_CHANGELOG": "Release notes",
|
||||
"INPUT_ACTION_TYPE": "release-monthly",
|
||||
# Missing required INPUT_TOKEN
|
||||
"INPUT_PREFIX": "v",
|
||||
}
|
||||
|
||||
result = self.run_validator(env_vars)
|
||||
|
||||
assert result.returncode == 1
|
||||
assert "Required input 'version' is missing" in result.stderr
|
||||
assert "Required input 'token' is missing" in result.stderr
|
||||
|
||||
def test_validator_script_calver_validation(self):
|
||||
"""Test validator script with CalVer version."""
|
||||
def test_validator_script_semver_validation(self):
|
||||
"""Test validator script with semantic version."""
|
||||
env_vars = {
|
||||
"INPUT_ACTION_TYPE": "github-release",
|
||||
"INPUT_VERSION": "2024.3.1",
|
||||
"INPUT_CHANGELOG": "Release notes",
|
||||
"INPUT_ACTION_TYPE": "action-versioning",
|
||||
"INPUT_MAJOR_VERSION": "v2025",
|
||||
}
|
||||
|
||||
result = self.run_validator(env_vars)
|
||||
@@ -101,18 +100,17 @@ class TestValidatorIntegration:
|
||||
assert result.returncode == 0
|
||||
assert "All input validation checks passed" in result.stderr
|
||||
|
||||
def test_validator_script_invalid_calver(self):
|
||||
"""Test validator script with invalid CalVer version."""
|
||||
def test_validator_script_invalid_semver(self):
|
||||
"""Test validator script with invalid semantic version."""
|
||||
env_vars = {
|
||||
"INPUT_ACTION_TYPE": "github-release",
|
||||
"INPUT_VERSION": "2024.13.1", # Invalid month
|
||||
"INPUT_CHANGELOG": "Release notes",
|
||||
"INPUT_ACTION_TYPE": "action-versioning",
|
||||
"INPUT_MAJOR_VERSION": "invalid.version", # Invalid version
|
||||
}
|
||||
|
||||
result = self.run_validator(env_vars)
|
||||
|
||||
assert result.returncode == 1
|
||||
assert "Invalid CalVer format" in result.stderr
|
||||
assert "Input validation failed" in result.stderr
|
||||
|
||||
def test_validator_script_docker_build(self):
|
||||
"""Test validator script with docker-build action."""
|
||||
@@ -239,8 +237,8 @@ class TestValidatorIntegration:
|
||||
def test_validator_script_output_file_creation(self):
|
||||
"""Test that validator script creates GitHub output file."""
|
||||
env_vars = {
|
||||
"INPUT_ACTION_TYPE": "github-release",
|
||||
"INPUT_VERSION": "1.2.3",
|
||||
"INPUT_ACTION_TYPE": "release-monthly",
|
||||
"INPUT_TOKEN": "github_pat_" + "a" * 71,
|
||||
}
|
||||
|
||||
result = self.run_validator(env_vars)
|
||||
@@ -259,8 +257,8 @@ class TestValidatorIntegration:
|
||||
"""Test validator script handles exceptions gracefully."""
|
||||
# Test with invalid GITHUB_OUTPUT path to trigger exception
|
||||
env_vars = {
|
||||
"INPUT_ACTION_TYPE": "github-release",
|
||||
"INPUT_VERSION": "1.2.3",
|
||||
"INPUT_ACTION_TYPE": "release-monthly",
|
||||
"INPUT_TOKEN": "github_pat_" + "a" * 71,
|
||||
"GITHUB_OUTPUT": "/invalid/path/that/does/not/exist",
|
||||
}
|
||||
|
||||
@@ -272,9 +270,9 @@ class TestValidatorIntegration:
|
||||
@pytest.mark.parametrize(
|
||||
"action_type,inputs,expected_success",
|
||||
[
|
||||
("github-release", {"version": "1.2.3"}, True),
|
||||
("github-release", {"version": "2024.3.1"}, True),
|
||||
("github-release", {"version": "invalid"}, False),
|
||||
("release-monthly", {"token": "github_pat_" + "a" * 71}, True),
|
||||
("release-monthly", {"token": "github_pat_" + "a" * 71, "prefix": "v"}, True),
|
||||
("release-monthly", {"token": "invalid"}, False),
|
||||
("docker-build", {"context": ".", "image-name": "app", "tag": "latest"}, True),
|
||||
(
|
||||
"docker-build",
|
||||
|
||||
@@ -1,74 +0,0 @@
|
||||
"""Tests for set-git-config custom validator.
|
||||
|
||||
Generated by generate-tests.py - Do not edit manually.
|
||||
"""
|
||||
# pylint: disable=invalid-name # Test file name matches action name
|
||||
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
# Add action directory to path to import custom validator
|
||||
action_path = Path(__file__).parent.parent.parent / "set-git-config"
|
||||
sys.path.insert(0, str(action_path))
|
||||
|
||||
# pylint: disable=wrong-import-position
|
||||
from CustomValidator import CustomValidator
|
||||
|
||||
|
||||
class TestCustomSetGitConfigValidator:
|
||||
"""Test cases for set-git-config custom validator."""
|
||||
|
||||
def setup_method(self):
|
||||
"""Set up test fixtures."""
|
||||
self.validator = CustomValidator("set-git-config")
|
||||
|
||||
def teardown_method(self):
|
||||
"""Clean up after tests."""
|
||||
self.validator.clear_errors()
|
||||
|
||||
def test_validate_inputs_valid(self):
|
||||
"""Test validation with valid inputs."""
|
||||
# TODO: Add specific valid inputs for set-git-config
|
||||
inputs = {}
|
||||
result = self.validator.validate_inputs(inputs)
|
||||
# Adjust assertion based on required inputs
|
||||
assert isinstance(result, bool)
|
||||
|
||||
def test_validate_inputs_invalid(self):
|
||||
"""Test validation with invalid inputs."""
|
||||
# TODO: Add specific invalid inputs for set-git-config
|
||||
inputs = {"invalid_key": "invalid_value"}
|
||||
result = self.validator.validate_inputs(inputs)
|
||||
# Custom validators may have specific validation rules
|
||||
assert isinstance(result, bool)
|
||||
|
||||
def test_required_inputs(self):
|
||||
"""Test required inputs detection."""
|
||||
required = self.validator.get_required_inputs()
|
||||
assert isinstance(required, list)
|
||||
# TODO: Assert specific required inputs for set-git-config
|
||||
|
||||
def test_validation_rules(self):
|
||||
"""Test validation rules."""
|
||||
rules = self.validator.get_validation_rules()
|
||||
assert isinstance(rules, dict)
|
||||
# TODO: Assert specific validation rules for set-git-config
|
||||
|
||||
def test_github_expressions(self):
|
||||
"""Test GitHub expression handling."""
|
||||
inputs = {
|
||||
"test_input": "${{ github.token }}",
|
||||
}
|
||||
result = self.validator.validate_inputs(inputs)
|
||||
assert isinstance(result, bool)
|
||||
# GitHub expressions should generally be accepted
|
||||
|
||||
def test_error_propagation(self):
|
||||
"""Test error propagation from sub-validators."""
|
||||
# Custom validators often use sub-validators
|
||||
# Test that errors are properly propagated
|
||||
inputs = {"test": "value"}
|
||||
self.validator.validate_inputs(inputs)
|
||||
# Check error handling
|
||||
if self.validator.has_errors():
|
||||
assert len(self.validator.errors) > 0
|
||||
@@ -212,6 +212,7 @@ class ConventionBasedValidator(BaseValidator):
|
||||
"format": "report_format",
|
||||
"output_format": "report_format",
|
||||
"report_format": "report_format",
|
||||
"mode": "mode_enum",
|
||||
}
|
||||
return exact_matches.get(name_lower)
|
||||
|
||||
@@ -556,7 +557,7 @@ class ConventionBasedValidator(BaseValidator):
|
||||
return self._validator_modules["codeql"], f"validate_{validator_type}"
|
||||
|
||||
# PHP-specific validators
|
||||
if validator_type in ["php_extensions", "coverage_driver"]:
|
||||
if validator_type in ["php_extensions", "coverage_driver", "mode_enum"]:
|
||||
# Return self for PHP-specific validation methods
|
||||
return self, f"_validate_{validator_type}"
|
||||
|
||||
@@ -637,3 +638,23 @@ class ConventionBasedValidator(BaseValidator):
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
def _validate_mode_enum(self, value: str, input_name: str) -> bool:
|
||||
"""Validate mode enum for linting actions.
|
||||
|
||||
Args:
|
||||
value: The mode value
|
||||
input_name: The input name for error messages
|
||||
|
||||
Returns:
|
||||
True if valid, False otherwise
|
||||
"""
|
||||
valid_modes = ["check", "fix"]
|
||||
|
||||
if value and value not in valid_modes:
|
||||
self.add_error(
|
||||
f"Invalid {input_name}: {value}. Must be one of: {', '.join(valid_modes)}"
|
||||
)
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
Reference in New Issue
Block a user