Cover schema extensions ci (#26)

* Format

* Add a task to load extensions

* Add step in ci pipeline

* Support 3 degrees of dependencies

* Add doc

* Improve CI file

* Add quick example for loading schema

Author: BaptisteGi

.github/workflows/ci.yml

@@ -32,6 +32,7 @@ jobs:
           filters: .github/file-filters.yml
 
   yaml-lint:
+    name: Run yaml lint
     if: needs.files-changed.outputs.yaml == 'true'
     needs: ["files-changed"]
     runs-on: "ubuntu-latest"
@@ -44,7 +45,9 @@ jobs:
       - name: "Linting: yamllint"
         run: "yamllint -s ."
 
-  E2E-testing-invoke-start:
+  # FIXME: This should be triggered only when some YAML schema changes...
+  schema-test:
+    name: Test all schema files
     needs:
       - files-changed
       - yaml-lint
@@ -91,9 +94,8 @@ jobs:
       - name: Test base schema files
         run: invoke load-schema-base
 
-      # NOTE: Doesn't work now
-      # - name: Test experimental schema files
-      #   run: invoke load-schema-experimental
+      - name: Test extensions schema files
+        run: invoke load-schema-extensions
 
       - name: "Clear docker environment and force vmagent to stop"
         if: always()

README.md

@@ -13,6 +13,15 @@ Welcome to the Schema Library for Infrahub! This repository offers a collection
 There are several ways to [load a schema in Infrahub](https://docs.infrahub.app/guides/import-schema):
 
 - Quick View: To take a quick look at a schema, you can use Infrahub CTL. Follow [this guide](https://docs.infrahub.app/infrahubctl) to install Infrahub CTL.
+
+```console
+  # Load the base
+  infrahubctl schema load base
+
+  # Load an extension
+  infrahubctl schema load extensions/location_minimal
+```
+
 - Controlled Integration: For a more organized and unified approach to loading schemas, you can connect a Git repository. Follow [this guide](https://docs.infrahub.app/guides/repository) to connect a Git repository.
 
 > [!NOTE]

tasks.py

@@ -1,40 +1,70 @@
 import os
-
 from pathlib import Path
 
-from invoke import task, Context  # type: ignore
+from invoke import Context, task  # type: ignore
 
 # If no version is indicated, we will take the latest
 VERSION = os.getenv("INFRAHUB_VERSION", None)
 DOCKER_PROJECT = os.getenv("INFRAHUB_BUILD_NAME", "schema-library-ci")
 COMPOSE_COMMAND = f"curl https://infrahub.opsmill.io/{VERSION if VERSION else ''} | sed 's/8000:8000/0:8000/' | docker compose -p {DOCKER_PROJECT} -f -"
 
+
+def _parse_and_load_extensions(
+    context: Context, extensions_path: Path, allowed_to_fail: bool
+) -> None:
+    # Looping over all entries in extensions dir
+    for entry in os.listdir(extensions_path):
+        # Make sure it's a dir
+        # TODO: here if in extensions folder we have a dir without schema it will fail
+        if os.path.isdir(extensions_path / entry):
+            print(f"Loading `{entry}`")
+
+            # Load extensions
+            # TODO: Maybe improve what we return here...
+            context.run(
+                f"infrahubctl schema load {extensions_path / entry}",
+                warn=allowed_to_fail,
+            )
+
+
 @task
 def start(context: Context) -> None:
     context.run(f"{COMPOSE_COMMAND} up -d --wait")
 
+
 @task
-def load_schema_base(context: Context, schema: Path=Path("./base/*.yml")) -> None:
-    context.run(f"infrahubctl schema load {schema}")
+def load_schema_base(context: Context) -> None:
+    base_path = Path("./base")
+    context.run(f"infrahubctl schema load {base_path}")
+
 
 @task
-def load_schema_experimental(context: Context, schema: Path=Path("./experimental/**/*.yml")) -> None:
-    Base=Path("./base/*.yml")
-    context.run(f"infrahubctl schema load {Base}")
-    context.run(f"infrahubctl schema load {schema}")
+def load_schema_extensions(context: Context) -> None:
+    extensions_path = Path("./extensions")
+
+    # FIXME: Find a more efficient way to deal with dependencies that doesn't
+    # require developer to explicitly maintain it
+
+    # First/second loop: here we allow to fail so it will load as much as it can
+    print("Loading all extensions once ...")
+    _parse_and_load_extensions(context, extensions_path, True)
+
+    print("Loading all extensions second time ...")
+    _parse_and_load_extensions(context, extensions_path, True)
+
+    # Third loop: all the dependencies are loaded it MUST work
+    print("Loading all extensions third time ...")
+    _parse_and_load_extensions(context, extensions_path, True)
+
+    # FIXME: If we have 4 degrees of dependencies it won't work
+    print("All good!")
+
 
 @task
 def destroy(context: Context) -> None:
     context.run(f"{COMPOSE_COMMAND} down -v")
 
+
 @task
 def stop(context: Context) -> None:
     context.run(f"{COMPOSE_COMMAND} down")
-
-@task
-def restart(context: Context, component: str="")-> None:
-    if component:
-        context.run(f"{COMPOSE_COMMAND} restart {component}")
-        return
-
-    context.run(f"{COMPOSE_COMMAND} restart")