parser: More tests

Author: i80and

parser/snooty/gizaparser/nodes.py

@@ -4,7 +4,7 @@
 import re
 from dataclasses import dataclass, field
 from pathlib import Path, PurePath
-from typing import cast, Any, Callable, Dict, Set, Generic, Optional, \
+from typing import cast, Callable, Dict, Set, Generic, Optional, \
                    TypeVar, Tuple, Iterator, Sequence, List, Union
 from ..flutter import checked
 from ..types import Diagnostic, Page, EmbeddedRstParser, SerializableType, ProjectConfig
@@ -242,21 +242,3 @@ def render_heading(self, parse_rst: EmbeddedRstParser) -> Sequence[SerializableT
             'position': {'start': {'line': self.line}},
             'children': result
         },)
-
-
-def ast_to_testing_string(ast: Any) -> str:
-    value = ast.get('value', '')
-    children = ast.get('children', [])
-    attrs = ' '.join(
-        '{}="{}"'.format(k, v) for k, v in ast.items() if k not in (
-            'argument', 'value', 'children', 'type', 'position') and v)
-    contents = value if value else (''.join(
-        ast_to_testing_string(child) for child in children)
-        if children else '')
-    if 'argument' in ast:
-        contents = ''.join(ast_to_testing_string(part) for part in ast['argument']) + contents
-    return '<{}{}>{}</{}>'.format(
-        ast['type'],
-        ' ' + attrs if attrs else '',
-        contents,
-        ast['type'])

parser/snooty/gizaparser/test_extracts.py

@@ -1,9 +1,9 @@
 from pathlib import Path, PurePath
 from typing import Dict, Tuple, List
 from .extracts import GizaExtractsCategory
-from .nodes import ast_to_testing_string
 from ..types import Diagnostic, Page, EmbeddedRstParser, ProjectConfig
 from ..parser import make_embedded_rst_parser
+from ..util import ast_to_testing_string
 
 
 def test_extract() -> None:
@@ -32,6 +32,7 @@ def add_child_file() -> List[Diagnostic]:
     all_diagnostics[path] = add_main_file()
     all_diagnostics[child_path] = add_child_file()
 
+    assert len(category) == 2
     file_id, giza_node = next(category.reify_all_files(all_diagnostics))
 
     def create_page() -> Tuple[Page, EmbeddedRstParser]:

parser/snooty/gizaparser/test_nodes.py

@@ -38,6 +38,9 @@ def test_substitution() -> None:
     substituted_string = 'testing substitution. test.'
     assert nodes.substitute_text(test_string, replacements) == substituted_string
 
+    obj = object()
+    assert nodes.substitute(obj, replacements) is obj
+
     # Test complex substitution
     node = SubstitutionTest(
         foo=test_string,
@@ -56,3 +59,15 @@ def test_substitution() -> None:
     # Ensure the identity of the zero-substitutions case remains the same
     test_string = 'foo'
     assert nodes.substitute_text(test_string, {}) is test_string
+
+
+def test_inheritance() -> None:
+    parent = nodes.Inheritable('parent', {'foo': 'bar', 'old': ''}, source=None, inherit=None)
+    child = nodes.Inheritable(
+        'child',
+        {'bar': 'baz', 'old': 'new'},
+        source=nodes.Inherit('self.yaml', 'parent'),
+        inherit=None)
+    child = nodes.inherit(child, parent)
+
+    assert child.replacement == {'foo': 'bar', 'bar': 'baz', 'old': 'new'}

parser/snooty/gizaparser/test_steps.py

@@ -1,9 +1,9 @@
 from pathlib import Path, PurePath
 from typing import Dict, Tuple, List
 from .steps import GizaStepsCategory
-from .nodes import ast_to_testing_string
 from ..types import Diagnostic, Page, EmbeddedRstParser, ProjectConfig
 from ..parser import make_embedded_rst_parser
+from ..util import ast_to_testing_string
 
 
 def test_step() -> None:
@@ -31,6 +31,7 @@ def add_child_file() -> List[Diagnostic]:
     all_diagnostics[path] = add_main_file()
     all_diagnostics[child_path] = add_child_file()
 
+    assert len(category) == 2
     file_id, giza_node = next(category.reify_all_files(all_diagnostics))
 
     def create_page() -> Tuple[Page, EmbeddedRstParser]:
@@ -49,17 +50,24 @@ def create_page() -> Tuple[Page, EmbeddedRstParser]:
 
         '<directive name="step"><section><heading><text>Create a </text><literal><text>',
         '/etc/apt/sources.list.d/mongodb-org-3.4.list</text></literal><text> file for MongoDB.',
-        '</text></heading><paragraph><text>Create the list file using the command appropriate for ',
-        'your version\nof Debian.</text></paragraph></section></directive>',
+        '</text></heading>',
+        '<section><heading><text>Optional: action heading</text></heading>'
+        '<paragraph><text>Create the list file using the command appropriate for ',
+        'your version\nof Debian.</text></paragraph>',
+        '<paragraph><text>action-content</text></paragraph>',
+        '<paragraph><text>action-post</text></paragraph>',
+        '</section></section></directive>',
 
         '<directive name="step"><section><heading><text>Reload local package database.</text>',
         '</heading><paragraph><text>Issue the following command to reload the local package ',
         'database:</text></paragraph><code lang="sh" copyable="True">sudo apt-get update\n</code>',
         '</section></directive>',
 
         '<directive name="step"><section><heading><text>Install the MongoDB packages.</text>',
-        '</heading><paragraph><text>You can install either the latest stable version of MongoDB ',
+        '</heading><paragraph><text>hi</text></paragraph>',
+        '<paragraph><text>You can install either the latest stable version of MongoDB ',
         'or a\nspecific version of MongoDB.</text></paragraph>',
         '<directive name="code-block">',
-        '<text>sh</text><literal></literal></directive></section></directive></directive>'
+        '<text>sh</text><literal></literal></directive><paragraph><text>bye</text></paragraph>',
+        '</section></directive></directive>'
     ))

parser/snooty/language_server.py

@@ -162,7 +162,7 @@ class WorkspaceEntry:
     document_uri: Uri
     diagnostics: List[types.Diagnostic]
 
-    def create_lsp_diagnostics(self) -> object:
+    def create_lsp_diagnostics(self) -> List[object]:
         return [{
             'range': {
                 'start': {

parser/snooty/rstparser.py

@@ -20,7 +20,7 @@
 PAT_EXPLICIT_TILE = re.compile(r'^(?P<label>.+?)\s*(?<!\x00)<(?P<target>.*?)>$', re.DOTALL)
 PAT_WHITESPACE = re.compile(r'^\x20*')
 PAT_BLOCK_HAS_ARGUMENT = re.compile(r'^\x20*\.\.\x20[^\s]+::\s*\S+')
-SPECIAL_DIRECTIVES = {'code-block', 'include', 'tabs-drivers', 'tabs', 'tabs-platforms', 'only'}
+SPECIAL_DIRECTIVES = {'code-block', 'include', 'only'}
 
 
 @checked

parser/snooty/test_language_server.py

@@ -0,0 +1,67 @@
+import sys
+import time
+from dataclasses import dataclass
+from pathlib import Path
+from . import language_server
+from .types import Diagnostic
+from .flutter import checked, check_type
+
+
+@checked
+@dataclass
+class LSPPosition:
+    line: int
+    character: int
+
+
+@checked
+@dataclass
+class LSPRange:
+    start: LSPPosition
+    end: LSPPosition
+
+
+@checked
+@dataclass
+class LSPDiagnostic:
+    message: str
+    severity: int
+    range: LSPRange
+
+
+def test_debounce() -> None:
+    bounces = [0]
+
+    @language_server.debounce(0.1)
+    def inc() -> None:
+        bounces[0] += 1
+
+    inc()
+    inc()
+    inc()
+
+    time.sleep(0.2)
+    inc()
+
+    assert bounces[0] == 1
+
+
+def test_pid_exists() -> None:
+    assert language_server.pid_exists(0)
+    # Test that an invalid PID returns False
+    assert not language_server.pid_exists(537920)
+
+
+def test_workspace_entry() -> None:
+    entry = language_server.WorkspaceEntry('', '', [
+        Diagnostic.error('foo', 10),
+        Diagnostic.warning('fo', 10, 12),
+    ])
+    parsed = [check_type(LSPDiagnostic, diag) for diag in entry.create_lsp_diagnostics()]
+    assert parsed[0] == LSPDiagnostic('foo', 1, LSPRange(LSPPosition(10, 0), LSPPosition(10, 1000)))
+    assert parsed[1] == LSPDiagnostic('fo', 2, LSPRange(LSPPosition(10, 0), LSPPosition(12, 1000)))
+
+
+def test_language_server() -> None:
+    server = language_server.LanguageServer(sys.stdin.buffer, sys.stdout.buffer)
+    assert server.uri_to_path('file://foo.rst') == Path('foo.rst')

parser/snooty/test_main.py

@@ -0,0 +1,30 @@
+import builtins
+from pathlib import PurePath
+from typing import Any, List
+from .types import Diagnostic
+from . import main
+
+
+def test_backend() -> None:
+    messages: List[str] = []
+
+    def test_print(*values: Any, **kwargs: Any) -> None:
+        messages.extend(str(val) for val in values)
+
+    backend = main.Backend()
+    orig_print = builtins.print
+    builtins.print = test_print
+    try:
+        backend.on_diagnostics(PurePath('foo/bar.rst'), [
+            Diagnostic.error('an error', 10, 12),
+            Diagnostic.error('another error', (10, 0), (12, 30))])
+        backend.on_diagnostics(PurePath('foo/foo.rst'), [Diagnostic.warning('a warning', 10)])
+        assert backend.total_warnings == 3
+    finally:
+        builtins.print = orig_print
+
+    assert messages == [
+        'ERROR(foo/bar.rst:10ish): an error',
+        'ERROR(foo/bar.rst:10ish): another error',
+        'WARNING(foo/foo.rst:10ish): a warning'
+    ]

parser/snooty/test_parser.py

@@ -0,0 +1,38 @@
+from pathlib import Path
+from . import rstparser
+from .util import ast_to_testing_string
+from .types import ProjectConfig
+from .parser import parse_rst, JSONVisitor
+
+
+def test_tabs() -> None:
+    root = Path('test_data')
+    tabs_path = Path(root).joinpath(Path('test_tabs.rst'))
+    project_config = ProjectConfig(root, '')
+    parser = rstparser.Parser(project_config, JSONVisitor)
+    page, diagnostics = parse_rst(parser, tabs_path, None)
+
+    assert ast_to_testing_string(page.ast) == ''.join((
+        '<root>',
+
+        '<directive name="tabs"><directive name="tab"><text>bionic</text>',
+        '<paragraph><text>Bionic content</text></paragraph></directive>',
+
+        '<directive name="tab"><text>xenial</text><paragraph><text>',
+        'Xenial content</text></paragraph></directive>',
+
+        '<directive name="tab"><text>trusty</text><paragraph><text>',
+        'Trusty content</text></paragraph></directive></directive>',
+
+        '<directive name="tabs"><directive name="tab"><text>trusty</text><paragraph><text>',
+        'Trusty content</text></paragraph></directive>',
+
+        '<directive name="tab"><text>xenial</text><paragraph><text>',
+        'Xenial content</text></paragraph></directive></directive>',
+
+        '</root>'
+    ))
+
+    assert len(diagnostics) == 1 and \
+        diagnostics[0].message.startswith('Unexpected field') and \
+        diagnostics[0].start[0] == 36

parser/snooty/util.py

@@ -1,7 +1,7 @@
 import os
 import docutils.nodes
 from pathlib import Path, PurePath
-from typing import cast, Container, Optional, Tuple, Iterator
+from typing import cast, Any, Container, Optional, Tuple, Iterator
 
 
 def reroot_path(filename: PurePath,
@@ -46,3 +46,21 @@ def line_of_node(node: docutils.nodes.Node) -> Optional[int]:
         node = node.parent
 
     return cast(int, line_of_node(node)) - 1
+
+
+def ast_to_testing_string(ast: Any) -> str:
+    value = ast.get('value', '')
+    children = ast.get('children', [])
+    attrs = ' '.join(
+        '{}="{}"'.format(k, v) for k, v in ast.items() if k not in (
+            'argument', 'value', 'children', 'type', 'position') and v)
+    contents = value if value else (''.join(
+        ast_to_testing_string(child) for child in children)
+        if children else '')
+    if 'argument' in ast:
+        contents = ''.join(ast_to_testing_string(part) for part in ast['argument']) + contents
+    return '<{}{}>{}</{}>'.format(
+        ast['type'],
+        ' ' + attrs if attrs else '',
+        contents,
+        ast['type'])