Expose various attributes on SlurmRestApi instances (#231)

So that downstream applications can e.g. check expiry on the user token.

Load user_token from external file in SlurmRestApi rather than in the
zocalo.configuration Slurm plugin to allow token changes to be picked
up without reloading zocalo.configuration (which may have side effects
such as duplicating graylog logging handlers.

Author: rjgildea

HISTORY.rst

@@ -4,6 +4,8 @@ History
 
 Unreleased
 ----------
+* Expose ``url``, ``version``, ``user_name`` and ``user_token`` attributes on ``SlurmRestApi`` instances
+* Load ``user_token`` from external file in ``SlurmRestApi`` rather than in the ``zocalo.configuration`` Slurm plugin to allow token changes to be picked up without re-loading ``zocalo.configuration``
 
 0.28.0 (2023-03-20)
 -------------------

src/zocalo/configuration/plugin_slurm.py

@@ -1,7 +1,5 @@
 from __future__ import annotations
 
-import os
-
 from marshmallow import fields
 
 from zocalo.configuration import PluginSchema
@@ -16,8 +14,4 @@ class Schema(PluginSchema):
 
     @staticmethod
     def activate(configuration):
-        user_token = configuration.get("user_token")
-        if user_token and os.path.isfile(user_token):
-            with open(user_token, "r") as f:
-                configuration["user_token"] = f.read().strip()
         return configuration

src/zocalo/util/slurm/__init__.py

@@ -1,6 +1,8 @@
 from __future__ import annotations
 
-from typing import Any, Optional
+import os
+import pathlib
+from typing import Any
 
 import requests
 
@@ -14,16 +16,23 @@ def __init__(
         self,
         url: str,
         version: str = "v0.0.36",
-        user_name: Optional[str] = None,
-        user_token: Optional[str] = None,
+        user_name: str | None = None,
+        user_token: str | pathlib.Path | None = None,
     ):
-        self._url = url
-        self._version = version
-        self._session = requests.Session()
-        if user_name:
-            self._session.headers["X-SLURM-USER-NAME"] = user_name
-        if user_token:
-            self._session.headers["X-SLURM-USER-TOKEN"] = user_token
+        self.url = url
+        self.version = version
+        self.user_name = user_name
+        if user_token and os.path.isfile(user_token):
+            with open(user_token, "r") as f:
+                self.user_token = f.read().strip()
+        else:
+            assert isinstance(user_token, str)
+            self.user_token = user_token
+        self.session = requests.Session()
+        if self.user_name:
+            self.session.headers["X-SLURM-USER-NAME"] = self.user_name
+        if self.user_token:
+            self.session.headers["X-SLURM-USER-TOKEN"] = self.user_token
 
     @classmethod
     def from_zocalo_configuration(cls, zc: zocalo.configuration.Configuration):
@@ -37,8 +46,8 @@ def from_zocalo_configuration(cls, zc: zocalo.configuration.Configuration):
     def get(
         self, endpoint: str, params: dict[str, Any] = None, timeout: float | None = None
     ) -> requests.Response:
-        response = self._session.get(
-            f"{self._url}/{endpoint}", params=params, timeout=timeout
+        response = self.session.get(
+            f"{self.url}/{endpoint}", params=params, timeout=timeout
         )
         response.raise_for_status()
         return response
@@ -50,8 +59,8 @@ def put(
         json: dict[str, Any] = None,
         timeout: float | None = None,
     ) -> requests.Response:
-        response = self._session.put(
-            f"{self._url}/{endpoint}", params=params, json=json, timeout=timeout
+        response = self.session.put(
+            f"{self.url}/{endpoint}", params=params, json=json, timeout=timeout
         )
         response.raise_for_status()
         return response
@@ -63,34 +72,34 @@ def post(
         json: dict[str, Any] | None = None,
         timeout: float | None = None,
     ) -> requests.Response:
-        response = self._session.post(
-            f"{self._url}/{endpoint}", data=data, json=json, timeout=timeout
+        response = self.session.post(
+            f"{self.url}/{endpoint}", data=data, json=json, timeout=timeout
         )
         response.raise_for_status()
         return response
 
     def delete(
         self, endpoint: str, params: dict[str, Any] = None, timeout: float | None = None
     ) -> requests.Response:
-        response = self._session.delete(
-            f"{self._url}/{endpoint}", params=params, timeout=timeout
+        response = self.session.delete(
+            f"{self.url}/{endpoint}", params=params, timeout=timeout
         )
         response.raise_for_status()
         return response
 
     def get_jobs(self) -> models.JobsResponse:
-        endpoint = f"slurm/{self._version}/jobs"
+        endpoint = f"slurm/{self.version}/jobs"
         response = self.get(endpoint)
         return models.JobsResponse(**response.json())
 
     def get_job_info(self, job_id: int) -> models.JobsResponse:
-        endpoint = f"slurm/{self._version}/job/{job_id}"
+        endpoint = f"slurm/{self.version}/job/{job_id}"
         response = self.get(endpoint)
         return models.JobsResponse(**response.json())
 
     def submit_job(
         self, job_submission: models.JobSubmission
     ) -> models.JobSubmissionResponse:
-        endpoint = f"slurm/{self._version}/job/submit"
+        endpoint = f"slurm/{self.version}/job/submit"
         response = self.post(endpoint, json=job_submission.dict(exclude_defaults=True))
         return models.JobSubmissionResponse(**response.json())

tests/configuration/test_plugin_slurm.py

@@ -81,7 +81,7 @@ def test_user_token_from_external_file(tmp_path):
     assert zc.slurm is None
     zc.activate_environment("live")
     assert isinstance(zc.slurm, dict)
-    assert zc.slurm["user_token"] == user_token
+    assert zc.slurm["user_token"] == str(user_token_file)
 
 
 def test_invalid_config():

tests/util/test_slurm.py

@@ -77,6 +77,25 @@ def jobs_response():
     }
 
 
+def test_get_slurm_api_from_zocalo_configuration(slurm_api):
+    assert slurm_api.url == "http://slurm.example.com:1234"
+    assert slurm_api.version == "v0.0.36"
+    assert slurm_api.user_name == "foo"
+    assert slurm_api.user_token == "sometoken"
+
+
+def test_get_slurm_api_user_token_external_file(tmp_path):
+    user_token_file = tmp_path / "slurm-user-token"
+    user_token_file.write_text("foobar")
+    api = slurm.SlurmRestApi(
+        url="http://slurm.example.com:1234",
+        version="v0.0.36",
+        user_name="foo",
+        user_token=user_token_file,
+    )
+    assert api.user_token == "foobar"
+
+
 def test_get_jobs(requests_mock, slurm_api, jobs_response):
     requests_mock.get(
         "/slurm/v0.0.36/jobs",