From 6f26b49b9f2d8b1b070b3201366038c8b9b497e6 Mon Sep 17 00:00:00 2001
From: Christian Kellner <christian@kellner.me>
Date: Fri, 24 Jul 2020 19:21:24 +0200
Subject: [PATCH] api: ability to auto-generate socket addresses

Make the `socket_address` argument to `BaseAPI` optional, i.e.
allow it to be `None`. In that case, create a temporary directory
and place the socket, named with the value of `endpoint`, in that
directory. On context exit, the directory is cleaned up. As long
as the jsoncomm.Socket server is running, `socket_address` will
always be valid and indicating the address of the server.
---
 osbuild/api.py | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/osbuild/api.py b/osbuild/api.py
index cb48af19..0f4fdab3 100644
--- a/osbuild/api.py
+++ b/osbuild/api.py
@@ -6,6 +6,8 @@ import os
 import sys
 import tempfile
 import threading
+from typing import Optional
+from .util.types import PathLike
 from .util import jsoncomm
 
 
@@ -30,11 +32,12 @@ class BaseAPI(abc.ABC):
     clean up resources after the context is left and the
     communication channel shut down.
     """
-    def __init__(self, socket_address):
+    def __init__(self, socket_address: Optional[PathLike] = None):
         self.socket_address = socket_address
         self.barrier = threading.Barrier(2)
         self.event_loop = None
         self.thread = None
+        self._socketdir = None
 
     @property
     @classmethod
@@ -49,6 +52,11 @@ class BaseAPI(abc.ABC):
     def _cleanup(self):
         """Called after the event loop is shut down"""
 
+    @classmethod
+    def _make_socket_dir(cls):
+        """Called to create the temporary socket dir"""
+        return tempfile.TemporaryDirectory(prefix="api-", dir="/run/osbuild")
+
     def _run_event_loop(self):
         with jsoncomm.Socket.new_server(self.socket_address) as server:
             self.barrier.wait()
@@ -61,6 +69,11 @@ class BaseAPI(abc.ABC):
         # We are not re-entrant, so complain if re-entered.
         assert self.event_loop is None
 
+        if not self.socket_address:
+            self._socketdir = self._make_socket_dir()
+            address = os.path.join(self._socketdir.name, self.endpoint)
+            self.socket_address = address
+
         self.event_loop = asyncio.new_event_loop()
         self.thread = threading.Thread(target=self._run_event_loop)
 
@@ -81,6 +94,11 @@ class BaseAPI(abc.ABC):
         self.thread = None
         self.event_loop = None
 
+        if self._socketdir:
+            self._socketdir.cleanup()
+            self._socketdir = None
+            self.socket_address = None
+
 
 class API(BaseAPI):
     """The main OSBuild API"""