Check parent directories for btest.cfg

Author: evantypanski

README

@@ -414,10 +414,11 @@ Configuration
 -------------
 
 Specifics of ``btest``'s execution can be tuned with a configuration
-file, which by default is ``btest.cfg`` if that's found in the
-current directory. It can alternatively be specified with the
-``--config`` command line option, or a ``BTEST_CFG`` environment
-variable. The configuration file is
+file, which by default is ``btest.cfg`` if that's found in the current
+directory or parent directories. It can alternatively be specified
+with the ``--config`` command line option (which will not search
+parent directories), or a ``BTEST_CFG`` environment variable.
+The configuration file is
 "INI-style", and an example comes with the distribution, see
 ``btest.cfg.example``. A configuration file has one main section,
 ``btest``, that defines most options; as well as an optional section

btest

@@ -61,10 +61,9 @@ VERSION = "1.2-9"  # Automatically filled in.
 Name = "btest"
 Config = None
 
-try:
-    ConfigDefault = os.environ["BTEST_CFG"]
-except KeyError:
-    ConfigDefault = "btest.cfg"
+DEFAULT_CONFIG_NAME = "btest.cfg"
+
+ConfigDefault = os.environ.get("BTEST_CFG", DEFAULT_CONFIG_NAME)
 
 
 def normalize_path(path):
@@ -2708,6 +2707,21 @@ def outputDocumentation(tests, fmt):
             print()
 
 
+# Finds a file, recursing to parent directories if not found
+def find_file(filename, *, recurse):
+    current_dir = pathlib.Path.cwd()
+
+    for d in [current_dir, *current_dir.parents]:
+        f = d / filename
+        if f.is_file():
+            return str(f)
+
+        if not recurse:
+            break
+
+    return None
+
+
 def parse_options():
     optparser = optparse.OptionParser(
         usage="%prog [options] <directories>", version=VERSION
@@ -2950,9 +2964,6 @@ def parse_options():
         warning("ignoring requested parallelism in interactive-update mode")
         options.threads = 1
 
-    if not os.path.exists(options.config):
-        error(f"configuration file '{options.config}' not found")
-
     return options, parsed_args
 
 
@@ -2991,18 +3002,22 @@ if __name__ == "__main__":
 
     (Options, args) = parse_options()
 
+    btest_cfg = find_file(Options.config, recurse=Options.config == DEFAULT_CONFIG_NAME)
+    if not btest_cfg:
+        error(f"configuration file '{Options.config}' not found")
+
     # The defaults come from environment variables, plus a few additional items.
     defaults = {}
     # Changes to defaults should not change os.environ
     defaults.update(os.environ)
     defaults["default_path"] = os.environ["PATH"]
 
-    dirname = os.path.dirname(Options.config)
+    dirname = os.path.dirname(btest_cfg)
     if not dirname:
         dirname = os.getcwd()
 
     # If the BTEST_TEST_BASE envirnoment var is set, we'll use that as the testbase.
-    # If not, we'll use the current directory.
+    # If not, we'll use the config file's directory.
     TestBase = normalize_path(os.environ.get("BTEST_TEST_BASE", dirname))
     defaults["testbase"] = TestBase
     defaults["baselinedir"] = normalize_path(
@@ -3012,7 +3027,7 @@ if __name__ == "__main__":
 
     # Parse our config
     Config = getcfgparser(defaults)
-    Config.read(Options.config, encoding="utf-8")
+    Config.read(btest_cfg, encoding="utf-8")
 
     defaults["baselinedir"] = getOption("BaselineDir", defaults["baselinedir"])
 
@@ -3044,7 +3059,7 @@ if __name__ == "__main__":
                     # At this point, our defaults have changed, so we
                     # reread the configuration.
                     new_config = getcfgparser(defaults)
-                    new_config.read(Options.config)
+                    new_config.read(btest_cfg)
                     return new_config, value
 
             return Config, default

testing/Baseline/tests.btest-cfg/nopath

@@ -5,4 +5,4 @@ btest-cfg ... ok
 all 1 tests successful
 btest-cfg ... ok
 all 1 tests successful
-configuration file 'btest.cfg' not found
+configuration file 'nonexistant' not found

testing/tests/btest-cfg.test

@@ -2,7 +2,7 @@
 # %TEST-EXEC: btest -c myfile %INPUT > nopath 2>&1
 # %TEST-EXEC: BTEST_CFG=myfile btest %INPUT >> nopath 2>&1
 # %TEST-EXEC: BTEST_CFG=notexist btest -c myfile %INPUT >> nopath 2>&1
-# %TEST-EXEC-FAIL: btest %INPUT >> nopath 2>&1
+# %TEST-EXEC-FAIL: btest -c nonexistant %INPUT >> nopath 2>&1
 # %TEST-EXEC: btest-diff nopath
 # %TEST-EXEC: mkdir z
 # %TEST-EXEC: mv myfile z/btest.cfg