def test_cite_command_render_stdout(args, filename):
"""
Test the stdout output of `manubot cite --render` with various formats.
The output is sensitive to the version of Pandoc used, so expected output
files include the pandoc version stamp in their filename.
When the expected version is missing, the test fails but writes the
command output to that file. Therefore, subsequent runs of the same test
will pass. Before committing the auto-generated output, do look to ensure
its integrity.
This test uses --bibliography to avoid slow network calls.
Regenerate the CSL JSON using:
```shell
manubot cite \
--output=manubot/cite/tests/cite-command-rendered/input-references.json \
arxiv:1806.05726v1 doi:10.7717/peerj.338 pmid:29618526
```
"""
# get pandoc version info
pandoc_version = get_pandoc_version()
pandoc_stamp = ".".join(map(str, pandoc_version))
path = data_dir.joinpath(filename.format(pandoc_stamp))
# skip test on old pandoc versions
for output in "markdown", "html", "jats":
if output in args and pandoc_version < (2, 5):
pytest.skip(f"Test {output} output assumes pandoc >= 2.5")
if pandoc_version < (2, 0):
pytest.skip("Test requires pandoc >= 2.0 to support --lua-filter and --csl=URL")
args = [
"manubot",
"cite",
"--bibliography=input-references.json",
"--render",
"--csl=https://github.com/greenelab/manubot-rootstock/raw/e83e51dcd89256403bb787c3d9a46e4ee8d04a9e/build/assets/style.csl",
"arxiv:1806.05726v1",
"doi:10.7717/peerj.338",
"pmid:29618526",
] + args
process = subprocess.run(
args,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
encoding="utf-8",
cwd=data_dir,
)
print(shlex_join(process.args))
if not path.exists():
# https://github.com/manubot/manubot/pull/146#discussion_r333132261
print(
f"Missing expected output at {path}\n"
"Writing output to file such that future tests will pass."
)
path.write_text(process.stdout, encoding="utf-8")
assert False
print(process.stdout)
print(process.stderr)
expected = path.read_text(encoding="utf-8-sig")
assert process.stdout == expected
def test_get_pandoc_version():
version = get_pandoc_version()
assert isinstance(version, tuple)
assert len(version) >= 2
for v in version:
assert isinstance(v, int)
def test_cite_command_file(tmpdir):
path = pathlib.Path(tmpdir) / "csl-items.json"
process = subprocess.run(
["manubot", "cite", "--output", str(path), "arxiv:1806.05726v1"],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
print(process.stderr.decode())
assert process.returncode == 0
with path.open() as read_file:
(csl,) = json.load(read_file)
assert csl["URL"] == "https://arxiv.org/abs/1806.05726v1"
pandoc_version = get_pandoc_version()
@pytest.mark.skipif(
not shutil.which("pandoc"), reason="pandoc installation not found on system"
)
@pytest.mark.skipif(
not shutil.which("pandoc-citeproc"),
reason="pandoc-citeproc installation not found on system",
)
class Base_cite_command_render_stdout:
"""
Expecting reference values for test to be at files on path:
cite-command-rendered/references-{format}-{pandoc_stamp}.{extension}
Examples: