infrahub-server 1.2.0rc0__py3-none-any.whl → 1.2.1__py3-none-any.whl

infrahub_sdk/query_groups.py

@@ -19,7 +19,6 @@ class InfrahubGroupContextBase:
         self.related_node_ids: list[str] = []
         self.related_group_ids: list[str] = []
         self.unused_member_ids: list[str] | None = None
-        self.unused_child_ids: list[str] | None = None
         self.previous_members: list[RelatedNodeBase] | None = None
         self.previous_children: list[RelatedNodeBase] | None = None
         self.identifier: str | None = None
@@ -88,7 +87,7 @@ class InfrahubGroupContext(InfrahubGroupContextBase):
     async def get_group(self, store_peers: bool = False) -> InfrahubNode | None:
         group_name = self._generate_group_name()
         try:
-            group = await self.client.get(kind=self.group_type, name__value=group_name, include=["members", "children"])
+            group = await self.client.get(kind=self.group_type, name__value=group_name, include=["members"])
         except NodeNotFoundError:
             return None
 
@@ -96,7 +95,6 @@ class InfrahubGroupContext(InfrahubGroupContextBase):
             return group
 
         self.previous_members = group.members.peers  # type: ignore[attr-defined]
-        self.previous_children = group.children.peers  # type: ignore[attr-defined]
         return group
 
     async def delete_unused(self) -> None:
@@ -105,11 +103,6 @@ class InfrahubGroupContext(InfrahubGroupContextBase):
                 if member.id in self.unused_member_ids and member.typename:
                     await self.client.delete(kind=member.typename, id=member.id)
 
-        if self.previous_children and self.unused_child_ids:
-            for child in self.previous_children:
-                if child.id in self.unused_child_ids and child.typename:
-                    await self.client.delete(kind=child.typename, id=child.id)
-
     async def add_related_nodes(self, ids: list[str], update_group_context: bool | None = None) -> None:
         """
         Add related Nodes IDs to the context.
@@ -140,15 +133,9 @@ class InfrahubGroupContext(InfrahubGroupContextBase):
         """
         Create or update (using upsert) a CoreStandardGroup to store all the Nodes and Groups used during an execution.
         """
-        children: list[str] = []
-        members: list[str] = []
-
-        if self.related_group_ids:
-            children = self.related_group_ids
-        if self.related_node_ids:
-            members = self.related_node_ids
+        members: list[str] = self.related_group_ids + self.related_node_ids
 
-        if not children and not members:
+        if not members:
             return
 
         group_name = self._generate_group_name()
@@ -164,7 +151,6 @@ class InfrahubGroupContext(InfrahubGroupContextBase):
             name=group_name,
             description=description,
             members=members,
-            children=children,
         )
         await group.save(allow_upsert=True, update_group_context=False)
 
@@ -173,7 +159,6 @@ class InfrahubGroupContext(InfrahubGroupContextBase):
 
         # Calculate how many nodes should be deleted
         self.unused_member_ids = set(existing_group.members.peer_ids) - set(members)  # type: ignore
-        self.unused_child_ids = set(existing_group.children.peer_ids) - set(children)  # type: ignore
 
         if not self.delete_unused_nodes:
             return
@@ -194,7 +179,7 @@ class InfrahubGroupContextSync(InfrahubGroupContextBase):
     def get_group(self, store_peers: bool = False) -> InfrahubNodeSync | None:
         group_name = self._generate_group_name()
         try:
-            group = self.client.get(kind=self.group_type, name__value=group_name, include=["members", "children"])
+            group = self.client.get(kind=self.group_type, name__value=group_name, include=["members"])
         except NodeNotFoundError:
             return None
 
@@ -202,7 +187,6 @@ class InfrahubGroupContextSync(InfrahubGroupContextBase):
             return group
 
         self.previous_members = group.members.peers  # type: ignore[attr-defined]
-        self.previous_children = group.children.peers  # type: ignore[attr-defined]
         return group
 
     def delete_unused(self) -> None:
@@ -211,11 +195,6 @@ class InfrahubGroupContextSync(InfrahubGroupContextBase):
                 if member.id in self.unused_member_ids and member.typename:
                     self.client.delete(kind=member.typename, id=member.id)
 
-        if self.previous_children and self.unused_child_ids:
-            for child in self.previous_children:
-                if child.id in self.unused_child_ids and child.typename:
-                    self.client.delete(kind=child.typename, id=child.id)
-
     def add_related_nodes(self, ids: list[str], update_group_context: bool | None = None) -> None:
         """
         Add related Nodes IDs to the context.
@@ -246,15 +225,9 @@ class InfrahubGroupContextSync(InfrahubGroupContextBase):
         """
         Create or update (using upsert) a CoreStandardGroup to store all the Nodes and Groups used during an execution.
         """
-        children: list[str] = []
-        members: list[str] = []
-
-        if self.related_group_ids:
-            children = self.related_group_ids
-        if self.related_node_ids:
-            members = self.related_node_ids
+        members: list[str] = self.related_node_ids + self.related_group_ids
 
-        if not children and not members:
+        if not members:
             return
 
         group_name = self._generate_group_name()
@@ -270,7 +243,6 @@ class InfrahubGroupContextSync(InfrahubGroupContextBase):
             name=group_name,
             description=description,
             members=members,
-            children=children,
         )
         group.save(allow_upsert=True, update_group_context=False)
 
@@ -279,7 +251,6 @@ class InfrahubGroupContextSync(InfrahubGroupContextBase):
 
         # Calculate how many nodes should be deleted
         self.unused_member_ids = set(existing_group.members.peer_ids) - set(members)  # type: ignore
-        self.unused_child_ids = set(existing_group.children.peer_ids) - set(children)  # type: ignore
 
         if not self.delete_unused_nodes:
             return

infrahub_sdk/schema/__init__.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import asyncio
-from collections import defaultdict
 from collections.abc import MutableMapping
 from enum import Enum
 from time import sleep
@@ -22,6 +21,7 @@ from ..queries import SCHEMA_HASH_SYNC_STATUS
 from .main import (
     AttributeSchema,
     AttributeSchemaAPI,
+    BranchSchema,
     BranchSupportType,
     GenericSchema,
     GenericSchemaAPI,
@@ -169,7 +169,7 @@ class InfrahubSchemaBase:
 class InfrahubSchema(InfrahubSchemaBase):
     def __init__(self, client: InfrahubClient):
         self.client = client
-        self.cache: dict = defaultdict(lambda: dict)
+        self.cache: dict[str, BranchSchema] = {}
 
     async def get(
         self,
@@ -183,23 +183,27 @@ class InfrahubSchema(InfrahubSchemaBase):
         kind_str = self._get_schema_name(schema=kind)
 
         if refresh:
-            self.cache[branch] = await self.fetch(branch=branch, timeout=timeout)
+            self.cache[branch] = await self._fetch(branch=branch, timeout=timeout)
 
-        if branch in self.cache and kind_str in self.cache[branch]:
-            return self.cache[branch][kind_str]
+        if branch in self.cache and kind_str in self.cache[branch].nodes:
+            return self.cache[branch].nodes[kind_str]
 
         # Fetching the latest schema from the server if we didn't fetch it earlier
         #   because we coulnd't find the object on the local cache
         if not refresh:
-            self.cache[branch] = await self.fetch(branch=branch, timeout=timeout)
+            self.cache[branch] = await self._fetch(branch=branch, timeout=timeout)
 
-        if branch in self.cache and kind_str in self.cache[branch]:
-            return self.cache[branch][kind_str]
+        if branch in self.cache and kind_str in self.cache[branch].nodes:
+            return self.cache[branch].nodes[kind_str]
 
         raise SchemaNotFoundError(identifier=kind_str)
 
     async def all(
-        self, branch: str | None = None, refresh: bool = False, namespaces: list[str] | None = None
+        self,
+        branch: str | None = None,
+        refresh: bool = False,
+        namespaces: list[str] | None = None,
+        schema_hash: str | None = None,
     ) -> MutableMapping[str, MainSchemaTypesAPI]:
         """Retrieve the entire schema for a given branch.
 
@@ -209,15 +213,19 @@ class InfrahubSchema(InfrahubSchemaBase):
         Args:
             branch (str, optional): Name of the branch to query. Defaults to default_branch.
             refresh (bool, optional): Force a refresh of the schema. Defaults to False.
+            schema_hash (str, optional): Only refresh if the current schema doesn't match this hash.
 
         Returns:
             dict[str, MainSchemaTypes]: Dictionary of all schema organized by kind
         """
         branch = branch or self.client.default_branch
+        if refresh and branch in self.cache and schema_hash and self.cache[branch].hash == schema_hash:
+            refresh = False
+
         if refresh or branch not in self.cache:
-            self.cache[branch] = await self.fetch(branch=branch, namespaces=namespaces)
+            self.cache[branch] = await self._fetch(branch=branch, namespaces=namespaces)
 
-        return self.cache[branch]
+        return self.cache[branch].nodes
 
     async def load(
         self, schemas: list[dict], branch: str | None = None, wait_until_converged: bool = False
@@ -392,11 +400,17 @@ class InfrahubSchema(InfrahubSchemaBase):
 
         Args:
             branch (str): Name of the branch to fetch the schema for.
-            timeout (int, optional): Overrides default timeout used when querying the graphql API. Specified in seconds.
+            timeout (int, optional): Overrides default timeout used when querying the GraphQL API. Specified in seconds.
 
         Returns:
             dict[str, MainSchemaTypes]: Dictionary of all schema organized by kind
         """
+        branch_schema = await self._fetch(branch=branch, namespaces=namespaces, timeout=timeout)
+        return branch_schema.nodes
+
+    async def _fetch(
+        self, branch: str, namespaces: list[str] | None = None, timeout: int | None = None
+    ) -> BranchSchema:
         url_parts = [("branch", branch)]
         if namespaces:
             url_parts.extend([("namespaces", ns) for ns in namespaces])
@@ -425,16 +439,22 @@ class InfrahubSchema(InfrahubSchemaBase):
             template = TemplateSchemaAPI(**template_schema)
             nodes[template.kind] = template
 
-        return nodes
+        schema_hash = data.get("main", "")
+
+        return BranchSchema(hash=schema_hash, nodes=nodes)
 
 
 class InfrahubSchemaSync(InfrahubSchemaBase):
     def __init__(self, client: InfrahubClientSync):
         self.client = client
-        self.cache: dict = defaultdict(lambda: dict)
+        self.cache: dict[str, BranchSchema] = {}
 
     def all(
-        self, branch: str | None = None, refresh: bool = False, namespaces: list[str] | None = None
+        self,
+        branch: str | None = None,
+        refresh: bool = False,
+        namespaces: list[str] | None = None,
+        schema_hash: str | None = None,
     ) -> MutableMapping[str, MainSchemaTypesAPI]:
         """Retrieve the entire schema for a given branch.
 
@@ -444,15 +464,19 @@ class InfrahubSchemaSync(InfrahubSchemaBase):
         Args:
             branch (str, optional): Name of the branch to query. Defaults to default_branch.
             refresh (bool, optional): Force a refresh of the schema. Defaults to False.
+            schema_hash (str, optional): Only refresh if the current schema doesn't match this hash.
 
         Returns:
             dict[str, MainSchemaTypes]: Dictionary of all schema organized by kind
         """
         branch = branch or self.client.default_branch
+        if refresh and branch in self.cache and schema_hash and self.cache[branch].hash == schema_hash:
+            refresh = False
+
         if refresh or branch not in self.cache:
-            self.cache[branch] = self.fetch(branch=branch, namespaces=namespaces)
+            self.cache[branch] = self._fetch(branch=branch, namespaces=namespaces)
 
-        return self.cache[branch]
+        return self.cache[branch].nodes
 
     def get(
         self,
@@ -466,18 +490,18 @@ class InfrahubSchemaSync(InfrahubSchemaBase):
         kind_str = self._get_schema_name(schema=kind)
 
         if refresh:
-            self.cache[branch] = self.fetch(branch=branch)
+            self.cache[branch] = self._fetch(branch=branch)
 
-        if branch in self.cache and kind_str in self.cache[branch]:
-            return self.cache[branch][kind_str]
+        if branch in self.cache and kind_str in self.cache[branch].nodes:
+            return self.cache[branch].nodes[kind_str]
 
         # Fetching the latest schema from the server if we didn't fetch it earlier
         #   because we coulnd't find the object on the local cache
         if not refresh:
-            self.cache[branch] = self.fetch(branch=branch, timeout=timeout)
+            self.cache[branch] = self._fetch(branch=branch, timeout=timeout)
 
-        if branch in self.cache and kind_str in self.cache[branch]:
-            return self.cache[branch][kind_str]
+        if branch in self.cache and kind_str in self.cache[branch].nodes:
+            return self.cache[branch].nodes[kind_str]
 
         raise SchemaNotFoundError(identifier=kind_str)
 
@@ -600,17 +624,20 @@ class InfrahubSchemaSync(InfrahubSchemaBase):
 
         Args:
             branch (str): Name of the branch to fetch the schema for.
-            timeout (int, optional): Overrides default timeout used when querying the graphql API. Specified in seconds.
+            timeout (int, optional): Overrides default timeout used when querying the GraphQL API. Specified in seconds.
 
         Returns:
             dict[str, MainSchemaTypes]: Dictionary of all schema organized by kind
         """
+        branch_schema = self._fetch(branch=branch, namespaces=namespaces, timeout=timeout)
+        return branch_schema.nodes
+
+    def _fetch(self, branch: str, namespaces: list[str] | None = None, timeout: int | None = None) -> BranchSchema:
         url_parts = [("branch", branch)]
         if namespaces:
             url_parts.extend([("namespaces", ns) for ns in namespaces])
         query_params = urlencode(url_parts)
         url = f"{self.client.address}/api/schema?{query_params}"
-
         response = self.client._get(url=url, timeout=timeout)
         response.raise_for_status()
 
@@ -633,7 +660,9 @@ class InfrahubSchemaSync(InfrahubSchemaBase):
             template = TemplateSchemaAPI(**template_schema)
             nodes[template.kind] = template
 
-        return nodes
+        schema_hash = data.get("main", "")
+
+        return BranchSchema(hash=schema_hash, nodes=nodes)
 
     def load(
         self, schemas: list[dict], branch: str | None = None, wait_until_converged: bool = False

infrahub_sdk/schema/main.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import warnings
+from collections.abc import MutableMapping
 from enum import Enum
 from typing import TYPE_CHECKING, Any, Union
 
@@ -348,3 +349,10 @@ class SchemaRootAPI(BaseModel):
     nodes: list[NodeSchemaAPI] = Field(default_factory=list)
     profiles: list[ProfileSchemaAPI] = Field(default_factory=list)
     templates: list[TemplateSchemaAPI] = Field(default_factory=list)
+
+
+class BranchSchema(BaseModel):
+    hash: str = Field(...)
+    nodes: MutableMapping[str, GenericSchemaAPI | NodeSchemaAPI | ProfileSchemaAPI | TemplateSchemaAPI] = Field(
+        default_factory=dict
+    )

infrahub_sdk/task/__init__.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from .models import Task, TaskFilter, TaskLog, TaskRelatedNode, TaskState
+
+__all__ = [
+    "Task",
+    "TaskFilter",
+    "TaskLog",
+    "TaskRelatedNode",
+    "TaskState",
+]

infrahub_sdk/task/constants.py

@@ -0,0 +1,3 @@
+from .models import TaskState
+
+FINAL_STATES = [TaskState.COMPLETED, TaskState.FAILED, TaskState.CANCELLED, TaskState.CRASHED]

infrahub_sdk/task/exceptions.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+
+class TaskError(Exception):
+    def __init__(self, message: str | None = None):
+        self.message = message
+        super().__init__(self.message)
+
+
+class TaskNotFoundError(TaskError):
+    def __init__(self, id: str):
+        self.message = f"Task with id {id} not found"
+        super().__init__(self.message)
+
+
+class TooManyTasksError(TaskError):
+    def __init__(self, expected_id: str, received_ids: list[str]):
+        self.message = f"Expected 1 task with id {expected_id}, but got {len(received_ids)}"
+        super().__init__(self.message)
+
+
+class TaskNotCompletedError(TaskError):
+    def __init__(self, id: str, message: str | None = None):
+        self.message = message or f"Task with id {id} is not completed"
+        super().__init__(self.message)