Skip to content

check_config_sync.md

Latest commit

 

History

History
128 lines (87 loc) · 4.47 KB

check_config_sync.md

File metadata and controls

128 lines (87 loc) · 4.47 KB

check_config_sync.py

Config-code sync checker for Autohive integrations.

Requires: Python 3.13+

Overview

This script validates that the config.json file and the integration's Python code are in sync. It scans all .py files in the integration directory (not just the entry point), supporting modular integrations where action handlers are split across multiple files. It uses AST (Abstract Syntax Tree) parsing to extract @action decorators and inputs access patterns from the code, then cross-validates them against the actions and input schemas declared in config.json.

Usage

python scripts/check_config_sync.py <dir> [dir ...]

Arguments

Argument Required Description
dir Yes (one or more) Path to an integration directory to check

Exit Codes

Code Meaning
0 Config and code are in sync
1 One or more sync errors found
2 An error occurred during processing (missing files, parse error, usage error)

Checks Performed

The script performs five checks:

1. Action Existence

Verifies that every action declared in config.json has a corresponding @action-decorated function in the code, and vice versa.

  • Config-only actions: declared in config.json but no matching @action decorator in the code
  • Code-only actions: decorated with @action in the code but not listed in config.json

2. Input Parameter Coverage

Checks that every input parameter defined in the config.json schema for an action is actually accessed in the corresponding function's code.

  • Detects dead schema fields that are declared but never used

3. Code Parameter Coverage

Checks that every inputs key accessed in the code has a corresponding entry in the config.json schema.

  • Detects undocumented parameters that are used in code but missing from the config

4. Required/Optional Consistency

Validates that the required/optional status of parameters in config.json matches how they are accessed in the code (e.g., parameters accessed with .get() or default values should be optional).

5. Action Name Matching

Ensures that action names in config.json exactly match the decorator arguments or function names used in the code, catching typos and naming drift.

How It Works

flowchart TD
    A[Read config.json] --> B[Parse actions and input schemas]
    B --> C[Find all .py files in integration dir]
    C --> D[Parse each file with AST]
    D --> E[Extract @action decorators]
    D --> F[Extract inputs access patterns]
    E --> G{Actions match?}
    G -->|Mismatch| H[Record errors]
    G -->|Match| I{Input params match?}
    F --> I
    B --> I
    I -->|Mismatch| H
    I -->|Match| J{All checks passed?}
    H --> J
    J -->|No| K[Print report, exit 1]
    J -->|Yes| L[Exit 0]
Loading

Step-by-Step

  1. Read config.json and extract declared actions and their input schemas
  2. Scan all .py files in the integration directory (supporting modular layouts)
  3. Parse each file into an Abstract Syntax Tree (no code execution)
  4. Extract @action decorator names and inputs key access patterns from the AST
  5. Compare actions between config and code — report any mismatches
  6. Compare input parameters for each action — report undocumented, dead, or mismatched fields
  7. Report all errors and warnings

Output Format

🔗 Checking config-code sync...
   ✅ Config-code sync OK

On failure:

🔗 Checking config-code sync...
   ⚠️ Action 'send_email' in config.json but not found in code
   ❌ Input 'recipient' declared in config.json but never accessed in code
   ❌ Input 'priority' accessed in code but missing from config.json schema

   ❌ Config-code sync errors found

   Fix: Ensure config.json actions and input schemas match the code
   Run locally: python scripts/check_config_sync.py <dir>

Dependencies

  • Python 3.13+ — for ast, json, and pathlib standard library modules

No external dependencies are required. The script uses only Python's standard library.

Integration with CI

This script is called by check_code.py as the final check step (step 9). It runs after all other quality checks have passed. It is also exercised independently by the self-test.yml workflow against test examples in tests/examples/.

# Called internally by check_code.py:
from check_config_sync import check_config_sync
check_config_sync(str(dir_path))