tests: Add tests for new coverage functionality

We migrate the code we're measuring coverage for to a package so we can
validate the new module coverage functionality.

Signed-off-by: Stephen Finucane <[email protected]>

Author: stephenfin

tests/roots/test-ext-coverage/conf.py

@@ -5,8 +5,11 @@
 
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage']
 
+coverage_modules = [
+    'mypackage',
+]
 coverage_ignore_pyobjects = [
-    r'^coverage_ignored(\..*)?$',
+    r'^mypackage\.coverage_ignored(\..*)?$',
     r'\.Ignored$',
     r'\.Documented\.ignored\d$',
 ]

tests/roots/test-ext-coverage/index.rst

@@ -1,6 +1,6 @@
-.. automodule:: coverage_ignored
+.. automodule:: mypackage.coverage_ignored
    :members:
 
 
-.. automodule:: coverage_not_ignored
+.. automodule:: mypackage.coverage_not_ignored
    :members:

tests/roots/test-ext-coverage/mypackage/__init__.py

@@ -0,0 +1,8 @@
+"""This module is intentionally not documented."""
+
+class Missing:
+    """An undocumented class."""
+
+    def missing_a(self):
+        """An undocumented method."""
+        pass

tests/roots/test-ext-coverage/coverage_ignored.py renamed to tests/roots/test-ext-coverage/mypackage/coverage_ignored.py

@@ -10,8 +10,10 @@ def test_build(app, status, warning):
     app.builder.build_all()
 
     py_undoc = (app.outdir / 'python.txt').read_text(encoding='utf8')
-    assert py_undoc.startswith('Undocumented Python objects\n'
-                               '===========================\n')
+    assert py_undoc.startswith(
+        'Undocumented Python objects\n'
+        '===========================\n'
+    )
     assert 'autodoc_target\n--------------\n' in py_undoc
     assert ' * Class -- missing methods:\n' in py_undoc
     assert ' * raises\n' in py_undoc
@@ -23,8 +25,10 @@ def test_build(app, status, warning):
     assert "undocumented  py" not in status.getvalue()
 
     c_undoc = (app.outdir / 'c.txt').read_text(encoding='utf8')
-    assert c_undoc.startswith('Undocumented C API elements\n'
-                              '===========================\n')
+    assert c_undoc.startswith(
+        'Undocumented C API elements\n'
+        '===========================\n'
+    )
     assert 'api.h' in c_undoc
     assert ' * Py_SphinxTest' in c_undoc
 
@@ -54,16 +58,26 @@ def test_coverage_ignore_pyobjects(app, status, warning):
 Statistics
 ----------
 
-+----------------------+----------+--------------+
-| Module               | Coverage | Undocumented |
-+======================+==========+==============+
-| coverage_not_ignored | 0.00%    | 2            |
-+----------------------+----------+--------------+
-| TOTAL                | 0.00%    | 2            |
-+----------------------+----------+--------------+
++--------------------------------+----------+--------------+
+| Module                         | Coverage | Undocumented |
++================================+==========+==============+
+| mypackage                      | 100.00%  | 0            |
++--------------------------------+----------+--------------+
+| mypackage.coverage_missing     | 100.00%  | 0            |
++--------------------------------+----------+--------------+
+| mypackage.coverage_not_ignored | 0.00%    | 2            |
++--------------------------------+----------+--------------+
+| TOTAL                          | 0.00%    | 2            |
++--------------------------------+----------+--------------+
+
+mypackage.coverage_missing
+--------------------------
 
-coverage_not_ignored
---------------------
+Classes:
+ * Missing
+
+mypackage.coverage_not_ignored
+------------------------------
 
 Classes:
  * Documented -- missing methods: