Merge pull request #509 from opsmill/develop

ogenstad · web-flow · commit 1359a2d7697a · 2025-08-26T08:54:43.000+02:00
Merge 'develop' into 'stable' for SDK 1.14 &amp; Infrahub 1.4
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -46,7 +46,7 @@ jobs:
       github_workflows: ${{ steps.changes.outputs.github_workflows }}
     steps:
       - name: "Check out repository code"
-        uses: "actions/checkout@v4"
+        uses: "actions/checkout@v5"
       - name: Check for file changes
         uses: dorny/paths-filter@v3
         id: changes
@@ -63,7 +63,7 @@ jobs:
     timeout-minutes: 5
     steps:
       - name: "Check out repository code"
-        uses: "actions/checkout@v4"
+        uses: "actions/checkout@v5"
       - name: "Setup environment"
         run: "pip install yamllint==1.35.1"
       - name: "Linting: yamllint"
@@ -76,7 +76,7 @@ jobs:
     timeout-minutes: 5
     steps:
       - name: "Check out repository code"
-        uses: "actions/checkout@v4"
+        uses: "actions/checkout@v5"
       - name: "Setup environment"
         run: "pip install ruff==0.11.0"
       - name: "Linting: ruff check"
@@ -94,7 +94,7 @@ jobs:
     timeout-minutes: 5
     steps:
       - name: "Check out repository code"
-        uses: "actions/checkout@v4"
+        uses: "actions/checkout@v5"
       - name: "Linting: markdownlint"
         uses: DavidAnson/markdownlint-cli2-action@v20
         with:
@@ -110,7 +110,7 @@ jobs:
     timeout-minutes: 5
     steps:
       - name: "Check out repository code"
-        uses: "actions/checkout@v4"
+        uses: "actions/checkout@v5"
       - name: Check workflow files
         run: |
           bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash)
@@ -134,7 +134,7 @@ jobs:
     timeout-minutes: 5
     steps:
       - name: "Check out repository code"
-        uses: "actions/checkout@v4"
+        uses: "actions/checkout@v5"
         with:
           submodules: true
       - name: Install NodeJS
@@ -161,7 +161,7 @@ jobs:
     timeout-minutes: 5
     steps:
       - name: "Check out repository code"
-        uses: "actions/checkout@v4"
+        uses: "actions/checkout@v5"
         with:
           submodules: true
       - name: Set up Python
@@ -190,7 +190,7 @@ jobs:
     timeout-minutes: 5
     steps:
       - name: "Check out repository code"
-        uses: "actions/checkout@v4"
+        uses: "actions/checkout@v5"
         with:
           submodules: true
 
@@ -227,7 +227,7 @@ jobs:
     timeout-minutes: 30
     steps:
       - name: "Check out repository code"
-        uses: "actions/checkout@v4"
+        uses: "actions/checkout@v5"
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
@@ -276,7 +276,7 @@ jobs:
     timeout-minutes: 30
     steps:
       - name: "Check out repository code"
-        uses: "actions/checkout@v4"
+        uses: "actions/checkout@v5"
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
@@ -316,14 +316,14 @@ jobs:
   #   timeout-minutes: 30
   #   steps:
   #     - name: "Check out repository code"
-  #       uses: "actions/checkout@v4"
+  #       uses: "actions/checkout@v5"
 
   #     - name: "Extract target branch name"
   #       id: extract_branch
   #       run: echo "TARGET_BRANCH=${{ github.base_ref }}" >> $GITHUB_ENV
 
   #     - name: "Checkout infrahub repository"
-  #       uses: "actions/checkout@v4"
+  #       uses: "actions/checkout@v5"
   #       with:
   #         repository: "opsmill/infrahub"
   #         path: "infrahub-server"
diff --git a/.github/workflows/labels.yml b/.github/workflows/labels.yml
@@ -17,7 +17,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       -
         name: Run Labeler
         uses: crazy-max/ghaction-github-labeler@v5
diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml
@@ -50,7 +50,7 @@ jobs:
           installer-parallel: true
 
       - name: "Check out repository code"
-        uses: "actions/checkout@v4"
+        uses: "actions/checkout@v5"
         with:
           submodules: true
 
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -21,7 +21,7 @@ jobs:
       latest_tag: ${{ steps.release.outputs.latest_tag }}
     steps:
       - name: "Check out repository code"
-        uses: "actions/checkout@v4"
+        uses: "actions/checkout@v5"
         with:
           submodules: true
 
diff --git a/.github/workflows/repository-dispatch.yml b/.github/workflows/repository-dispatch.yml
@@ -42,7 +42,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Repository Dispatch
         uses: peter-evans/repository-dispatch@v3
diff --git a/.github/workflows/sync-docs.yml b/.github/workflows/sync-docs.yml
@@ -16,12 +16,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout source repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           path: source-repo
 
       - name: Checkout target repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           repository: opsmill/infrahub-docs
           token: ${{ secrets.PAT_TOKEN }}
diff --git a/.github/workflows/update-submodule.yml b/.github/workflows/update-submodule.yml
@@ -33,7 +33,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Trigger submodule update
         run: |
diff --git a/changelog/466.added.md b/changelog/466.added.md
@@ -0,0 +1 @@
+Added `infrahubctl repository init` command to allow the initialization of an Infrahub repository using [infrahub-template](https://github.com/opsmill/infrahub-template).
diff --git a/docs/docs/infrahubctl/infrahubctl-repository.mdx b/docs/docs/infrahubctl/infrahubctl-repository.mdx
@@ -19,6 +19,7 @@ $ infrahubctl repository [OPTIONS] COMMAND [ARGS]...
 **Commands**:
 
 * `add`: Add a new repository.
+* `init`: Initialize a new Infrahub repository.
 * `list`
 
 ## `infrahubctl repository add`
@@ -47,6 +48,29 @@ $ infrahubctl repository add [OPTIONS] NAME LOCATION
 * `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
 * `--help`: Show this message and exit.
 
+## `infrahubctl repository init`
+
+Initialize a new Infrahub repository.
+
+**Usage**:
+
+```console
+$ infrahubctl repository init [OPTIONS] DIRECTORY
+```
+
+**Arguments**:
+
+* `DIRECTORY`: Directory path for the new project.  [required]
+
+**Options**:
+
+* `--template TEXT`: Template to use for the new repository. Can be a local path or a git repository URL.  [default: https://github.com/opsmill/infrahub-template.git]
+* `--data PATH`: Path to YAML file containing answers to CLI prompt.
+* `--vcs-ref TEXT`: VCS reference to use for the template. Defaults to HEAD.  [default: HEAD]
+* `--trust / --no-trust`: Trust the template repository. If set, the template will be cloned without verification.  [default: no-trust]
+* `--config-file TEXT`: [env var: INFRAHUBCTL_CONFIG; default: infrahubctl.toml]
+* `--help`: Show this message and exit.
+
 ## `infrahubctl repository list`
 
 **Usage**:
diff --git a/infrahub_sdk/ctl/repository.py b/infrahub_sdk/ctl/repository.py
@@ -1,10 +1,12 @@
 from __future__ import annotations
 
+import asyncio
 from pathlib import Path
 from typing import Optional
 
 import typer
 import yaml
+from copier import run_copy
 from pydantic import ValidationError
 from rich.console import Console
 from rich.table import Table
@@ -165,3 +167,52 @@ async def list(
         )
 
     console.print(table)
+
+
+@app.command()
+async def init(
+    directory: Path = typer.Argument(help="Directory path for the new project."),
+    template: str = typer.Option(
+        default="https://github.com/opsmill/infrahub-template.git",
+        help="Template to use for the new repository. Can be a local path or a git repository URL.",
+    ),
+    data: Optional[Path] = typer.Option(default=None, help="Path to YAML file containing answers to CLI prompt."),
+    vcs_ref: Optional[str] = typer.Option(
+        default="HEAD",
+        help="VCS reference to use for the template. Defaults to HEAD.",
+    ),
+    trust: Optional[bool] = typer.Option(
+        default=False,
+        help="Trust the template repository. If set, the template will be cloned without verification.",
+    ),
+    _: str = CONFIG_PARAM,
+) -> None:
+    """Initialize a new Infrahub repository."""
+
+    config_data = None
+    if data:
+        try:
+            with Path.open(data, encoding="utf-8") as file:
+                config_data = yaml.safe_load(file)
+            typer.echo(f"Loaded config: {config_data}")
+        except Exception as exc:
+            typer.echo(f"Error loading YAML file: {exc}", err=True)
+            raise typer.Exit(code=1)
+
+    # Allow template to be a local path or a URL
+    template_source = template or ""
+    if template and Path(template).exists():
+        template_source = str(Path(template).resolve())
+
+    try:
+        await asyncio.to_thread(
+            run_copy,
+            template_source,
+            str(directory),
+            data=config_data,
+            vcs_ref=vcs_ref,
+            unsafe=trust,
+        )
+    except Exception as e:
+        typer.echo(f"Error running copier: {e}", err=True)
+        raise typer.Exit(code=1)
diff --git a/infrahub_sdk/ctl/schema.py b/infrahub_sdk/ctl/schema.py
@@ -36,7 +36,7 @@ def validate_schema_content_and_exit(client: InfrahubClient, schemas: list[Schem
     has_error: bool = False
     for schema_file in schemas:
         try:
-            client.schema.validate(data=schema_file.content)
+            client.schema.validate(data=schema_file.payload)
         except ValidationError as exc:
             console.print(f"[red]Schema not valid, found '{len(exc.errors())}' error(s) in {schema_file.location}")
             has_error = True
@@ -48,7 +48,7 @@ def validate_schema_content_and_exit(client: InfrahubClient, schemas: list[Schem
         raise typer.Exit(1)
 
 
-def display_schema_load_errors(response: dict[str, Any], schemas_data: list[dict]) -> None:
+def display_schema_load_errors(response: dict[str, Any], schemas_data: list[SchemaFile]) -> None:
     console.print("[red]Unable to load the schema:")
     if "detail" not in response:
         handle_non_detail_errors(response=response)
@@ -87,7 +87,7 @@ def handle_non_detail_errors(response: dict[str, Any]) -> None:
     if "error" in response:
         console.print(f"  {response.get('error')}")
     elif "errors" in response:
-        for error in response.get("errors"):
+        for error in response["errors"]:
             console.print(f"  {error.get('message')}")
     else:
         console.print(f"  '{response}'")
@@ -97,9 +97,9 @@ def valid_error_path(loc_path: list[Any]) -> bool:
     return len(loc_path) >= 6 and loc_path[0] == "body" and loc_path[1] == "schemas"
 
 
-def get_node(schemas_data: list[dict], schema_index: int, node_index: int) -> dict | None:
-    if schema_index < len(schemas_data) and node_index < len(schemas_data[schema_index].content["nodes"]):
-        return schemas_data[schema_index].content["nodes"][node_index]
+def get_node(schemas_data: list[SchemaFile], schema_index: int, node_index: int) -> dict | None:
+    if schema_index < len(schemas_data) and node_index < len(schemas_data[schema_index].payload["nodes"]):
+        return schemas_data[schema_index].payload["nodes"][node_index]
     return None
 
 
@@ -122,7 +122,7 @@ async def load(
     validate_schema_content_and_exit(client=client, schemas=schemas_data)
 
     start_time = time.time()
-    response = await client.schema.load(schemas=[item.content for item in schemas_data], branch=branch)
+    response = await client.schema.load(schemas=[item.payload for item in schemas_data], branch=branch)
     loading_time = time.time() - start_time
 
     if response.errors:
@@ -170,10 +170,10 @@ async def check(
     client = initialize_client()
     validate_schema_content_and_exit(client=client, schemas=schemas_data)
 
-    success, response = await client.schema.check(schemas=[item.content for item in schemas_data], branch=branch)
+    success, response = await client.schema.check(schemas=[item.payload for item in schemas_data], branch=branch)
 
     if not success:
-        display_schema_load_errors(response=response, schemas_data=schemas_data)
+        display_schema_load_errors(response=response or {}, schemas_data=schemas_data)
     else:
         for schema_file in schemas_data:
             console.print(f"[green] schema '{schema_file.location}' is Valid!")
diff --git a/infrahub_sdk/pytest_plugin/items/graphql_query.py b/infrahub_sdk/pytest_plugin/items/graphql_query.py
@@ -16,7 +16,7 @@
 
 class InfrahubGraphQLQueryItem(InfrahubItem):
     def validate_resource_config(self) -> None:
-        # Resource name does not need to match against infrahub repo config
+        # Resource name does not need to match against Infrahub repository configuration
         return
 
     def execute_query(self) -> Any:
diff --git a/infrahub_sdk/schema/repository.py b/infrahub_sdk/schema/repository.py
@@ -24,7 +24,7 @@
 
 
 class InfrahubRepositoryConfigElement(BaseModel):
-    """Class to regroup all elements of the infrahub configuration for a repository for typing purpose."""
+    """Class to regroup all elements of the Infrahub configuration for a repository for typing purpose."""
 
 
 class InfrahubRepositoryArtifactDefinitionConfig(InfrahubRepositoryConfigElement):
diff --git a/infrahub_sdk/testing/docker.py b/infrahub_sdk/testing/docker.py
@@ -13,7 +13,7 @@
 
 def skip_version(min_infrahub_version: str | None = None, max_infrahub_version: str | None = None) -> bool:
     """
-    Check if a test should be skipped depending on infrahub version.
+    Check if a test should be skipped depending on Infrahub version.
     """
     if INFRAHUB_VERSION is None:
         return True
diff --git a/infrahub_sdk/utils.py b/infrahub_sdk/utils.py
@@ -95,7 +95,7 @@ def decode_json(response: httpx.Response) -> dict:
     try:
         return response.json()
     except json.decoder.JSONDecodeError as exc:
-        raise JsonDecodeError(content=response.text, url=response.url) from exc
+        raise JsonDecodeError(content=response.text, url=str(response.url)) from exc
 
 
 def generate_uuid() -> str:
@@ -232,7 +232,7 @@ def get_branch(branch: str | None = None, directory: str | Path = ".") -> str:
     if branch:
         return branch
 
-    repo = GitRepoManager(directory)
+    repo = GitRepoManager(root_directory=str(directory))
     return str(repo.active_branch)
 
 
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/tests/integration/test_infrahub_client.py b/tests/integration/test_infrahub_client.py
diff --git a/tests/unit/ctl/test_repository_app.py b/tests/unit/ctl/test_repository_app.py
diff --git a/tests/unit/sdk/test_topological_sort.py b/tests/unit/sdk/test_topological_sort.py

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ jobs:`
`17`	`17`	`steps:`
`18`	`18`	`-`
`19`	`19`	`name: Checkout`
`20`		`- uses: actions/checkout@v4`
	`20`	`+ uses: actions/checkout@v5`
`21`	`21`	`-`
`22`	`22`	`name: Run Labeler`
`23`	`23`	`uses: crazy-max/ghaction-github-labeler@v5`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Added `infrahubctl repository init` command to allow the initialization of an Infrahub repository using [infrahub-template](https://github.com/opsmill/infrahub-template).