summaryrefslogtreecommitdiff
path: root/tests/test_ext_coverage.py
diff options
context:
space:
mode:
Diffstat (limited to 'tests/test_ext_coverage.py')
-rw-r--r--tests/test_ext_coverage.py48
1 files changed, 48 insertions, 0 deletions
diff --git a/tests/test_ext_coverage.py b/tests/test_ext_coverage.py
new file mode 100644
index 00000000..e59d42bc
--- /dev/null
+++ b/tests/test_ext_coverage.py
@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+"""
+ test_coverage
+ ~~~~~~~~~~~~~
+
+ Test the coverage builder.
+
+ :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
+ :license: BSD, see LICENSE for details.
+"""
+
+import pickle
+
+from util import with_app
+
+
+@with_app(buildername='coverage')
+def test_build(app, status, warning):
+ app.builder.build_all()
+
+ py_undoc = (app.outdir / 'python.txt').text()
+ assert py_undoc.startswith('Undocumented Python objects\n'
+ '===========================\n')
+ assert 'test_autodoc\n------------\n' in py_undoc
+ assert ' * Class -- missing methods:\n' in py_undoc
+ assert ' * process_docstring\n' in py_undoc
+ assert ' * function\n' not in py_undoc # these two are documented
+ assert ' * Class\n' not in py_undoc # in autodoc.txt
+
+ assert ' * mod -- No module named mod' # in the "failed import" section
+
+ c_undoc = (app.outdir / 'c.txt').text()
+ assert c_undoc.startswith('Undocumented C API elements\n'
+ '===========================\n')
+ assert 'api.h' in c_undoc
+ assert ' * Py_SphinxTest' in c_undoc
+
+ undoc_py, undoc_c = pickle.loads((app.outdir / 'undoc.pickle').bytes())
+ assert len(undoc_c) == 1
+ # the key is the full path to the header file, which isn't testable
+ assert list(undoc_c.values())[0] == set([('function', 'Py_SphinxTest')])
+
+ assert 'test_autodoc' in undoc_py
+ assert 'funcs' in undoc_py['test_autodoc']
+ assert 'process_docstring' in undoc_py['test_autodoc']['funcs']
+ assert 'classes' in undoc_py['test_autodoc']
+ assert 'Class' in undoc_py['test_autodoc']['classes']
+ assert 'undocmeth' in undoc_py['test_autodoc']['classes']['Class']