DOCSP-5424: Validate include files within repo

Author: rayangler

snooty/parser.py

@@ -347,6 +347,31 @@ def handle_directive(
                 msg = f'Invalid "literalinclude": {err}'
                 self.diagnostics.append(Diagnostic.error(msg, util.get_line(node)))
             return
+        elif name == "include":
+            if argument_text is None:
+                self.diagnostics.append(
+                    Diagnostic.error(
+                        f'"{name}" expected a path argument', util.get_line(node)
+                    )
+                )
+                return
+
+            fileid, path = util.reroot_path(
+                Path(argument_text), self.docpath, self.source_path
+            )
+
+            # Validate if file exists
+            if not path.is_file():
+                # Check if file is snooty-generated
+                if (
+                    fileid.match("steps/*.rst")
+                    or fileid.match("extracts/*.rst")
+                    or fileid.match("release/*.rst")
+                ):
+                    pass
+                else:
+                    msg = f'"{name}" could not open "{argument_text}: No such file exists"'
+                    self.diagnostics.append(Diagnostic.error(msg, util.get_line(node)))
 
         if options:
             doc["options"] = options

snooty/test_parser.py

@@ -178,6 +178,46 @@ def test_literalinclude() -> None:
     assert len(diagnostics) == 1
 
 
+def test_include() -> None:
+    root = Path("test_data")
+    path = Path(root).joinpath(Path("test.rst"))
+    project_config = ProjectConfig(root, "", source="./")
+    parser = rstparser.Parser(project_config, JSONVisitor)
+
+    # Test good include
+    page, diagnostics = parse_rst(
+        parser,
+        path,
+        """
+        .. include:: /driver-examples/rstexample.rst
+        """,
+    )
+    page.finish(diagnostics)
+    assert diagnostics == []
+
+    # Test generated include
+    page, diagnostics = parse_rst(
+        parser,
+        path,
+        """
+        .. include:: /driver-examples/steps/generated-include.rst
+        """,
+    )
+    page.finish(diagnostics)
+    assert diagnostics == []
+
+    # Test bad include
+    page, diagnostics = parse_rst(
+        parser,
+        path,
+        """
+        .. include:: /driver-examples/fake-include.rst
+        """,
+    )
+    page.finish(diagnostics)
+    assert len(diagnostics) == 1
+
+
 def test_admonition() -> None:
     root = Path("test_data")
     path = Path(root).joinpath(Path("test.rst"))