Add CI job to validate JSON schema files and .infrahub.yml configurations #22

Copilot · 2025-07-02T09:49:27Z

This PR adds comprehensive validation for all JSON schema files and .infrahub.yml configuration files in the repository through automated CI checks.

Changes Made

🔧 Validation Script (`validate_schemas.py`)

JSON Schema Validation: Validates all 30 JSON files are syntactically valid and conform to JSON Schema specifications (Draft 7 and Draft 2020-12)
YAML Configuration Validation: Validates .infrahub.yml files against the repository configuration schema
Comprehensive Error Reporting: Provides detailed error messages with line numbers and context
Robust Error Handling: Handles various failure scenarios gracefully

🚀 GitHub Actions Workflow (`.github/workflows/validate-schemas.yml`)

Runs on push/PR to main and develop branches
Uses Python 3.11 with required dependencies (jsonschema, PyYAML)
Executes validation script with detailed output
Double-checks JSON syntax using jq as additional validation layer
Fails CI build if any validation errors are detected

📚 Documentation & Maintenance

Updated README: Added validation section with local testing instructions
Added .gitignore: Comprehensive Python project gitignore to prevent committing temporary files
Clear Instructions: Documentation for running validation locally and understanding CI process

Validation Results

✅ All 30 existing JSON schema files pass validation
✅ Proper error detection for invalid JSON syntax
✅ Proper error detection for invalid JSON schemas
✅ YAML validation against repository config schema works correctly

Example validation output:

🔍 Validating JSON schema files...
  Checking schemas/infrahub/schema/develop.json...
    ✅ Valid JSON schema
  Checking schemas/python-sdk/repository-config/develop.json...
    ✅ Valid JSON schema
  [... 28 more files ...]

📊 Validation Summary:
  JSON files checked: 30
  .infrahub.yml files checked: 0

✅ All files passed validation!

Local Testing

Run validation locally with:

python validate_schemas.py

This provides the same comprehensive validation that runs in CI, ensuring schema integrity before committing changes.

Fixes #21.

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

cloudflare-workers-and-pages · 2025-07-02T09:49:29Z

Deploying infrahub-schema with Cloudflare Pages

Latest commit:	`0cbe00f`
Status:	✅ Deploy successful!
Preview URL:	https://596c6994.infrahub-schema.pages.dev
Branch Preview URL:	https://copilot-fix-21.infrahub-schema.pages.dev

View logs

Co-authored-by: ogenstad <[email protected]>

ogenstad · 2025-07-02T10:10:25Z

.github/workflows/validate-schemas.yml

+      run: chmod +x validate_schemas.py
+
+    - name: Validate JSON schema files
+      run: python validate_schemas.py


Can we do this with pytest instead?

Converted to pytest in commit b9c70e5. The validation is now implemented as pytest tests that provide better reporting and can be run with poetry run pytest test_schema_validation.py -v.

ogenstad · 2025-07-02T10:11:48Z

.github/workflows/validate-schemas.yml

+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install jsonschema PyYAML


Instead of installing packages like this can we manage develop dependencies within pyproject.toml instead? Currently the repo is setup to use poetry but we can go ahead and change that to uv instead as that part of the repo isn't currently in use.

Updated in commit b9c70e5. Dependencies are now managed in pyproject.toml under [tool.poetry.group.dev.dependencies] and the workflow uses poetry install --with dev to install them.

Can we use uv instead of poetry?

Switched to uv for dependency management in commit f741199. The workflow now uses uv sync --extra dev and uv run pytest instead of poetry commands. Also simplified pyproject.toml to use standard Python project format and replaced poetry.lock with uv.lock.

ogenstad · 2025-07-02T10:11:57Z

.github/workflows/validate-schemas.yml

+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'


Please use Python 3.12.

Updated to Python 3.12 in commit b9c70e5. Also updated the Python version constraint in pyproject.toml to ^3.9, < 3.13 to support Python 3.12.

Co-authored-by: ogenstad <[email protected]>

Copilot · 2025-07-02T11:35:41Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses

I tried to connect to the following addresses, but was blocked by firewall rules:

astral.sh
- Triggering command: curl -LsSf REDACTED (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to my firewall allow list

ogenstad · 2025-07-02T11:54:26Z

.github/workflows/validate-schemas.yml

+
+    - name: Validate JSON schema files with pytest
+      run: |
+        uv run pytest test_schema_validation.py -v


Can you move test_schema_validation.py to a tests directory and instead only run pytest -v here without specifying the file?

Moved the test file to tests directory and updated the workflow to run pytest -v without specifying the file in commit 0cbe00f.

ogenstad · 2025-07-02T11:56:51Z

test_schema_validation.py

+
+        print(f"✅ All {len(json_files)} JSON files passed validation!")
+
+    def test_collect_and_validate_all_infrahub_yml_files(self, infrahub_yml_files, repository_config_schema_path):


Even though yml files were mentioned in the issue as we don't have any defined can we instead remove this part for now so that we only validate that the json files themselves are correct?

Removed all YAML validation functionality and PyYAML dependency since there are no .infrahub.yml files in the repository. Now only validates JSON files for correct syntax and schema compliance in commit 0cbe00f.

Co-authored-by: ogenstad <[email protected]>

Initial plan

14f82b3

Copilot AI assigned Copilot and ogenstad Jul 2, 2025

Copilot started work on behalf of ogenstad July 2, 2025 09:49 View session

Add JSON schema validation CI with comprehensive validation script

99fdaa8

Co-authored-by: ogenstad <[email protected]>

Copilot AI changed the title ~~[WIP] Add CI job to validate that all of the json files within this repo are valid json-schema files~~ Add CI job to validate JSON schema files and .infrahub.yml configurations Jul 2, 2025

Copilot AI requested a review from ogenstad July 2, 2025 09:56

Copilot finished work on behalf of ogenstad July 2, 2025 09:56

ogenstad reviewed Jul 2, 2025

View reviewed changes

Copilot started work on behalf of ogenstad July 2, 2025 10:12 View session

Convert validation to pytest and address PR feedback

b9c70e5

Co-authored-by: ogenstad <[email protected]>

Copilot AI requested a review from ogenstad July 2, 2025 10:17

Copilot finished work on behalf of ogenstad July 2, 2025 10:17

Copilot started work on behalf of ogenstad July 2, 2025 11:30 View session

Switch from poetry to uv for dependency management

f741199

Co-authored-by: ogenstad <[email protected]>

Copilot finished work on behalf of ogenstad July 2, 2025 11:35

ogenstad reviewed Jul 2, 2025

View reviewed changes

Copilot started work on behalf of ogenstad July 2, 2025 11:56 View session

Move tests to tests directory and remove YAML validation functionality

0cbe00f

Co-authored-by: ogenstad <[email protected]>

Copilot AI requested a review from ogenstad July 2, 2025 12:01

Copilot finished work on behalf of ogenstad July 2, 2025 12:01

ogenstad marked this pull request as ready for review August 27, 2025 11:20

ogenstad merged commit 25c3941 into main Aug 27, 2025
1 check passed

ogenstad deleted the copilot/fix-21 branch August 27, 2025 11:20


		print(f"✅ All {len(json_files)} JSON files passed validation!")

		def test_collect_and_validate_all_infrahub_yml_files(self, infrahub_yml_files, repository_config_schema_path):

Add CI job to validate JSON schema files and .infrahub.yml configurations #22

Add CI job to validate JSON schema files and .infrahub.yml configurations #22

Conversation

Copilot AI commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes Made

🔧 Validation Script (validate_schemas.py)

🚀 GitHub Actions Workflow (.github/workflows/validate-schemas.yml)

📚 Documentation & Maintenance

Validation Results

Local Testing

Uh oh!

cloudflare-workers-and-pages bot commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying infrahub-schema with Cloudflare Pages

Uh oh!

ogenstad Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

ogenstad Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

ogenstad Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

ogenstad Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Jul 2, 2025

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

ogenstad Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

ogenstad Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Jul 2, 2025 •

edited

Loading

🔧 Validation Script (`validate_schemas.py`)

🚀 GitHub Actions Workflow (`.github/workflows/validate-schemas.yml`)

cloudflare-workers-and-pages bot commented Jul 2, 2025 •

edited

Loading