anki/pylib/tests/test_latex.py
2021-04-13 18:45:35 +10:00

100 lines
3.5 KiB
Python

# Copyright: Ankitects Pty Ltd and contributors
# License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
# coding: utf-8
import os
import shutil
from anki.lang import without_unicode_isolation
from tests.shared import getEmptyCol
def test_latex():
col = getEmptyCol()
# change latex cmd to simulate broken build
import anki.latex
anki.latex.pngCommands[0][0] = "nolatex"
# add a note with latex
note = col.newNote()
note["Front"] = "[latex]hello[/latex]"
col.addNote(note)
# but since latex couldn't run, there's nothing there
assert len(os.listdir(col.media.dir())) == 0
# check the error message
msg = note.cards()[0].q()
assert "executing nolatex" in without_unicode_isolation(msg)
assert "installed" in msg
# check if we have latex installed, and abort test if we don't
if not shutil.which("latex") or not shutil.which("dvipng"):
print("aborting test; latex or dvipng is not installed")
return
# fix path
anki.latex.pngCommands[0][0] = "latex"
# check media db should cause latex to be generated
col.media.render_all_latex()
assert len(os.listdir(col.media.dir())) == 1
assert ".png" in note.cards()[0].q()
# adding new notes should cause generation on question display
note = col.newNote()
note["Front"] = "[latex]world[/latex]"
col.addNote(note)
note.cards()[0].q()
assert len(os.listdir(col.media.dir())) == 2
# another note with the same media should reuse
note = col.newNote()
note["Front"] = " [latex]world[/latex]"
col.addNote(note)
assert len(os.listdir(col.media.dir())) == 2
oldcard = note.cards()[0]
assert ".png" in oldcard.q()
# if we turn off building, then previous cards should work, but cards with
# missing media will show a broken image
anki.latex.build = False
note = col.newNote()
note["Front"] = "[latex]foo[/latex]"
col.addNote(note)
assert len(os.listdir(col.media.dir())) == 2
assert ".png" in oldcard.q()
# turn it on again so other test don't suffer
anki.latex.build = True
# bad commands
(result, msg) = _test_includes_bad_command("\\write18")
assert result, msg
(result, msg) = _test_includes_bad_command("\\readline")
assert result, msg
(result, msg) = _test_includes_bad_command("\\input")
assert result, msg
(result, msg) = _test_includes_bad_command("\\include")
assert result, msg
(result, msg) = _test_includes_bad_command("\\catcode")
assert result, msg
(result, msg) = _test_includes_bad_command("\\openout")
assert result, msg
(result, msg) = _test_includes_bad_command("\\write")
assert result, msg
(result, msg) = _test_includes_bad_command("\\loop")
assert result, msg
(result, msg) = _test_includes_bad_command("\\def")
assert result, msg
(result, msg) = _test_includes_bad_command("\\shipout")
assert result, msg
# inserting commands beginning with a bad name should not raise an error
(result, msg) = _test_includes_bad_command("\\defeq")
assert not result, msg
# normal commands should not either
(result, msg) = _test_includes_bad_command("\\emph")
assert not result, msg
def _test_includes_bad_command(bad):
col = getEmptyCol()
note = col.newNote()
note["Front"] = "[latex]%s[/latex]" % bad
col.addNote(note)
q = without_unicode_isolation(note.cards()[0].q())
return ("'%s' is not allowed on cards" % bad in q, "Card content: %s" % q)