chore: import upstream snapshot with attribution

tests/docs/test_docs_training_data.py

@@ -0,0 +1,67 @@
+from pathlib import Path
+from typing import List, Text, Tuple
+import re
+
+import pytest
+
+import rasa.shared.utils.validation
+from rasa.shared.core.training_data.story_reader.yaml_story_reader import (
+    CORE_SCHEMA_FILE,
+)
+from rasa.shared.nlu.training_data.formats.rasa_yaml import NLU_SCHEMA_FILE
+from rasa.shared.constants import DOMAIN_SCHEMA_FILE
+
+
+DOCS_BASE_DIR = Path("docs/")
+MDX_DOCS_FILES = list((DOCS_BASE_DIR / "docs").glob("**/*.mdx"))
+
+# Exclude the migration guide from this check as the migration guide might
+# contain training data which once was valid but is not valid anymore.
+# E.g. the migration guide for Rasa Open Source 2 defined a form schema which
+# is no longer valid since Rasa Open Source 3.
+MDX_DOCS_FILES.remove(Path("docs/docs/migration-guide.mdx"))
+
+# we're matching codeblocks with either `yaml-rasa` or `yml-rasa` types
+# we support title or no title (you'll get a nice error message if there is a title)
+TRAINING_DATA_CODEBLOCK_RE = re.compile(
+    r"```y(?:a)?ml-rasa(?: title=[\"'][^\"']+[\"'])?(?: \((?P<yaml_path>.+?)\))?[^\n]*\n(?P<codeblock>.*?)```",  # noqa: E501
+    re.DOTALL,
+)
+
+
+@pytest.mark.parametrize("mdx_file_path", MDX_DOCS_FILES)
+def test_docs_training_data(mdx_file_path: Path):
+    with mdx_file_path.open("r") as handle:
+        mdx_content = handle.read()
+
+    matches = TRAINING_DATA_CODEBLOCK_RE.finditer(mdx_content)
+    lines_with_errors: List[Tuple[Text, Text]] = []
+
+    for match in matches:
+        yaml_path = match.group("yaml_path")
+        if yaml_path:
+            with (DOCS_BASE_DIR / yaml_path).open("r") as handle:
+                codeblock = handle.read()
+        else:
+            codeblock = match.group("codeblock")
+
+        start_index = match.span()[0]
+        line_number = mdx_content.count("\n", 0, start_index) + 1
+
+        # the responses schema is automatically checked in validate_yaml_schema,
+        # don't need to add it here
+        schemas_to_try = [NLU_SCHEMA_FILE, CORE_SCHEMA_FILE, DOMAIN_SCHEMA_FILE]
+        for schema in schemas_to_try:
+            try:
+                rasa.shared.utils.validation.validate_yaml_schema(codeblock, schema)
+            except ValueError as error:
+                lines_with_errors.append((str(line_number), str(error)))
+
+    if lines_with_errors:
+        error_details = "\n\n" + "\n".join(
+            f" - At line {line}: {error} " for line, error in lines_with_errors
+        )
+        raise AssertionError(
+            f"({mdx_file_path}): Invalid training data found "
+            f"at line{'s' if len(lines_with_errors) > 1 else ''}: {error_details}"
+        )