Add tests

Author: hukkin

.github/workflows/tests.yaml

@@ -51,7 +51,7 @@ jobs:
 
     - name: Test with pytest
       run: |
-        pytest --cov --cov-fail-under=100
+        pytest --cov
 
     - name: Report coverage
       if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.11'

pyproject.toml

@@ -71,7 +71,7 @@ description = run tests
 deps =
     -r tests/requirements.txt
 commands =
-    pytest {posargs}
+    pytest {posargs:--cov}
 
 [testenv:profile]
 description = run profiler (use e.g. `firefox .tox/prof/combined.svg` to open)
@@ -135,20 +135,7 @@ commands =
 
 [tool.coverage.run]
 source = ["mdformat"]
-omit = ["*/__main__.py"]
-
-[tool.coverage.report]
-# Regexes for lines to exclude from consideration
-exclude_lines = [
-    # Re-enable the standard pragma (with extra strictness)
-    '# pragma: no cover\b',
-    # Ellipsis lines after @typing.overload
-    '^ +\.\.\.$',
-    # Code for static type checkers
-    "if TYPE_CHECKING:",
-    # Scripts
-    'if __name__ == .__main__.:',
-]
+plugins = ["covdefaults"]
 
 
 [tool.mypy]

src/mdformat/_cli.py

@@ -21,7 +21,7 @@
 
 class RendererWarningPrinter(logging.Handler):
     def emit(self, record: logging.LogRecord) -> None:
-        if record.levelno >= logging.WARNING:
+        if record.levelno >= logging.WARNING:  # pragma: no branch
             sys.stderr.write(f"Warning: {record.msg}\n")
 
 
@@ -59,10 +59,10 @@ def run(cli_args: Sequence[str]) -> int:  # noqa: C901
             return 1
         opts: Mapping = {**DEFAULT_OPTS, **toml_opts, **cli_opts}
 
-        if sys.version_info >= (3, 13):  # pragma: no cover
+        if sys.version_info >= (3, 13):  # pragma: >=3.13 cover
             if is_excluded(path, opts["exclude"], toml_path, "exclude" in cli_opts):
                 continue
-        else:  # pragma: no cover
+        else:  # pragma: <3.13 cover
             if "exclude" in toml_opts:
                 print_error(
                     "'exclude' patterns are only available on Python 3.13+.",
@@ -172,7 +172,7 @@ def make_arg_parser(
         choices=("lf", "crlf", "keep"),
         help="output file line ending mode (default: lf)",
     )
-    if sys.version_info >= (3, 13):  # pragma: no cover
+    if sys.version_info >= (3, 13):  # pragma: >=3.13 cover
         parser.add_argument(
             "--exclude",
             action="append",
@@ -218,7 +218,7 @@ def resolve_file_paths(path_strings: Iterable[str]) -> list[None | Path]:
     return file_paths
 
 
-def is_excluded(
+def is_excluded(  # pragma: >=3.13 cover
     path: Path | None,
     patterns: list[str],
     toml_path: Path | None,

src/mdformat/_compat.py

@@ -2,12 +2,12 @@
 
 import sys
 
-if sys.version_info >= (3, 11):  # pragma: no cover
+if sys.version_info >= (3, 11):  # pragma: >=3.11 cover
     import tomllib
-else:  # pragma: no cover
+else:  # pragma: <3.11 cover
     import tomli as tomllib
 
-if sys.version_info >= (3, 10):  # pragma: no cover
+if sys.version_info >= (3, 10):  # pragma: >=3.10 cover
     from importlib import metadata as importlib_metadata
-else:  # pragma: no cover
+else:  # pragma: <3.10 cover
     import importlib_metadata

src/mdformat/_conf.py

@@ -59,7 +59,7 @@ def _validate_values(opts: Mapping, conf_path: Path) -> None:  # noqa: C901
     if "number" in opts:
         if not isinstance(opts["number"], bool):
             raise InvalidConfError(f"Invalid 'number' value in {conf_path}")
-    if "exclude" in opts:
+    if "exclude" in opts:  # pragma: >=3.13 cover
         if not isinstance(opts["exclude"], list):
             raise InvalidConfError(f"Invalid 'exclude' value in {conf_path}")
         for pattern in opts["exclude"]:

tests/requirements.txt

@@ -1,3 +1,4 @@
 pytest
 pytest-randomly
 pytest-cov
+covdefaults

tests/test_api.py

@@ -1,9 +1,11 @@
 import os
 
+from markdown_it import MarkdownIt
 import pytest
 
 import mdformat
 from mdformat._util import is_md_equal
+from mdformat.renderer import MDRenderer
 
 UNFORMATTED_MARKDOWN = "\n\n# A header\n\n"
 FORMATTED_MARKDOWN = "# A header\n"
@@ -127,3 +129,15 @@ def test_no_timestamp_modify(tmp_path):
     # Assert that modification time does not change when no changes are applied
     mdformat.file(file_path)
     assert os.path.getmtime(file_path) == initial_mod_time
+
+
+def test_mdrenderer_no_finalize(tmp_path):
+    mdit = MarkdownIt()
+    mdit.options["store_labels"] = True
+    env = {}
+    tokens = mdit.parse(
+        "[gl ref]: https://gitlab.com\n\nHere's a link to [GitLab][gl ref]", env
+    )
+    unfinalized = MDRenderer().render(tokens, {}, env, finalize=False)
+    finalized = MDRenderer().render(tokens, {}, env)
+    assert finalized == unfinalized + "\n\n[gl ref]: https://gitlab.com\n"

tests/test_cli.py

@@ -37,6 +37,13 @@ def test_format__folder(tmp_path):
     assert file_path_3.read_text() == UNFORMATTED_MARKDOWN
 
 
+def test_format__folder_leads_to_invalid(tmp_path):
+    file_path_1 = tmp_path / "test_markdown1.md"
+    file_path_1.mkdir()
+    assert run((str(tmp_path),)) == 0
+    assert file_path_1.is_dir()
+
+
 def test_format__symlinks(tmp_path):
     # Create two MD files
     file_path_1 = tmp_path / "test_markdown1.md"
@@ -62,6 +69,19 @@ def test_format__symlinks(tmp_path):
     assert symlink_2.is_symlink()
 
 
+def test_broken_symlink(tmp_path, capsys):
+    # Create a broken symlink
+    file_path = tmp_path / "test_markdown1.md"
+    symlink_path = tmp_path / "symlink"
+    symlink_path.symlink_to(file_path)
+
+    with pytest.raises(SystemExit) as exc_info:
+        run([str(symlink_path)])
+    assert exc_info.value.code == 2
+    captured = capsys.readouterr()
+    assert "does not exist" in captured.err
+
+
 def test_invalid_file(capsys):
     with pytest.raises(SystemExit) as exc_info:
         run(("this is not a valid filepath?`=|><@{[]\\/,.%¤#'",))
@@ -70,6 +90,15 @@ def test_invalid_file(capsys):
     assert "does not exist" in captured.err
 
 
+def test_fifo(tmp_path, capsys):
+    fifo_path = tmp_path / "fifo1"
+    os.mkfifo(fifo_path)
+    with pytest.raises(SystemExit) as exc_info:
+        run((str(fifo_path),))
+    assert exc_info.value.code == 2
+    assert "does not exist" in capsys.readouterr().err
+
+
 def test_check(tmp_path):
     file_path = tmp_path / "test_markdown.md"
     file_path.write_bytes(FORMATTED_MARKDOWN.encode())

tests/test_config_file.py

@@ -6,11 +6,12 @@
 
 from mdformat._cli import run
 from mdformat._conf import read_toml_opts
+from tests.test_cli import FORMATTED_MARKDOWN, UNFORMATTED_MARKDOWN
 
 
 def test_cli_override(tmp_path):
     config_path = tmp_path / ".mdformat.toml"
-    config_path.write_text("wrap = 'no'")
+    config_path.write_text("wrap = 'no'\nend_of_line = 'lf'")
 
     file_path = tmp_path / "test_markdown.md"
     file_path.write_text("remove\nthis\nwrap\n")
@@ -65,9 +66,13 @@ def test_invalid_toml(tmp_path, capsys):
         ("wrap", "wrap = -3"),
         ("end_of_line", "end_of_line = 'lol'"),
         ("number", "number = 0"),
+        ("exclude", "exclude = '**'"),
+        ("exclude", "exclude = ['1',3]"),
     ],
 )
 def test_invalid_conf_value(bad_conf, conf_key, tmp_path, capsys):
+    if conf_key == "exclude" and sys.version_info < (3, 13):
+        pytest.skip("exclude conf only on Python 3.13+")
     config_path = tmp_path / ".mdformat.toml"
     config_path.write_text(bad_conf)
 
@@ -91,3 +96,53 @@ def test_conf_with_stdin(tmp_path, capfd, monkeypatch):
         assert run(("-",)) == 0
     captured = capfd.readouterr()
     assert captured.out == "1. one\n2. two\n3. three\n"
+
+
+@pytest.mark.skipif(
+    sys.version_info >= (3, 13), reason="'exclude' only possible on 3.13+"
+)
+def test_exclude_conf_on_old_python(tmp_path, capsys):
+    config_path = tmp_path / ".mdformat.toml"
+    config_path.write_text("exclude = ['**']")
+
+    file_path = tmp_path / "test_markdown.md"
+    file_path.write_text("# Test Markdown")
+
+    assert run((str(file_path),)) == 1
+    assert "only available on Python 3.13+" in capsys.readouterr().err
+
+
+@pytest.mark.skipif(
+    sys.version_info < (3, 13), reason="'exclude' only possible on 3.13+"
+)
+def test_exclude(tmp_path, capsys):
+    config_path = tmp_path / ".mdformat.toml"
+    config_path.write_text("exclude = ['dir1/*', 'file1.md']")
+
+    dir1_path = tmp_path / "dir1"
+    file1_path = tmp_path / "file1.md"
+    file2_path = tmp_path / "file2.md"
+    file3_path = tmp_path / dir1_path / "file3.md"
+    dir1_path.mkdir()
+    file1_path.write_text(UNFORMATTED_MARKDOWN)
+    file2_path.write_text(UNFORMATTED_MARKDOWN)
+    file3_path.write_text(UNFORMATTED_MARKDOWN)
+
+    assert run((str(tmp_path),)) == 0
+    assert file1_path.read_text() == UNFORMATTED_MARKDOWN
+    assert file2_path.read_text() == FORMATTED_MARKDOWN
+    assert file3_path.read_text() == UNFORMATTED_MARKDOWN
+
+
+@pytest.mark.skipif(
+    sys.version_info < (3, 13), reason="'exclude' only possible on 3.13+"
+)
+def test_empty_exclude(tmp_path, capsys):
+    config_path = tmp_path / ".mdformat.toml"
+    config_path.write_text("exclude = []")
+
+    file1_path = tmp_path / "file1.md"
+    file1_path.write_text(UNFORMATTED_MARKDOWN)
+
+    assert run((str(tmp_path),)) == 0
+    assert file1_path.read_text() == FORMATTED_MARKDOWN

tests/test_plugins.py

@@ -103,7 +103,7 @@ def test_table(monkeypatch):
     other text
     """
         ),
-        extensions=["table"],
+        extensions=["table", "table"],
     )
     assert text == dedent(
         """\
@@ -195,7 +195,7 @@ def format_json(unformatted: str, _info_str: str) -> str:
         return json.dumps(parsed, indent=2) + "\n"
 
 
-def test_code_format_warnings(monkeypatch, tmp_path, capsys):
+def test_code_format_warnings__cli(monkeypatch, tmp_path, capsys):
     monkeypatch.setitem(CODEFORMATTERS, "json", JSONFormatterPlugin.format_json)
     file_path = tmp_path / "test_markdown.md"
     file_path.write_text("```json\nthis is invalid json\n```\n")
@@ -207,6 +207,18 @@ def test_code_format_warnings(monkeypatch, tmp_path, capsys):
     )
 
 
+def test_code_format_warnings__api(monkeypatch, caplog):
+    monkeypatch.setitem(CODEFORMATTERS, "json", JSONFormatterPlugin.format_json)
+    assert (
+        mdformat.text("```json\nthis is invalid json\n```\n", codeformatters=("json",))
+        == "```json\nthis is invalid json\n```\n"
+    )
+    assert (
+        caplog.messages[0]
+        == "Failed formatting content of a json code block (line 1 before formatting)"
+    )
+
+
 def test_plugin_conflict(monkeypatch, tmp_path, capsys):
     """Test a warning when plugins try to render same syntax."""
     plugin_name_1 = "plug1"