def test_plugin_versions_in_cli_help(monkeypatch, capsys):
monkeypatch.setitem(PARSER_EXTENSIONS, "table", ExampleTablePlugin)
with pytest.raises(SystemExit) as exc_info:
run(["--help"])
assert exc_info.value.code == 0
captured = capsys.readouterr()
assert "Installed plugins:" in captured.out
assert "tests: unknown" in captured.out
def test_wrap(tmp_path):
file_path = tmp_path / "test_markdown.md"
file_path.write_text(
"This\n"
"text\n"
"should\n"
"be wrapped again so that wrap width is whatever is defined below. "
"Also whitespace should\t\tbe collapsed. "
"Next up a second paragraph:\n"
"\n"
"This paragraph should also be wrapped. "
"Here's some more text to wrap. "
"Here's some more text to wrap. "
"Here's some more text to wrap. "
)
assert run([str(file_path), "--wrap=60"]) == 0
assert (
file_path.read_text()
== "This text should be wrapped again so that wrap width is\n"
"whatever is defined below. Also whitespace should be\n"
"collapsed. Next up a second paragraph:\n"
"\n"
"This paragraph should also be wrapped. Here's some more text\n"
"to wrap. Here's some more text to wrap. Here's some more\n"
"text to wrap.\n"
)
def test_ast_changing_plugin(monkeypatch, tmp_path):
plugin = ExampleASTChangingPlugin()
monkeypatch.setitem(PARSER_EXTENSIONS, "ast_changer", plugin)
file_path = tmp_path / "test_markdown.md"
# Test that the AST changing formatting is applied successfully
# under normal operation.
file_path.write_text("Some markdown here\n")
assert run((str(file_path), )) == 0
assert file_path.read_text() == plugin.TEXT_REPLACEMENT + "\n"
# Set the plugin's `CHANGES_AST` flag to False and test that the
# equality check triggers, notices the AST breaking changes and a
# non-zero error code is returned.
plugin.CHANGES_AST = False
file_path.write_text("Some markdown here\n")
assert run((str(file_path), )) == 1
assert file_path.read_text() == "Some markdown here\n"
def test_code_format_warnings(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")
assert run([str(file_path)]) == 0
captured = capsys.readouterr()
assert (
captured.err
== "Warning: Failed formatting content of a json code block (line 1 before formatting)\n" # noqa: E501
)
def test_format__folder(tmp_path):
file_path_1 = tmp_path / "test_markdown1.md"
file_path_2 = tmp_path / "test_markdown2.md"
file_path_3 = tmp_path / "not_markdown3"
file_path_1.write_text(UNFORMATTED_MARKDOWN)
file_path_2.write_text(UNFORMATTED_MARKDOWN)
file_path_3.write_text(UNFORMATTED_MARKDOWN)
assert run((str(tmp_path),)) == 0
assert file_path_1.read_text() == FORMATTED_MARKDOWN
assert file_path_2.read_text() == FORMATTED_MARKDOWN
assert file_path_3.read_text() == UNFORMATTED_MARKDOWN
def test_consecutive_wrap_width_lines(tmp_path):
"""Test a case where two consecutive lines' width equals wrap width.
There was a bug where this would cause an extra newline and split
the paragraph, hence the test.
"""
wrap_width = 20
file_path = tmp_path / "test_markdown.md"
text = "A" * wrap_width + "\n" + "A" * wrap_width + "\n"
file_path.write_text(text)
assert run([str(file_path), f"--wrap={wrap_width}"]) == 0
assert file_path.read_text() == text
def test_check__multi_fail(capsys, tmp_path):
"""Test for --check flag when multiple files are unformatted.
Test that the names of all unformatted files are listed when using
--check.
"""
file_path1 = tmp_path / "test_markdown1.md"
file_path2 = tmp_path / "test_markdown2.md"
file_path1.write_text(UNFORMATTED_MARKDOWN)
file_path2.write_text(UNFORMATTED_MARKDOWN)
assert run((str(tmp_path), "--check")) == 1
captured = capsys.readouterr()
assert str(file_path1) in captured.err
assert str(file_path2) in captured.err
def test_cli_options(monkeypatch, tmp_path):
"""Test that CLI arguments added by plugins are correctly added to the
options dict."""
monkeypatch.setitem(PARSER_EXTENSIONS, "table", ExamplePluginWithCli)
file_path = tmp_path / "test_markdown.md"
file_path.touch()
with patch.object(MDRenderer, "render", return_value="") as mock_render:
assert run((str(file_path), "--o1", "other", "--o3", "4")) == 0
(call_, ) = mock_render.call_args_list
posargs = call_[0]
# Options is the second positional arg of MDRender.render
opts = posargs[1]
assert opts["mdformat"]["o1"] == "other"
assert opts["mdformat"]["o2"] == "a"
assert opts["mdformat"]["arg_name"] == 4
def test_no_wrap(tmp_path):
file_path = tmp_path / "test_markdown.md"
file_path.write_text("all\n"
"these newlines\n"
"except the one in this hardbreak \n"
"should be\n"
"removed because they are\n"
"in the same paragraph\n"
"\n"
"This however is the next\n"
"paragraph. Whitespace should be collapsed\n"
" \t here\n")
assert run([str(file_path), "--wrap=no"]) == 0
assert (
file_path.read_text() ==
"all these newlines except the one in this hardbreak\\\n"
"should be removed because they are in the same paragraph\n"
"\n"
"This however is the next paragraph. Whitespace should be collapsed here\n"
)
def test_format__symlinks(tmp_path):
# Create two MD files
file_path_1 = tmp_path / "test_markdown1.md"
file_path_2 = tmp_path / "test_markdown2.md"
file_path_1.write_text(UNFORMATTED_MARKDOWN)
file_path_2.write_text(UNFORMATTED_MARKDOWN)
# Create a symlink to both files: one in the root folder, one in a sub folder
subdir_path = tmp_path / "subdir"
subdir_path.mkdir()
symlink_1 = subdir_path / "symlink1.md"
symlink_1.symlink_to(file_path_1)
symlink_2 = tmp_path / "symlink2.md"
symlink_2.symlink_to(file_path_2)
# Format file 1 via directory of the symlink, and file 2 via symlink
assert run([str(subdir_path), str(symlink_2)]) == 0
# Assert that files are formatted and symlinks are not overwritten
assert file_path_1.read_text() == FORMATTED_MARKDOWN
assert file_path_2.read_text() == FORMATTED_MARKDOWN
assert symlink_1.is_symlink()
assert symlink_2.is_symlink()
def test_check__fail(tmp_path):
file_path = tmp_path / "test_markdown.md"
file_path.write_text(UNFORMATTED_MARKDOWN)
assert run((str(file_path), "--check")) == 1
def test_invalid_file(capsys):
with pytest.raises(SystemExit) as exc_info:
run(("this is not a valid filepath?`=|><@{[]\\/,.%¤#'",))
assert exc_info.value.code == 2
captured = capsys.readouterr()
assert "does not exist" in captured.err
def test_format(tmp_path):
file_path = tmp_path / "test_markdown.md"
file_path.write_text(UNFORMATTED_MARKDOWN)
assert run((str(file_path),)) == 0
assert file_path.read_text() == FORMATTED_MARKDOWN
def test_version(capsys):
with pytest.raises(SystemExit) as exc_info:
run(["--version"])
assert exc_info.value.code == 0
captured = capsys.readouterr()
assert captured.out == f"mdformat {mdformat.__version__}\n"
def test_for_profiler():
docs_path = PROJECT_ROOT / "docs"
readme_path = PROJECT_ROOT / "README.md"
assert run([str(docs_path), str(readme_path), "--check"]) == 0
def test_formatter_plugin(tmp_path, monkeypatch):
monkeypatch.setitem(CODEFORMATTERS, "lang", example_formatter)
file_path = tmp_path / "test_markdown.md"
file_path.write_text("```lang\nother\n```\n")
assert run((str(file_path),)) == 0
assert file_path.read_text() == "```lang\ndummy\n```\n"
def test_dash_stdin(capsys, monkeypatch):
monkeypatch.setattr(sys, "stdin", StringIO(UNFORMATTED_MARKDOWN))
assert run(("-",)) == 0
captured = capsys.readouterr()
assert captured.out == FORMATTED_MARKDOWN
def test_no_files_passed():
assert run(()) == 0
