Fix windows tests failing due to ~ in directory

facebookresearch · Oct 25, 2024 · 2455551 · 2455551
1 parent 7ccf653
commit 2455551
Show file tree

Hide file tree

Showing 18 changed files with 100 additions and 97 deletions.
diff --git a/examples/advanced/hydra_app_example/tests/test_installed_app.py b/examples/advanced/hydra_app_example/tests/test_installed_app.py
@@ -16,7 +16,7 @@ def test_python_run(self, tmpdir: str) -> None:
                 [
                     sys.executable,
                     "hydra_app/main.py",
-                    f"hydra.run.dir={tmpdir}",
+                    f'hydra.run.dir="{tmpdir}"',
                     "app.user=test_user",
                 ]
             )
@@ -26,7 +26,7 @@ def test_python_run(self, tmpdir: str) -> None:
     def test_installed_run(self, tmpdir: str) -> None:
         self.verify_output(
             subprocess.check_output(
-                ["hydra_app", f"hydra.run.dir={tmpdir}", "app.user=test_user"]
+                ["hydra_app", f'hydra.run.dir="{tmpdir}"', "app.user=test_user"]
             )
         )
 

diff --git a/hydra/test_utils/launcher_common_tests.py b/hydra/test_utils/launcher_common_tests.py
@@ -5,7 +5,7 @@
 import copy
 import os
 import re
-from pathlib import Path
+from pathlib import Path, PureWindowsPath
 from typing import Any, Callable, List, Optional, Set
 
 from omegaconf import DictConfig, OmegaConf
@@ -657,6 +657,9 @@ def test_to_absolute_path_multirun(
         cfg = OmegaConf.merge(task_launcher_cfg, task_config)
         assert isinstance(cfg, DictConfig)
         path = str(Path("/foo/bar").absolute())
+        # Hack to use the right drive on windows
+        if path.startswith("D:"):
+            path.replace("D:", "C:", 1)
         integration_test(
             tmpdir=self.get_test_scratch_dir(tmpdir),
             task_config=cfg,

diff --git a/hydra/test_utils/test_utils.py b/hydra/test_utils/test_utils.py
@@ -69,7 +69,7 @@ def __enter__(self) -> "TaskTestFunction":
             self.temp_dir = tempfile.mkdtemp()
             overrides = copy.deepcopy(self.overrides)
             assert overrides is not None
-            overrides.append(f"hydra.run.dir={self.temp_dir}")
+            overrides.append(f'hydra.run.dir="{self.temp_dir}"')
             self.job_ret = self.hydra.run(
                 config_name=self.config_name,
                 task_function=self,

diff --git a/plugins/hydra_ax_sweeper/tests/test_ax_sweeper_plugin.py b/plugins/hydra_ax_sweeper/tests/test_ax_sweeper_plugin.py
@@ -216,7 +216,7 @@ def test_ax_logging(tmpdir: Path, cmd_arg: str, expected_str: str) -> None:
     cmd = [
         "tests/apps/polynomial.py",
         "-m",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
         "polynomial.x=interval(-5, -2)",
         "polynomial.z=10",
@@ -239,7 +239,7 @@ def test_search_space_exhausted_exception(tmpdir: Path, cmd_args: List[str]) ->
     cmd = [
         "tests/apps/polynomial.py",
         "-m",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
         "hydra.sweeper.ax_config.max_trials=2",
     ] + cmd_args
@@ -260,7 +260,7 @@ def test_search_space_with_constraint_metric(tmpdir: Path, cmd_args: List[str])
     cmd = [
         "tests/apps/polynomial_with_constraint.py",
         "-m",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
         "hydra.sweeper.ax_config.max_trials=2",
     ] + cmd_args
@@ -294,7 +294,7 @@ def test_jobs_using_choice_between_lists(
     cmd = [
         "tests/apps/polynomial_with_list_coefficients.py",
         "-m",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
         "hydra.sweeper.ax_config.max_trials=3",
     ] + [cmd_arg]
@@ -331,7 +331,7 @@ def test_jobs_using_choice_between_dicts(
     cmd = [
         "tests/apps/polynomial_with_dict_coefficients.py",
         "-m",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
         "hydra.sweeper.ax_config.max_trials=3",
     ] + [cmd_arg]
@@ -345,7 +345,7 @@ def test_example_app(tmpdir: Path) -> None:
     cmd = [
         "example/banana.py",
         "-m",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
         "banana.x=int(interval(-5, 5))",
         "banana.y=interval(-5, 10.1)",

diff --git a/tests/test_basic_sweeper.py b/tests/test_basic_sweeper.py
@@ -70,7 +70,7 @@ def test_partial_failure(
         "tests/test_apps/app_can_fail/my_app.py",
         "--multirun",
         "+divisor=1,0",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
         "hydra.hydra_logging.formatters.simple.format='[HYDRA] %(message)s'",
     ]

diff --git a/tests/test_callbacks.py b/tests/test_callbacks.py
@@ -98,7 +98,7 @@ def test_app_with_callbacks(
 ) -> None:
     cmd = [
         app_path,
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
         "hydra.hydra_logging.formatters.simple.format='[HYDRA] %(message)s'",
         "hydra.job_logging.formatters.simple.format='[JOB] %(message)s'",
@@ -120,7 +120,7 @@ def test_experimental_save_job_info_callback(tmpdir: Path, multirun: bool) -> No
 
     cmd = [
         app_path,
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.sweep.dir=" + str(tmpdir),
         "hydra.job.chdir=True",
     ]
@@ -167,7 +167,7 @@ def test_save_job_return_callback(tmpdir: Path, multirun: bool) -> None:
     cmd = [
         sys.executable,
         app_path,
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.sweep.dir=" + str(tmpdir),
         "hydra.job.chdir=True",
     ]
@@ -202,7 +202,7 @@ def test_experimental_rerun(
 
     cmd = [
         app_path,
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.sweep.dir=" + str(tmpdir),
         "hydra.job.chdir=False",
         "hydra.hydra_logging.formatters.simple.format='[HYDRA] %(message)s'",

diff --git a/tests/test_env_defaults.py b/tests/test_env_defaults.py
@@ -9,7 +9,7 @@
 def test_env_defaults(tmpdir: Path) -> None:
     cmd = [
         "tests/test_apps/custom_env_defaults/my_app.py",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
     ]
     run_python_script(cmd)
diff --git a/tests/test_examples/test_advanced_config_search_path.py b/tests/test_examples/test_advanced_config_search_path.py
@@ -36,7 +36,7 @@ def test_config_search_path(
 ) -> None:
     cmd = [
         "examples/advanced/config_search_path/my_app.py",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
     ]
     cmd.extend(args)

diff --git a/tests/test_examples/test_advanced_package_overrides.py b/tests/test_examples/test_advanced_package_overrides.py
@@ -11,7 +11,7 @@
 def test_advanced_package_override_simple(tmpdir: Path) -> None:
     cmd = [
         "examples/advanced/package_overrides/simple.py",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
     ]
     result, _err = run_python_script(cmd)
@@ -23,7 +23,7 @@ def test_advanced_package_override_simple(tmpdir: Path) -> None:
 def test_advanced_package_override_two_packages(tmpdir: Path) -> None:
     cmd = [
         "examples/advanced/package_overrides/two_packages.py",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
     ]
     result, _err = run_python_script(cmd)

diff --git a/tests/test_examples/test_basic_sweep.py b/tests/test_examples/test_basic_sweep.py
@@ -70,7 +70,7 @@ def test_basic_sweep_example(
     cmd = [
         app_path,
         "--multirun",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
         "hydra.hydra_logging.formatters.simple.format='[HYDRA] %(message)s'",
         "hydra.job_logging.formatters.simple.format='[JOB] %(message)s'",

diff --git a/tests/test_examples/test_configure_hydra.py b/tests/test_examples/test_configure_hydra.py
@@ -16,7 +16,7 @@ def test_custom_help(tmpdir: Path) -> None:
     result, _err = run_python_script(
         [
             "examples/configure_hydra/custom_help/my_app.py",
-            "hydra.run.dir=" + str(tmpdir),
+            f'hydra.run.dir="{str(tmpdir)}"',
             "hydra.job.chdir=True",
             "--help",
         ]
@@ -55,7 +55,7 @@ def test_custom_help(tmpdir: Path) -> None:
 def test_job_name_no_config_override(tmpdir: Path) -> None:
     cmd = [
         "examples/configure_hydra/job_name/no_config_file_override.py",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
     ]
     result, _err = run_python_script(cmd)
@@ -65,7 +65,7 @@ def test_job_name_no_config_override(tmpdir: Path) -> None:
 def test_job_name_with_config_override(tmpdir: Path) -> None:
     cmd = [
         "examples/configure_hydra/job_name/with_config_file_override.py",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
     ]
     result, _err = run_python_script(cmd)
@@ -90,7 +90,7 @@ def test_job_override_dirname(tmpdir: Path) -> None:
 def test_logging(tmpdir: Path) -> None:
     cmd = [
         "examples/configure_hydra/logging/my_app.py",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
     ]
     result, _err = run_python_script(cmd)
@@ -100,7 +100,7 @@ def test_logging(tmpdir: Path) -> None:
 def test_disabling_logging(tmpdir: Path) -> None:
     cmd = [
         "examples/configure_hydra/logging/my_app.py",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
         "hydra/job_logging=none",
         "hydra/hydra_logging=none",

diff --git a/tests/test_examples/test_experimental.py b/tests/test_examples/test_experimental.py
@@ -8,7 +8,7 @@
 def test_rerun(tmpdir: Path) -> None:
     cmd = [
         "examples/experimental/rerun/my_app.py",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
         "hydra.hydra_logging.formatters.simple.format='[HYDRA] %(message)s'",
         "hydra.job_logging.formatters.simple.format='[JOB] %(message)s'",

diff --git a/tests/test_examples/test_instantiate_examples.py b/tests/test_examples/test_instantiate_examples.py
@@ -24,7 +24,7 @@
 def test_instantiate_object(tmpdir: Path, overrides: List[str], output: str) -> None:
     cmd = [
         "examples/instantiate/object/my_app.py",
-        f"hydra.run.dir={tmpdir}",
+        f'hydra.run.dir="{tmpdir}"',
         "hydra.job.chdir=True",
     ] + overrides
     result, _err = run_python_script(cmd)
@@ -46,7 +46,7 @@ def test_instantiate_object_recursive(
 ) -> None:
     cmd = [
         "examples/instantiate/object_recursive/my_app.py",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
     ] + overrides
     result, _err = run_python_script(cmd)
@@ -56,7 +56,7 @@ def test_instantiate_object_recursive(
 def test_instantiate_object_partial(tmpdir: Path) -> None:
     cmd = [
         "examples/instantiate/partial/my_app.py",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
     ]
     result, _err = run_python_script(cmd)
@@ -73,7 +73,7 @@ def test_instantiate_object_partial(tmpdir: Path) -> None:
 def test_instantiate_schema(tmpdir: Path, overrides: List[str], output: str) -> None:
     cmd = [
         "examples/instantiate/schema/my_app.py",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
     ] + overrides
     result, _err = run_python_script(cmd)
@@ -102,7 +102,7 @@ def test_instantiate_schema_recursive(
 ) -> None:
     cmd = [
         "examples/instantiate/schema_recursive/my_app.py",
-        f"hydra.run.dir={tmpdir}",
+        f'hydra.run.dir="{tmpdir}"',
         "hydra.job.chdir=True",
     ] + overrides
     result, _err = run_python_script(cmd)
@@ -141,7 +141,7 @@ def test_instantiate_docs_example(
 ) -> None:
     cmd = [
         "examples/instantiate/docs_example/my_app.py",
-        f"hydra.run.dir={tmpdir}",
+        f'hydra.run.dir="{tmpdir}"',
         "hydra.job.chdir=True",
     ] + overrides
     result, _err = run_python_script(cmd)

diff --git a/tests/test_examples/test_patterns.py b/tests/test_examples/test_patterns.py
@@ -39,7 +39,7 @@ def test_specializing_config_example(
 def test_write_protect_config_node(tmpdir: Any) -> None:
     cmd = [
         "examples/patterns/write_protect_config_node/frozen.py",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
         "data_bits=10",
     ]
@@ -71,7 +71,7 @@ def test_extending_configs(
     monkeypatch.chdir("examples/patterns/extending_configs")
     cmd = [
         "my_app.py",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
     ] + overrides
     result, _err = run_python_script(cmd)
@@ -112,7 +112,7 @@ def test_configuring_experiments(
     monkeypatch.chdir("examples/patterns/configuring_experiments")
     cmd = [
         "my_app.py",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
     ] + overrides
     result, _err = run_python_script(cmd)
@@ -183,7 +183,7 @@ def test_multi_select(
     monkeypatch.chdir("examples/patterns/multi-select")
     cmd = [
         "my_app.py",
-        "hydra.run.dir=" + str(tmpdir),
+        f'hydra.run.dir="{str(tmpdir)}"',
         "hydra.job.chdir=True",
     ] + overrides
     result, _err = run_python_script(cmd)