Extend the network client

Makefile

@@ -286,7 +286,7 @@ network-module-test: assets
 INTEGRATION_TEST_IN_DOCKER = docker exec core_test
 network-integration-test:
 	$(DOCKER_COMPOSE) --file tests/network/docker-compose.yml up -d
-	-$(INTEGRATION_TEST_IN_DOCKER) pytest -k 'test_integration_' -v --ignore-glob="$(TESTDIR)/network/*ocrd_all*.py"
+	-$(INTEGRATION_TEST_IN_DOCKER) pytest -k 'test_integration_' -v --ignore-glob="tests/network/*ocrd_all*.py"
 	$(DOCKER_COMPOSE) --file tests/network/docker-compose.yml down --remove-orphans
 
 network-integration-test-cicd:

src/ocrd_network/cli/client.py

@@ -1,11 +1,43 @@
 import click
+from http.server import BaseHTTPRequestHandler, HTTPServer
 from typing import Optional
 
 from ocrd.decorators import parameter_option
 from ocrd_network import Client
 from ocrd_utils import DEFAULT_METS_BASENAME
 
 
+STOP_WAITING_CALLBACK = False
+
+
+class ClientCallbackHandler(BaseHTTPRequestHandler):
+    """
+    A simple callback handler for the network client to be invoked when the Processing Worker
+    sends requests to the `callback_url` set in the processing request submitted to the Processing Server.
+    """
+
+    def do_POST(self):
+        self.send_response(200)
+        self.send_header("Content-Type", "text/plain")
+        self.end_headers()
+        self.wfile.write("finished".encode("utf-8"))
+        len = int(self.headers.get("Content-Length", 0))
+        data = self.rfile.read(len).decode("utf-8")
+        # TODO: how should the callback-content be handled/printed
+        print(f"Processor finished: {data}")
+        global STOP_WAITING_CALLBACK
+        STOP_WAITING_CALLBACK = True
+
+
+class ClientCallbackServer(HTTPServer):
+    """
+    A simple http-server that listens for callbacks from the Processing Server/Worker.
+    """
+    def __init__(self):
+        super().__init__(server_address=("0.0.0.0", 0), RequestHandlerClass=ClientCallbackHandler)
+        self.callback_url = f"http://172.17.0.1:{self.server_address[1]}"
+
+
 @click.group('client')
 def client_cli():
     """
@@ -43,25 +75,27 @@ def processing_cli():
 @click.option('--callback-url')
 @click.option('--agent-type', default='worker')
 def send_processing_request(
-        address: Optional[str],
-        processor_name: str,
-        mets: str,
-        input_file_grp: str,
-        output_file_grp: Optional[str],
-        page_id: Optional[str],
-        parameter: Optional[dict],
-        result_queue_name: Optional[str],
-        callback_url: Optional[str],
-        # TODO: This is temporally available to toggle
-        #  between the ProcessingWorker/ProcessorServer
-        agent_type: Optional[str]
+    address: Optional[str],
+    processor_name: str,
+    mets: str,
+    input_file_grp: str,
+    output_file_grp: Optional[str],
+    page_id: Optional[str],
+    parameter: Optional[dict],
+    result_queue_name: Optional[str],
+    callback_url: Optional[str],
+    # TODO: This is temporally available to toggle
+    #  between the ProcessingWorker/ProcessorServer
+    agent_type: Optional[str]
 ):
+    callback_server = ClientCallbackServer()
     req_params = {
         "path_to_mets": mets,
         "description": "OCR-D Network client request",
         "input_file_grps": input_file_grp.split(','),
         "parameters": parameter if parameter else {},
         "agent_type": agent_type,
+        "callback_url": callback_server.callback_url
     }
     if output_file_grp:
         req_params["output_file_grps"] = output_file_grp.split(',')
@@ -72,15 +106,12 @@ def send_processing_request(
     if callback_url:
         req_params["callback_url"] = callback_url
 
-    client = Client(
-        server_addr_processing=address
-    )
-    response = client.send_processing_request(
-        processor_name=processor_name,
-        req_params=req_params
-    )
+    client = Client(server_addr_processing=address)
+    response = client.send_processing_request(processor_name=processor_name, req_params=req_params)
     processing_job_id = response.get('job_id', None)
     print(f"Processing job id: {processing_job_id}")
+    while not STOP_WAITING_CALLBACK:
+        callback_server.handle_request()
 
 
 @client_cli.group('workflow')

src/ocrd_network/client.py

@@ -5,22 +5,13 @@
 from .constants import NETWORK_PROTOCOLS
 
 
-# TODO: This is just a conceptual implementation and first try to
-#  trigger further discussions on how this should look like.
 class Client:
-    def __init__(
-        self,
-        server_addr_processing: str = config.OCRD_NETWORK_SERVER_ADDR_PROCESSING,
-        server_addr_workflow: str = config.OCRD_NETWORK_SERVER_ADDR_WORKFLOW,
-        server_addr_workspace: str = config.OCRD_NETWORK_SERVER_ADDR_WORKSPACE
-    ):
+    def __init__(self, server_addr_processing: str = config.OCRD_NETWORK_SERVER_ADDR_PROCESSING):
         self.log = getLogger(f"ocrd_network.client")
         self.server_addr_processing = server_addr_processing
-        self.server_addr_workflow = server_addr_workflow
-        self.server_addr_workspace = server_addr_workspace
+        verify_server_protocol(self.server_addr_processing)
 
     def send_processing_request(self, processor_name: str, req_params: dict):
-        verify_server_protocol(self.server_addr_processing)
         req_url = f"{self.server_addr_processing}/processor/{processor_name}"
         req_headers = {"Content-Type": "application/json; charset=utf-8"}
         req_json = loads(dumps(req_params))

tests/network/test_integration_6_client.py

@@ -0,0 +1,32 @@
+from click.testing import CliRunner
+
+from src.ocrd_network.constants import AgentType, JobState
+from tests.base import assets
+from tests.network.config import test_config
+from ocrd_network.cli.client import client_cli
+
+PROCESSING_SERVER_URL = test_config.PROCESSING_SERVER_URL
+
+
+def test_client_processing_processor():
+    workspace_root = "kant_aufklaerung_1784/data"
+    path_to_mets = assets.path_to(f"{workspace_root}/mets.xml")
+    runner = CliRunner()
+    result = runner.invoke(
+        client_cli,
+        args=[
+            "processing", "processor", "ocrd-dummy",
+            "--address", PROCESSING_SERVER_URL,
+            "--mets", path_to_mets,
+            "--input-file-grp", "OCR-D-IMG",
+            "--output-file-grp", "OCR-D-DUMMY-TEST-CLIENT",
+            "--agent-type", AgentType.PROCESSING_WORKER
+        ]
+    )
+    # TODO: Do a better result check
+    assert result.output.count("finished") == 1
+
+
+def test_client_processing_workflow():
+    pass
+