parser: Add test coverage for steps and util.get_files()

Author: i80and

parser/snooty/flutter.py

@@ -18,6 +18,7 @@ def __init__(self, **kwargs: object) -> None: ...
 
 
 class mapping_dict(Dict[str, Any]):
+    """A dictionary that also contains source line information."""
     __slots__ = ('_start_line', '_end_line')
     _start_line: int
     _end_line: int

parser/snooty/gizaparser/nodes.py

@@ -247,12 +247,14 @@ def render_heading(self, parse_rst: EmbeddedRstParser) -> Sequence[SerializableT
 def ast_to_testing_string(ast: Any) -> str:
     value = ast.get('value', '')
     children = ast.get('children', [])
-    attrs = ', '.join(
+    attrs = ' '.join(
         '{}="{}"'.format(k, v) for k, v in ast.items() if k not in (
-            'value', 'children', 'type', 'position'))
+            '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 '',

parser/snooty/gizaparser/parse.py

@@ -67,5 +67,5 @@ def parse(ty: Type[_T],
         return parsed, text, diagnostics
     except LoadError as err:
         mapping = err.bad_data if isinstance(err.bad_data, dict) else {}
-        lineno = mapping.get('_start_line', 0)
+        lineno = mapping._start_line if isinstance(mapping, mapping_dict) else 0
         return [], text, diagnostics + [Diagnostic.error(str(err), lineno)]

parser/snooty/gizaparser/test_steps.py

@@ -0,0 +1,65 @@
+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
+
+
+def test_step() -> None:
+    project_path, project_config, project_diagnostics = ProjectConfig.open(Path('test_data'))
+    assert project_diagnostics == []
+
+    category = GizaStepsCategory(project_config)
+    path = Path('test_data/steps-test.yaml')
+    child_path = Path('test_data/steps-test-child.yaml')
+
+    def add_main_file() -> List[Diagnostic]:
+        steps, text, parse_diagnostics = category.parse(path)
+        category.add(path, text, steps)
+        assert len(parse_diagnostics) == 0
+        assert len(steps) == 4
+        return parse_diagnostics
+
+    def add_child_file() -> List[Diagnostic]:
+        steps, text, parse_diagnostics = category.parse(child_path)
+        category.add(child_path, text, steps)
+        assert len(parse_diagnostics) == 0
+        return parse_diagnostics
+
+    all_diagnostics: Dict[PurePath, List[Diagnostic]] = {}
+    all_diagnostics[path] = add_main_file()
+    all_diagnostics[child_path] = add_child_file()
+
+    file_id, giza_node = next(category.reify_all_files(all_diagnostics))
+
+    def create_page() -> Tuple[Page, EmbeddedRstParser]:
+        page = Page(path, '', {})
+        return page, make_embedded_rst_parser(project_config, page, all_diagnostics[path])
+
+    pages = category.to_pages(create_page, giza_node.data)
+    assert len(pages) == 1
+    print(repr(ast_to_testing_string(pages[0].ast)))
+    assert ast_to_testing_string(pages[0].ast) == ''.join((
+        '<directive name="steps"><directive name="step"><section><heading><text>Import the public ',
+        'key used by the package management system.</text></heading><paragraph><text>Issue the ',
+        'following command to import the\n</text><reference><text>MongoDB public GPG Key</text>',
+        '</reference><target ids="[\'mongodb-public-gpg-key\']"></target></paragraph></section>',
+        '</directive>',
+
+        '<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>',
+
+        '<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 ',
+        'or a\nspecific version of MongoDB.</text></paragraph>',
+        '<directive name="code-block">',
+        '<text>sh</text><literal></literal></directive></section></directive></directive>'
+    ))

parser/snooty/test_source_constants.py

@@ -3,7 +3,8 @@
 
 
 def test_project() -> None:
-    root_path, project_config, project_diagnostics = ProjectConfig.open(Path('test_data'))
+    path = Path('test_data/bad_project')
+    root_path, project_config, project_diagnostics = ProjectConfig.open(path)
     assert len(project_diagnostics) == 1
     assert project_config.constants == {
         'version': '3.4',

parser/snooty/test_util.py

@@ -13,3 +13,9 @@ def test_reroot_path() -> None:
         PurePath('../bar/baz.rst'),
         PurePath('foo/dir/test.txt'),
         Path('foo'))[0] == PurePath('foo/bar/baz.rst')
+
+
+def test_get_files() -> None:
+    assert list(util.get_files(PurePath('test_data'), ('.toml',))) == [
+        Path('test_data/snooty.toml'),
+        Path('test_data/bad_project/snooty.toml')]

parser/test_data/bad_project/snooty.toml

@@ -0,0 +1,6 @@
+name = "test_data"
+
+[constants]
+version = 3.4
+package_title = "{+version+}.tar.gz"
+invalid = "{+foo+}"

parser/test_data/snooty.toml

@@ -2,5 +2,5 @@ name = "test_data"
 
 [constants]
 version = 3.4
-package_title = "{+version+}.tar.gz"
-invalid = "{+foo+}"
+package-name-org = "mongodb-org"
+pgp-version = "{+version+}"

parser/test_data/steps-test-child.yaml

@@ -0,0 +1,45 @@
+title: Import the public key used by the package management system.
+stepnum: 1
+level: 4
+ref: import-key
+action:
+  pre: |
+    Issue the following command to import the
+    `MongoDB public GPG Key <https://www.mongodb.org/static/pgp/server-{+pgp-version+}.asc>`_
+---
+title: Create a list file for MongoDB.
+stepnum: 2
+level: 4
+ref: sources-list
+content: |
+
+   Create the list file
+   ``/etc/apt/sources.list.d/mongodb-org-{+version+}.list`` for your
+   version of Ubuntu.
+
+---
+title: Reload local package database.
+stepnum: 3
+level: 4
+ref: reload
+action:
+  pre: |
+    Issue the following command to reload the local package database:
+  language: sh
+  copyable: true
+  code: |
+    sudo apt-get update
+---
+title: Install the MongoDB packages.
+stepnum: 4
+level: 4
+ref: install
+content: |
+
+   You can install either the latest stable version of MongoDB or a
+   specific version of MongoDB.
+
+   .. code-block:: sh
+
+      echo "{+package-name-org+} hold" | sudo dpkg --set-selections
+...

parser/test_data/steps-test.yaml

@@ -0,0 +1,27 @@
+stepnum: 1
+level: 4
+source:
+  file: steps-test-child.yaml
+  ref: import-key
+---
+title: Create a ``/etc/apt/sources.list.d/mongodb-org-{+version+}.list`` file for MongoDB.
+stepnum: 2
+level: 4
+ref: sources-list
+action:
+  pre: |
+    Create the list file using the command appropriate for your version
+    of Debian.
+---
+stepnum: 3
+level: 4
+source:
+  file: steps-test-child.yaml
+  ref: reload
+---
+stepnum: 4
+level: 4
+source:
+  file: steps-test-child.yaml
+  ref: install
+...