tests/tests.py (1)

73-92: Use try/finally for cleanup to ensure tmpdir removal on test failure.

If the assertion on line 91 fails, the shutil.rmtree on line 92 won't execute, leaving the temporary directory behind. Other tests in this file (e.g., test_github_issue1384, test_github_issue1882) use try/finally for this pattern.

♻️ Suggested refactor

 def test_unlock_cli():
     # run the workflow once to create the .snakemake/locks folder
     tmpdir = run(dpath("test_unlock"), cleanup=False)
-    locks = os.path.join(tmpdir, ".snakemake", "locks")
-    # the lock directory may be cleaned up automatically by Snakemake,
-    # so ensure there's at least one file inside to simulate a stale lock.
-    os.makedirs(locks, exist_ok=True)
-    lockfile = os.path.join(locks, "dummy.lock")
-    open(lockfile, "w").close()
-    assert os.listdir(locks), "expected at least one lock file"
-
-    # run the CLI unlock command and verify it succeeds
-    sp.run(
-        [sys.executable, "-m", "snakemake", "--unlock"],
-        cwd=tmpdir,
-        check=True,
-    )
-    # after unlocking the locks directory should be removed or empty
-    assert not os.path.exists(locks) or not os.listdir(locks)
-    shutil.rmtree(tmpdir, ignore_errors=ON_WINDOWS)
+    try:
+        locks = os.path.join(tmpdir, ".snakemake", "locks")
+        # the lock directory may be cleaned up automatically by Snakemake,
+        # so ensure there's at least one file inside to simulate a stale lock.
+        os.makedirs(locks, exist_ok=True)
+        Path(locks, "dummy.lock").touch()
+        assert os.listdir(locks), "expected at least one lock file"
+
+        # run the CLI unlock command and verify it succeeds
+        sp.run(
+            [sys.executable, "-m", "snakemake", "--unlock"],
+            cwd=tmpdir,
+            check=True,
+        )
+        # after unlocking the locks directory should be removed or empty
+        assert not os.path.exists(locks) or not os.listdir(locks)
+    finally:
+        shutil.rmtree(tmpdir, ignore_errors=ON_WINDOWS)

Note: The diff also replaces open(lockfile, "w").close() with Path(...).touch() since Path is already imported.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@tests/tests.py` around lines 73 - 92, The test_unlock_cli function should
ensure tmpdir is always removed by wrapping the test body (after tmpdir =
run(...)) in a try/finally where the finally calls shutil.rmtree(tmpdir,
ignore_errors=ON_WINDOWS); also replace open(lockfile, "w").close() with
Path(lockfile).touch() since Path is already imported and used elsewhere. Locate
the test by the test_unlock_cli function and adjust the run/locks setup and the
sp.run(... "--unlock") invocation to live inside the try, leaving only the
shutil.rmtree(...) call in the finally block to guarantee cleanup on assertion
or other failures.