[graphql-pydantic-converter] stringify mutation input

Author: Jozef Volak

.github/workflows/release_utils.yml

@@ -35,7 +35,7 @@ jobs:
         run: |
           echo "IMAGE_NAME=frinx/${{ env.PACKAGE_NAME }}:${{ env.PACKAGE_VERSION }}" >> "$GITHUB_ENV"
       - name: Poetry publish
-        run: poetry publish -u "__token__" -p "${{ secrets.PYPI_TOKEN }}" --build --dry-run
+        run: poetry publish -u "__token__" -p "${{ secrets.PYPI_TOKEN }}" --build
       - name: Build docker image
         run: docker build . --file Dockerfile --build-arg git_commit=$(git rev-parse HEAD) --tag ${{ env.IMAGE_NAME }}
       - name: Log into docker hub
@@ -53,4 +53,4 @@ jobs:
           body: |
             - Release of ${{ env.PACKAGE_NAME }}:${{ env.PACKAGE_VERSION }} for image with tag ${{ env.IMAGE_NAME }}
           draft: false
-          prerelease: false
+          prerelease: false

utils/graphql-pydantic-converter/CHANGELOG.md

@@ -15,5 +15,10 @@
 # 1.0.0
 - Migration to pydantic v2
 
-# 1.1.0
-- Change Map type to dict (key, value)
+# 1.0.1
+- Change Map type to dict (key, value)
+
+# 1.0.2
+- Stringify mutation input strings
+- Add __typename to payload
+- create test folder as a module

utils/graphql-pydantic-converter/graphql_pydantic_converter/graphql_types.py

@@ -1,10 +1,13 @@
 from __future__ import annotations
 
+import json
+import typing
 from enum import Enum
 from typing import TYPE_CHECKING
 
 from pydantic import BaseModel
 from pydantic import ConfigDict
+from pydantic import Field
 
 if TYPE_CHECKING:
     from typing import Any
@@ -101,6 +104,7 @@ class Interface(BaseModel):
 
 
 class Payload(BaseModel):
+    typename: bool = Field(default=False, alias='__typename')
 
     model_config = ConfigDict(
         extra='forbid',
@@ -153,7 +157,10 @@ def _parse_num(value: int | float) -> str:
 
     @staticmethod
     def _parse_str(value: Any) -> str:
-        return f'"{value}"'
+        try:
+            return json.dumps(json.loads(json.dumps(value)))
+        except ValueError:
+            return f'"{value}"'
 
     @staticmethod
     def _parse_tuple(value: tuple[Any, ...]) -> str:
@@ -270,7 +277,10 @@ def _parse_num(value: int | float) -> str:
 
     @staticmethod
     def _parse_str(value: Any) -> str:
-        return f'"{value}"'
+        try:
+            return json.dumps(json.loads(json.dumps(value)))
+        except ValueError:
+            return f'"{value}"'
 
     @staticmethod
     def _parse_tuple(value: tuple[Any, ...]) -> str:
@@ -350,6 +360,6 @@ def render(self) -> str:
         return f'{{ { name }{variable} {{ {payload} }} }}'
 
 
-def concatenate_queries(queries: list[Union[Query, Mutation]]) -> str:
+def concatenate_queries(queries: typing.Sequence[Union[Query, Mutation]]) -> str:
     merged_query = ''.join(query.render()[1:-1] for query in queries)
     return f'{{ {merged_query} }}'

utils/graphql-pydantic-converter/pyproject.toml

@@ -19,7 +19,7 @@ packages = [{ include = "graphql_pydantic_converter" }]
 name = "graphql-pydantic-converter"
 description = "Convert pydantic schema to pydantic datamodel and build request from it"
 authors = ["Jozef Volak <[email protected]>"]
-version = '1.0.1'
+version = '1.0.2'
 readme = ["README.md", "CHANGELOG.md"]
 keywords = ["graphql", "pydantic"]
 license = "Apache 2.0"

utils/graphql-pydantic-converter/tests/__init__.py

@@ -0,0 +1,14 @@
+{
+	"cli": {
+		"cli-topology:host": "sample-topology",
+		"cli-topology:port": "{{port}}",
+		"cli-topology:transport-type": "ssh",
+		"cli-topology:device-type": "{{device_type}}",
+		"cli-topology:device-version": "{{device_version}}",
+		"cli-topology:password": "{{password}}",
+		"cli-topology:username": "{{username}}",
+		"cli-topology:journal-size": 500,
+		"cli-topology:dry-run-journal-size": 180,
+		"cli-topology:parsing-engine": "tree-parser"
+	}
+}

utils/graphql-pydantic-converter/tests/blueprint.json

@@ -1,35 +1,37 @@
 import json
 import typing
 
-from model import AddBlueprintInput
-from model import AddBlueprintMutation
-from model import AddBlueprintPayload
-from model import Blueprint
-from model import BlueprintConnection
-from model import BlueprintEdge
-from model import BlueprintsQuery
 from pydantic import Field
-from render_models import AllocationStrategy
-from render_models import ClaimResourceMutation
-from render_models import PageInfoSchedule
-from render_models import Resource
-from render_models import ResourcePool
-from render_models import ResourcePoolConnection
-from render_models import ResourcePoolEdge
-from render_models import Schedule
-from render_models import ScheduleConnection
-from render_models import ScheduleEdge
-from render_models import SchedulesFilterInput
-from render_models import SchedulesQuery
-from render_models import SearchPoolsByTagsQuery
-from render_models import TagAnd
-from render_models import TagOr
 
 import graphql_pydantic_converter.graphql_types
 from graphql_pydantic_converter.graphql_types import ENUM
 from graphql_pydantic_converter.graphql_types import Input
 from graphql_pydantic_converter.schema_converter import GraphqlJsonParser
 
+from .model import AddBlueprintInput
+from .model import AddBlueprintMutation
+from .model import AddBlueprintPayload
+from .model import Blueprint
+from .model import BlueprintConnection
+from .model import BlueprintEdge
+from .model import BlueprintsQuery
+from .model import BlueprintsQueryResponse
+from .render_models import AllocationStrategy
+from .render_models import ClaimResourceMutation
+from .render_models import PageInfoSchedule
+from .render_models import Resource
+from .render_models import ResourcePool
+from .render_models import ResourcePoolConnection
+from .render_models import ResourcePoolEdge
+from .render_models import Schedule
+from .render_models import ScheduleConnection
+from .render_models import ScheduleEdge
+from .render_models import SchedulesFilterInput
+from .render_models import SchedulesQuery
+from .render_models import SearchPoolsByTagsQuery
+from .render_models import TagAnd
+from .render_models import TagOr
+
 
 class TestTaskGenerator:
     def test_render_json(self) -> None:
@@ -131,6 +133,38 @@ class AddDeviceInput(Input):
 
         assert reference == mutation
 
+        json_blueprint = 'tests/blueprint.json'
+
+        with open(json_blueprint) as json_file:
+            device_import_json = json_file.read()
+            template = device_import_json
+
+            mutation = AddBlueprintMutation(
+                payload=AddBlueprintPayload(
+                    blueprint=Blueprint(
+                        id=True,
+                        name=True,
+                        template=True
+                    )
+                ),
+                input=AddBlueprintInput(
+                    name='blueprint',
+                    template=template,
+                )
+            ).render()
+
+        reference = ('mutation { addBlueprint ( input: { name: "blueprint", template: "{\n\t\"cli\": '
+                     '{\n\t\t\"cli-topology:host\": \"sample-topology\",\n\t\t\"cli-topology:port\": '
+                     '\"{{port}}\",\n\t\t\"cli-topology:transport-type\": \"ssh\",\n\t\t\"cli-topology:device-type\": '
+                     '\"{{device_type}}\",\n\t\t\"cli-topology:device-version\": '
+                     '\"{{device_version}}\",\n\t\t\"cli-topology:password\": '
+                     '\"{{password}}\",\n\t\t\"cli-topology:username\": '
+                     '\"{{username}}\",\n\t\t\"cli-topology:journal-size\": '
+                     '500,\n\t\t\"cli-topology:dry-run-journal-size\": 180,\n\t\t\"cli-topology:parsing-engine\": '
+                     '\"tree-parser\"\n\t}\n}" }) { blueprint { id name template } } }')
+
+        assert reference == mutation
+
     def test_render_input_advanced(self) -> None:
         query = SearchPoolsByTagsQuery(
             tags=TagOr(
@@ -202,7 +236,6 @@ def test_render_input_advanced(self) -> None:
         assert reference == query_render
 
     def test_parse_response(self) -> None:
-        from model import BlueprintsQueryResponse
 
         response: typing.Any = {
             'data': {
@@ -253,7 +286,9 @@ def test_multiple_query(self) -> None:
 
         query_second = SchedulesQuery(
             payload=ScheduleConnection(
+                __typename=True,
                 pageInfo=PageInfoSchedule(
+                    __typename=True,
                     hasNextPage=True,
                     hasPreviousPage=True,
                     startCursor=True,
@@ -285,9 +320,9 @@ def test_multiple_query(self) -> None:
         reference = '{  SearchPoolsByTags ( tags: { matchesAny: [  { matchesAll: [ "root_pool" ] }  ]  } ) ' \
             '{ edges { node { AllocationStrategy { Name } ' \
             'Name PoolProperties PoolType id } } totalCount }  schedules ( after: "aaa", first: 10, filter: ' \
-            '{ workflowName: "TEST_A" , workflowVersion: "1"  } ) { edges { node { name enabled ' \
+            '{ workflowName: "TEST_A" , workflowVersion: "1"  } ) { __typename edges { node { name enabled ' \
             'cronString } cursor } ' \
-            'pageInfo { hasNextPage hasPreviousPage startCursor endCursor } totalCount }  }'
+            'pageInfo { __typename hasNextPage hasPreviousPage startCursor endCursor } totalCount }  }'
 
         merged_query = graphql_pydantic_converter.graphql_types.concatenate_queries(queries)
         assert reference == merged_query