Return function type (#1626)

* return function type

* black & lint

* black & lint

* fix serializers and add feature to client

* added integration test

* fixed types

* fixed types

* change to static variables

* lint

* test a new configuration for the k8s test

* use 0.20.0 kind

* install simpler dependencies

* use kind 0.27.0

* last updates to the gha configuration

* test with 2gb of memory

* setup memory to 3 for the tests

---------

Co-authored-by: David <[email protected]>

Author: korgan00

.github/workflows/kubernetes-deploy.yaml

@@ -12,17 +12,17 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 45
     steps:
-      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 #4.1.7
+      - uses: actions/checkout@v4.2.2
       - name: Install Kind
         run: |
-          curl -Lo ./kind "https://github.com/kubernetes-sigs/kind/releases/download/v0.20.0/kind-$(uname)-amd64"
+          curl -Lo ./kind "https://github.com/kubernetes-sigs/kind/releases/download/v0.27.0/kind-$(uname)-amd64"
           chmod +x ./kind
           sudo mv kind /usr/local/bin
           which kind
       - name: Create Kind cluster
         uses: chainguard-dev/actions/setup-kind@main
         with:
-          k8s-version: 1.29.x
+          k8s-version: 1.31.x
           kind-worker-count: 0
       - name: Label nodes
         run: kubectl label node kind-control-plane has-gpu=gpu has-cpu=cpu
@@ -44,14 +44,13 @@ jobs:
           helm dependency build
           helm install qs \
             --set platform=kind \
-            --set repositoryEnable=false \
             --set nginxIngressControllerEnable=false \
             --set gateway.image.repository=gateway \
             --set gateway.image.tag=test \
             --set gateway.application.ray.nodeImage=ray:test \
             --set gateway.application.ray.cpu=1 \
+            --set gateway.application.ray.memory=3 \
             --set gateway.application.debug=1 \
-            --set gateway.application.limits.keepClusterOnComplete=false \
             --set gateway.application.authMockproviderRegistry=test \
             .
           GATEWAY=$(kubectl get pod -l app.kubernetes.io/name=gateway -o name)
@@ -62,19 +61,9 @@ jobs:
           python-version: "3.11"
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip==24.2
+          python -m pip install --upgrade pip>=24.2
           cd client
           pip install . --no-cache-dir
-          pip install --no-cache-dir \
-            ipywidgets==8.1.1 \
-            circuit-knitting-toolbox>=0.6.0 \
-            matplotlib==3.7.1 \
-            pyscf==2.2.1 \
-            scipy==1.10 \
-            qiskit-ibm-provider>=0.9.0 \
-            qiskit-aer>=0.13.3 \
-            certifi==2024.7.4
-          pip install nbmake==1.5.4 pytest==8.3.2
       - name: Run tests
         run: |
           kubectl patch svc gateway -p '{"spec": {"type": "LoadBalancer"}}'

client/qiskit_serverless/core/clients/serverless_client.py

@@ -432,15 +432,12 @@ def functions(self, **kwargs) -> List[RunnableQiskitFunction]:
             )
         )
 
+        for program_data in response_data:
+            program_data["client"] = self
+
         return [
-            RunnableQiskitFunction(
-                client=self,
-                title=program.get("title"),
-                provider=program.get("provider", None),
-                raw_data=program,
-                description=program.get("description"),
-            )
-            for program in response_data
+            RunnableQiskitFunction.from_json(program_data)
+            for program_data in response_data
         ]
 
     @_trace_functions("get_by_title")
@@ -461,12 +458,9 @@ def function(
             )
         )
 
-        return RunnableQiskitFunction(
-            client=self,
-            title=response_data.get("title"),
-            provider=response_data.get("provider", None),
-            raw_data=response_data,
-        )
+        response_data["client"] = self
+        the_function = RunnableQiskitFunction.from_json(response_data)
+        return the_function
 
     #####################
     ####### FILES #######

client/qiskit_serverless/core/function.py

@@ -30,13 +30,17 @@
 import dataclasses
 import warnings
 from dataclasses import dataclass
-from typing import Optional, Dict, List, Any, Tuple, Union
+from typing import ClassVar, Literal, Optional, Dict, List, Any, Tuple, Union
 
 from qiskit_serverless.core.job import (
     Job,
     Configuration,
 )
 
+GenericType = Literal["GENERIC"]
+ApplicationType = Literal["APPLICATION"]
+CircuitType = Literal["CIRCUIT"]
+
 
 @dataclass
 class QiskitFunction:  # pylint: disable=too-many-instance-attributes
@@ -54,6 +58,10 @@ class QiskitFunction:  # pylint: disable=too-many-instance-attributes
         version: version of a program
     """
 
+    GENERIC: ClassVar[GenericType] = "GENERIC"
+    APPLICATION: ClassVar[ApplicationType] = "APPLICATION"
+    CIRCUIT: ClassVar[CircuitType] = "CIRCUIT"
+
     title: str
     provider: Optional[str] = None
     entrypoint: Optional[str] = None
@@ -67,6 +75,7 @@ class QiskitFunction:  # pylint: disable=too-many-instance-attributes
     image: Optional[str] = None
     validate: bool = True
     schema: Optional[str] = None
+    type: Union[GenericType, ApplicationType, CircuitType] = GENERIC
 
     def __post_init__(self):
         title_has_provider = "/" in self.title
@@ -154,7 +163,7 @@ def __init__(  # pylint:  disable=too-many-positional-arguments
     @classmethod
     def from_json(cls, data: Dict[str, Any]):
         """Reconstructs QiskitPattern from dictionary."""
-        field_names = set(f.name for f in dataclasses.fields(QiskitFunction))
+        field_names = set(f.name for f in dataclasses.fields(RunnableQiskitFunction))
         client = data["client"]
         return RunnableQiskitFunction(
             client, **{k: v for k, v in data.items() if k in field_names}

client/qiskit_serverless/core/job.py

@@ -34,7 +34,7 @@
 import os
 import time
 import warnings
-from typing import Dict, Any, Optional, Union
+from typing import ClassVar, Dict, Any, Literal, Optional, Union
 from dataclasses import dataclass
 
 import ray.runtime_env
@@ -111,21 +111,35 @@ def filtered_logs(self, job_id: str, **kwargs) -> str:
         """
 
 
+PendingType = Literal["PENDING"]
+RunningType = Literal["RUNNING"]
+StoppedType = Literal["STOPPED"]
+SucceededType = Literal["SUCCEEDED"]
+FailedType = Literal["FAILED"]
+QueuedType = Literal["QUEUED"]
+# RUNNING statuses
+MappingType = Literal["MAPPING"]
+OptimizingHardwareType = Literal["OPTIMIZING_HARDWARE"]
+WaitingQpuType = Literal["WAITING_QPU"]
+ExecutingQpuType = Literal["EXECUTING_QPU"]
+PostProcessingType = Literal["POST_PROCESSING"]
+
+
 class Job:
     """Job."""
 
-    PENDING = "PENDING"
-    RUNNING = "RUNNING"
-    STOPPED = "STOPPED"
-    SUCCEEDED = "SUCCEEDED"
-    FAILED = "FAILED"
-    QUEUED = "QUEUED"
+    PENDING: ClassVar[PendingType] = "PENDING"
+    RUNNING: ClassVar[RunningType] = "RUNNING"
+    STOPPED: ClassVar[StoppedType] = "STOPPED"
+    SUCCEEDED: ClassVar[SucceededType] = "SUCCEEDED"
+    FAILED: ClassVar[FailedType] = "FAILED"
+    QUEUED: ClassVar[QueuedType] = "QUEUED"
     # RUNNING statuses
-    MAPPING = "MAPPING"
-    OPTIMIZING_HARDWARE = "OPTIMIZING_HARDWARE"
-    WAITING_QPU = "WAITING_QPU"
-    EXECUTING_QPU = "EXECUTING_QPU"
-    POST_PROCESSING = "POST_PROCESSING"
+    MAPPING: ClassVar[MappingType] = "MAPPING"
+    OPTIMIZING_HARDWARE: ClassVar[OptimizingHardwareType] = "OPTIMIZING_HARDWARE"
+    WAITING_QPU: ClassVar[WaitingQpuType] = "WAITING_QPU"
+    EXECUTING_QPU: ClassVar[ExecutingQpuType] = "EXECUTING_QPU"
+    POST_PROCESSING: ClassVar[PostProcessingType] = "POST_PROCESSING"
 
     def __init__(
         self,

gateway/api/v1/serializers.py

@@ -31,6 +31,7 @@ class Meta(serializers.ProgramSerializer.Meta):
             "provider",
             "description",
             "documentation_url",
+            "type",
         ]
 
 
@@ -91,6 +92,7 @@ def validate(self, attrs):  # pylint: disable=too-many-branches
                 raise ValidationError(
                     f"Custom images must be in {provider_instance.registry}."
                 )
+
         return super().validate(attrs)
 
     class Meta(serializers.UploadProgramSerializer.Meta):
@@ -103,12 +105,13 @@ class Meta(serializers.UploadProgramSerializer.Meta):
             "image",
             "provider",
             "description",
+            "type",
         ]
 
 
 class RunProgramSerializer(serializers.RunProgramSerializer):
     """
-    RunExistingProgramSerializer is used by the /upload end-point
+    RunExistingProgramSerializer is used by the /run end-point
     """
 
 

gateway/tests/api/test_v1_serializers.py

@@ -61,12 +61,14 @@ def test_upload_program_serializer_creates_program(self):
 
         title = "Hello world"
         entrypoint = "pattern.py"
+        type = Program.CIRCUIT
         arguments = "{}"
         dependencies = "[]"
 
         data = {}
         data["title"] = title
         data["entrypoint"] = entrypoint
+        data["type"] = type
         data["arguments"] = arguments
         data["dependencies"] = dependencies
         data["artifact"] = upload_file
@@ -76,6 +78,7 @@ def test_upload_program_serializer_creates_program(self):
 
         program: Program = serializer.save(author=user)
         self.assertEqual(title, program.title)
+        self.assertEqual(type, program.type)
         self.assertEqual(entrypoint, program.entrypoint)
         self.assertEqual(dependencies, program.dependencies)
 

tests/docker/test_docker.py

@@ -36,10 +36,12 @@ def test_simple_function(self, base_client: BaseClient):
         runnable_function = base_client.upload(simple_function)
 
         assert runnable_function is not None
+        assert runnable_function.type == "GENERIC"
 
         runnable_function = base_client.function(simple_function.title)
 
         assert runnable_function is not None
+        assert runnable_function.type == "GENERIC"
 
         job = runnable_function.run()