Search up tree for config (#1122)

* write_default_config takes parent dir

* search up tree

* formatting

* Add another test

Author: bkorycki

src/modelgauge/config.py

@@ -12,21 +12,40 @@
 CONFIG_TEMPLATES = [DEFAULT_SECRETS]
 
 
-def write_default_config(dir: str = DEFAULT_CONFIG_DIR):
+def find_config_dir(path: str = ".") -> str:
+    """Search up the tree for the config directory."""
+    current_dir = os.path.abspath(path)
+    while True:
+        config_dir = os.path.join(current_dir, DEFAULT_CONFIG_DIR)
+        if os.path.exists(config_dir):
+            return config_dir
+        parent_dir = os.path.dirname(current_dir)
+        if parent_dir == current_dir:  # Reached root directory
+            raise FileNotFoundError(
+                f"Could not find the config directory '{DEFAULT_CONFIG_DIR}' anywhere along the path to '{path}'."
+            )
+        current_dir = parent_dir
+
+
+def write_default_config(parent_dir: str = "."):
     """If the config directory doesn't exist, fill it with defaults."""
-    if os.path.exists(dir):
+    try:
+        find_config_dir(parent_dir)
+        # Don't do anything if the config directory already exists.
         # Assume if it exists we don't need to add templates
-        return
-    os.makedirs(dir)
-    for template in CONFIG_TEMPLATES:
-        source_file = str(resources.files(config_templates) / template)
-        output_file = os.path.join(dir, template)
-        shutil.copyfile(source_file, output_file)
+    except FileNotFoundError:
+        dir = os.path.join(parent_dir, DEFAULT_CONFIG_DIR)
+        os.makedirs(dir)
+        for template in CONFIG_TEMPLATES:
+            source_file = str(resources.files(config_templates) / template)
+            output_file = os.path.join(dir, template)
+            shutil.copyfile(source_file, output_file)
 
 
-def load_secrets_from_config(path: str = SECRETS_PATH) -> RawSecrets:
+def load_secrets_from_config(path: str = ".") -> RawSecrets:
     """Load the toml file and verify it is shaped as expected."""
-    with open(path, "rb") as f:
+    secrets_path = os.path.join(find_config_dir(path), DEFAULT_SECRETS)
+    with open(secrets_path, "rb") as f:
         data = tomli.load(f)
     for values in data.values():
         # Verify the config is shaped as expected.

tests/modelgauge_tests/test_config.py

@@ -3,43 +3,88 @@
 from modelgauge.config import (
     DEFAULT_SECRETS,
     MissingSecretsFromConfig,
+    find_config_dir,
     load_secrets_from_config,
     raise_if_missing_from_config,
     write_default_config,
 )
 from modelgauge.secret_values import MissingSecretValues, SecretDescription
 
 
+def test_find_config_dir(tmpdir):
+    config_dir = tmpdir.join("config")
+    os.makedirs(config_dir)
+    found_dir = find_config_dir(str(tmpdir))
+    assert found_dir == config_dir
+
+
+def test_find_config_dir_searches_up_tree(tmpdir):
+    config_dir = tmpdir.join("config")
+    os.makedirs(config_dir)
+    sub_dir = tmpdir.join("subdir")
+    os.makedirs(sub_dir)
+    found_dir = find_config_dir(str(sub_dir))
+    assert found_dir == config_dir
+
+
+def test_find_config_dir_no_config(tmpdir):
+    with pytest.raises(FileNotFoundError):
+        find_config_dir(str(tmpdir))
+
+
 def test_write_default_config_writes_files(tmpdir):
+    write_default_config(tmpdir)
     config_dir = tmpdir.join("config")
-    write_default_config(config_dir)
     files = [f.basename for f in config_dir.listdir()]
     assert files == ["secrets.toml"]
 
 
 def test_write_default_config_skips_existing_dir(tmpdir):
     config_dir = tmpdir.join("config")
     os.makedirs(config_dir)
-    write_default_config(config_dir)
+    write_default_config(tmpdir)
     files = [f.basename for f in config_dir.listdir()]
     # No files created
     assert files == []
 
 
-def test_load_secrets_from_config_loads_default(tmpdir):
+def test_write_default_config_searches_up_tree(tmpdir):
     config_dir = tmpdir.join("config")
-    write_default_config(config_dir)
-    secrets_file = config_dir.join(DEFAULT_SECRETS)
+    os.makedirs(config_dir)
+    sub_dir = tmpdir.join("subdir")
+    os.makedirs(sub_dir)
+    write_default_config(sub_dir)
+    # Nothing created in subdir
+    assert not os.path.exists(sub_dir.join("config"))
 
-    assert load_secrets_from_config(secrets_file) == {"demo": {"api_key": "12345"}}
+
+def test_load_secrets_from_config_loads_default(tmpdir):
+    write_default_config(tmpdir)
+    assert load_secrets_from_config(tmpdir) == {"demo": {"api_key": "12345"}}
+
+
+def test_load_secrets_works_with_file_path(tmpdir):
+    """Test that you can also pass in a file path to load_secrets_from_config."""
+    config_dir = tmpdir.join("subdir", "config")
+    os.makedirs(config_dir)
+    secrets_file = config_dir.join("secrets.toml")
+    with open(secrets_file, "w") as f:
+        f.write(
+            """\
+        [scope]
+        api_key = "12345"
+        """
+        )
+    secrets = load_secrets_from_config(secrets_file)
+    assert secrets == {"scope": {"api_key": "12345"}}
 
 
 def test_load_secrets_from_config_no_file(tmpdir):
     config_dir = tmpdir.join("config")
-    secrets_file = config_dir.join(DEFAULT_SECRETS)
+    os.makedirs(config_dir)
 
     with pytest.raises(FileNotFoundError):
-        load_secrets_from_config(secrets_file)
+        load_secrets_from_config(tmpdir)
 
 
 def test_load_secrets_from_config_bad_format(tmpdir):
@@ -49,7 +94,7 @@ def test_load_secrets_from_config_bad_format(tmpdir):
     with open(secrets_file, "w") as f:
         f.write("""not_scoped = "some-value"\n""")
     with pytest.raises(AssertionError) as err_info:
-        load_secrets_from_config(secrets_file)
+        load_secrets_from_config(tmpdir)
     err_text = str(err_info.value)
     assert err_text == "All keys should be in a [scope]."