summaryrefslogtreecommitdiffstats
path: root/tests/test_ext_todo.py
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 17:25:40 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 17:25:40 +0000
commitcf7da1843c45a4c2df7a749f7886a2d2ba0ee92a (patch)
tree18dcde1a8d1f5570a77cd0c361de3b490d02c789 /tests/test_ext_todo.py
parentInitial commit. (diff)
downloadsphinx-cf7da1843c45a4c2df7a749f7886a2d2ba0ee92a.tar.xz
sphinx-cf7da1843c45a4c2df7a749f7886a2d2ba0ee92a.zip
Adding upstream version 7.2.6.upstream/7.2.6
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'tests/test_ext_todo.py')
-rw-r--r--tests/test_ext_todo.py109
1 files changed, 109 insertions, 0 deletions
diff --git a/tests/test_ext_todo.py b/tests/test_ext_todo.py
new file mode 100644
index 0000000..7d39495
--- /dev/null
+++ b/tests/test_ext_todo.py
@@ -0,0 +1,109 @@
+"""Test sphinx.ext.todo extension."""
+
+import re
+
+import pytest
+
+
+@pytest.mark.sphinx('html', testroot='ext-todo', freshenv=True,
+ confoverrides={'todo_include_todos': True, 'todo_emit_warnings': True})
+def test_todo(app, status, warning):
+ todos = []
+
+ def on_todo_defined(app, node):
+ todos.append(node)
+
+ app.connect('todo-defined', on_todo_defined)
+ app.builder.build_all()
+
+ # check todolist
+ content = (app.outdir / 'index.html').read_text(encoding='utf8')
+ assert ('<p class="admonition-title">Todo</p>\n'
+ '<p>todo in foo</p>') in content
+
+ assert ('<p class="admonition-title">Todo</p>\n'
+ '<p>todo in bar</p>') in content
+
+ # check todo
+ content = (app.outdir / 'foo.html').read_text(encoding='utf8')
+ assert ('<p class="admonition-title">Todo</p>\n'
+ '<p>todo in foo</p>') in content
+
+ assert ('<p class="admonition-title">Todo</p>\n'
+ '<p>todo in param field</p>') in content
+
+ # check emitted warnings
+ assert 'WARNING: TODO entry found: todo in foo' in warning.getvalue()
+ assert 'WARNING: TODO entry found: todo in bar' in warning.getvalue()
+
+ # check handled event
+ assert len(todos) == 3
+ assert {todo[1].astext() for todo in todos} == {'todo in foo',
+ 'todo in bar',
+ 'todo in param field'}
+
+
+@pytest.mark.sphinx('html', testroot='ext-todo', freshenv=True,
+ confoverrides={'todo_include_todos': False, 'todo_emit_warnings': True})
+def test_todo_not_included(app, status, warning):
+ todos = []
+
+ def on_todo_defined(app, node):
+ todos.append(node)
+
+ app.connect('todo-defined', on_todo_defined)
+ app.builder.build_all()
+
+ # check todolist
+ content = (app.outdir / 'index.html').read_text(encoding='utf8')
+ assert ('<p class="admonition-title">Todo</p>\n'
+ '<p>todo in foo</p>') not in content
+
+ assert ('<p class="admonition-title">Todo</p>\n'
+ '<p>todo in bar</p>') not in content
+
+ # check todo
+ content = (app.outdir / 'foo.html').read_text(encoding='utf8')
+ assert ('<p class="admonition-title">Todo</p>\n'
+ '<p>todo in foo</p>') not in content
+
+ # check emitted warnings
+ assert 'WARNING: TODO entry found: todo in foo' in warning.getvalue()
+ assert 'WARNING: TODO entry found: todo in bar' in warning.getvalue()
+
+ # check handled event
+ assert len(todos) == 3
+ assert {todo[1].astext() for todo in todos} == {'todo in foo',
+ 'todo in bar',
+ 'todo in param field'}
+
+
+@pytest.mark.sphinx('latex', testroot='ext-todo', freshenv=True,
+ confoverrides={'todo_include_todos': True})
+def test_todo_valid_link(app, status, warning):
+ """
+ Test that the inserted "original entry" links for todo items have a target
+ that exists in the LaTeX output. The target was previously incorrectly
+ omitted (GitHub issue #1020).
+ """
+
+ # Ensure the LaTeX output is built.
+ app.builder.build_all()
+
+ content = (app.outdir / 'python.tex').read_text(encoding='utf8')
+
+ # Look for the link to foo. Note that there are two of them because the
+ # source document uses todolist twice. We could equally well look for links
+ # to bar.
+ link = (r'{\\hyperref\[\\detokenize{(.*?foo.*?)}]{\\sphinxcrossref{'
+ r'\\sphinxstyleemphasis{original entry}}}}')
+ m = re.findall(link, content)
+ assert len(m) == 4
+ target = m[0]
+
+ # Look for the targets of this link.
+ labels = re.findall(r'\\label{\\detokenize{([^}]*)}}', content)
+ matched = [l for l in labels if l == target]
+
+ # If everything is correct we should have exactly one target.
+ assert len(matched) == 1