Update examples

Author: minitriga

infrahub_sdk/ctl/example_repo/README.md

@@ -1,11 +1,34 @@
-# Infrahub Repository Template
+# Infrahub Repository
 
-This template allows you to initialize a repository that conforms to Opsmills best practices when organising a repository to be imported into Infrahub.
+Welcome! This repository was initialized via the `infrahubctl repo init` command. That bootstraps a repository for use with some example data.
 
-To use this template simply install the `infrahub-sdk[ctl]` package and run the following:
+## Installation
+Running `poetry install` will install all the main dependencies you need to interact with this repository.
 
-```shell
-infrahubctl repository init /path/to/folder
+## Starting Infrahub
+
+Included in the repository are a set of helper commands to get Infrahub up and running using `invoke`.
+
+```bash
+Available tasks:
+
+  destroy                 Stop and remove containers, networks, and volumes.
+  download-compose-file   Download docker-compose.yml from InfraHub if missing or override is True.
+  load-schema             Load schemas into InfraHub using infrahubctl.
+  restart                 Restart all services or a specific one using docker-compose.
+  start                   Start the services using docker-compose in detached mode.
+  stop                    Stop containers and remove networks.
+  test                    Run tests using pytest.
+```
+
+To start infrahub simply use `invoke start`
+
+## Tests
+By default there are some integration tests that will spin up Infrahub and its dependencies in docker and load the repository and schema. This can be run using the following:
+
+```bash
+poetry install --with=dev
+pytest tests/integration
 ```
 
-You will be prompted with several options.
+To change the version of infrahub being used you can use an environment variable: `export INFRAHUB_TESTING_IMAGE_VERSION=1.2.5`.

infrahub_sdk/ctl/example_repo/pyproject.toml.jinja

@@ -13,14 +13,15 @@ package-mode = false
 {% endif %}
 
 [tool.poetry.dependencies]
-python = ">=3.9,<3.13"
-infrahub-sdk = {extras = ["ctl"], version = "^1.7.2"}
+python = ">=3.9,<=3.13.1"
+infrahub-sdk = { extras = ["all"], version = "*" }
+invoke = "*"
 
 [tool.poetry.group.dev.dependencies]
-ruff = "^0.9.10"
-pytest = "^8.3.5"
-infrahub-testcontainers = "^1.1.8"
-pytest-asyncio = "^0.25.3"
+ruff = "*"
+pytest = "*"
+infrahub-testcontainers = "*"
+pytest-asyncio = "*"
 
 [build-system]
 requires = ["poetry-core"]

infrahub_sdk/ctl/example_repo/tasks.py

@@ -0,0 +1,82 @@
+from invoke import Context, task
+from pathlib import Path
+import httpx
+import os
+
+# If no version is indicated, we will take the latest
+VERSION = os.getenv("INFRAHUB_IMAGE_VER", None)
+
+
+@task
+def start(context: Context) -> None:
+    """
+    Start the services using docker-compose in detached mode.
+    """
+    compose_file = download_compose_file(context, override=False)
+    context.run("docker compose up -d")
+
+
+@task
+def destroy(context: Context) -> None:
+    """
+    Stop and remove containers, networks, and volumes.
+    """
+    compose_file = download_compose_file(context, override=False)
+    context.run("docker compose down -v")
+
+
+@task
+def stop(context: Context) -> None:
+    """
+    Stop containers and remove networks.
+    """
+    compose_file = download_compose_file(context, override=False)
+    context.run("docker compose down")
+
+
+@task(help={"component": "Optional name of a specific service to restart."})
+def restart(context: Context, component: str = "") -> None:
+    """
+    Restart all services or a specific one using docker-compose.
+    """
+    download_compose_file(context, override=False)
+    if component:
+        context.run(f"docker compose restart {component}")
+        return
+
+    context.run("docker compose restart")
+
+
+@task
+def load_schema(ctx: Context):
+    """
+    Load schemas into InfraHub using infrahubctl.
+    """
+    ctx.run("infrahubctl schema load schemas")
+
+
+@task
+def test(ctx: Context):
+    """
+    Run tests using pytest.
+    """
+    ctx.run("pytest tests")
+
+
+@task(help={"override": "Redownload the compose file even if it already exists."})
+def download_compose_file(context: Context, override: bool = False) -> Path:
+    """
+    Download docker-compose.yml from InfraHub if missing or override is True.
+    """
+    compose_file = Path("./docker-compose.yml")
+
+    if compose_file.exists() and not override:
+        return compose_file
+
+    response = httpx.get("https://infrahub.opsmill.io")
+    response.raise_for_status()
+
+    with compose_file.open("w") as f:
+        f.write(response.content.decode())
+
+    return compose_file

infrahub_sdk/ctl/example_repo/{% if package_mode %}lib{% endif %}/example.py

@@ -0,0 +1,9 @@
+from infrahub_sdk import InfrahubClient
+from infrahub_sdk.node import InfrahubNode
+from typing import List
+import logging
+
+
+def print_nodes(client: InfrahubClient, log: logging.Logger, nodes: List[InfrahubNode]):
+    for node in nodes.keys():
+        log.info(f"{node} present.")

infrahub_sdk/ctl/example_repo/{% if scripts %}scripts{% endif %}/example_script.py

@@ -0,0 +1,14 @@
+import logging
+
+from infrahub_sdk import InfrahubClient
+from lib.example import print_nodes
+
+
+async def run(
+    client: InfrahubClient,
+    log: logging.Logger,
+    branch: str,
+):
+    log.info("Running example script...")
+    nodes = await client.schema.all()
+    print_nodes(client, log, nodes)

infrahub_sdk/ctl/example_repo/{% if tests %}tests{% endif %}/integration/conftest.py

@@ -17,10 +17,10 @@ def root_directory() -> Path:
 
 @pytest.fixture
 def schemas_directory(root_directory: Path) -> Path:
-    return root_directory / "schema"
+    return root_directory / "schemas"
 
 
 @pytest.fixture
 def schemas(schemas_directory: Path) -> list[dict[str, Any]]:
     schema_files = SchemaFile.load_from_disk(paths=[schemas_directory])
-    return [item.content for item in schema_files if item.content]
+    return [item.content for item in schema_files if item.content]

infrahub_sdk/ctl/example_repo/{% if tests %}tests{% endif %}/integration/test_infrahub.py

@@ -7,18 +7,34 @@
 
 
 class TestInfrahub(TestInfrahubDockerClient):
-    @pytest.fixture(scope="class")
-    def infrahub_version(self) -> str:
-        """Required to define the version of infrahub to use."""
-        return "1.1.8"
-
     @pytest.mark.asyncio
-    async def test_load_schema(
-        self, default_branch: str, client: InfrahubClient, schemas
-    ):
+    async def test_load_schema(self, default_branch: str, client: InfrahubClient, schemas):
         await client.schema.wait_until_converged(branch=default_branch)
 
-        resp = await client.schema.load(
-            schemas=schemas, branch=default_branch, wait_until_converged=True
-        )
+        resp = await client.schema.load(schemas=schemas, branch=default_branch, wait_until_converged=True)
         assert resp.errors == {}
+
+    @pytest.mark.asyncio
+    async def test_load_repository(
+        self,
+        client: InfrahubClient,
+        remote_repos_dir: Path,
+        root_directory: Path,
+    ) -> None:
+        """Add the local directory as a repository in Infrahub and wait for the import to be complete"""
+
+        repo = GitRepo(
+            name="local-repository",
+            src_directory=root_directory,
+            dst_directory=remote_repos_dir,
+        )
+        await repo.add_to_infrahub(client=client)
+        in_sync = await repo.wait_for_sync_to_complete(client=client)
+        assert in_sync
+
+        repos = await client.all(kind=CoreGenericRepository)
+
+        ### A breakpoint can be added to pause the tests from running and keep the test containers active
+        # breakpoint()
+
+        assert repos