From d58dc341d6941dd16c6454fb4f50c856a69a3c1a Mon Sep 17 00:00:00 2001
From: "Ware, Joseph (DLSLtd,RAL,LSCI)" <joseph.ware@diamond.ac.uk>
Date: Wed, 21 Feb 2024 10:47:32 +0000
Subject: [PATCH] Enable getting Stomp authentication credentials from the
 environment

---
 src/blueapi/config.py | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/src/blueapi/config.py b/src/blueapi/config.py
index c802c5187..70cb97268 100644
--- a/src/blueapi/config.py
+++ b/src/blueapi/config.py
@@ -1,9 +1,10 @@
+import os
 from enum import Enum
 from pathlib import Path
 from typing import Any, Dict, Generic, Literal, Mapping, Optional, Type, TypeVar, Union
 
 import yaml
-from pydantic import BaseModel, Field, ValidationError, parse_obj_as
+from pydantic import BaseModel, Field, ValidationError, parse_obj_as, validator
 
 from blueapi.utils import BlueapiBaseModel, InvalidConfigError
 
@@ -23,12 +24,21 @@ class Source(BaseModel):
 
 class BasicAuthentication(BaseModel):
     """
-    Log in details for when a server uses authentication
+    Log in details for when a server uses authentication.
+    If username or passcode match exactly the regex ^\\${(.*)}$
+    they attempt to replace with an environment variable of the same.
+    i.e. ${foo} or ${FOO} are replaced with the value of FOO
     """
 
     username: str = "guest"
     passcode: str = "guest"
 
+    @validator("username", "passcode")
+    def get_from_env(cls, v: str):
+        if v.startswith("${") and v.endswith("}"):
+            return os.environ[v.removeprefix("${").removesuffix("}").upper()]
+        return v
+
 
 class StompConfig(BaseModel):
     """