Add tests for keep alive file

Author: bbugyi200

src/zorg/config.py

@@ -24,7 +24,7 @@ class Config(clack.Config):
 
     command: Command
 
-    template_pattern_map: dict[Pattern, Path]
+    template_pattern_map: dict[Pattern, Path] = {}
     zettel_dir: Path = Path.home() / "org"
 
 

src/zorg/runners.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from functools import partial
 from pathlib import Path
 import tempfile
 from typing import Any, Iterable, Iterator, Mapping
@@ -66,8 +67,12 @@ def _add_paths_to_zdir(
 
 
 def _start_vim_loop(zo_paths: Iterable[Path], cfg: EditConfig) -> None:
-    cfg.keep_alive_file.parent.mkdir(parents=True, exist_ok=True)
-    cfg.keep_alive_file.touch()
+    zvim = partial(
+        vimala.vim,
+        commands=_process_vim_commands(cfg.zettel_dir, cfg.vim_commands),
+    )
+    zvim(*zo_paths).unwrap()
+
     logger.debug(
         "Vim loop will run as long as the keep alive file exists.",
         keep_alive_file=cfg.keep_alive_file,
@@ -90,10 +95,7 @@ def _start_vim_loop(zo_paths: Iterable[Path], cfg: EditConfig) -> None:
             paths = last_paths = new_paths
 
         cfg.keep_alive_file.unlink()
-        vimala.vim(
-            *_add_paths_to_zdir(cfg.zettel_dir, paths),
-            commands=_process_vim_commands(cfg.zettel_dir, cfg.vim_commands),
-        ).unwrap()
+        zvim(*paths).unwrap()
 
 
 def _process_vim_commands(

tests/common.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from pathlib import Path
 from typing import Any, Final, Protocol
 
 
@@ -16,6 +17,8 @@
 YEST_DD: Final = "02"
 TODAY: Final = f"{YYYY}-{MM}-{DD}"
 
+keep_alive_file_path = Path("/tmp/zorg_test_keep_alive")
+
 
 class MainType(Protocol):
     """Type returned by main() fixture."""

tests/conftest.py

@@ -32,7 +32,7 @@ def main(make_config_file: MakeConfigFile, tmp_path: Path) -> c.MainType:
 
     def inner_main(*args: str, **kwargs: Any) -> int:
         kwargs.setdefault("zettel_dir", default_zettel_dir)
-        kwargs.setdefault("template_pattern_map", {".*": "default.zo"})
+        kwargs.setdefault("keep_alive_file", c.keep_alive_file_path)
 
         cfg_kwargs = {
             k: v if isinstance(v, dict) else str(v)

tests/test_edit_cmd.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 from pathlib import Path
-from unittest.mock import Mock
+from unittest.mock import Mock, call
 
 from syrupy.assertion import SnapshotAssertion as Snapshot
 
@@ -62,3 +62,51 @@ def test_edit_day_logs(
         stderr=None,
         timeout=None,
     )
+
+
+def test_whenEmptyKeepAliveFileExists_shouldRestartVim(
+    main: c.MainType, vim_proc_mock: Mock, tmp_path: Path
+) -> None:
+    """Test that we can use the keep alive file to have zorg re-run vim."""
+    zettel_dir = tmp_path / "org"
+
+    c.keep_alive_file_path.touch()
+    exit_code = main("--dir", str(zettel_dir), "edit", "foobar.zo")
+
+    assert exit_code == 0
+    vim_proc_mock.assert_called_with(
+        ["vim", str(zettel_dir / "foobar.zo")],
+        stdout=None,
+        stderr=None,
+        timeout=None,
+    )
+    assert vim_proc_mock.call_count == 2
+
+
+def test_whenKeepAliveFileContainsPaths_useThosePathsOnRestart(
+    main: c.MainType, vim_proc_mock: Mock, tmp_path: Path
+) -> None:
+    """Test that we can use the keep alive file to change our vim file args."""
+    zettel_dir = tmp_path / "org"
+
+    c.keep_alive_file_path.write_text("baz.zo buz.zo")
+    exit_code = main("--dir", str(zettel_dir), "edit", "foobar.zo")
+
+    assert exit_code == 0
+    vim_proc_mock.assert_has_calls([
+        call(
+            ["vim", str(zettel_dir / "foobar.zo")],
+            stdout=None,
+            stderr=None,
+            timeout=None,
+        ),
+        call().unwrap(),
+        call(
+            ["vim", "baz.zo", "buz.zo"],
+            stdout=None,
+            stderr=None,
+            timeout=None,
+        ),
+        call().unwrap(),
+    ])
+    assert vim_proc_mock.call_count == 2