Merge pull request #572 from simvue-io/feature/simvue-pyproject-toml

Allow non-authentication configurations to be read as key `tool.simvue` from `pyproject.toml`

Author: kzscisoft

simvue/config/user.py

@@ -42,6 +42,38 @@ class SimvueConfiguration(pydantic.BaseModel):
     run: DefaultRunSpecifications = DefaultRunSpecifications()
     offline: OfflineSpecifications = OfflineSpecifications()
 
+    @classmethod
+    def _load_pyproject_configs(cls) -> typing.Optional[dict]:
+        """Recover any Simvue non-authentication configurations from pyproject.toml"""
+        _pyproject_toml = sv_util.find_first_instance_of_file(
+            file_names=["pyproject.toml"], check_user_space=False
+        )
+
+        if not _pyproject_toml:
+            return
+
+        _project_data = toml.load(_pyproject_toml)
+
+        if not (_simvue_setup := _project_data.get("tool", {}).get("simvue")):
+            return
+
+        # Do not allow reading of authentication credentials within a project file
+        _server_credentials = _simvue_setup.get("server", {})
+        _offline_credentials = _simvue_setup.get("offline", {})
+
+        if any(
+            [
+                _server_credentials.get("token"),
+                _server_credentials.get("url"),
+                _offline_credentials.get("cache"),
+            ]
+        ):
+            raise RuntimeError(
+                "Provision of Simvue URL, Token or offline directory in pyproject.toml is not allowed."
+            )
+
+        return _simvue_setup
+
     @classmethod
     @sv_util.prettify_pydantic
     def fetch(
@@ -67,13 +99,13 @@ def fetch(
             object containing configurations
 
         """
-        _config_dict: dict[str, dict[str, str]] = {}
+        _config_dict: dict[str, dict[str, str]] = cls._load_pyproject_configs() or {}
 
         try:
             logger.info(f"Using config file '{cls.config_file()}'")
 
             # NOTE: Legacy INI support has been removed
-            _config_dict = toml.load(cls.config_file())
+            _config_dict |= toml.load(cls.config_file())
 
         except FileNotFoundError:
             if not server_token or not server_url:

tests/refactor/test_config.py

@@ -14,8 +14,8 @@
     ids=("use_env", "no_env")
 )
 @pytest.mark.parametrize(
-    "use_file", (None, "basic", "extended"),
-    ids=("no_file", "basic_file", "extended_file")
+    "use_file", (None, "basic", "extended", "pyproject.toml"),
+    ids=("no_file", "basic_file", "extended_file", "pyproject_toml")
 )
 @pytest.mark.parametrize(
     "use_args", (True, False),
@@ -35,8 +35,11 @@ def test_config_setup(
     _other_url: str = "http://simvue.example.com/"
     _arg_url: str = "http://simvue.example.io/"
     _description: str = "test case for runs"
+    _description_ppt: str = "test case for runs using pyproject.toml"
     _folder: str = "/test-case"
+    _folder_ppt: str = "/test-case-ppt"
     _tags: list[str] = ["tag-test", "other-tag"]
+    _tags_ppt: list[str] = ["tag-test-ppt", "other-tag-ppt"]
 
     # Deactivate the server checks for this test
     monkeypatch.setenv("SIMVUE_NO_SERVER_CHECK", "True")
@@ -49,10 +52,24 @@ def test_config_setup(
 
     with tempfile.TemporaryDirectory() as temp_d:
         _config_file = None
+        _ppt_file = None
         if use_file:
+            if use_file == "pyproject.toml":
+                _lines_ppt: str = f"""
+[tool.poetry]
+name = "simvue_testing"
+version = "0.1.0"
+description = "A dummy test project"
+
+[tool.simvue.run]
+description = "{_description_ppt}"
+folder = "{_folder_ppt}"
+tags = {_tags_ppt}
+"""
+                with open((_ppt_file := pathlib.Path(temp_d).joinpath("pyproject.toml")), "w") as out_f:
+                    out_f.write(_lines_ppt)
             with open(_config_file := pathlib.Path(temp_d).joinpath("simvue.toml"), "w") as out_f:
-                if use_file:
-                    _lines: str = f"""
+                _lines: str = f"""
 [server]
 url = "{_url}"
 token = "{_token}"
@@ -72,7 +89,15 @@ def test_config_setup(
             SimvueConfiguration.config_file.cache_clear()
 
         mocker.patch("simvue.config.parameters.get_expiry", lambda *_, **__: 1e10)
-        mocker.patch("simvue.config.user.sv_util.find_first_instance_of_file", lambda *_, **__: _config_file)
+
+
+        def _mocked_find(file_names: list[str], *_, ppt_file=_ppt_file, conf_file=_config_file, **__) -> str:
+            if "pyproject.toml" in file_names:
+                return ppt_file
+            else:
+                return conf_file
+
+        mocker.patch("simvue.config.user.sv_util.find_first_instance_of_file", _mocked_find)
 
         import simvue.config.user
 
@@ -88,7 +113,7 @@ def test_config_setup(
         else:
             _config = simvue.config.user.SimvueConfiguration.fetch()
 
-        if use_file:
+        if use_file and use_file != "pyproject.toml":
             assert _config.config_file() == _config_file
 
         if use_env:
@@ -97,7 +122,7 @@ def test_config_setup(
         elif use_args:
             assert _config.server.url == _arg_url
             assert _config.server.token == _arg_token
-        elif use_file:
+        elif use_file and use_file != "pyproject.toml":
             assert _config.server.url == _url
             assert _config.server.token == _token
             assert _config.offline.cache == temp_d
@@ -106,6 +131,10 @@ def test_config_setup(
             assert _config.run.description == _description
             assert _config.run.folder == _folder
             assert _config.run.tags == _tags
+        elif use_file == "pyproject.toml":
+            assert _config.run.description == _description_ppt
+            assert _config.run.folder == _folder_ppt
+            assert _config.run.tags == _tags_ppt
         elif use_file:
             assert _config.run.folder == "/"
             assert not _config.run.description