Skip to content

🐛 FIX: cli.parse: return 0 for non-error #53 #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

🐛 FIX: cli.parse: return 0 for non-error #53 #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4905dd5
🐛 FIX: cli.parse: return 0 for non-error #53
westurner Oct 1, 2020
1d71c4c
🧪 TEST: fix and add a CLI returncode test
westurner Oct 1, 2020
5434e30
TEST: tests/test_cli.py: check SysyemExit exc_info return code
westurner Oct 24, 2020
953f0f0
Merge branch 'master' into BUG_fix_cli_returncode
chrisjsewell Oct 31, 2020
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion markdown_it/cli/parse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ def main(args=None):
convert(namespace.filenames)
else:
interactive()
return True
RET_OK = 0
return RET_OK


def convert(filenames):
Expand Down
10 changes: 9 additions & 1 deletion tests/test_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,22 @@
import tempfile
from unittest.mock import patch

import pytest

from markdown_it.cli import parse


def test_parse():
with tempfile.TemporaryDirectory() as tempdir:
path = pathlib.Path(tempdir).joinpath("test.md")
path.write_text("a b c")
assert parse.main([str(path)])
assert parse.main([str(path)]) == 0


def test_parse_fail():
with pytest.raises(SystemExit) as exc_info:
parse.main(["/tmp/nonexistant_path/for_cli_test.md"])
assert exc_info.value.code == 1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One way to fix the test failure is:

Suggested change
assert exc_info.value.code == 1
assert isinstance(exc_info.value.code, str)

Another way, that I personally would prefer but don't know if @chrisjsewell would, is go to markdown_it.cli.parse.convert_file and replace

sys.exit('Cannot open file "{}".'.format(filename))

with

sys.stderr.write('Cannot open file "{}".\n'.format(filename)) sys.exit(1)


def test_print_heading():
Expand Down