Minor changes and fix test_graphql_group_update test

Author: LucasG0

backend/infrahub/api/query.py

@@ -23,8 +23,8 @@
     GRAPHQL_RESPONSE_SIZE_METRICS,
     GRAPHQL_TOP_LEVEL_QUERIES_METRICS,
 )
-from infrahub.graphql.models import RequestGraphQLQueryGroupUpdate
 from infrahub.graphql.utils import extract_data
+from infrahub.groups.models import RequestGraphQLQueryGroupUpdate
 from infrahub.log import get_logger
 from infrahub.workflows.catalogue import REQUEST_GRAPHQL_QUERY_GROUP_UPDATE
 

backend/infrahub/graphql/tasks.py

@@ -2,13 +2,6 @@
 
 from infrahub_sdk import InfrahubClient
 from infrahub_sdk.node import InfrahubNode
-from infrahub_sdk.utils import dict_hash
-from prefect import flow
-
-from infrahub.core.constants import InfrahubKind
-from infrahub.graphql.models import RequestGraphQLQueryGroupUpdate
-from infrahub.services import services
-from infrahub.workflows.utils import add_branch_tag
 
 
 async def _group_add_subscriber(
@@ -33,31 +26,3 @@ async def _group_add_subscriber(
     )
 
     return await client.execute_graphql(query=query, branch_name=branch, tracker="mutation-relationshipadd")
-
-
-@flow(name="request_graphql_query_group_update")
-async def request_graphql_query_group_update(model: RequestGraphQLQueryGroupUpdate) -> None:
-    """Create or Update a GraphQLQueryGroup."""
-
-    await add_branch_tag(branch_name=model.branch)
-    service = services.service
-
-    params_hash = dict_hash(model.params)
-    group_name = f"{model.query_name}__{params_hash}"
-    group_label = f"Query {model.query_name} Hash({params_hash[:8]})"
-    group = await service.client.create(
-        kind=InfrahubKind.GRAPHQLQUERYGROUP,
-        branch=model.branch,
-        name=group_name,
-        label=group_label,
-        group_type="internal",
-        query=model.query_id,
-        parameters=model.params,
-        members=model.related_node_ids,
-    )
-    await group.save(allow_upsert=True)
-
-    if model.subscribers:
-        await _group_add_subscriber(
-            client=service.client, group=group, subscribers=model.subscribers, branch=model.branch
-        )

backend/infrahub/groups/__init__.py

@@ -0,0 +1,35 @@
+from infrahub_sdk.utils import dict_hash
+
+from infrahub.core.constants import InfrahubKind
+from infrahub.graphql.tasks import _group_add_subscriber
+from infrahub.groups.models import RequestGraphQLQueryGroupUpdate
+from infrahub.services import services
+from infrahub.workflows.utils import add_branch_tag
+
+
+# @flow(name="update_graphql_query_group")
+async def update_graphql_query_group(model: RequestGraphQLQueryGroupUpdate) -> None:
+    """Create or Update a GraphQLQueryGroup."""
+
+    await add_branch_tag(branch_name=model.branch)
+    service = services.service
+
+    params_hash = dict_hash(model.params)
+    group_name = f"{model.query_name}__{params_hash}"
+    group_label = f"Query {model.query_name} Hash({params_hash[:8]})"
+    group = await service.client.create(
+        kind=InfrahubKind.GRAPHQLQUERYGROUP,
+        branch=model.branch,
+        name=group_name,
+        label=group_label,
+        group_type="internal",
+        query=model.query_id,
+        parameters=model.params,
+        members=model.related_node_ids,
+    )
+    await group.save(allow_upsert=True)
+
+    if model.subscribers:
+        await _group_add_subscriber(
+            client=service.client, group=group, subscribers=model.subscribers, branch=model.branch
+        )

backend/infrahub/graphql/models.py renamed to backend/infrahub/groups/models.py

@@ -188,12 +188,11 @@
 )
 
 REQUEST_GRAPHQL_QUERY_GROUP_UPDATE = WorkflowDefinition(
-    name="request_graphql_query_group_update",
+    name="update_graphql_query_group",
     type=WorkflowType.INTERNAL,
     module="infrahub.graphql.tasks",
-    function="request_graphql_query_group_update",
+    function="update_graphql_query_group",
     branch_support=BranchSupportType.AWARE,
-    tags=[WorkflowTag.DATABASE_CHANGE],
 )
 
 worker_pools = [INFRAHUB_WORKER_POOL]

backend/infrahub/groups/tasks.py

@@ -1,6 +1,12 @@
+from contextlib import contextmanager
+from typing import Generator
+
+from infrahub_sdk import InfrahubClient
 from testcontainers.core.container import DockerContainer
 from testcontainers.core.waiting_utils import wait_for_logs
 
+from infrahub.services import InfrahubServices, services
+from infrahub.services.adapters.workflow.local import WorkflowLocalExecution
 from tests.helpers.constants import PORT_BOLT_NEO4J, PORT_HTTP_NEO4J
 
 
@@ -29,3 +35,19 @@ def start_neo4j_container(neo4j_image: str) -> DockerContainer:
     container.start()
     wait_for_logs(container, "Started.")  # wait_container_is_ready does not seem to be enough
     return container
+
+
+@contextmanager
+def init_service_with_client(client: InfrahubClient) -> Generator:
+    """
+    This helper is needed for tests defining a specific client while `service` still needs to be accessed
+    through a global variable within prefect tasks.
+    """
+
+    original = services.service
+    service = InfrahubServices(client=client, workflow=WorkflowLocalExecution())
+    services.service = service
+    try:
+        yield service
+    finally:
+        services.service = original

backend/infrahub/workflows/catalogue.py

@@ -6,7 +6,7 @@
 import pytest
 
 from infrahub.core.initialization import create_branch
-from infrahub.graphql.models import RequestGraphQLQueryGroupUpdate
+from infrahub.groups.models import RequestGraphQLQueryGroupUpdate
 from infrahub.workflows.catalogue import REQUEST_GRAPHQL_QUERY_GROUP_UPDATE
 
 if TYPE_CHECKING:

backend/tests/helpers/utils.py

@@ -2943,9 +2943,6 @@ def workflow_local():
 @pytest.fixture
 def init_service(db: InfrahubDatabase):
     original = services.service
-    database = db
-    workflow = WorkflowLocalExecution()
-    service = InfrahubServices(database=database, workflow=workflow)
-    services.service = service
-    yield service
+    services.service = InfrahubServices(database=db, workflow=WorkflowLocalExecution())
+    yield services.service
     services.service = original

backend/tests/unit/api/test_05_query_api.py

@@ -1,16 +1,17 @@
 import os
 import uuid
 from pathlib import Path
+from unittest.mock import patch
 
 import pytest
 import ujson
 from infrahub_sdk import Config, InfrahubClient
 from pytest_httpx import HTTPXMock
 
 from infrahub.database import InfrahubDatabase
-from infrahub.graphql.models import RequestGraphQLQueryGroupUpdate
-from infrahub.graphql.tasks import request_graphql_query_group_update
-from infrahub.services import InfrahubServices
+from infrahub.groups.models import RequestGraphQLQueryGroupUpdate
+from infrahub.groups.tasks import update_graphql_query_group
+from tests.helpers.utils import init_service_with_client
 
 
 @pytest.fixture
@@ -44,23 +45,26 @@ async def test_graphql_group_update(db: InfrahubDatabase, httpx_mock: HTTPXMock,
     client = InfrahubClient(
         config=config,
     )
-    service = InfrahubServices(client=client)
 
-    response1 = {
-        "data": {"CoreGraphQLQueryGroupUpsert": {"ok": True, "object": {"id": "957aea37-4510-4386-916f-3febd6665ae6"}}}
-    }
+    with init_service_with_client(client=client), patch("infrahub.groups.tasks.add_branch_tag"):
+        # add_branch_tag requires a prefect client, ie it does not work with WorkflowLocal
+        response1 = {
+            "data": {
+                "CoreGraphQLQueryGroupUpsert": {"ok": True, "object": {"id": "957aea37-4510-4386-916f-3febd6665ae6"}}
+            }
+        }
 
-    httpx_mock.add_response(
-        method="POST",
-        json=response1,
-        match_headers={"X-Infrahub-Tracker": "mutation-coregraphqlquerygroup-upsert"},
-    )
+        httpx_mock.add_response(
+            method="POST",
+            json=response1,
+            match_headers={"X-Infrahub-Tracker": "mutation-coregraphqlquerygroup-upsert"},
+        )
 
-    response2 = {"data": {"RelationshipAdd": {"ok": True}}}
-    httpx_mock.add_response(
-        method="POST",
-        json=response2,
-        match_headers={"X-Infrahub-Tracker": "mutation-relationshipadd"},
-    )
+        response2 = {"data": {"RelationshipAdd": {"ok": True}}}
+        httpx_mock.add_response(
+            method="POST",
+            json=response2,
+            match_headers={"X-Infrahub-Tracker": "mutation-relationshipadd"},
+        )
 
-    await request_graphql_query_group_update.fn(message=model, service=service)
+        await update_graphql_query_group(model=model)