FEA: Add octue question ask CLI command

skipci

Author: cortadocodes

octue/cli.py

@@ -11,6 +11,8 @@
 from google import auth
 
 from octue.cloud import pub_sub, storage
+from octue.cloud.deployment.google.answer_pub_sub_question import answer_question
+from octue.cloud.events.utils import make_originator_question_event
 from octue.cloud.pub_sub.service import Service
 from octue.cloud.service_id import create_sruid, get_sruid_parts
 from octue.cloud.storage import GoogleCloudStorageClient
@@ -70,6 +72,78 @@ def octue_cli(id, logger_uri, log_level, force_reset):
         global_cli_context["log_handler"] = get_remote_handler(logger_uri=global_cli_context["logger_uri"])
 
 
+@octue_cli.group()
+def question():
+    """Ask and interact with questions to an Octue Twined data service."""
+
+
+@question.command()
+@click.argument("sruid", type=str)
+@click.option(
+    "-i",
+    "--input-values",
+    type=str,
+    default=None,
+    help="Any input values for the question as a JSON-encoded string.",
+)
+@click.option(
+    "-m",
+    "--input-manifest",
+    type=str,
+    default=None,
+    help="An optional input manifest for the question serialised as a JSON-encoded string.",
+)
+@click.option(
+    "-c",
+    "--service-config",
+    type=click.Path(dir_okay=False),
+    default=None,
+    help="The path to an `octue.yaml` file defining the service to run. If not provided, the "
+    "`OCTUE_SERVICE_CONFIGURATION_PATH` environment variable is used if present, otherwise the local path `octue.yaml` "
+    "is used.",
+)
+def ask(sruid, input_values, input_manifest, service_config):
+    """Ask a question to a local or remote Octue Twined service.
+
+    SRUID should be:
+
+    - For remote services: a valid service revision unique identifier for an existing Octue Twined service
+
+      e.g. octue question ask octue/example-service:1.0.3
+
+    - For a local service: "local"
+
+      e.g. octue question ask local
+    """
+    if sruid == "local":
+        service_configuration, app_configuration = load_service_and_app_configuration(service_config)
+        service_namespace, service_name, service_revision_tag = get_sruid_parts(service_configuration)
+
+        child_sruid = create_sruid(namespace=service_namespace, name=service_name, revision_tag=service_revision_tag)
+        parent_sruid = "local/local:local"
+
+        question = make_originator_question_event(
+            input_values=input_values,
+            input_manifest=input_manifest,
+            parent_sruid=parent_sruid,
+            child_sruid=child_sruid,
+        )
+
+        backend_configuration_values = (app_configuration.configuration_values or {}).get("backend")
+
+        if backend_configuration_values:
+            backend_configuration_values = copy.deepcopy(backend_configuration_values)
+            backend = service_backends.get_backend(backend_configuration_values.pop("name"))(
+                **backend_configuration_values
+            )
+        else:
+            # If no backend details are provided, use Google Pub/Sub with the default project.
+            _, project_name = auth.default()
+            backend = service_backends.get_backend()(project_name=project_name)
+
+        answer_question(question=question, project_name=backend.project_name, service_configuration=service_config)
+
+
 @octue_cli.command()
 @click.option(
     "-c",

octue/cloud/__init__.py

@@ -1,8 +1,13 @@
+import importlib.metadata
+
 import octue.exceptions
 import twined.exceptions
 from octue.utils.exceptions import create_exceptions_mapping
 
 
+LOCAL_SDK_VERSION = importlib.metadata.version("octue")
+
+
 EXCEPTIONS_MAPPING = create_exceptions_mapping(
     globals()["__builtins__"],
     vars(twined.exceptions),

octue/cloud/deployment/google/answer_pub_sub_question.py

@@ -11,14 +11,18 @@
 logger = logging.getLogger(__name__)
 
 
-def answer_question(question, project_name):
+def answer_question(question, project_name, service_configuration=None, app_configuration=None):
     """Answer a question sent to an app deployed in Google Cloud.
 
-    :param dict|tuple question:
+    :param dict question:
     :param str project_name:
+    :param service_configuration:
+    :param app_configuration:
     :return None:
     """
-    service_configuration, app_configuration = load_service_and_app_configuration()
+    if not service_configuration:
+        service_configuration, app_configuration = load_service_and_app_configuration()
+
     service_namespace, service_name, service_revision_tag = get_sruid_parts(service_configuration)
 
     service_sruid = create_sruid(

octue/cloud/events/utils.py

@@ -0,0 +1,49 @@
+import datetime
+import uuid
+
+from octue.cloud import LOCAL_SDK_VERSION
+
+
+def make_originator_question_event(input_values, input_manifest, parent_sruid, child_sruid, question_uuid=None):
+    question_uuid = question_uuid or uuid.uuid4()
+
+    return {
+        "event": {
+            "input_values": input_values,
+            "input_manifest": input_manifest,
+        },
+        "attributes": make_attributes(
+            question_uuid=question_uuid,
+            parent_question_uuid=question_uuid,
+            originator_question_uuid=question_uuid,
+            parent=parent_sruid,
+            originator=parent_sruid,
+            sender=parent_sruid,
+            recipient=child_sruid,
+        ),
+    }
+
+
+def make_attributes(
+    parent_question_uuid,
+    originator_question_uuid,
+    parent,
+    originator,
+    sender,
+    recipient,
+    question_uuid=None,
+    retry_count=0,
+):
+    return {
+        "uuid": str(uuid.uuid4()),
+        "datetime": datetime.datetime.now(tz=datetime.timezone.utc).isoformat(),
+        "question_uuid": question_uuid or str(uuid.uuid4()),
+        "parent_question_uuid": parent_question_uuid,
+        "originator_question_uuid": originator_question_uuid,
+        "parent": parent,
+        "originator": originator,
+        "sender": sender,
+        "sender_sdk_version": LOCAL_SDK_VERSION,
+        "recipient": recipient,
+        "retry_count": retry_count,
+    }

octue/cloud/pub_sub/service.py

@@ -1,6 +1,5 @@
 import concurrent.futures
 import copy
-import datetime
 import functools
 import importlib.metadata
 import json
@@ -15,7 +14,9 @@
 from google.cloud import pubsub_v1
 
 import octue.exceptions
+from octue.cloud import LOCAL_SDK_VERSION
 from octue.cloud.events import OCTUE_SERVICES_PREFIX
+from octue.cloud.events.utils import make_attributes
 from octue.cloud.events.validation import raise_if_event_is_invalid
 from octue.cloud.pub_sub import Subscription, Topic
 from octue.cloud.pub_sub.events import GoogleCloudPubSubEventHandler, extract_event_and_attributes_from_pub_sub_message
@@ -85,7 +86,6 @@ def __init__(self, backend, service_id=None, run_function=None, service_registri
         self.service_registries = service_registries
 
         self._pub_sub_id = convert_service_id_to_pub_sub_form(self.id)
-        self._local_sdk_version = importlib.metadata.version("octue")
         self._event_handler = None
 
     def __repr__(self):
@@ -288,7 +288,7 @@ def answer(self, question, heartbeat_interval=120, timeout=30):
             if heartbeater is not None:
                 heartbeater.cancel()
 
-            warn_if_incompatible(child_sdk_version=self._local_sdk_version, parent_sdk_version=parent_sdk_version)
+            warn_if_incompatible(child_sdk_version=LOCAL_SDK_VERSION, parent_sdk_version=parent_sdk_version)
             self.send_exception(timeout=timeout, **routing_metadata)
             raise error
 
@@ -538,19 +538,16 @@ def _emit_event(
         attributes = attributes or {}
 
         attributes.update(
-            {
-                "uuid": str(uuid.uuid4()),
-                "datetime": datetime.datetime.now(tz=datetime.timezone.utc).isoformat(),
-                "question_uuid": question_uuid,
-                "parent_question_uuid": parent_question_uuid,
-                "originator_question_uuid": originator_question_uuid,
-                "parent": parent,
-                "originator": originator,
-                "sender": self.id,
-                "sender_sdk_version": self._local_sdk_version,
-                "recipient": recipient,
-                "retry_count": retry_count,
-            }
+            make_attributes(
+                question_uuid=question_uuid,
+                parent_question_uuid=parent_question_uuid,
+                originator_question_uuid=originator_question_uuid,
+                parent=parent,
+                originator=originator,
+                sender=self.id,
+                recipient=recipient,
+                retry_count=retry_count,
+            )
         )
 
         converted_attributes = {}

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "octue"
-version = "0.62.0"
+version = "0.63.0"
 description = "A package providing template applications for data services, and a python SDK to the Octue API."
 readme = "README.md"
 authors = ["Marcus Lugg <marcus@octue.com>", "Thomas Clark <support@octue.com>"]