Fix: Improve env-handling (#71)

* fix: improve env-handling, tests
* bump version

Author: ren-jentic

python/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "jentic"
-version = "0.9.7"
+version = "0.9.8"
 description = "Jentic SDK for the discovery and execution of APIs and workflows"
 requires-python = ">=3.11"
 readme = "README.md"

python/src/jentic/lib/cfg.py

@@ -1,6 +1,9 @@
 import os
 from dataclasses import dataclass
 from typing import cast
+import logging
+
+logger = logging.getLogger(__name__)
 
 from jentic.lib.exc import JenticEnvironmentError, MissingAgentKeyError
 
@@ -51,11 +54,14 @@ def from_env(cls) -> "AgentConfig":
             raise JenticEnvironmentError(f"Invalid environment: {environment}")
 
         # Expose timeouts as environment variables
-        connect_timeout = cast(float, os.getenv("JENTIC_CONNECT_TIMEOUT", 10.0))
-        read_timeout = cast(float, os.getenv("JENTIC_READ_TIMEOUT", 10.0))
-        write_timeout = cast(float, os.getenv("JENTIC_WRITE_TIMEOUT", 120.0))
-        pool_timeout = cast(float, os.getenv("JENTIC_POOL_TIMEOUT", 120.0))
+        connect_timeout = float(os.getenv("JENTIC_CONNECT_TIMEOUT", "10.0"))
+        read_timeout = float(os.getenv("JENTIC_READ_TIMEOUT", "10.0"))
+        write_timeout = float(os.getenv("JENTIC_WRITE_TIMEOUT", "120.0"))
+        pool_timeout = float(os.getenv("JENTIC_POOL_TIMEOUT", "120.0"))
 
+        logger.debug(
+            f"Built config for {environment} with connect_timeout: {connect_timeout}, read_timeout: {read_timeout}, write_timeout: {write_timeout}, pool_timeout: {pool_timeout}"
+        )
         return AgentConfig(
             agent_api_key=agent_api_key,
             environment=environment,

python/tests/test_cfg.py

@@ -29,3 +29,61 @@ def test_cfg_from_env__happy_path(monkeypatch):
     cfg = AgentConfig.from_env()
     assert cfg.environment == "qa"
     assert cfg.core_api_url == "https://api-gw.qa1.eu-west-1.jenticdev.net/api/v1/"
+
+
+def test_cfg_from_env__timeouts_defaults(monkeypatch):
+    # Ensure required env vars are set and timeout vars are *not* set
+    monkeypatch.setenv("JENTIC_AGENT_API_KEY", "ak_19814bi2f98jhwg")
+    monkeypatch.setenv("JENTIC_ENVIRONMENT", "prod")
+    monkeypatch.delenv("JENTIC_CONNECT_TIMEOUT", raising=False)
+    monkeypatch.delenv("JENTIC_READ_TIMEOUT", raising=False)
+    monkeypatch.delenv("JENTIC_WRITE_TIMEOUT", raising=False)
+    monkeypatch.delenv("JENTIC_POOL_TIMEOUT", raising=False)
+
+    cfg = AgentConfig.from_env()
+
+    assert cfg.connect_timeout == 10.0
+    assert cfg.read_timeout == 10.0
+    assert cfg.write_timeout == 120.0
+    assert cfg.pool_timeout == 120.0
+
+
+@pytest.mark.parametrize(
+    "env_var, value, attr",
+    [
+        ("JENTIC_CONNECT_TIMEOUT", "1.5", "connect_timeout"),
+        ("JENTIC_READ_TIMEOUT", "2.5", "read_timeout"),
+        ("JENTIC_WRITE_TIMEOUT", "130.0", "write_timeout"),
+        ("JENTIC_POOL_TIMEOUT", "140.0", "pool_timeout"),
+    ],
+)
+def test_cfg_from_env__timeouts_overrides(monkeypatch, env_var, value, attr):
+    monkeypatch.setenv("JENTIC_AGENT_API_KEY", "ak_19814bi2f98jhwg")
+    monkeypatch.setenv("JENTIC_ENVIRONMENT", "prod")
+    monkeypatch.setenv(env_var, value)
+
+    cfg = AgentConfig.from_env()
+
+    assert getattr(cfg, attr) == float(value)
+
+
+@pytest.mark.parametrize(
+    "env_var, bad_value",
+    [
+        ("JENTIC_CONNECT_TIMEOUT", ""),
+        ("JENTIC_CONNECT_TIMEOUT", " "),
+        ("JENTIC_READ_TIMEOUT", ""),
+        ("JENTIC_READ_TIMEOUT", " "),
+        ("JENTIC_WRITE_TIMEOUT", ""),
+        ("JENTIC_WRITE_TIMEOUT", " "),
+        ("JENTIC_POOL_TIMEOUT", ""),
+        ("JENTIC_POOL_TIMEOUT", " "),
+    ],
+)
+def test_cfg_from_env__timeouts_invalid_values(monkeypatch, env_var, bad_value):
+    monkeypatch.setenv("JENTIC_AGENT_API_KEY", "ak_19814bi2f98jhwg")
+    monkeypatch.setenv("JENTIC_ENVIRONMENT", "prod")
+    monkeypatch.setenv(env_var, bad_value)
+
+    with pytest.raises(ValueError):
+        AgentConfig.from_env()