sambacc: extend rados opener to support passing client name

Add an intermediate type, _RADOSInterface, to act as a shim between the
opener type and rados module api. This way we are able to bundle values
like the client name so we don't need to pass everything through all the
intermediate layers.

Signed-off-by: John Mulligan <[email protected]>

Author: phlogistonjohn

sambacc/rados_opener.py

@@ -27,6 +27,7 @@
 from .typelets import ExcType, ExcValue, ExcTraceback
 
 _RADOSModule = typing.Any
+_RADOSObject = typing.Any
 
 _CHUNK_SIZE = 4 * 1024
 
@@ -35,43 +36,60 @@ class RADOSUnsupported(Exception):
     pass
 
 
+class _RADOSInterface:
+    api: _RADOSModule
+    client_name: str
+    full_name: bool
+
+    def Rados(self) -> _RADOSObject:
+        name = rados_id = ""
+        if self.full_name:
+            name = self.client_name
+        else:
+            rados_id = self.client_name
+        return self.api.Rados(
+            name=name,
+            rados_id=rados_id,
+            conffile=self.api.Rados.DEFAULT_CONF_FILES,
+        )
+
+
 class _RADOSHandler(urllib.request.BaseHandler):
-    _rados_api: typing.Optional[_RADOSModule] = None
+    _interface: typing.Optional[_RADOSInterface] = None
 
     def rados_open(self, req: urllib.request.Request) -> typing.IO:
-        if self._rados_api is None:
+        if self._interface is None:
             raise RADOSUnsupported()
         if req.selector.startswith("mon-config-key:"):
             return _get_mon_config_key(
-                self._rados_api, req.selector.split(":", 1)[1]
+                self._interface, req.selector.split(":", 1)[1]
             )
         sel = req.selector.lstrip("/")
         if req.host:
             pool = req.host
             ns, key = sel.split("/", 1)
         else:
             pool, ns, key = sel.split("/", 2)
-        return _RADOSResponse(self._rados_api, pool, ns, key)
+        return _RADOSResponse(self._interface, pool, ns, key)
 
 
 # it's quite annoying to have a read-only typing.IO we're forced to
 # have so many stub methods. Go's much more granular io interfaces for
 # readers/writers is much nicer for this.
 class _RADOSResponse(typing.IO):
     def __init__(
-        self, rados_api: _RADOSModule, pool: str, ns: str, key: str
+        self, interface: _RADOSInterface, pool: str, ns: str, key: str
     ) -> None:
         self._pool = pool
         self._ns = ns
         self._key = key
 
-        self._open(rados_api)
+        self._open(interface)
         self._test()
 
-    def _open(self, rados_api: _RADOSModule) -> None:
+    def _open(self, interface: _RADOSInterface) -> None:
         # TODO: connection caching
-        self._conn = rados_api.Rados()
-        self._conn.conf_read_file()
+        self._conn = interface.Rados()
         self._conn.connect()
         self._connected = True
         self._ioctx = self._conn.open_ioctx(self._pool)
@@ -177,14 +195,14 @@ def writelines(self, ls: typing.Iterable[typing.Any]) -> None:
         raise NotImplementedError()
 
 
-def _get_mon_config_key(rados_api: _RADOSModule, key: str) -> io.BytesIO:
+def _get_mon_config_key(interface: _RADOSInterface, key: str) -> io.BytesIO:
     mcmd = json.dumps(
         {
             "prefix": "config-key get",
             "key": str(key),
         }
     )
-    with rados_api.Rados(conffile=rados_api.Rados.DEFAULT_CONF_FILES) as rc:
+    with interface.Rados() as rc:
         ret, out, err = rc.mon_command(mcmd, b"")
         if ret == 0:
             # We need to return a file like object. Since we are handed just
@@ -196,7 +214,12 @@ def _get_mon_config_key(rados_api: _RADOSModule, key: str) -> io.BytesIO:
         raise OSError(ret, msg)
 
 
-def enable_rados_url_opener(cls: typing.Type[url_opener.URLOpener]) -> None:
+def enable_rados_url_opener(
+    cls: typing.Type[url_opener.URLOpener],
+    *,
+    client_name: str = "",
+    full_name: bool = False,
+) -> None:
     """Extend the URLOpener type to support pseudo-URLs for rados
     object storage. If rados libraries are not found the function
     does nothing.
@@ -211,5 +234,10 @@ def enable_rados_url_opener(cls: typing.Type[url_opener.URLOpener]) -> None:
     except ImportError:
         return
 
-    _RADOSHandler._rados_api = rados
+    rados_interface = _RADOSInterface()
+    rados_interface.api = rados
+    rados_interface.client_name = client_name
+    rados_interface.full_name = full_name
+
+    _RADOSHandler._interface = rados_interface
     cls._handlers.append(_RADOSHandler)

tests/test_rados_opener.py

@@ -45,6 +45,54 @@ def test_enable_rados_url_opener_fail(monkeypatch):
     assert not cls_mock._handlers.append.called
 
 
+def test_enable_rados_url_opener_with_args(monkeypatch):
+    mock = unittest.mock.MagicMock()
+    monkeypatch.setitem(sys.modules, "rados", mock)
+
+    cls_mock = unittest.mock.MagicMock()
+    cls_mock._handlers = []
+    sambacc.rados_opener.enable_rados_url_opener(cls_mock, client_name="user1")
+    assert len(cls_mock._handlers) == 1
+    assert isinstance(
+        cls_mock._handlers[0]._interface, sambacc.rados_opener._RADOSInterface
+    )
+    assert cls_mock._handlers[0]._interface.api is mock
+    assert cls_mock._handlers[0]._interface.client_name == "user1"
+    assert not cls_mock._handlers[0]._interface.full_name
+    ri = cls_mock._handlers[0]._interface
+    ri.Rados()
+    assert ri.api.Rados.call_args[1]["rados_id"] == "user1"
+    assert ri.api.Rados.call_args[1]["name"] == ""
+    assert (
+        ri.api.Rados.call_args[1]["conffile"] == mock.Rados.DEFAULT_CONF_FILES
+    )
+
+
+def test_enable_rados_url_opener_with_args2(monkeypatch):
+    mock = unittest.mock.MagicMock()
+    monkeypatch.setitem(sys.modules, "rados", mock)
+
+    cls_mock = unittest.mock.MagicMock()
+    cls_mock._handlers = []
+    sambacc.rados_opener.enable_rados_url_opener(
+        cls_mock, client_name="client.user1", full_name=True
+    )
+    assert len(cls_mock._handlers) == 1
+    assert isinstance(
+        cls_mock._handlers[0]._interface, sambacc.rados_opener._RADOSInterface
+    )
+    assert cls_mock._handlers[0]._interface.api is mock
+    assert cls_mock._handlers[0]._interface.client_name == "client.user1"
+    assert cls_mock._handlers[0]._interface.full_name
+    ri = cls_mock._handlers[0]._interface
+    ri.Rados()
+    assert ri.api.Rados.call_args[1]["rados_id"] == ""
+    assert ri.api.Rados.call_args[1]["name"] == "client.user1"
+    assert (
+        ri.api.Rados.call_args[1]["conffile"] == mock.Rados.DEFAULT_CONF_FILES
+    )
+
+
 def test_rados_handler_parse():
     class RH(sambacc.rados_opener._RADOSHandler):
         _rados_api = unittest.mock.MagicMock()
@@ -67,7 +115,7 @@ def test_rados_handler_norados():
     # Generally, this shouldn't happen because the rados handler shouldn't
     # be added to the URLOpener if rados module was unavailable.
     class RH(sambacc.rados_opener._RADOSHandler):
-        _rados_api = None
+        _interface = None
 
     rh = RH()
     rq = urllib.request.Request("rados://foo/bar/baz")
@@ -160,9 +208,9 @@ def test_rados_response_not_implemented():
 
 def test_rados_handler_config_key():
     class RH(sambacc.rados_opener._RADOSHandler):
-        _rados_api = unittest.mock.MagicMock()
+        _interface = unittest.mock.MagicMock()
 
-    mc = RH._rados_api.Rados.return_value.__enter__.return_value.mon_command
+    mc = RH._interface.Rados.return_value.__enter__.return_value.mon_command
     mc.return_value = (0, b"rubber baby buggy bumpers", "")
 
     rh = RH()