From f5e6e1796bce80b08f405d07c3737b29dcc54782 Mon Sep 17 00:00:00 2001
From: Pavel Raiskup <praiskup@redhat.com>
Date: Wed, 8 Nov 2023 11:25:02 +0100
Subject: [PATCH] backend: self-identify the resalloc resource in logs

If the `cmd_new` (pools.yaml config) commands returns a YAML-formatted
output, try to parse 'host' and 'name' fields.  The 'name' in particular
should match the RESALLOC_NAME.
---
 backend/copr_backend/vm_alloc.py | 33 +++++++++++++++++++++++++++++++-
 backend/tests/test_vm_alloc.py   |  9 +++++++++
 2 files changed, 41 insertions(+), 1 deletion(-)

diff --git a/backend/copr_backend/vm_alloc.py b/backend/copr_backend/vm_alloc.py
index ec6d2092d..4ddb7d025 100644
--- a/backend/copr_backend/vm_alloc.py
+++ b/backend/copr_backend/vm_alloc.py
@@ -3,6 +3,7 @@
 """
 
 import time
+import yaml
 from resalloc.client import Connection as ResallocConnection
 
 
@@ -91,6 +92,34 @@ class ResallocHost(RemoteHost):
     """
     ticket = None
 
+    """ RESALLOC_NAME """
+    name = None
+
+    def parse_ticket_data(self):
+        """
+        Historically we expected a single-line input containing hostname/IP.  We
+        continue to support this format.  But if the output looks like YAML
+        document, we parse the output and detect additional metadata.
+        """
+        output = str(self.ticket.output)
+        lines = output.split("\n")
+        if lines[0] == "---":
+            try:
+                data = yaml.safe_load(output)
+                # We expect IP or hostname here
+                self.hostname = data["host"]
+                # RESALLOC_NAME
+                self.name = data["name"]
+            except yaml.YAMLError as exc:
+                raise RemoteHostAllocationTerminated(
+                    f"Can't parse YAML data from the resalloc ticket:\n{output}") from exc
+            except KeyError as exc:
+                raise RemoteHostAllocationTerminated(
+                    f"Missing YAML fields in the resalloc ticket output\n{output}") from exc
+        else:
+            # The old format
+            self.hostname = lines[0]
+
     def check_ready(self):
         self.ticket.collect()
         if self.ticket.closed:
@@ -98,7 +127,7 @@ def check_ready(self):
             raise RemoteHostAllocationTerminated
         if not self.ticket.ready:
             return False
-        self.hostname = str(self.ticket.output).strip()
+        self.parse_ticket_data()
         return True
 
     def release(self):
@@ -111,6 +140,8 @@ def info(self):
             message += ", ticket_id={}".format(self.ticket.id)
         if self.hostname:
             message += ", hostname={}".format(self.hostname)
+        if self.name:
+            message += ", name={}".format(self.name)
         return message
 
 
diff --git a/backend/tests/test_vm_alloc.py b/backend/tests/test_vm_alloc.py
index 113ac5718..879103bb2 100644
--- a/backend/tests/test_vm_alloc.py
+++ b/backend/tests/test_vm_alloc.py
@@ -24,6 +24,15 @@ def test_ticket(_rcon):
     assert host.check_ready()
     assert host.hostname == "1.1.1.1"
 
+    host.ticket.output = (
+        "---\n"
+        "host: 1.2.3.4\n"
+        "name: copr_pool_123456\n"
+    )
+    assert host.check_ready()
+    assert host.hostname == "1.2.3.4"
+    assert host.name == "copr_pool_123456"
+
     host.ticket.closed = True
     with pytest.raises(RemoteHostAllocationTerminated):
         assert host.check_ready()