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

infrahub_sdk/generator.py

@@ -11,6 +11,7 @@ from .exceptions import UninitializedError
 
 if TYPE_CHECKING:
     from .client import InfrahubClient
+    from .context import RequestContext
     from .node import InfrahubNode
     from .store import NodeStore
 
@@ -29,6 +30,7 @@ class InfrahubGenerator:
         params: dict | None = None,
         convert_query_response: bool = False,
         logger: logging.Logger | None = None,
+        request_context: RequestContext | None = None,
     ) -> None:
         self.query = query
         self.branch = branch
@@ -44,6 +46,7 @@ class InfrahubGenerator:
         self.infrahub_node = infrahub_node
         self.convert_query_response = convert_query_response
         self.logger = logger if logger else logging.getLogger("infrahub.tasks")
+        self.request_context = request_context
 
     @property
     def store(self) -> NodeStore:
@@ -122,7 +125,7 @@ class InfrahubGenerator:
         await self._init_client.schema.all(branch=self.branch_name)
 
         for kind in data:
-            if kind in self._init_client.schema.cache[self.branch_name]:
+            if kind in self._init_client.schema.cache[self.branch_name].nodes.keys():
                 for result in data[kind].get("edges", []):
                     node = await self.infrahub_node.from_graphql(
                         client=self._init_client, branch=self.branch_name, data=result

infrahub_sdk/graphql.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from enum import Enum
 from typing import Any
 
 from pydantic import BaseModel
@@ -7,19 +8,30 @@ from pydantic import BaseModel
 VARIABLE_TYPE_MAPPING = ((str, "String!"), (int, "Int!"), (float, "Float!"), (bool, "Boolean!"))
 
 
-def convert_to_graphql_as_string(value: str | bool | list) -> str:
+def convert_to_graphql_as_string(value: str | bool | list | BaseModel | Enum | Any, convert_enum: bool = False) -> str:  # noqa: PLR0911
     if isinstance(value, str) and value.startswith("$"):
         return value
+    if isinstance(value, Enum):
+        if convert_enum:
+            return convert_to_graphql_as_string(value=value.value, convert_enum=True)
+        return value.name
     if isinstance(value, str):
         return f'"{value}"'
     if isinstance(value, bool):
         return repr(value).lower()
     if isinstance(value, list):
-        values_as_string = [convert_to_graphql_as_string(item) for item in value]
+        values_as_string = [convert_to_graphql_as_string(value=item, convert_enum=convert_enum) for item in value]
         return "[" + ", ".join(values_as_string) + "]"
     if isinstance(value, BaseModel):
         data = value.model_dump()
-        return "{ " + ", ".join(f"{key}: {convert_to_graphql_as_string(val)}" for key, val in data.items()) + " }"
+        return (
+            "{ "
+            + ", ".join(
+                f"{key}: {convert_to_graphql_as_string(value=val, convert_enum=convert_enum)}"
+                for key, val in data.items()
+            )
+            + " }"
+        )
 
     return str(value)
 
@@ -38,7 +50,7 @@ def render_variables_to_string(data: dict[str, type[str | int | float | bool]])
     return ", ".join([f"{key}: {value}" for key, value in vars_dict.items()])
 
 
-def render_query_block(data: dict, offset: int = 4, indentation: int = 4) -> list[str]:
+def render_query_block(data: dict, offset: int = 4, indentation: int = 4, convert_enum: bool = False) -> list[str]:
     FILTERS_KEY = "@filters"
     ALIAS_KEY = "@alias"
     KEYWORDS_TO_SKIP = [FILTERS_KEY, ALIAS_KEY]
@@ -60,25 +72,36 @@ def render_query_block(data: dict, offset: int = 4, indentation: int = 4) -> lis
 
             if value.get(FILTERS_KEY):
                 filters_str = ", ".join(
-                    [f"{key2}: {convert_to_graphql_as_string(value2)}" for key2, value2 in value[FILTERS_KEY].items()]
+                    [
+                        f"{key2}: {convert_to_graphql_as_string(value=value2, convert_enum=convert_enum)}"
+                        for key2, value2 in value[FILTERS_KEY].items()
+                    ]
                 )
                 lines.append(f"{offset_str}{key_str}({filters_str}) " + "{")
             else:
                 lines.append(f"{offset_str}{key_str} " + "{")
 
-            lines.extend(render_query_block(data=value, offset=offset + indentation, indentation=indentation))
+            lines.extend(
+                render_query_block(
+                    data=value, offset=offset + indentation, indentation=indentation, convert_enum=convert_enum
+                )
+            )
             lines.append(offset_str + "}")
 
     return lines
 
 
-def render_input_block(data: dict, offset: int = 4, indentation: int = 4) -> list[str]:
+def render_input_block(data: dict, offset: int = 4, indentation: int = 4, convert_enum: bool = False) -> list[str]:
     offset_str = " " * offset
     lines = []
     for key, value in data.items():
         if isinstance(value, dict):
             lines.append(f"{offset_str}{key}: " + "{")
-            lines.extend(render_input_block(data=value, offset=offset + indentation, indentation=indentation))
+            lines.extend(
+                render_input_block(
+                    data=value, offset=offset + indentation, indentation=indentation, convert_enum=convert_enum
+                )
+            )
             lines.append(offset_str + "}")
         elif isinstance(value, list):
             lines.append(f"{offset_str}{key}: " + "[")
@@ -90,14 +113,17 @@ def render_input_block(data: dict, offset: int = 4, indentation: int = 4) -> lis
                             data=item,
                             offset=offset + indentation + indentation,
                             indentation=indentation,
+                            convert_enum=convert_enum,
                         )
                     )
                     lines.append(f"{offset_str}{' ' * indentation}" + "},")
                 else:
-                    lines.append(f"{offset_str}{' ' * indentation}{convert_to_graphql_as_string(item)},")
+                    lines.append(
+                        f"{offset_str}{' ' * indentation}{convert_to_graphql_as_string(value=item, convert_enum=convert_enum)},"
+                    )
             lines.append(offset_str + "]")
         else:
-            lines.append(f"{offset_str}{key}: {convert_to_graphql_as_string(value)}")
+            lines.append(f"{offset_str}{key}: {convert_to_graphql_as_string(value=value, convert_enum=convert_enum)}")
     return lines
 
 
@@ -127,9 +153,13 @@ class BaseGraphQLQuery:
 class Query(BaseGraphQLQuery):
     query_type = "query"
 
-    def render(self) -> str:
+    def render(self, convert_enum: bool = False) -> str:
         lines = [self.render_first_line()]
-        lines.extend(render_query_block(data=self.query, indentation=self.indentation, offset=self.indentation))
+        lines.extend(
+            render_query_block(
+                data=self.query, indentation=self.indentation, offset=self.indentation, convert_enum=convert_enum
+            )
+        )
         lines.append("}")
 
         return "\n" + "\n".join(lines) + "\n"
@@ -143,7 +173,7 @@ class Mutation(BaseGraphQLQuery):
         self.mutation = mutation
         super().__init__(*args, **kwargs)
 
-    def render(self) -> str:
+    def render(self, convert_enum: bool = False) -> str:
         lines = [self.render_first_line()]
         lines.append(" " * self.indentation + f"{self.mutation}(")
         lines.extend(
@@ -151,6 +181,7 @@ class Mutation(BaseGraphQLQuery):
                 data=self.input_data,
                 indentation=self.indentation,
                 offset=self.indentation * 2,
+                convert_enum=convert_enum,
             )
         )
         lines.append(" " * self.indentation + "){")
@@ -159,6 +190,7 @@ class Mutation(BaseGraphQLQuery):
                 data=self.query,
                 indentation=self.indentation,
                 offset=self.indentation * 2,
+                convert_enum=convert_enum,
             )
         )
         lines.append(" " * self.indentation + "}")

infrahub_sdk/node.py

@@ -22,6 +22,7 @@ if TYPE_CHECKING:
     from typing_extensions import Self
 
     from .client import InfrahubClient, InfrahubClientSync
+    from .context import RequestContext
     from .schema import AttributeSchemaAPI, MainSchemaTypesAPI, RelationshipSchemaAPI
     from .types import Order
 
@@ -187,6 +188,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 +257,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:
@@ -766,6 +770,16 @@ class InfrahubNodeBase:
                 Attribute(name=attr_name, schema=attr_schema, data=attr_data),
             )
 
+    def _get_request_context(self, request_context: RequestContext | None = None) -> dict[str, Any] | None:
+        if request_context:
+            return request_context.model_dump(exclude_none=True)
+
+        client: InfrahubClient | InfrahubClientSync | None = getattr(self, "_client", None)
+        if not client or not client.request_context:
+            return None
+
+        return client.request_context.model_dump(exclude_none=True)
+
     def _init_relationships(self, data: dict | None = None) -> None:
         pass
 
@@ -794,7 +808,12 @@ class InfrahubNodeBase:
     def get_raw_graphql_data(self) -> dict | None:
         return self._data
 
-    def _generate_input_data(self, exclude_unmodified: bool = False, exclude_hfid: bool = False) -> dict[str, dict]:  # noqa: C901
+    def _generate_input_data(  # noqa: C901
+        self,
+        exclude_unmodified: bool = False,
+        exclude_hfid: bool = False,
+        request_context: RequestContext | None = None,
+    ) -> dict[str, dict]:
         """Generate a dictionary that represent the input data required by a mutation.
 
         Returns:
@@ -872,7 +891,15 @@ class InfrahubNodeBase:
         elif self.hfid is not None and not exclude_hfid:
             data["hfid"] = self.hfid
 
-        return {"data": {"data": data}, "variables": variables, "mutation_variables": mutation_variables}
+        mutation_payload = {"data": data}
+        if context_data := self._get_request_context(request_context=request_context):
+            mutation_payload["context"] = context_data
+
+        return {
+            "data": mutation_payload,
+            "variables": variables,
+            "mutation_variables": mutation_variables,
+        }
 
     @staticmethod
     def _strip_unmodified_dict(data: dict, original_data: dict, variables: dict, item: str) -> None:
@@ -1129,8 +1156,11 @@ class InfrahubNode(InfrahubNodeBase):
         content = await self._client.object_store.get(identifier=artifact.storage_id.value)  # type: ignore[attr-defined]
         return content
 
-    async def delete(self, timeout: int | None = None) -> None:
+    async def delete(self, timeout: int | None = None, request_context: RequestContext | None = None) -> None:
         input_data = {"data": {"id": self.id}}
+        if context_data := self._get_request_context(request_context=request_context):
+            input_data["context"] = context_data
+
         mutation_query = {"ok": None}
         query = Mutation(
             mutation=f"{self._schema.kind}Delete",
@@ -1145,12 +1175,16 @@ class InfrahubNode(InfrahubNodeBase):
         )
 
     async def save(
-        self, allow_upsert: bool = False, update_group_context: bool | None = None, timeout: int | None = None
+        self,
+        allow_upsert: bool = False,
+        update_group_context: bool | None = None,
+        timeout: int | None = None,
+        request_context: RequestContext | None = None,
     ) -> None:
         if self._existing is False or allow_upsert is True:
-            await self.create(allow_upsert=allow_upsert, timeout=timeout)
+            await self.create(allow_upsert=allow_upsert, timeout=timeout, request_context=request_context)
         else:
-            await self.update(timeout=timeout)
+            await self.update(timeout=timeout, request_context=request_context)
 
         if update_group_context is None and self._client.mode == InfrahubClientMode.TRACKING:
             update_group_context = True
@@ -1379,15 +1413,17 @@ class InfrahubNode(InfrahubNodeBase):
             await related_node.fetch(timeout=timeout)
             setattr(self, rel_name, related_node)
 
-    async def create(self, allow_upsert: bool = False, timeout: int | None = None) -> None:
+    async def create(
+        self, allow_upsert: bool = False, timeout: int | None = None, request_context: RequestContext | None = None
+    ) -> None:
         mutation_query = self._generate_mutation_query()
 
         if allow_upsert:
-            input_data = self._generate_input_data(exclude_hfid=False)
+            input_data = self._generate_input_data(exclude_hfid=False, request_context=request_context)
             mutation_name = f"{self._schema.kind}Upsert"
             tracker = f"mutation-{str(self._schema.kind).lower()}-upsert"
         else:
-            input_data = self._generate_input_data(exclude_hfid=True)
+            input_data = self._generate_input_data(exclude_hfid=True, request_context=request_context)
             mutation_name = f"{self._schema.kind}Create"
             tracker = f"mutation-{str(self._schema.kind).lower()}-create"
         query = Mutation(
@@ -1405,8 +1441,10 @@ class InfrahubNode(InfrahubNodeBase):
         )
         await self._process_mutation_result(mutation_name=mutation_name, response=response, timeout=timeout)
 
-    async def update(self, do_full_update: bool = False, timeout: int | None = None) -> None:
-        input_data = self._generate_input_data(exclude_unmodified=not do_full_update)
+    async def update(
+        self, do_full_update: bool = False, timeout: int | None = None, request_context: RequestContext | None = None
+    ) -> None:
+        input_data = self._generate_input_data(exclude_unmodified=not do_full_update, request_context=request_context)
         mutation_query = self._generate_mutation_query()
         mutation_name = f"{self._schema.kind}Update"
 
@@ -1635,18 +1673,21 @@ 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
 
-    def delete(self, timeout: int | None = None) -> None:
+    def delete(self, timeout: int | None = None, request_context: RequestContext | None = None) -> None:
         input_data = {"data": {"id": self.id}}
+        if context_data := self._get_request_context(request_context=request_context):
+            input_data["context"] = context_data
+
         mutation_query = {"ok": None}
         query = Mutation(
             mutation=f"{self._schema.kind}Delete",
@@ -1661,12 +1702,16 @@ class InfrahubNodeSync(InfrahubNodeBase):
         )
 
     def save(
-        self, allow_upsert: bool = False, update_group_context: bool | None = None, timeout: int | None = None
+        self,
+        allow_upsert: bool = False,
+        update_group_context: bool | None = None,
+        timeout: int | None = None,
+        request_context: RequestContext | None = None,
     ) -> None:
         if self._existing is False or allow_upsert is True:
-            self.create(allow_upsert=allow_upsert, timeout=timeout)
+            self.create(allow_upsert=allow_upsert, timeout=timeout, request_context=request_context)
         else:
-            self.update(timeout=timeout)
+            self.update(timeout=timeout, request_context=request_context)
 
         if update_group_context is None and self._client.mode == InfrahubClientMode.TRACKING:
             update_group_context = True
@@ -1890,15 +1935,17 @@ class InfrahubNodeSync(InfrahubNodeBase):
             related_node.fetch(timeout=timeout)
             setattr(self, rel_name, related_node)
 
-    def create(self, allow_upsert: bool = False, timeout: int | None = None) -> None:
+    def create(
+        self, allow_upsert: bool = False, timeout: int | None = None, request_context: RequestContext | None = None
+    ) -> None:
         mutation_query = self._generate_mutation_query()
 
         if allow_upsert:
-            input_data = self._generate_input_data(exclude_hfid=False)
+            input_data = self._generate_input_data(exclude_hfid=False, request_context=request_context)
             mutation_name = f"{self._schema.kind}Upsert"
             tracker = f"mutation-{str(self._schema.kind).lower()}-upsert"
         else:
-            input_data = self._generate_input_data(exclude_hfid=True)
+            input_data = self._generate_input_data(exclude_hfid=True, request_context=request_context)
             mutation_name = f"{self._schema.kind}Create"
             tracker = f"mutation-{str(self._schema.kind).lower()}-create"
         query = Mutation(
@@ -1917,8 +1964,10 @@ class InfrahubNodeSync(InfrahubNodeBase):
         )
         self._process_mutation_result(mutation_name=mutation_name, response=response, timeout=timeout)
 
-    def update(self, do_full_update: bool = False, timeout: int | None = None) -> None:
-        input_data = self._generate_input_data(exclude_unmodified=not do_full_update)
+    def update(
+        self, do_full_update: bool = False, timeout: int | None = None, request_context: RequestContext | None = None
+    ) -> None:
+        input_data = self._generate_input_data(exclude_unmodified=not do_full_update, request_context=request_context)
         mutation_query = self._generate_mutation_query()
         mutation_name = f"{self._schema.kind}Update"
 

infrahub_sdk/protocols.py

@@ -29,6 +29,7 @@ if TYPE_CHECKING:
         StringOptional,
     )
 
+# pylint: disable=too-many-ancestors
 
 # ---------------------------------------------
 # ASYNC
@@ -72,7 +73,7 @@ class CoreArtifactTarget(CoreNode):
 
 
 class CoreBasePermission(CoreNode):
-    decision: Enum
+    description: StringOptional
     identifier: StringOptional
     roles: RelationshipManager
 
@@ -107,7 +108,6 @@ class CoreGenericAccount(CoreNode):
     label: StringOptional
     description: StringOptional
     account_type: Enum
-    role: Enum
     status: Dropdown
     tokens: RelationshipManager
 
@@ -154,6 +154,10 @@ class CoreMenu(CoreNode):
     children: RelationshipManager
 
 
+class CoreObjectTemplate(CoreNode):
+    template_name: String
+
+
 class CoreProfile(CoreNode):
     profile_name: String
     profile_priority: IntegerOptional
@@ -199,6 +203,8 @@ class CoreValidator(CoreNode):
 
 class CoreWebhook(CoreNode):
     name: String
+    event_type: Enum
+    branch_scope: Dropdown
     description: StringOptional
     url: URL
     validate_certificates: BooleanOptional
@@ -221,7 +227,7 @@ class CoreAccount(LineageOwner, LineageSource, CoreGenericAccount):
     pass
 
 
-class CoreAccountGroup(CoreGroup):
+class CoreAccountGroup(LineageOwner, LineageSource, CoreGroup):
     roles: RelationshipManager
 
 
@@ -349,8 +355,8 @@ class CoreGeneratorValidator(CoreValidator):
 
 
 class CoreGlobalPermission(CoreBasePermission):
-    name: String
     action: Dropdown
+    decision: Enum
 
 
 class CoreGraphQLQuery(CoreNode):
@@ -401,6 +407,7 @@ class CoreObjectPermission(CoreBasePermission):
     namespace: String
     name: String
     action: Enum
+    decision: Enum
 
 
 class CoreObjectThread(CoreThread):
@@ -537,7 +544,7 @@ class CoreArtifactTargetSync(CoreNodeSync):
 
 
 class CoreBasePermissionSync(CoreNodeSync):
-    decision: Enum
+    description: StringOptional
     identifier: StringOptional
     roles: RelationshipManagerSync
 
@@ -572,7 +579,6 @@ class CoreGenericAccountSync(CoreNodeSync):
     label: StringOptional
     description: StringOptional
     account_type: Enum
-    role: Enum
     status: Dropdown
     tokens: RelationshipManagerSync
 
@@ -619,6 +625,10 @@ class CoreMenuSync(CoreNodeSync):
     children: RelationshipManagerSync
 
 
+class CoreObjectTemplateSync(CoreNodeSync):
+    template_name: String
+
+
 class CoreProfileSync(CoreNodeSync):
     profile_name: String
     profile_priority: IntegerOptional
@@ -664,6 +674,8 @@ class CoreValidatorSync(CoreNodeSync):
 
 class CoreWebhookSync(CoreNodeSync):
     name: String
+    event_type: Enum
+    branch_scope: Dropdown
     description: StringOptional
     url: URL
     validate_certificates: BooleanOptional
@@ -686,7 +698,7 @@ class CoreAccountSync(LineageOwnerSync, LineageSourceSync, CoreGenericAccountSyn
     pass
 
 
-class CoreAccountGroupSync(CoreGroupSync):
+class CoreAccountGroupSync(LineageOwnerSync, LineageSourceSync, CoreGroupSync):
     roles: RelationshipManagerSync
 
 
@@ -814,8 +826,8 @@ class CoreGeneratorValidatorSync(CoreValidatorSync):
 
 
 class CoreGlobalPermissionSync(CoreBasePermissionSync):
-    name: String
     action: Dropdown
+    decision: Enum
 
 
 class CoreGraphQLQuerySync(CoreNodeSync):
@@ -866,6 +878,7 @@ class CoreObjectPermissionSync(CoreBasePermissionSync):
     namespace: String
     name: String
     action: Enum
+    decision: Enum
 
 
 class CoreObjectThreadSync(CoreThreadSync):

infrahub_sdk/protocols_base.py

@@ -5,6 +5,7 @@ from typing import TYPE_CHECKING, Any, Protocol, runtime_checkable
 if TYPE_CHECKING:
     import ipaddress
 
+    from .context import RequestContext
     from .schema import MainSchemaTypes
 
 
@@ -169,13 +170,23 @@ class CoreNodeBase(Protocol):
 
 @runtime_checkable
 class CoreNode(CoreNodeBase, Protocol):
-    async def save(self, allow_upsert: bool = False, update_group_context: bool | None = None) -> None: ...
+    async def save(
+        self,
+        allow_upsert: bool = False,
+        update_group_context: bool | None = None,
+        timeout: int | None = None,
+        request_context: RequestContext | None = None,
+    ) -> None: ...
 
-    async def delete(self) -> None: ...
+    async def delete(self, timeout: int | None = None, request_context: RequestContext | None = None) -> None: ...
 
-    async def update(self, do_full_update: bool) -> None: ...
+    async def update(
+        self, do_full_update: bool, timeout: int | None = None, request_context: RequestContext | None = None
+    ) -> None: ...
 
-    async def create(self, allow_upsert: bool = False) -> None: ...
+    async def create(
+        self, allow_upsert: bool = False, timeout: int | None = None, request_context: RequestContext | None = None
+    ) -> None: ...
 
     async def add_relationships(self, relation_to_update: str, related_nodes: list[str]) -> None: ...
 
@@ -184,13 +195,23 @@ class CoreNode(CoreNodeBase, Protocol):
 
 @runtime_checkable
 class CoreNodeSync(CoreNodeBase, Protocol):
-    def save(self, allow_upsert: bool = False, update_group_context: bool | None = None) -> None: ...
-
-    def delete(self) -> None: ...
-
-    def update(self, do_full_update: bool) -> None: ...
-
-    def create(self, allow_upsert: bool = False) -> None: ...
+    def save(
+        self,
+        allow_upsert: bool = False,
+        update_group_context: bool | None = None,
+        timeout: int | None = None,
+        request_context: RequestContext | None = None,
+    ) -> None: ...
+
+    def delete(self, timeout: int | None = None, request_context: RequestContext | None = None) -> None: ...
+
+    def update(
+        self, do_full_update: bool, timeout: int | None = None, request_context: RequestContext | None = None
+    ) -> None: ...
+
+    def create(
+        self, allow_upsert: bool = False, timeout: int | None = None, request_context: RequestContext | None = None
+    ) -> None: ...
 
     def add_relationships(self, relation_to_update: str, related_nodes: list[str]) -> None: ...