# -*- coding: utf-8 -*- """ test_ext_todo ~~~~~~~~~~~~~ Test sphinx.ext.todo extension. :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ 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').text() html = ('
Todo
\n' 'todo in foo
') assert re.search(html, content, re.S) html = ('Todo
\n' 'todo in bar
') assert re.search(html, content, re.S) # check todo content = (app.outdir / 'foo.html').text() html = ('Todo
\n' 'todo in foo
') assert re.search(html, content, re.S) # 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) == 2 assert set(todo[1].astext() for todo in todos) == set(['todo in foo', 'todo in bar']) @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').text() html = ('Todo
\n' 'todo in foo
') assert not re.search(html, content, re.S) html = ('Todo
\n' 'todo in bar
') assert not re.search(html, content, re.S) # check todo content = (app.outdir / 'foo.html').text() html = ('Todo
\n' 'todo in foo
') assert not re.search(html, content, re.S) # 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) == 2 assert set(todo[1].astext() for todo in todos) == set(['todo in foo', 'todo in bar'])