Fix: Deprecations using script_runner (#453)

Add: Types and mypy coverage for tests.

Co-authored-by: Oscar Levin <oscar.levin@unco.edu>

Author: bjones1

tests/test_cli.py

@@ -9,15 +9,18 @@
 from contextlib import contextmanager
 import requests
 import pretext
+from typing import cast, Generator
+from pytest_console_scripts import ScriptRunner
 
 EXAMPLES_DIR = Path(__file__).parent / "examples"
 
-PTX_CMD = shutil.which("pretext")
+PTX_CMD = cast(str, shutil.which("pretext"))
+assert PTX_CMD is not None
 PY_CMD = sys.executable
 
 
 @contextmanager
-def pretext_view(*args):
+def pretext_view(*args: str) -> Generator:
     process = subprocess.Popen(
         [PTX_CMD, "-v", "debug", "view", "--no-launch"] + list(args)
     )
@@ -29,8 +32,8 @@ def pretext_view(*args):
         process.wait()
 
 
-def test_entry_points(script_runner):
-    ret = script_runner.run(PTX_CMD, "-v", "debug", "-h")
+def test_entry_points(script_runner: ScriptRunner) -> None:
+    ret = script_runner.run([PTX_CMD, "-v", "debug", "-h"])
     assert ret.success
     assert (
         subprocess.run(
@@ -40,33 +43,33 @@ def test_entry_points(script_runner):
     )
 
 
-def test_version(script_runner):
-    ret = script_runner.run(PTX_CMD, "-v", "debug", "--version")
+def test_version(script_runner: ScriptRunner) -> None:
+    ret = script_runner.run([PTX_CMD, "-v", "debug", "--version"])
     assert ret.stdout.strip() == pretext.VERSION
 
 
-def test_new(tmp_path: Path, script_runner):
-    assert script_runner.run(PTX_CMD, "-v", "debug", "new", cwd=tmp_path).success
+def test_new(tmp_path: Path, script_runner: ScriptRunner) -> None:
+    assert script_runner.run([PTX_CMD, "-v", "debug", "new"], cwd=tmp_path).success
     assert (tmp_path / "new-pretext-project" / "project.ptx").exists()
 
 
-def test_devscript(script_runner):
+def test_devscript(script_runner: ScriptRunner) -> None:
     """
     Test that `pretext devscript -h` aliases `python /path/to/.ptx/pretext/pretext -h`.
     """
-    result = script_runner.run(PTX_CMD, "devscript", "-h")
+    result = script_runner.run([PTX_CMD, "devscript", "-h"])
     assert result.success
     assert "PreTeXt utility script" in result.stdout
 
 
-def test_build(tmp_path: Path, script_runner):
+def test_build(tmp_path: Path, script_runner: ScriptRunner) -> None:
     path_with_spaces = "test path with spaces"
     project_path = tmp_path / path_with_spaces
     assert script_runner.run(
-        PTX_CMD, "-v", "debug", "new", "demo", "-d", path_with_spaces, cwd=tmp_path
+        [PTX_CMD, "-v", "debug", "new", "demo", "-d", path_with_spaces], cwd=tmp_path
     ).success
     assert script_runner.run(
-        PTX_CMD, "-v", "debug", "build", "web", cwd=project_path
+        [PTX_CMD, "-v", "debug", "build", "web"], cwd=project_path
     ).success
     web_path = project_path / "output" / "web"
     assert web_path.exists()
@@ -92,74 +95,72 @@ def test_build(tmp_path: Path, script_runner):
         f"{source_prefix}backmatter.ptx": ["backmatter"],
     }
     assert script_runner.run(
-        PTX_CMD,
-        "-v",
-        "debug",
-        "build",
-        "subset",
-        "-x",
-        "ch-first-without-spaces",
+        [PTX_CMD, "-v", "debug", "build", "subset", "-x", "ch-first-without-spaces"],
         cwd=project_path,
     ).success
     assert (project_path / "output" / "subset").exists()
     assert not (project_path / "output" / "subset" / "ch-empty.html").exists()
     assert (
         project_path / "output" / "subset" / "ch-first-without-spaces.html"
     ).exists()
-    assert script_runner.run(PTX_CMD, "build", "print-latex", cwd=project_path).success
+    assert script_runner.run(
+        [PTX_CMD, "build", "print-latex"], cwd=project_path
+    ).success
     assert (project_path / "output" / "print-latex").exists()
     assert script_runner.run(
-        PTX_CMD, "-v", "debug", "build", "-g", cwd=project_path
+        [PTX_CMD, "-v", "debug", "build", "-g"], cwd=project_path
     ).success
     assert (project_path / "generated-assets").exists()
     shutil.rmtree(project_path / "generated-assets")
     assert script_runner.run(
-        PTX_CMD, "-v", "debug", "build", "-g", "webwork", cwd=project_path
+        [PTX_CMD, "-v", "debug", "build", "-g", "webwork"], cwd=project_path
     ).success
     assert (project_path / "generated-assets").exists()
 
 
-def test_init(tmp_path: Path, script_runner):
-    assert script_runner.run(PTX_CMD, "-v", "debug", "init", cwd=tmp_path).success
+def test_init(tmp_path: Path, script_runner: ScriptRunner) -> None:
+    assert script_runner.run([PTX_CMD, "-v", "debug", "init"], cwd=tmp_path).success
     assert (tmp_path / "project.ptx").exists()
     assert (tmp_path / "requirements.txt").exists()
     assert (tmp_path / ".gitignore").exists()
     assert (tmp_path / "publication" / "publication.ptx").exists()
     assert len([*tmp_path.glob("project-*.ptx")]) == 0  # need to refresh
-    assert script_runner.run(PTX_CMD, "-v", "debug", "init", "-r", cwd=tmp_path).success
+    assert script_runner.run(
+        [PTX_CMD, "-v", "debug", "init", "-r"], cwd=tmp_path
+    ).success
     assert len([*tmp_path.glob("project-*.ptx")]) > 0
     assert len([*tmp_path.glob("requirements-*.txt")]) > 0
     assert len([*tmp_path.glob(".gitignore-*")]) > 0
     assert len([*tmp_path.glob("publication/publication-*.ptx")]) > 0
 
 
-def test_generate_asymptote(tmp_path: Path, script_runner):
-    assert script_runner.run(PTX_CMD, "-v", "debug", "init", cwd=tmp_path).success
+def test_generate_asymptote(tmp_path: Path, script_runner: ScriptRunner) -> None:
+    assert script_runner.run([PTX_CMD, "-v", "debug", "init"], cwd=tmp_path).success
     (tmp_path / "source").mkdir()
     shutil.copyfile(EXAMPLES_DIR / "asymptote.ptx", tmp_path / "source" / "main.ptx")
     assert script_runner.run(
-        PTX_CMD, "-v", "debug", "generate", "asymptote", cwd=tmp_path
+        [PTX_CMD, "-v", "debug", "generate", "asymptote"], cwd=tmp_path
     ).success
     assert (tmp_path / "generated-assets" / "asymptote" / "test.html").exists()
     os.remove(tmp_path / "generated-assets" / "asymptote" / "test.html")
     assert script_runner.run(
-        PTX_CMD, "-v", "debug", "generate", "-x", "test", cwd=tmp_path
+        [PTX_CMD, "-v", "debug", "generate", "-x", "test"], cwd=tmp_path
     ).success
     assert (tmp_path / "generated-assets" / "asymptote" / "test.html").exists()
     os.remove(tmp_path / "generated-assets" / "asymptote" / "test.html")
     assert script_runner.run(
-        PTX_CMD, "-v", "debug", "generate", "asymptote", "-t", "web", cwd=tmp_path
+        [PTX_CMD, "-v", "debug", "generate", "asymptote", "-t", "web"], cwd=tmp_path
     ).success
     os.remove(tmp_path / "generated-assets" / "asymptote" / "test.html")
 
 
 # @pytest.mark.skip(
 #     reason="Waiting on upstream changes to interactive preview generation"
 # )
-def test_generate_interactive(tmp_path: Path, script_runner):
+def test_generate_interactive(tmp_path: Path, script_runner: ScriptRunner) -> None:
     int_path = tmp_path / "interactive"
     shutil.copytree(EXAMPLES_DIR / "projects" / "interactive", int_path)
-    assert script_runner.run(PTX_CMD, "-v", "debug", "generate", cwd=int_path).success
+    assert script_runner.run([PTX_CMD, "-v", "debug", "generate"], cwd=int_path).success
     preview_file = (
         int_path / "generated-assets" / "preview" / "interactive-infinity-preview.png"
     )
@@ -168,49 +169,49 @@ def test_generate_interactive(tmp_path: Path, script_runner):
     assert qrcode_file.exists()
 
 
-def test_view(tmp_path: Path, script_runner):
+def test_view(tmp_path: Path, script_runner: ScriptRunner) -> None:
     os.chdir(tmp_path)
     port = random.randint(10_000, 65_536)
     with pretext_view("-d", ".", "-p", f"{port}"):
         assert requests.get(f"http://localhost:{port}/").status_code == 200
-    assert script_runner.run(PTX_CMD, "-v", "debug", "new", "-d", "1").success
+    assert script_runner.run([PTX_CMD, "-v", "debug", "new", "-d", "1"]).success
     os.chdir(Path("1"))
-    assert script_runner.run(PTX_CMD, "-v", "debug", "build").success
+    assert script_runner.run([PTX_CMD, "-v", "debug", "build"]).success
     port = random.randint(10_000, 65_536)
     with pretext_view("-p", f"{port}"):
         assert requests.get(f"http://localhost:{port}/").status_code == 200
     os.chdir(tmp_path)
-    assert script_runner.run(PTX_CMD, "-v", "debug", "new", "-d", "2").success
+    assert script_runner.run([PTX_CMD, "-v", "debug", "new", "-d", "2"]).success
     os.chdir(Path("2"))
     port = random.randint(10_000, 65_536)
     with pretext_view("-p", f"{port}", "-b", "-g"):
         assert requests.get(f"http://localhost:{port}/").status_code == 200
 
 
-def test_custom_xsl(tmp_path: Path, script_runner):
+def test_custom_xsl(tmp_path: Path, script_runner: ScriptRunner) -> None:
     custom_path = tmp_path / "custom"
     shutil.copytree(EXAMPLES_DIR / "projects" / "custom-xsl", custom_path)
-    assert script_runner.run(PTX_CMD, "-v", "debug", "build", cwd=custom_path).success
+    assert script_runner.run([PTX_CMD, "-v", "debug", "build"], cwd=custom_path).success
     assert (custom_path / "output" / "test").exists()
 
 
-def test_custom_webwork_server(tmp_path: Path, script_runner):
+def test_custom_webwork_server(tmp_path: Path, script_runner: ScriptRunner) -> None:
     custom_path = tmp_path / "custom"
     shutil.copytree(EXAMPLES_DIR / "projects" / "custom-wwserver", custom_path)
     result = script_runner.run(
-        PTX_CMD, "-v", "debug", "generate", "webwork", cwd=custom_path
+        [PTX_CMD, "-v", "debug", "generate", "webwork"], cwd=custom_path
     )
     assert result.success
     assert "webwork-dev" in result.stderr
-    result = script_runner.run(PTX_CMD, "-v", "debug", "build", cwd=custom_path)
+    result = script_runner.run([PTX_CMD, "-v", "debug", "build"], cwd=custom_path)
     assert result.success
 
 
-def test_slideshow(tmp_path: Path, script_runner):
+def test_slideshow(tmp_path: Path, script_runner: ScriptRunner) -> None:
     assert script_runner.run(
-        PTX_CMD, "-v", "debug", "new", "slideshow", "-d", ".", cwd=tmp_path
+        [PTX_CMD, "-v", "debug", "new", "slideshow", "-d", "."], cwd=tmp_path
     ).success
     assert script_runner.run(
-        PTX_CMD, "-v", "debug", "build", "web", cwd=tmp_path
+        [PTX_CMD, "-v", "debug", "build", "web"], cwd=tmp_path
     ).success
     assert (tmp_path / "output" / "web" / "slides.html").exists()

tests/test_utils.py

@@ -3,7 +3,7 @@
 from pretext import utils
 
 
-def test_working_directory(tmp_path: Path):
+def test_working_directory(tmp_path: Path) -> None:
     os.chdir(tmp_path)
     subdir = Path("foobar")
     subdir.mkdir()
@@ -13,19 +13,19 @@ def test_working_directory(tmp_path: Path):
     # TODO check path returns afterward
 
 
-def test_project_path(tmp_path: Path):
+def test_project_path(tmp_path: Path) -> None:
     os.chdir(tmp_path)
     Path("project.ptx").write_text("")
     assert Path("project.ptx").exists()
-    assert utils.project_path().resolve() == tmp_path.resolve()
+    assert utils.project_path_found().resolve() == tmp_path.resolve()
     subdir = Path("foobar")
     print(subdir.resolve())
     subdir.mkdir()
     os.chdir(subdir)
-    assert utils.project_path().resolve() == Path().resolve().parent
+    assert utils.project_path_found().resolve() == Path().resolve().parent
 
 
-def test_parse_git_remote():
+def test_parse_git_remote() -> None:
     valids = [
         "git@github.com:PreTeXtBook/pretext-cli.git",
         "https://github.com/PreTeXtBook/pretext-cli.git",