Merge pull request #6 from regro/in-container-util

feat: add util for using a container and tests

Author: beckermr

conda_forge_feedstock_ops/container_utils.py

@@ -191,3 +191,31 @@ def run_container_operation(
         )
 
     return ret["data"]
+
+
+def should_use_container(use_container: Optional[bool] = None):
+    """Determine if we should use a container.
+
+    Parameters
+    ----------
+    use_container
+        Whether to use a container to run the rerender.
+        If None, the function will use a container if the environment
+        variable `CF_FEEDSTOCK_OPS_IN_CONTAINER` is 'false'. This feature can be
+        used to avoid container in container calls.
+
+    Returns
+    -------
+    bool
+        Whether to use a container.
+    """
+    in_container = (
+        os.environ.get("CF_FEEDSTOCK_OPS_IN_CONTAINER", "false").lower() == "true"
+    )
+    if use_container is None:
+        use_container = not in_container
+
+    if use_container and not in_container:
+        return True
+    else:
+        return False

conda_forge_feedstock_ops/os_utils.py

@@ -26,7 +26,10 @@ def override_env(name, value):
     """Override an environment variable temporarily."""
     old = os.environ.get(name)
     try:
-        os.environ[name] = value
+        if value is None:
+            del os.environ[name]
+        else:
+            os.environ[name] = value
         yield
     finally:
         if old is None:

conda_forge_feedstock_ops/rerender.py

@@ -11,6 +11,7 @@
 from conda_forge_feedstock_ops.container_utils import (
     get_default_log_level_args,
     run_container_operation,
+    should_use_container,
 )
 from conda_forge_feedstock_ops.os_utils import (
     chmod_plus_rwX,
@@ -43,12 +44,7 @@ def rerender(feedstock_dir, timeout=None, use_container=None):
     str
         The commit message for the rerender. If None, the rerender didn't change anything.
     """
-
-    in_container = os.environ.get("CF_FEEDSTOCK_OPS_IN_CONTAINER", "false") == "true"
-    if use_container is None:
-        use_container = not in_container
-
-    if use_container and not in_container:
+    if should_use_container(use_container=use_container):
         return rerender_containerized(
             feedstock_dir,
             timeout=timeout,

tests/test_container_utils.py

@@ -0,0 +1,25 @@
+from conda_forge_feedstock_ops.container_utils import should_use_container
+from conda_forge_feedstock_ops.os_utils import override_env
+
+
+def test_should_use_container():
+    with override_env("CF_FEEDSTOCK_OPS_IN_CONTAINER", "tRue"):
+        assert not should_use_container()
+
+    with override_env("CF_FEEDSTOCK_OPS_IN_CONTAINER", "false"):
+        assert should_use_container()
+
+    with override_env("CF_FEEDSTOCK_OPS_IN_CONTAINER", None):
+        assert should_use_container()
+
+    with override_env("CF_FEEDSTOCK_OPS_IN_CONTAINER", "true"):
+        assert not should_use_container(use_container=True)
+
+    with override_env("CF_FEEDSTOCK_OPS_IN_CONTAINER", "false"):
+        assert should_use_container(use_container=True)
+
+    with override_env("CF_FEEDSTOCK_OPS_IN_CONTAINER", "true"):
+        assert not should_use_container(use_container=False)
+
+    with override_env("CF_FEEDSTOCK_OPS_IN_CONTAINER", "false"):
+        assert not should_use_container(use_container=False)