chore: use server or client naming in env vars to make them more easy to understand

Author: emre.akkaya

README.md

@@ -61,13 +61,13 @@ Configure the client with these environment variables:
 * **CONFIG_SERVER_FQDN** overrides host and port with a full URL (default `http://localhost:8080/`)
 * **CONFIG_SERVER_HOST** host used when `CONFIG_SERVER_FQDN` is unset (default `localhost`)
 * **CONFIG_SERVER_PORT** port paired with `CONFIG_SERVER_HOST` (default `8080`)
-* **CONFIG_SERVER_FAIL_FAST** exits when unable to reach the config server if set to `True` (default `False`)
-* **CONFIG_SERVER_RETRY_INITIAL_INTERVAL** wait (seconds) before the first retry (default `1`)
-* **CONFIG_SERVER_RETRY_MAX_INTERVAL** maximum wait (seconds) between retries (default `10`)
-* **CONFIG_SERVER_RETRY_MAX_ATTEMPTS** total attempts before giving up (default `5`)
-* **CONFIG_SERVER_RETRY_MULTIPLIER** exponential backoff multiplier applied between retries (default `1.1`)
-* **CONFIG_USERNAME** HTTP basic auth username (default `user`)
-* **CONFIG_PASSWORD** HTTP basic auth password (default empty)
+* **CONFIG_SERVER_USERNAME** HTTP basic auth username (default `user`)
+* **CONFIG_SERVER_PASSWORD** HTTP basic auth password (default empty)
+* **CONFIG_CLIENT_FAIL_FAST** exits when unable to reach the config server if set to `True` (default `False`)
+* **CONFIG_CLIENT_RETRY_INITIAL_INTERVAL** wait (seconds) before the first retry (default `1`)
+* **CONFIG_CLIENT_RETRY_MAX_INTERVAL** maximum wait (seconds) between retries (default `10`)
+* **CONFIG_CLIENT_RETRY_MAX_ATTEMPTS** total attempts before giving up (default `5`)
+* **CONFIG_CLIENT_RETRY_MULTIPLIER** exponential backoff multiplier applied between retries (default `1.1`)
 
 ## Unit Tests
 

spring_cloud_config_client/__init__.py

@@ -6,18 +6,18 @@
 
 _config_server_url = os.getenv("CONFIG_SERVER_FQDN", "http://{host}:{port}/".format(host=os.getenv("CONFIG_SERVER_HOST", "localhost"),
                                                     port=os.getenv("CONFIG_SERVER_PORT", "8080")))
-_fail_fast = os.getenv("CONFIG_SERVER_FAIL_FAST", "False").lower() in ("true", "1", "t")
-_retry_initial_interval = int(os.getenv("CONFIG_SERVER_RETRY_INITIAL_INTERVAL", "1"))
-_retry_max_interval = int(os.getenv("CONFIG_SERVER_RETRY_MAX_INTERVAL", "10"))
-_retry_max_attempts = int(os.getenv("CONFIG_SERVER_RETRY_MAX_ATTEMPTS", "5"))
-_retry_multiplier = float(os.getenv("CONFIG_SERVER_RETRY_MULTIPLIER", "1.1"))
+_fail_fast = os.getenv("CONFIG_CLIENT_FAIL_FAST", "False").lower() in ("true", "1", "t")
+_retry_initial_interval = int(os.getenv("CONFIG_CLIENT_RETRY_INITIAL_INTERVAL", "1"))
+_retry_max_interval = int(os.getenv("CONFIG_CLIENT_RETRY_MAX_INTERVAL", "10"))
+_retry_max_attempts = int(os.getenv("CONFIG_CLIENT_RETRY_MAX_ATTEMPTS", "5"))
+_retry_multiplier = float(os.getenv("CONFIG_CLIENT_RETRY_MULTIPLIER", "1.1"))
 
 
 def _test():
     if _fail_fast:
         r = requests.get("{url}{test_profile}".format(url=_config_server_url, test_profile="application-kafka.yml"),
-                         auth=HTTPBasicAuth(os.getenv("CONFIG_USERNAME", "user"),
-                                            os.getenv("CONFIG_PASSWORD")))
+                         auth=HTTPBasicAuth(os.getenv("CONFIG_SERVER_USERNAME", "user"),
+                                            os.getenv("CONFIG_SERVER_PASSWORD")))
         if r.status_code != 200:
             sys.exit(1)
 

tests/integration/test_props_integration.py

@@ -5,12 +5,12 @@
 
 @pytest.fixture
 def configured_props(monkeypatch):
-    monkeypatch.delenv("CONFIG_SERVICE_FQDN", raising=False)
-    monkeypatch.setenv("CONFIG_SERVICE_HOST", "localhost")
-    monkeypatch.setenv("CONFIG_SERVICE_PORT", "8888")
-    monkeypatch.setenv("CONFIG_USERNAME", "config")
-    monkeypatch.setenv("CONFIG_PASSWORD", "config")
-    monkeypatch.setenv("CONFIG_SERVICE_FAIL_FAST", "False")
+    monkeypatch.delenv("CONFIG_SERVER_FQDN", raising=False)
+    monkeypatch.setenv("CONFIG_SERVER_HOST", "localhost")
+    monkeypatch.setenv("CONFIG_SERVER_PORT", "8888")
+    monkeypatch.setenv("CONFIG_SERVER_USERNAME", "config")
+    monkeypatch.setenv("CONFIG_SERVER_PASSWORD", "config")
+    monkeypatch.setenv("CONFIG_CLIENT_FAIL_FAST", "False")
 
     import spring_cloud_config_client # noqa: PLC0415
     from spring_cloud_config_client import props # noqa: PLC0415

tests/unit/test_props.py

@@ -15,11 +15,13 @@ def reload_props(monkeypatch):
     defaults = {
         "CONFIG_SERVER_HOST": "config-service",
         "CONFIG_SERVER_PORT": "8012",
-        "CONFIG_SERVER_FAIL_FAST": "False",
-        "CONFIG_SERVER_RETRY_INITIAL_INTERVAL": "1",
-        "CONFIG_SERVER_RETRY_MAX_INTERVAL": "15",
-        "CONFIG_SERVER_RETRY_MAX_ATTEMPTS": "3",
-        "CONFIG_SERVER_RETRY_MULTIPLIER": "2",
+        "CONFIG_CLIENT_FAIL_FAST": "False",
+        "CONFIG_CLIENT_RETRY_INITIAL_INTERVAL": "1",
+        "CONFIG_CLIENT_RETRY_MAX_INTERVAL": "15",
+        "CONFIG_CLIENT_RETRY_MAX_ATTEMPTS": "3",
+        "CONFIG_CLIENT_RETRY_MULTIPLIER": "2",
+        "CONFIG_SERVER_USERNAME": "svc-user",
+        "CONFIG_SERVER_PASSWORD": "s3cret",
         "CONFIG_USERNAME": "svc-user",
         "CONFIG_PASSWORD": "s3cret",
     }
@@ -54,7 +56,7 @@ def test_init_requires_application_or_profiles(reload_props):
 
 
 def test_init_fetches_and_parses_remote_yaml(reload_props, monkeypatch):
-    props = reload_props(CONFIG_SERVER_RETRY_MAX_INTERVAL="25")
+    props = reload_props(CONFIG_CLIENT_RETRY_MAX_INTERVAL="25")
     captured = {}
 
     def fake_get(url, auth=None, timeout=None):
@@ -86,9 +88,9 @@ def fake_get(url, auth=None, timeout=None):
 
 def test_init_retries_until_success_without_fail_fast(reload_props, monkeypatch):
     props = reload_props(
-        CONFIG_SERVER_RETRY_MAX_ATTEMPTS="3",
-        CONFIG_SERVER_RETRY_INITIAL_INTERVAL="1",
-        CONFIG_SERVER_RETRY_MULTIPLIER="2",
+        CONFIG_CLIENT_RETRY_MAX_ATTEMPTS="3",
+        CONFIG_CLIENT_RETRY_INITIAL_INTERVAL="1",
+        CONFIG_CLIENT_RETRY_MULTIPLIER="2",
     )
     attempts = {"count": 0}
 
@@ -110,7 +112,7 @@ def flaky_get(*_, **__):
 
 
 def test_init_exits_immediately_when_fail_fast_is_enabled(reload_props, monkeypatch):
-    props = reload_props(CONFIG_SERVER_FAIL_FAST="True")
+    props = reload_props(CONFIG_CLIENT_FAIL_FAST="True")
 
     def failing_get(*_, **__):
         return SimpleNamespace(status_code=503, text="", reason="Service Unavailable")