Add Quix__State__Dir environment variable to configure app state directory (#844)

Author: ovv

quixstreams/app.py

@@ -168,7 +168,7 @@ def __init__(
               >***NOTE:*** the environment variable is set for you in the Quix Cloud
         :param consumer_group: Kafka consumer group.
             Passed as `group.id` to `confluent_kafka.Consumer`.
-            Linked Environment Variable: `Quix__Consumer__Group`.
+            Linked Environment Variable: `Quix__Consumer_Group`.
             Default - "quixstreams-default" (set during init)
               >***NOTE:*** Quix Applications will prefix it with the Quix workspace id.
         :param commit_interval: How often to commit the processed messages in seconds.
@@ -188,6 +188,7 @@ def __init__(
         :param producer_extra_config: A dictionary with additional options that
             will be passed to `confluent_kafka.Producer` as is.
         :param state_dir: path to the application state directory.
+            Linked Environment Variable: `Quix__State__Dir`.
             Default - `"state"`.
         :param rocksdb_options: RocksDB options.
             If `None`, the default options will be used.
@@ -232,7 +233,9 @@ def __init__(
         consumer_extra_config = consumer_extra_config or {}
 
         if state_dir is None:
-            state_dir = "/app/state" if is_quix_deployment() else "state"
+            state_dir = os.getenv(
+                "Quix__State__Dir", "/app/state" if is_quix_deployment() else "state"
+            )
         state_dir = Path(state_dir)
 
         # We can't use os.getenv as defaults (and have testing work nicely)

tests/test_quixstreams/test_app.py

@@ -479,12 +479,13 @@ def test_consumer_group_env(self):
         """
         Sanity check consumer_group gets set from the environment via getenv.
         """
-        consumer_group = "my_group"
-        with patch.dict(os.environ, {"Quix__Consumer__group": consumer_group}):
-            app = Application(
-                broker_address="my_address", consumer_group=consumer_group
-            )
-        assert app.config.consumer_group == consumer_group
+        with patch.dict(os.environ, {"Quix__Consumer_Group": "environ_group"}):
+            app = Application(broker_address="my_address")
+        assert app.config.consumer_group == "environ_group"
+
+        with patch.dict(os.environ, {"Quix__Consumer_Group": "environ_group"}):
+            app = Application(broker_address="my_address", consumer_group="app_group")
+        assert app.config.consumer_group == "app_group"
 
     def test_consumer_group_default(self):
         """
@@ -494,6 +495,21 @@ def test_consumer_group_default(self):
             app = Application(broker_address="my_address")
         assert app.config.consumer_group == "quixstreams-default"
 
+    def test_state_dir_env(self):
+        """
+        Sanity check state_dir gets set from the environment via getenv.
+        """
+        app = Application(broker_address="my_address")
+        assert app.config.state_dir == Path("state")
+
+        with patch.dict(os.environ, {"Quix__State__Dir": "/path/to/state"}):
+            app = Application(broker_address="my_address")
+        assert app.config.state_dir == Path("/path/to/state")
+
+        with patch.dict(os.environ, {"Quix__State__Dir": "/path/to/state"}):
+            app = Application(broker_address="my_address", state_dir="/path/to/other")
+        assert app.config.state_dir == Path("/path/to/other")
+
 
 class TestAppGroupBy:
     def test_group_by(