infrahub-server 1.1.6__py3-none-any.whl → 1.1.8__py3-none-any.whl

infrahub_sdk/client.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import asyncio
 import copy
 import logging
+import time
 from collections.abc import Coroutine, MutableMapping
 from functools import wraps
 from time import sleep
@@ -38,6 +39,7 @@ from .exceptions import (
     NodeNotFoundError,
     ServerNotReachableError,
     ServerNotResponsiveError,
+    URLNotFoundError,
 )
 from .graphql import Mutation, Query
 from .node import (
@@ -878,7 +880,8 @@ class InfrahubClient(BaseClient):
 
         retry = True
         resp = None
-        while retry:
+        start_time = time.time()
+        while retry and time.time() - start_time < self.config.max_retry_duration:
             retry = self.retry_on_failure
             try:
                 resp = await self._post(url=url, payload=payload, headers=headers, timeout=timeout)
@@ -902,6 +905,8 @@ class InfrahubClient(BaseClient):
                     errors = response.get("errors", [])
                     messages = [error.get("message") for error in errors]
                     raise AuthenticationError(" | ".join(messages)) from exc
+                if exc.response.status_code == 404:
+                    raise URLNotFoundError(url=url)
 
         if not resp:
             raise Error("Unexpected situation, resp hasn't been initialized.")
@@ -1613,7 +1618,8 @@ class InfrahubClientSync(BaseClient):
 
         retry = True
         resp = None
-        while retry:
+        start_time = time.time()
+        while retry and time.time() - start_time < self.config.max_retry_duration:
             retry = self.retry_on_failure
             try:
                 resp = self._post(url=url, payload=payload, headers=headers, timeout=timeout)
@@ -1637,6 +1643,8 @@ class InfrahubClientSync(BaseClient):
                     errors = response.get("errors", [])
                     messages = [error.get("message") for error in errors]
                     raise AuthenticationError(" | ".join(messages)) from exc
+                if exc.response.status_code == 404:
+                    raise URLNotFoundError(url=url)
 
         if not resp:
             raise Error("Unexpected situation, resp hasn't been initialized.")

infrahub_sdk/config.py

@@ -56,6 +56,9 @@ class ConfigBase(BaseSettings):
     pagination_size: int = Field(default=50, description="Page size for queries to the server")
     retry_delay: int = Field(default=5, description="Number of seconds to wait until attempting a retry.")
     retry_on_failure: bool = Field(default=False, description="Retry operation in case of failure")
+    max_retry_duration: int = Field(
+        default=300, description="Maximum duration until we stop attempting to retry if enabled."
+    )
     schema_converge_timeout: int = Field(
         default=60, description="Number of seconds to wait for schema to have converged"
     )

infrahub_sdk/ctl/check.py

@@ -5,7 +5,7 @@ import sys
 from asyncio import run as aiorun
 from dataclasses import dataclass
 from pathlib import Path
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Optional
 
 import typer
 from rich.console import Console
@@ -50,8 +50,8 @@ def run(
     format_json: bool,
     list_available: bool,
     variables: dict[str, str],
-    name: str | None = None,
-    branch: str | None = None,
+    name: Optional[str] = None,
+    branch: Optional[str] = None,
 ) -> None:
     """Locate and execute all checks under the defined path."""
 

infrahub_sdk/ctl/cli_commands.py

@@ -7,7 +7,7 @@ import logging
 import platform
 import sys
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Callable
+from typing import TYPE_CHECKING, Any, Callable, Optional
 
 import jinja2
 import typer
@@ -74,13 +74,13 @@ console = Console()
 @catch_exception(console=console)
 def check(
     check_name: str = typer.Argument(default="", help="Name of the Python check"),
-    branch: str | None = None,
+    branch: Optional[str] = None,
     path: str = typer.Option(".", help="Root directory"),
     debug: bool = False,
     format_json: bool = False,
     _: str = CONFIG_PARAM,
     list_available: bool = typer.Option(False, "--list", help="Show available Python checks"),
-    variables: list[str] | None = typer.Argument(
+    variables: Optional[list[str]] = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
 ) -> None:
@@ -102,12 +102,12 @@ def check(
 @catch_exception(console=console)
 async def generator(
     generator_name: str = typer.Argument(default="", help="Name of the Generator"),
-    branch: str | None = None,
+    branch: Optional[str] = None,
     path: str = typer.Option(".", help="Root directory"),
     debug: bool = False,
     _: str = CONFIG_PARAM,
     list_available: bool = typer.Option(False, "--list", help="Show available Generators"),
-    variables: list[str] | None = typer.Argument(
+    variables: Optional[list[str]] = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
 ) -> None:
@@ -129,14 +129,14 @@ async def run(
     method: str = "run",
     debug: bool = False,
     _: str = CONFIG_PARAM,
-    branch: str = typer.Option("main", help="Branch on which to run the script."),
-    concurrent: int | None = typer.Option(
+    branch: str = typer.Option(None, help="Branch on which to run the script."),
+    concurrent: Optional[int] = typer.Option(
         None,
         help="Maximum number of requests to execute at the same time.",
         envvar="INFRAHUB_MAX_CONCURRENT_EXECUTION",
     ),
     timeout: int = typer.Option(60, help="Timeout in sec", envvar="INFRAHUB_TIMEOUT"),
-    variables: list[str] | None = typer.Argument(
+    variables: Optional[list[str]] = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
 ) -> None:
@@ -259,7 +259,7 @@ def _run_transform(
 @catch_exception(console=console)
 def render(
     transform_name: str = typer.Argument(default="", help="Name of the Python transformation", show_default=False),
-    variables: list[str] | None = typer.Argument(
+    variables: Optional[list[str]] = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
     branch: str = typer.Option(None, help="Branch on which to render the transform."),
@@ -309,7 +309,7 @@ def render(
 @catch_exception(console=console)
 def transform(
     transform_name: str = typer.Argument(default="", help="Name of the Python transformation", show_default=False),
-    variables: list[str] | None = typer.Argument(
+    variables: Optional[list[str]] = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
     branch: str = typer.Option(None, help="Branch on which to run the transformation"),
@@ -352,7 +352,11 @@ def transform(
     # Run Transform
     result = asyncio.run(transform.run(data=data))
 
-    json_string = ujson.dumps(result, indent=2, sort_keys=True)
+    if isinstance(result, str):
+        json_string = result
+    else:
+        json_string = ujson.dumps(result, indent=2, sort_keys=True)
+
     if out:
         write_to_file(Path(out), json_string)
     else:
@@ -383,6 +387,7 @@ def protocols(
 
     else:
         client = initialize_client_sync()
+        branch = branch or client.default_branch
         schema.update(client.schema.fetch(branch=branch))
 
     code_generator = CodeGenerator(schema=schema)

infrahub_sdk/ctl/exceptions.py

@@ -6,9 +6,3 @@ class QueryNotFoundError(Error):
     def __init__(self, name: str, message: str = ""):
         self.message = message or f"The requested query '{name}' was not found."
         super().__init__(self.message)
-
-
-class FileNotValidError(Error):
-    def __init__(self, name: str, message: str = ""):
-        self.message = message or f"Cannot parse '{name}' content."
-        super().__init__(self.message)

infrahub_sdk/ctl/exporter.py

@@ -22,7 +22,7 @@ def dump(
     directory: Path = typer.Option(directory_name_with_timestamp, help="Directory path to store export"),
     quiet: bool = typer.Option(False, help="No console output"),
     _: str = CONFIG_PARAM,
-    branch: str = typer.Option("main", help="Branch from which to export"),
+    branch: str = typer.Option(None, help="Branch from which to export"),
     concurrent: int = typer.Option(
         4,
         help="Maximum number of requests to execute at the same time.",

infrahub_sdk/ctl/generator.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from pathlib import Path
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Optional
 
 import typer
 from rich.console import Console
@@ -9,7 +9,7 @@ from rich.console import Console
 from ..ctl import config
 from ..ctl.client import initialize_client
 from ..ctl.repository import get_repository_config
-from ..ctl.utils import execute_graphql_query, parse_cli_vars
+from ..ctl.utils import execute_graphql_query, init_logging, parse_cli_vars
 from ..exceptions import ModuleImportError
 from ..node import InfrahubNode
 
@@ -20,11 +20,12 @@ if TYPE_CHECKING:
 async def run(
     generator_name: str,
     path: str,  # noqa: ARG001
-    debug: bool,  # noqa: ARG001
+    debug: bool,
     list_available: bool,
     branch: str | None = None,
-    variables: list[str] | None = None,
+    variables: Optional[list[str]] = None,
 ) -> None:
+    init_logging(debug=debug)
     repository_config = get_repository_config(Path(config.INFRAHUB_REPO_CONFIG_FILE))
 
     if list_available or not generator_name:
@@ -34,7 +35,6 @@ async def run(
     generator_config = repository_config.get_generator_definition(name=generator_name)
 
     console = Console()
-
     relative_path = str(generator_config.file_path.parent) if generator_config.file_path.parent != Path() else None
 
     try:

infrahub_sdk/ctl/importer.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 from asyncio import run as aiorun
 from pathlib import Path
+from typing import Optional
 
 import typer
 from rich.console import Console
@@ -25,8 +26,8 @@ def load(
     ),
     quiet: bool = typer.Option(False, help="No console output"),
     _: str = CONFIG_PARAM,
-    branch: str = typer.Option("main", help="Branch from which to export"),
-    concurrent: int | None = typer.Option(
+    branch: str = typer.Option(None, help="Branch from which to export"),
+    concurrent: Optional[int] = typer.Option(
         None,
         help="Maximum number of requests to execute at the same time.",
         envvar="INFRAHUB_MAX_CONCURRENT_EXECUTION",

infrahub_sdk/ctl/menu.py

@@ -27,7 +27,7 @@ def callback() -> None:
 async def load(
     menus: list[Path],
     debug: bool = False,
-    branch: str = typer.Option("main", help="Branch on which to load the menu."),
+    branch: str = typer.Option(None, help="Branch on which to load the menu."),
     _: str = CONFIG_PARAM,
 ) -> None:
     """Load one or multiple menu files into Infrahub."""

infrahub_sdk/ctl/object.py

@@ -27,7 +27,7 @@ def callback() -> None:
 async def load(
     paths: list[Path],
     debug: bool = False,
-    branch: str = typer.Option("main", help="Branch on which to load the objects."),
+    branch: str = typer.Option(None, help="Branch on which to load the objects."),
     _: str = CONFIG_PARAM,
 ) -> None:
     """Load one or multiple objects files into Infrahub."""

infrahub_sdk/ctl/repository.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from pathlib import Path
+from typing import Optional
 
 import typer
 import yaml
@@ -8,15 +9,14 @@ from pydantic import ValidationError
 from rich.console import Console
 from rich.table import Table
 
-from infrahub_sdk.ctl.client import initialize_client
-
 from ..async_typer import AsyncTyper
-from ..ctl.exceptions import FileNotValidError
-from ..ctl.utils import init_logging
+from ..exceptions import FileNotValidError
 from ..graphql import Mutation, Query
 from ..schema.repository import InfrahubRepositoryConfig
-from ._file import read_file
+from ..utils import read_file
+from .client import initialize_client
 from .parameters import CONFIG_PARAM
+from .utils import init_logging
 
 app = AsyncTyper()
 console = Console()
@@ -69,12 +69,11 @@ async def add(
     name: str,
     location: str,
     description: str = "",
-    username: str | None = None,
+    username: Optional[str] = None,
     password: str = "",
-    commit: str = "",
+    ref: str = "",
     read_only: bool = False,
     debug: bool = False,
-    branch: str = typer.Option("main", help="Branch on which to add the repository."),
     _: str = CONFIG_PARAM,
 ) -> None:
     """Add a new repository."""
@@ -86,15 +85,24 @@ async def add(
             "name": {"value": name},
             "location": {"value": location},
             "description": {"value": description},
-            "commit": {"value": commit},
         },
     }
+    if read_only:
+        input_data["data"]["ref"] = {"value": ref}
+    else:
+        input_data["data"]["default_branch"] = {"value": ref}
 
     client = initialize_client()
 
-    credential = await client.create(kind="CorePasswordCredential", name=name, username=username, password=password)
-    await credential.save(allow_upsert=True)
-    input_data["data"]["credential"] = {"id": credential.id}
+    if username or password:
+        credential = await client.create(
+            kind="CorePasswordCredential",
+            name=name,
+            username=username,
+            password=password,
+        )
+        await credential.save(allow_upsert=True)
+        input_data["data"]["credential"] = {"id": credential.id}
 
     query = Mutation(
         mutation="CoreReadOnlyRepositoryCreate" if read_only else "CoreRepositoryCreate",
@@ -102,18 +110,18 @@ async def add(
         query={"ok": None},
     )
 
-    await client.execute_graphql(query=query.render(), branch_name=branch, tracker="mutation-repository-create")
+    await client.execute_graphql(query=query.render(), tracker="mutation-repository-create")
 
 
 @app.command()
 async def list(
-    branch: str | None = None,
+    branch: Optional[str] = typer.Option(None, help="Branch on which to list repositories."),
     debug: bool = False,
     _: str = CONFIG_PARAM,
 ) -> None:
     init_logging(debug=debug)
 
-    client = initialize_client(branch=branch)
+    client = initialize_client()
 
     repo_status_query = {
         "CoreGenericRepository": {

infrahub_sdk/ctl/schema.py

@@ -108,7 +108,7 @@ def get_node(schemas_data: list[dict], schema_index: int, node_index: int) -> di
 async def load(
     schemas: list[Path],
     debug: bool = False,
-    branch: str = typer.Option("main", help="Branch on which to load the schema."),
+    branch: str = typer.Option(None, help="Branch on which to load the schema."),
     wait: int = typer.Option(0, help="Time in seconds to wait until the schema has converged across all workers"),
     _: str = CONFIG_PARAM,
 ) -> None:
@@ -159,7 +159,7 @@ async def load(
 async def check(
     schemas: list[Path],
     debug: bool = False,
-    branch: str = typer.Option("main", help="Branch on which to check the schema."),
+    branch: str = typer.Option(None, help="Branch on which to check the schema."),
     _: str = CONFIG_PARAM,
 ) -> None:
     """Check if schema files are valid and what would be the impact of loading them with Infrahub."""

infrahub_sdk/ctl/utils.py

@@ -6,7 +6,7 @@ import traceback
 from collections.abc import Coroutine
 from functools import wraps
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Callable, NoReturn, TypeVar
+from typing import TYPE_CHECKING, Any, Callable, NoReturn, Optional, TypeVar
 
 import pendulum
 import typer
@@ -17,10 +17,10 @@ from rich.console import Console
 from rich.logging import RichHandler
 from rich.markup import escape
 
-from ..ctl.exceptions import FileNotValidError, QueryNotFoundError
 from ..exceptions import (
     AuthenticationError,
     Error,
+    FileNotValidError,
     GraphQLError,
     NodeNotFoundError,
     ResourceNotDefinedError,
@@ -30,6 +30,7 @@ from ..exceptions import (
 )
 from ..yaml import YamlFile
 from .client import initialize_client_sync
+from .exceptions import QueryNotFoundError
 
 if TYPE_CHECKING:
     from ..schema.repository import InfrahubRepositoryConfig
@@ -144,7 +145,7 @@ def print_graphql_errors(console: Console, errors: list) -> None:
             console.print(f"[red]{escape(str(error))}")
 
 
-def parse_cli_vars(variables: list[str] | None) -> dict[str, str]:
+def parse_cli_vars(variables: Optional[list[str]]) -> dict[str, str]:
     if not variables:
         return {}
 

infrahub_sdk/ctl/validate.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import sys
 from pathlib import Path
+from typing import Optional
 
 import typer
 import ujson
@@ -57,7 +58,7 @@ async def validate_schema(schema: Path, _: str = CONFIG_PARAM) -> None:
 @catch_exception(console=console)
 def validate_graphql(
     query: str,
-    variables: list[str] | None = typer.Argument(
+    variables: Optional[list[str]] = typer.Argument(
         None, help="Variables to pass along with the query. Format key=value key=value."
     ),
     debug: bool = typer.Option(False, help="Display more troubleshooting information."),

infrahub_sdk/exceptions.py

@@ -121,6 +121,12 @@ class AuthenticationError(Error):
         super().__init__(self.message)
 
 
+class URLNotFoundError(Error):
+    def __init__(self, url: str):
+        self.message = f"`{url}` not found."
+        super().__init__(self.message)
+
+
 class FeatureNotSupportedError(Error):
     """Raised when trying to use a method on a node that doesn't support it."""
 
@@ -131,3 +137,9 @@ class UninitializedError(Error):
 
 class InvalidResponseError(Error):
     """Raised when an object requires an initialization step before use"""
+
+
+class FileNotValidError(Error):
+    def __init__(self, name: str, message: str = ""):
+        self.message = message or f"Cannot parse '{name}' content."
+        super().__init__(self.message)

infrahub_sdk/generator.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import logging
 import os
 from abc import abstractmethod
 from typing import TYPE_CHECKING
@@ -27,6 +28,7 @@ class InfrahubGenerator:
         generator_instance: str = "",
         params: dict | None = None,
         convert_query_response: bool = False,
+        logger: logging.Logger | None = None,
     ) -> None:
         self.query = query
         self.branch = branch
@@ -41,6 +43,7 @@ class InfrahubGenerator:
         self._related_nodes: list[InfrahubNode] = []
         self.infrahub_node = infrahub_node
         self.convert_query_response = convert_query_response
+        self.logger = logger if logger else logging.getLogger("infrahub.tasks")
 
     @property
     def store(self) -> NodeStore:

infrahub_sdk/node.py

@@ -187,6 +187,7 @@ class RelatedNodeBase:
             if node_data:
                 self._id = node_data.get("id", None)
                 self._hfid = node_data.get("hfid", None)
+                self._kind = node_data.get("kind", None)
                 self._display_label = node_data.get("display_label", None)
                 self._typename = node_data.get("__typename", None)
 
@@ -255,6 +256,8 @@ class RelatedNodeBase:
             data["id"] = self.id
         elif self.hfid is not None:
             data["hfid"] = self.hfid
+            if self._kind is not None:
+                data["kind"] = self._kind
 
         for prop_name in self._properties:
             if getattr(self, prop_name) is not None:
@@ -1118,14 +1121,14 @@ class InfrahubNode(InfrahubNodeBase):
     async def artifact_generate(self, name: str) -> None:
         self._validate_artifact_support(ARTIFACT_GENERATE_FEATURE_NOT_SUPPORTED_MESSAGE)
 
-        artifact = await self._client.get(kind="CoreArtifact", definition__name__value=name, object__ids=[self.id])
+        artifact = await self._client.get(kind="CoreArtifact", name__value=name, object__ids=[self.id])
         await artifact.definition.fetch()  # type: ignore[attr-defined]
         await artifact.definition.peer.generate([artifact.id])  # type: ignore[attr-defined]
 
     async def artifact_fetch(self, name: str) -> str | dict[str, Any]:
         self._validate_artifact_support(ARTIFACT_GENERATE_FEATURE_NOT_SUPPORTED_MESSAGE)
 
-        artifact = await self._client.get(kind="CoreArtifact", definition__name__value=name, object__ids=[self.id])
+        artifact = await self._client.get(kind="CoreArtifact", name__value=name, object__ids=[self.id])
         content = await self._client.object_store.get(identifier=artifact.storage_id.value)  # type: ignore[attr-defined]
         return content
 
@@ -1635,13 +1638,13 @@ class InfrahubNodeSync(InfrahubNodeBase):
 
     def artifact_generate(self, name: str) -> None:
         self._validate_artifact_support(ARTIFACT_GENERATE_FEATURE_NOT_SUPPORTED_MESSAGE)
-        artifact = self._client.get(kind="CoreArtifact", definition__name__value=name, object__ids=[self.id])
+        artifact = self._client.get(kind="CoreArtifact", name__value=name, object__ids=[self.id])
         artifact.definition.fetch()  # type: ignore[attr-defined]
         artifact.definition.peer.generate([artifact.id])  # type: ignore[attr-defined]
 
     def artifact_fetch(self, name: str) -> str | dict[str, Any]:
         self._validate_artifact_support(ARTIFACT_FETCH_FEATURE_NOT_SUPPORTED_MESSAGE)
-        artifact = self._client.get(kind="CoreArtifact", definition__name__value=name, object__ids=[self.id])
+        artifact = self._client.get(kind="CoreArtifact", name__value=name, object__ids=[self.id])
         content = self._client.object_store.get(identifier=artifact.storage_id.value)  # type: ignore[attr-defined]
         return content
 

infrahub_sdk/testing/schemas/animal.py

@@ -80,6 +80,7 @@ class SchemaAnimal:
             namespace=NAMESPACE,
             include_in_menu=True,
             inherit_from=[TESTING_ANIMAL],
+            human_friendly_id=["owner__name__value", "name__value", "color__value"],
             display_labels=["name__value", "breed__value", "color__value"],
             order_by=["name__value"],
             attributes=[
@@ -108,6 +109,14 @@ class SchemaAnimal:
                     identifier="person__animal",
                     cardinality="many",
                     direction=RelationshipDirection.INBOUND,
+                    max_count=10,
+                ),
+                Rel(
+                    name="favorite_animal",
+                    peer=TESTING_ANIMAL,
+                    identifier="favorite_animal",
+                    cardinality="one",
+                    direction=RelationshipDirection.INBOUND,
                 ),
                 Rel(
                     name="best_friends",

infrahub_sdk/utils.py

@@ -17,7 +17,7 @@ from graphql import (
 
 from infrahub_sdk.repository import GitRepoManager
 
-from .exceptions import JsonDecodeError
+from .exceptions import FileNotValidError, JsonDecodeError
 
 if TYPE_CHECKING:
     from graphql import GraphQLResolveInfo
@@ -342,6 +342,16 @@ def write_to_file(path: Path, value: Any) -> bool:
     return written is not None
 
 
+def read_file(file_name: Path) -> str:
+    if not file_name.is_file():
+        raise FileNotValidError(name=str(file_name), message=f"{file_name} is not a valid file")
+    try:
+        with Path.open(file_name, encoding="utf-8") as fobj:
+            return fobj.read()
+    except UnicodeDecodeError as exc:
+        raise FileNotValidError(name=str(file_name), message=f"Unable to read {file_name} with utf-8 encoding") from exc
+
+
 def get_user_permissions(data: list[dict]) -> dict:
     groups = {}
     for group in data:

infrahub_sdk/yaml.py

@@ -8,9 +8,8 @@ import yaml
 from pydantic import BaseModel, Field
 from typing_extensions import Self
 
-from .ctl._file import read_file
-from .ctl.exceptions import FileNotValidError
-from .utils import find_files
+from .exceptions import FileNotValidError
+from .utils import find_files, read_file
 
 
 class InfrahubFileApiVersion(str, Enum):