feat: testing framework

Author: dotkas

.github/workflows/lint.yml

@@ -14,11 +14,11 @@ permissions:
   contents: read
 
 env:
-  PYTHON_VERSION: "3.14"
-  CSPELL_VERSION: "8.0.0"
-  BLACK_VERSION: "24.10.0"
-  PRETTIER_VERSION: "3.3.3"
-  COMMITLINT_CLI_VERSION: "20.2.0"
+  PYTHON_VERSION: '3.14'
+  CSPELL_VERSION: '8.0.0'
+  BLACK_VERSION: '24.10.0'
+  PRETTIER_VERSION: '3.3.3'
+  COMMITLINT_CLI_VERSION: '20.2.0'
 
 jobs:
   install-commitlint:
@@ -84,33 +84,25 @@ jobs:
       - name: Run Prettier check
         run: ./node_modules/.bin/prettier --check .
 
-  install-black:
+  run-black:
     runs-on: ubuntu-latest
     steps:
       - *checkout-code
 
-      - &create-black-lockfile
-        name: Create Black lockfile
-        run: echo "black==${{ env.BLACK_VERSION }}" > black-requirements.txt
-
-      - &setup-black
-        name: Setup Python
+      - name: Setup Python
         uses: actions/setup-python@v6
         with:
-          cache: "pip"
-          python-version: "${{ env.PYTHON_VERSION }}"
-          cache-dependency-path: black-requirements.txt
+          python-version: '${{ env.PYTHON_VERSION }}'
 
-      - name: Install Black
-        run: pip install -r black-requirements.txt
+      - name: Cache Black
+        uses: actions/cache@v4
+        id: cache-black
+        with:
+          path: ~/.cache/pip
+          key: v1-black-${{ env.BLACK_VERSION }}
 
-  run-black:
-    runs-on: ubuntu-latest
-    needs: install-black
-    steps:
-      - *checkout-code
-      - *create-black-lockfile
-      - *setup-black
+      - name: Install Black
+        run: pip install black==${{ env.BLACK_VERSION }}
 
       - name: Run Black check
         run: black --check .

.github/workflows/test.yml

@@ -0,0 +1,120 @@
+name: Test Actions
+
+on:
+  push:
+    branches-ignore:
+      - main
+  workflow_call:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  PYTHON_VERSION: '3.14'
+
+jobs:
+  python-unit-tests-actions:
+    name: Python Unit Tests (GitHub Actions)
+    runs-on: ubuntu-latest
+    steps:
+      - &checkout-code
+        name: Checkout code
+        uses: actions/checkout@v5
+
+      - &setup-python
+        name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install dependencies
+        working-directory: actions
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Run unit tests
+        working-directory: actions
+        run: python -m unittest discover -s . -p "test_*.py" -v
+
+  python-unit-tests-terraform:
+    name: Python Unit Tests (Terraform)
+    runs-on: ubuntu-latest
+    steps:
+      - *checkout-code
+      - *setup-python
+
+      - name: Run unit tests
+        working-directory: terraform
+        run: python -m unittest discover -s . -p "test_*.py" -v
+
+  test-actions:
+    name: Test GitHub Actions Updater
+    runs-on: ubuntu-latest
+    steps:
+      - *checkout-code
+
+      - name: Test actions updater
+        uses: ./actions
+        with:
+          dry-run: 'true'
+          file-glob: 'actions/test/.github/**/*.yml'
+
+  test-circleci-orbs:
+    name: Test CircleCI Orbs Updater
+    runs-on: ubuntu-latest
+    steps:
+      - *checkout-code
+
+      - name: Test CircleCI orbs updater
+        uses: ./circleci-orbs
+        with:
+          dry-run: 'true'
+          circleci-config-file: 'circleci-orbs/test/.circleci/config.yml'
+
+  test-golang:
+    name: Test Go Dependencies Updater
+    runs-on: ubuntu-latest
+    steps:
+      - *checkout-code
+
+      - name: Setup test fixtures
+        run: |
+          cp golang/test/go.mod .
+          cp golang/test/go.sum .
+
+      - name: Test Go dependencies updater
+        uses: ./golang
+        with:
+          dry-run: 'true'
+
+  test-npm:
+    name: Test NPM Dependencies Updater
+    runs-on: ubuntu-latest
+    steps:
+      - *checkout-code
+
+      - name: Setup test fixtures
+        run: |
+          cp npm/test/package.json .
+          cp npm/test/package-lock.json .
+          cp npm/test/.nvmrc .
+
+      - name: Test NPM dependencies updater
+        uses: ./npm
+        with:
+          dry-run: 'true'
+
+  test-terraform:
+    name: Test Terraform Dependencies Updater
+    runs-on: ubuntu-latest
+    steps:
+      - *checkout-code
+
+      - name: Test Terraform dependencies updater
+        uses: ./terraform
+        with:
+          dry-run: 'true'
+          working-dir: 'terraform/test'
+          var-file-path: 'test.tfvars'

actions/README.md

@@ -37,7 +37,7 @@ python cli.py --root /path/to/repo --file-glob '.github/**/*.yml' --prefixes 'ac
 ## :gear: Inputs
 
 | Input            | Description                                         | Required           | Default                 |
-|------------------|-----------------------------------------------------|--------------------|-------------------------|
+| ---------------- | --------------------------------------------------- | ------------------ | ----------------------- |
 | `base-branch`    | Base branch for the pull request                    | :white_check_mark: | `main`                  |
 | `token`          | GitHub token for authentication                     | :x:                | `${{ github.token }}`   |
 | `branch-prefix`  | Prefix for the update branch                        | :x:                | `update-actions`        |
@@ -52,9 +52,3 @@ python cli.py --root /path/to/repo --file-glob '.github/**/*.yml' --prefixes 'ac
 - Workflow files must be under `.github` and match the configured `file-glob`
 - The action requires write permissions to create branches and pull requests
 - GitHub CLI must be available in the runner environment
-
-## :test_tube: Tests
-
-```bash
-python -m unittest discover -s tests
-```

actions/action.yml

@@ -43,10 +43,16 @@ inputs:
     description: 'Whether a successful PR should be automatically merged'
     default: 'false'
 
+  dry-run:
+    required: false
+    description: 'Run without creating a PR (for testing purposes)'
+    default: 'false'
+
 runs:
   using: 'composite'
   steps:
     - name: Checkout and setup
+      if: inputs.dry-run != 'true'
       uses: alchemaxinc/composite-toolbox/checkout-and-setup@v1
       with:
         token: ${{ inputs.token }}
@@ -75,13 +81,14 @@ runs:
 
     - name: Check for changes
       id: check_changes
+      if: inputs.dry-run != 'true'
       uses: alchemaxinc/composite-toolbox/check-changes@v1
       with:
         files: '.github'
 
     - name: Create Pull Request
       id: open-pr
-      if: steps.check_changes.outputs.has_changes == 'true'
+      if: inputs.dry-run != 'true' && steps.check_changes.outputs.has_changes == 'true'
       uses: alchemaxinc/composite-toolbox/create-pr@v1
       with:
         token: ${{ inputs.token }}
@@ -113,7 +120,7 @@ runs:
           *Generated by the GitHub Actions Update action* :sparkles:
 
     - name: Auto-merge Pull Request
-      if: inputs.auto-merge == 'true' && steps.open-pr.outcome == 'success'
+      if: inputs.dry-run != 'true' && inputs.auto-merge == 'true' && steps.open-pr.outcome == 'success'
       uses: alchemaxinc/composite-toolbox/merge-pr@v1
       with:
         token: ${{ inputs.token }}

actions/requirements.txt

@@ -1,2 +1,2 @@
-PyYAML==6.0.1
+ruamel.yaml==0.18.5
 semver==3.0.2

actions/test/.github/workflows/test-workflow.yml

@@ -0,0 +1,9 @@
+name: Test Workflow
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3

actions/update_actions/scanner.py

@@ -1,15 +1,14 @@
 from __future__ import annotations
 
-import re
 import sys
+from io import StringIO
 from pathlib import Path
 
-import yaml
-
-USES_PATTERN = re.compile(r"(^\s*-?\s*uses:\s*)([^@\s]+)@([^\s#]+)", re.MULTILINE)
+from ruamel.yaml import YAML
 
 
 def find_uses(obj) -> list[str]:
+    """Recursively find all 'uses' values in a YAML structure."""
     found = []
     if isinstance(obj, dict):
         if isinstance(obj.get("steps"), list):
@@ -24,10 +23,45 @@ def find_uses(obj) -> list[str]:
     return found
 
 
+def update_uses_in_structure(obj, upgrades: dict[tuple[str, str], str]) -> bool:
+    """
+    Recursively update 'uses' values in a YAML structure.
+    Returns True if any updates were made.
+    """
+    updated = False
+    if isinstance(obj, dict):
+        if isinstance(obj.get("steps"), list):
+            for step in obj["steps"]:
+                if isinstance(step, dict) and isinstance(step.get("uses"), str):
+                    use = step["uses"]
+                    if "@" in use:
+                        repo, tag = use.split("@", 1)
+                        new_tag = upgrades.get((repo, tag))
+                        if new_tag:
+                            step["uses"] = f"{repo}@{new_tag}"
+                            updated = True
+        for value in obj.values():
+            if update_uses_in_structure(value, upgrades):
+                updated = True
+    elif isinstance(obj, list):
+        for item in obj:
+            if update_uses_in_structure(item, upgrades):
+                updated = True
+    return updated
+
+
 def find_uses_in_file(path: Path) -> tuple[list[str], str]:
+    """Parse a YAML file and find all 'uses' entries."""
     text = path.read_text(encoding="utf-8")
+    yaml = YAML()
+    yaml.preserve_quotes = True
+    yaml.default_flow_style = False
+    yaml.map_indent = 2
+    yaml.sequence_indent = 4
+    yaml.sequence_dash_offset = 2
+
     try:
-        docs = list(yaml.safe_load_all(text))
+        docs = list(yaml.load_all(text))
     except Exception as exc:
         print(
             f"::warning file={path}::Failed to parse YAML: {exc}",
@@ -44,17 +78,42 @@ def find_uses_in_file(path: Path) -> tuple[list[str], str]:
 
 
 def collect_workflow_files(root: Path, file_glob: str) -> list[Path]:
+    """Collect all workflow files matching the glob pattern."""
     return sorted(root.glob(file_glob))
 
 
 def apply_updates(text: str, upgrades: dict[tuple[str, str], str]) -> str:
-    def replace_match(match):
-        repo = match.group(2)
-        tag = match.group(3)
+    """
+    Apply updates to a YAML workflow file using ruamel.yaml.
+    This preserves formatting and comments.
+    """
+    yaml = YAML()
+    yaml.preserve_quotes = True
+    yaml.default_flow_style = False
+    yaml.map_indent = 2
+    yaml.sequence_indent = 4
+    yaml.sequence_dash_offset = 2
+
+    try:
+        docs = list(yaml.load_all(text))
+    except Exception:
+        # If parsing fails, return original text unchanged
+        return text
+
+    # Check if any updates are needed
+    any_updates = False
+    for doc in docs:
+        if doc is not None and update_uses_in_structure(doc, upgrades):
+            any_updates = True
+
+    if not any_updates:
+        return text
 
-        new_tag = upgrades.get((repo, tag))
-        if new_tag:
-            return f"{match.group(1)}{repo}@{new_tag}"
-        return match.group(0)
+    # Write back with preserved formatting
+    output = StringIO()
+    if len(docs) == 1:
+        yaml.dump(docs[0], output)
+    else:
+        yaml.dump_all(docs, output)
 
-    return USES_PATTERN.sub(replace_match, text)
+    return output.getvalue()