refactor(tests): Move test dir constants to pathlib.Path

Author: tony

tests/__init__.py

@@ -4,8 +4,8 @@
 ~~~~~~~~~~~
 
 """
-import os
+import pathlib
 
-current_dir = os.path.abspath(os.path.dirname(__file__))
-example_dir = os.path.abspath(os.path.join(current_dir, "..", "examples"))
-fixtures_dir = os.path.realpath(os.path.join(current_dir, "fixtures"))
+tests_dir = pathlib.Path(__file__).parent
+example_dir = tests_dir.parent / "examples"
+fixtures_dir = tests_dir / "fixtures"

tests/test_config.py

@@ -1,6 +1,7 @@
 """Test for tmuxp configuration import, inlining, expanding and export."""
 import os
 import pathlib
+from typing import Union
 
 import pytest
 
@@ -14,12 +15,20 @@
 TMUXP_DIR = pathlib.Path(__file__).parent / ".tmuxp"
 
 
-def load_yaml(yaml):
-    return kaptan.Kaptan(handler="yaml").import_config(yaml).get()
+def load_yaml(path: Union[str, pathlib.Path]) -> str:
+    return (
+        kaptan.Kaptan(handler="yaml")
+        .import_config(str(path) if isinstance(path, pathlib.Path) else path)
+        .get()
+    )
 
 
-def load_config(_file):
-    return kaptan.Kaptan().import_config(_file).get()
+def load_config(path: Union[str, pathlib.Path]) -> str:
+    return (
+        kaptan.Kaptan()
+        .import_config(str(path) if isinstance(path, pathlib.Path) else path)
+        .get()
+    )
 
 
 def test_export_json(tmp_path: pathlib.Path):
@@ -282,7 +291,7 @@ def test_expands_blank_panes():
 
     """
 
-    yaml_config_file = os.path.join(example_dir, "blank-panes.yaml")
+    yaml_config_file = example_dir / "blank-panes.yaml"
     test_config = load_config(yaml_config_file)
     assert config.expand(test_config) == fixtures.expand_blank.expected
 

tests/test_util.py

@@ -1,6 +1,4 @@
 """Tests for utility functions in tmux."""
-import os
-
 import pytest
 
 from tmuxp import exc
@@ -11,7 +9,7 @@
 
 
 def test_raise_BeforeLoadScriptNotExists_if_not_exists():
-    script_file = os.path.join(fixtures_dir, "script_noexists.sh")
+    script_file = fixtures_dir / "script_noexists.sh"
 
     with pytest.raises(BeforeLoadScriptNotExists):
         run_before_script(script_file)
@@ -21,30 +19,30 @@ def test_raise_BeforeLoadScriptNotExists_if_not_exists():
 
 
 def test_raise_BeforeLoadScriptError_if_retcode():
-    script_file = os.path.join(fixtures_dir, "script_failed.sh")
+    script_file = fixtures_dir / "script_failed.sh"
 
     with pytest.raises(BeforeLoadScriptError):
         run_before_script(script_file)
 
 
 def test_return_stdout_if_ok(capsys):
-    script_file = os.path.join(fixtures_dir, "script_complete.sh")
+    script_file = fixtures_dir / "script_complete.sh"
 
     run_before_script(script_file)
     out, err = capsys.readouterr()
     assert "hello" in out
 
 
 def test_beforeload_returncode():
-    script_file = os.path.join(fixtures_dir, "script_failed.sh")
+    script_file = fixtures_dir / "script_failed.sh"
 
     with pytest.raises(exc.BeforeLoadScriptError) as excinfo:
         run_before_script(script_file)
         assert excinfo.match(r"113")
 
 
 def test_beforeload_returns_stderr_messages():
-    script_file = os.path.join(fixtures_dir, "script_failed.sh")
+    script_file = fixtures_dir / "script_failed.sh"
 
     with pytest.raises(exc.BeforeLoadScriptError) as excinfo:
         run_before_script(script_file)

tests/test_workspacebuilder.py

@@ -405,8 +405,8 @@ def test_automatic_rename_option(session):
 
 def test_blank_pane_count(session):
     """:todo: Verify blank panes of various types build into workspaces."""
-    yaml_config_file = os.path.join(example_dir, "blank-panes.yaml")
-    test_config = kaptan.Kaptan().import_config(yaml_config_file).get()
+    yaml_config_file = example_dir / "blank-panes.yaml"
+    test_config = kaptan.Kaptan().import_config(str(yaml_config_file)).get()
     test_config = config.expand(test_config)
     builder = WorkspaceBuilder(sconf=test_config)
     builder.build(session=session)
@@ -590,7 +590,7 @@ def test_before_load_throw_error_if_retcode_error(server):
     sconfig = kaptan.Kaptan(handler="yaml")
     yaml = config_script_fails.format(
         fixtures_dir=fixtures_dir,
-        script_failed=os.path.join(fixtures_dir, "script_failed.sh"),
+        script_failed=fixtures_dir / "script_failed.sh",
     )
 
     sconfig = sconfig.import_config(yaml).get()
@@ -616,7 +616,7 @@ def test_before_load_throw_error_if_file_not_exists(server):
     sconfig = kaptan.Kaptan(handler="yaml")
     yaml = config_script_not_exists.format(
         fixtures_dir=fixtures_dir,
-        script_not_exists=os.path.join(fixtures_dir, "script_not_exists.sh"),
+        script_not_exists=fixtures_dir / "script_not_exists.sh",
     )
     sconfig = sconfig.import_config(yaml).get()
     sconfig = config.expand(sconfig)
@@ -639,11 +639,12 @@ def test_before_load_true_if_test_passes(server):
     config_script_completes = load_fixture(
         "workspacebuilder/config_script_completes.yaml"
     )
-    assert os.path.exists(os.path.join(fixtures_dir, "script_complete.sh"))
+    script_complete_sh = fixtures_dir / "script_complete.sh"
+    assert script_complete_sh.exists()
     sconfig = kaptan.Kaptan(handler="yaml")
     yaml = config_script_completes.format(
         fixtures_dir=fixtures_dir,
-        script_complete=os.path.join(fixtures_dir, "script_complete.sh"),
+        script_complete=script_complete_sh,
     )
 
     sconfig = sconfig.import_config(yaml).get()
@@ -660,12 +661,11 @@ def test_before_load_true_if_test_passes_with_args(server):
     config_script_completes = load_fixture(
         "workspacebuilder/config_script_completes.yaml"
     )
-
-    assert os.path.exists(os.path.join(fixtures_dir, "script_complete.sh"))
+    script_complete_sh = fixtures_dir / "script_complete.sh"
+    assert script_complete_sh.exists()
     sconfig = kaptan.Kaptan(handler="yaml")
     yaml = config_script_completes.format(
-        fixtures_dir=fixtures_dir,
-        script_complete=os.path.join(fixtures_dir, "script_complete.sh") + " -v",
+        fixtures_dir=fixtures_dir, script_complete=script_complete_sh
     )
 
     sconfig = sconfig.import_config(yaml).get()