From 212fca65248fc89670fb4a04a317b7c4f2515065 Mon Sep 17 00:00:00 2001
From: Scott Wales <scott.wales@bom.gov.au>
Date: Fri, 8 Sep 2023 13:47:49 +1000
Subject: [PATCH 1/3] Allow setting user conf through environment variables

---
 CONTRIBUTING.md                          |  1 +
 README.md                                |  6 ++++--
 cylc/uiserver/config_util.py             |  2 +-
 cylc/uiserver/logging_util.py            |  2 +-
 cylc/uiserver/tests/test_config.py       | 14 ++++++++++++++
 cylc/uiserver/tests/test_logging_util.py |  7 +++++++
 6 files changed, 28 insertions(+), 4 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 41ef50ae..4c8b2e7a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -52,6 +52,7 @@ below.
  - David Matthews
  - Mel Hall
  - Christopher Bennett
+ - Scott Wales
  <!-- end-shortlog -->
 
 (All contributors are identifiable with email addresses in the git version
diff --git a/README.md b/README.md
index 318e9ae7..2133b517 100644
--- a/README.md
+++ b/README.md
@@ -141,7 +141,8 @@ The Cylc Hub will load the following files in order:
 
 3) User Config
 
-   This file
+   This file configures the Hub/UIS for the current user. The default path can
+   be changed by the ``CYLC_CONF_PATH`` environment variable.
 
    (`~/.cylc/uiserver/jupyter_config.py`)
 
@@ -174,7 +175,8 @@ are run use the `ServerApp.jpserver_extensions` configuration, see the
 [Jupyter Server configuration documentation](https://jupyter-server.readthedocs.io/en/latest/other/full-config.html#other-full-config).
 
 By default the Cylc part of the UI Server log is written to
-`~/.cylc/uiserver/uiserver.log`.
+`~/.cylc/uiserver/log/log`. This can be changed with the environment
+variable ``CYLC_UISERVER_LOG_PATH``.
 
 <!--
 TODO: Link to Jupyter Server logging_config docs when published
diff --git a/cylc/uiserver/config_util.py b/cylc/uiserver/config_util.py
index 3b34af5a..5c2ba3c8 100644
--- a/cylc/uiserver/config_util.py
+++ b/cylc/uiserver/config_util.py
@@ -38,7 +38,7 @@
     or GlobalConfig.DEFAULT_SITE_CONF_PATH,
     UISERVER_DIR
 )
-USER_CONF_ROOT = Path.home() / '.cylc' / UISERVER_DIR
+USER_CONF_ROOT = Path(os.getenv('CYLC_CONF_PATH') or Path.home() / '.cylc', UISERVER_DIR)
 
 
 def get_conf_dir_hierarchy(
diff --git a/cylc/uiserver/logging_util.py b/cylc/uiserver/logging_util.py
index 36a27544..082faaff 100644
--- a/cylc/uiserver/logging_util.py
+++ b/cylc/uiserver/logging_util.py
@@ -30,7 +30,7 @@ class RotatingUISFileHandler(logging.handlers.RotatingFileHandler):
     LOG_NAME_EXTENSION = "-uiserver.log"
 
     def __init__(self):
-        self.file_path = Path(USER_CONF_ROOT / "log").expanduser()
+        self.file_path = Path(os.getenv('CYLC_UISERVER_LOG_PATH') or USER_CONF_ROOT, "log").expanduser()
 
     def on_start(self):
         """Set up logging"""
diff --git a/cylc/uiserver/tests/test_config.py b/cylc/uiserver/tests/test_config.py
index e7349c84..207c9dea 100644
--- a/cylc/uiserver/tests/test_config.py
+++ b/cylc/uiserver/tests/test_config.py
@@ -84,6 +84,20 @@ def test_cylc_site_conf_path(clear_env, capload, monkeypatch):
     ]
 
 
+def test_cylc_user_conf_path(clear_env, capload, monkeypatch):
+    """The user config should change to $CYLC_CONF_PATH if set."""
+    monkeypatch.setenv('CYLC_CONF_PATH', 'elephant')
+    monkeypatch.setattr(config_util, '__version__', '0')
+    load()
+    assert capload == [
+        SYS_CONF,
+        (SITE_CONF / 'jupyter_config.py'),
+        (SITE_CONF / '0/jupyter_config.py'),
+        Path('elephant/uiserver/jupyter_config.py'),
+        Path('elephant/uiserver/0/jupyter_config.py'),
+    ]
+
+
 def test_get_conf_dir_hierarchy(monkeypatch: pytest.MonkeyPatch):
     """Tests hierarchy of versioning for config"""
     config_paths = ['config_path/one', 'config_path/two']
diff --git a/cylc/uiserver/tests/test_logging_util.py b/cylc/uiserver/tests/test_logging_util.py
index 1e81c8d6..680d29b7 100644
--- a/cylc/uiserver/tests/test_logging_util.py
+++ b/cylc/uiserver/tests/test_logging_util.py
@@ -75,6 +75,13 @@ def test_first_init_log(tmp_path):
         LOG.file_path / '01-uiserver.log')
 
 
+def test_log_conf_path(tmp_path, monkeypatch):
+    """Check initial setup, no previous logs present"""
+    monkeypatch.setenv('CYLC_UISERVER_LOG_PATH', 'elephant')
+    LOG = RotatingUISFileHandler()
+    assert LOG.file_path == 'elephant/log'
+
+
 def test_init_log_with_established_setup(tmp_path):
     """Tests the entire logging init with a typically full logging dir"""
     LOG = RotatingUISFileHandler()

From 52b0adc2403724e530b90b390e503461e179a69b Mon Sep 17 00:00:00 2001
From: Scott Wales <scott.wales@bom.gov.au>
Date: Fri, 8 Sep 2023 14:30:47 +1000
Subject: [PATCH 2/3] Fix tests

---
 cylc/uiserver/tests/test_config.py       | 17 ++++++++++++++++-
 cylc/uiserver/tests/test_logging_util.py |  2 +-
 2 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/cylc/uiserver/tests/test_config.py b/cylc/uiserver/tests/test_config.py
index 207c9dea..b422af03 100644
--- a/cylc/uiserver/tests/test_config.py
+++ b/cylc/uiserver/tests/test_config.py
@@ -18,6 +18,7 @@
 from cylc.uiserver import config_util
 
 import pytest
+import importlib
 
 from cylc.flow.cfgspec.globalcfg import GlobalConfig
 from cylc.uiserver import __file__ as UIS_PKG
@@ -84,10 +85,24 @@ def test_cylc_site_conf_path(clear_env, capload, monkeypatch):
     ]
 
 
-def test_cylc_user_conf_path(clear_env, capload, monkeypatch):
+def test_cylc_user_conf_path(clear_env, monkeypatch):
     """The user config should change to $CYLC_CONF_PATH if set."""
     monkeypatch.setenv('CYLC_CONF_PATH', 'elephant')
+
+    # Reload modules with updated environment
+    import cylc.uiserver
+    importlib.reload(cylc.uiserver.config_util)
+    importlib.reload(cylc.uiserver.jupyterhub_config)
+    from cylc.uiserver.config_util import  USER_CONF_ROOT
+
     monkeypatch.setattr(config_util, '__version__', '0')
+
+    # Can't use the fixture due to the reload
+    capload = []
+    monkeypatch.setattr('cylc.uiserver.jupyterhub_config._load', capload.append)
+
+    assert USER_CONF_ROOT == Path('elephant/uiserver')
+
     load()
     assert capload == [
         SYS_CONF,
diff --git a/cylc/uiserver/tests/test_logging_util.py b/cylc/uiserver/tests/test_logging_util.py
index 680d29b7..3a8827c1 100644
--- a/cylc/uiserver/tests/test_logging_util.py
+++ b/cylc/uiserver/tests/test_logging_util.py
@@ -79,7 +79,7 @@ def test_log_conf_path(tmp_path, monkeypatch):
     """Check initial setup, no previous logs present"""
     monkeypatch.setenv('CYLC_UISERVER_LOG_PATH', 'elephant')
     LOG = RotatingUISFileHandler()
-    assert LOG.file_path == 'elephant/log'
+    assert str(LOG.file_path) == 'elephant/log'
 
 
 def test_init_log_with_established_setup(tmp_path):

From 0db213f588f65d46c652784d1410b2b9354d37b9 Mon Sep 17 00:00:00 2001
From: Scott Wales <scott.wales@bom.gov.au>
Date: Fri, 8 Sep 2023 14:35:28 +1000
Subject: [PATCH 3/3] Add to changelog

---
 CHANGES.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/CHANGES.md b/CHANGES.md
index f9691884..eb21f019 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -15,6 +15,10 @@ ones in. -->
 
 <!-- [Updated cylc-ui to x.y.z](https://github.com/cylc/cylc-ui/blob/master/CHANGES.md) -->
 
+### Enhancements
+[#496](https://github.com/cylc/cylc-uiserver/pull/496) - Allow configuring the
+user config path and log path with environment variables
+
 ### Fixes
 
 [#379](https://github.com/cylc/cylc-uiserver/pull/379) - Fixed lack of info