Create extension tests (#6)

Author: felix-hilden

src/sphinx_codeautolink/__init__.py

@@ -10,11 +10,11 @@
 
 _version_file = _Path(_os.path.realpath(__file__)).parent / "VERSION"
 __version__ = _version_file.read_text().strip()
-state = SphinxCodeAutoLink()
 
 
 def setup(app: Sphinx):
     """Set up extension, directives and events."""
+    state = SphinxCodeAutoLink()
     app.add_css_file('sphinx-codeautolink.css')
     app.add_config_value('codeautolink_autodoc_inject', True, 'html', types=[bool])
 

src/sphinx_codeautolink/extension/__init__.py

@@ -70,8 +70,6 @@ def once_on_doctree_resolved(self, app):
 
         for transforms in self.cache.transforms.values():
             self.filter_and_resolve(transforms, app)
-
-        for transforms in self.cache.transforms.values():
             for transform in transforms:
                 for name in transform.names:
                     self.code_refs.setdefault(name.resolved_location, []).append(
@@ -179,7 +177,7 @@ def resolve_location(chain: Name) -> Optional[str]:
 def locate_type(components: Tuple[str]) -> Optional[str]:
     """Find type hint and resolve to new location."""
     value, index = closest_module(components)
-    if index is None or index == len(components) - 1:
+    if index is None or index == len(components):
         return
     remaining = components[index:]
     real_location = '.'.join(components[:index])
@@ -214,8 +212,12 @@ def fully_qualified_name(type_: type) -> str:
 def closest_module(components: Tuple[str]) -> Tuple[Any, Optional[int]]:
     """Find closest importable module."""
     mod = None
-    for i in range(len(components)):
+    for i in range(1, len(components) + 1):
         try:
-            mod = import_module('.'.join(components[:i + 1]))
+            mod = import_module('.'.join(components[:i]))
         except ImportError:
-            return mod, i
+            break
+    else:
+        return None, None
+
+    return mod, i - 1

src/sphinx_codeautolink/extension/block.py

@@ -42,7 +42,7 @@ def __init__(self, *args, source_dir: str, **kwargs):
         self.title_stack = []
         self.current_refid = None
         self.implicit_imports = []
-        self.concat_global = 'off'
+        self.concat_global = False
         self.concat_section = False
         self.concat_sources = []
         self.autolink_skip = None
@@ -60,7 +60,8 @@ def unknown_visit(self, node):
             if node.mode == 'section':
                 self.concat_section = True
             else:
-                self.concat_global = node.mode
+                self.concat_section = False
+                self.concat_global = (node.mode == 'on')
             node.parent.remove(node)
         elif isinstance(node, ImplicitImportMarker):
             if '\n' in node.content:
@@ -143,7 +144,7 @@ def visit_literal_block(self, node: nodes.literal_block):
                 name.lineno -= hidden_len
                 name.end_lineno -= hidden_len
 
-        if self.concat_section or self.concat_global == 'on':
+        if self.concat_section or self.concat_global:
             self.concat_sources.extend(implicit_imports + [source])
 
         for name in names:

src/sphinx_codeautolink/extension/directive.py

@@ -58,12 +58,13 @@ class ConcatBlocks(Directive):
     """Toggle and cut literal block concatenation in a document."""
 
     has_content = False
-    required_arguments = 1
-    optional_arguments = 0
+    required_arguments = 0
+    optional_arguments = 1
 
     def run(self):
         """Insert :class:`ConcatBlocksMarker`."""
-        return [ConcatBlocksMarker(self.arguments[0])]
+        arg = self.arguments[0] if self.arguments else 'on'
+        return [ConcatBlocksMarker(arg)]
 
 
 class ImplicitImportMarker(nodes.Element):

tests/extension/__init__.py

@@ -0,0 +1,53 @@
+"""
+Basic extension tests.
+
+The tests are structured as .txt files, parsed and executed here.
+The structure of the file is::
+
+   number of expected autolinks
+   # split
+   lines to add to the default conf.py
+   # split
+   index.html content
+"""
+import sys
+import pytest
+
+from pathlib import Path
+from bs4 import BeautifulSoup
+from sphinx.cmd.build import main as sphinx_main
+
+# Insert test package root to path for all tests
+sys.path.insert(0, str(Path(__file__).parent / "src"))
+
+default_conf = """
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx_codeautolink",
+]
+
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": True,
+}
+"""
+
+txt_tests = list(Path(__file__).parent.glob('*.txt'))
+
+
+@pytest.mark.parametrize('file', txt_tests)
+def test_extension(file: Path, tmp_path: Path):
+    n_links, conf, index = file.read_text('utf-8').split('# split')
+    src_dir = tmp_path / 'src'
+    src_dir.mkdir()
+    (src_dir / 'conf.py').write_text(default_conf + conf, 'utf-8')
+    (src_dir / 'index.rst').write_text(index, 'utf-8')
+
+    build_dir = tmp_path / 'build'
+    sphinx_main(['-M', 'html', str(src_dir), str(build_dir)])
+
+    index_html = build_dir / 'html' / 'index.html'
+    text = index_html.read_text('utf-8')
+    soup = BeautifulSoup(text, 'html.parser')
+    blocks = soup.find_all('a', attrs={'class': 'sphinx-codeautolink-a'})
+    assert len(blocks) == int(n_links.strip())

tests/extension/concat_off.txt

@@ -0,0 +1,19 @@
+1
+# split
+# split
+Test project
+============
+
+.. concat-blocks::
+.. code:: python
+
+   import test_project
+
+   test_project.bar()
+
+.. concat-blocks:: off
+.. code:: python
+
+   test_project.Foo
+
+.. automodule:: test_project

tests/extension/concat_on_across_sections.txt

@@ -0,0 +1,25 @@
+3
+# split
+# split
+Test project
+============
+
+.. concat-blocks:: on
+.. code:: python
+
+   import test_project
+
+   test_project.bar()
+
+.. code:: python
+
+   test_project.Foo
+
+Subsection
+----------
+
+.. code:: python
+
+   test_project.Baz
+
+.. automodule:: test_project

tests/extension/concat_on_breaks.txt

@@ -0,0 +1,20 @@
+1
+# split
+# split
+Test project
+============
+
+.. concat-blocks:: on
+.. code:: python
+
+   import test_project
+
+   test_project.bar()
+
+.. concat-blocks:: on
+
+.. code:: python
+
+   test_project.Foo
+
+.. automodule:: test_project

tests/extension/concat_section_breaks.txt

@@ -0,0 +1,26 @@
+2
+# split
+# split
+Test project
+============
+
+.. concat-blocks:: section
+
+.. code:: python
+
+   import test_project
+
+   test_project.bar()
+
+.. code:: python
+
+   test_project.Foo
+
+Subsection
+----------
+
+.. code:: python
+
+   test_project.Baz
+
+.. automodule:: test_project

tests/extension/concat_section_returns_to_global.txt

@@ -0,0 +1,31 @@
+3
+# split
+# split
+Test project
+============
+
+.. concat-blocks::
+.. concat-blocks:: section
+
+.. code:: python
+
+   import test_project
+
+   test_project.bar()
+
+.. code:: python
+
+   test_project.Foo
+
+Subsection
+----------
+
+.. code:: python
+
+   import test_project
+
+.. code:: python
+
+   test_project.Baz
+
+.. automodule:: test_project