From 31cd4b280928ab90826acec443322d4dcf24740a Mon Sep 17 00:00:00 2001
From: Matthew Abruzzo <matthewabruzzo@gmail.com>
Date: Sun, 22 Sep 2024 18:04:22 -0400
Subject: [PATCH] start importing some things from test_grdata.py

---
 src/python/tests/test_auto_files.py | 74 +++++++----------------------
 1 file changed, 17 insertions(+), 57 deletions(-)

diff --git a/src/python/tests/test_auto_files.py b/src/python/tests/test_auto_files.py
index ac0edf1b..011167f0 100644
--- a/src/python/tests/test_auto_files.py
+++ b/src/python/tests/test_auto_files.py
@@ -15,7 +15,6 @@
 import io
 import os
 import shutil
-import sys
 
 import numpy as np
 import pytest
@@ -30,63 +29,22 @@
 from pygrackle.utilities.physical_constants import sec_per_Myr
 from pygrackle.utilities.testing import assert_allequal_arraydict, ensure_dir
 
+from test_grdata import (
+    _ENV_VARS,  # holds list of environment variables that affect data dir location
+    modified_env,
+)
 from test_query_units import _setup_generic_chemistry_data
 
+
 # we probably don't have to skip everything
 if not hasattr(os, "putenv"):
     pytest.skip(
         "several tests need os.putenv to work properly", allow_module_level=True
     )
 
-# _ENV_VAR holds the list of environment variables that could affect the
-# location of the data directory
-if sys.platform.startswith("darwin"):
-    _ENV_VARS = ("HOME", "GRACKLE_DATA_DIR")
-else:
-    _ENV_VARS = ("HOME", "GRACKLE_DATA_DIR", "XDG_DATA_HOME")
-
-
-def _ensure_removed(d, key):
-    try:
-        del d[key]
-    except KeyError:
-        pass
-
-
-@contextlib.contextmanager
-def modified_env(new_env_vals, extra_cleared_variables=None):
-    """
-    Temporarily overwrite the environment variables. This is necessary to test C
-    extensions that rely upon the environment variables
-    """
-    if extra_cleared_variables is None:
-        extra_cleared_variables = None
-
-    # record the original values for any variable we will overwrite
-    original_vals = {}
-    try:
-        for var in filter(lambda e: e not in new_env_vals, extra_cleared_variables):
-            original_vals[var] = os.environ.get(var, None)
-            _ensure_removed(os.environ, var)
-
-        for var, new_val in new_env_vals.items():
-            original_vals[var] = os.environ.get(var, None)
-            if new_val is None:
-                _ensure_removed(os.environ, var)
-            else:
-                os.environ[var] = new_val
-
-        yield
-
-    finally:
-        # restore to the initial values
-        for var, val in original_vals.items():
-            if val is None:
-                _ensure_removed(os.environ, var)
-            else:
-                os.environ[var] = val
-
 
+# it would be nice to replace the following with test_grdata.CLIApp, but that would
+# definitely take some work
 class DataFileManagementHarness:
     """
     This is a wrapper around the cli interface provided by pygrackle.
@@ -247,6 +205,7 @@ def managed_datafile(request, tmp_path):
         ) as full_path:
             yield full_path
 
+
 def setup_generic_problem(parameter_overrides={}):
     """set up a really simplistic problem"""
     chem = _setup_generic_chemistry_data(
@@ -267,9 +226,11 @@ def setup_generic_problem(parameter_overrides={}):
 
 @pytest.mark.parametrize(
     "managed_datafile",
-    ([pytest.param(None, id = "default-datadir")] +
-     [pytest.param(var, id=f"arbitrary-{var}") for var in _ENV_VARS]),
-    indirect=True
+    (
+        [pytest.param(None, id="default-datadir")]
+        + [pytest.param(var, id=f"arbitrary-{var}") for var in _ENV_VARS]
+    ),
+    indirect=True,
 )
 def test_autofile_equivalence(managed_datafile):
     """
@@ -304,7 +265,7 @@ def test_autofile_equivalence(managed_datafile):
     fc_other, _ = setup_generic_problem(
         parameter_overrides={
             "grackle_data_file": fname,
-            "grackle_data_file_options": constants.GR_DFOPT_MANAGED
+            "grackle_data_file_options": constants.GR_DFOPT_MANAGED,
         }
     )
     fc_other.solve_chemistry(dt)
@@ -319,7 +280,7 @@ def test_autofile_fail_unknown_file():
         skip_initialize=True,
         parameter_overrides={
             "grackle_data_file": "not-a-file.png",
-            "grackle_data_file_options": constants.GR_DFOPT_MANAGED
+            "grackle_data_file_options": constants.GR_DFOPT_MANAGED,
         },
     )
     assert chem.initialize() == constants.GR_FAIL
@@ -345,7 +306,7 @@ def test_autofile_fail_known_missing_file(tmp_path):
             skip_initialize=True,
             parameter_overrides={
                 "grackle_data_file": alt_fname,
-                "grackle_data_file_options": constants.GR_DFOPT_MANAGED
+                "grackle_data_file_options": constants.GR_DFOPT_MANAGED,
             },
         )
         assert chem.initialize() == constants.GR_FAIL
@@ -374,8 +335,7 @@ def test_autofile_fail_bad_checksum(tmp_path):
             skip_initialize=True,
             parameter_overrides={
                 "grackle_data_file": alt_fname,
-                "grackle_data_file_options": constants.GR_DFOPT_MANAGED
+                "grackle_data_file_options": constants.GR_DFOPT_MANAGED,
             },
         )
         assert chem.initialize() == constants.GR_FAIL
-