Write unit tests for yamale validation, use strict_titles arg to control strict schema instead of path.

Author: Laren-AWS

aws_doc_sdk_examples_tools/doc_gen.py

@@ -270,7 +270,7 @@ def validate(self):
             service.validate(self.errors)
         for example in self.examples.values():
             example.validate(self.errors, self.root)
-        validate_metadata(self.root, self.errors)
+        validate_metadata(self.root, self.validation.strict_titles, self.errors)
         validate_no_duplicate_api_examples(self.examples.values(), self.errors)
         validate_snippets(
             [*self.examples.values()],

aws_doc_sdk_examples_tools/metadata_validator.py

@@ -203,7 +203,7 @@ def validate_files(
     return errors
 
 
-def validate_metadata(doc_gen_root: Path, errors: MetadataErrors) -> MetadataErrors:
+def validate_metadata(doc_gen_root: Path, strict: bool, errors: MetadataErrors) -> MetadataErrors:
     config = Path(__file__).parent / "config"
     with open(config / "sdks.yaml") as sdks_file:
         sdks_yaml: Dict[str, Any] = yaml.safe_load(sdks_file)
@@ -226,12 +226,10 @@ def validate_metadata(doc_gen_root: Path, errors: MetadataErrors) -> MetadataErr
     validators[String.tag] = StringExtension
 
     config_root = Path(__file__).parent / "config"
-    if "aws-doc-sdk-examples" in doc_gen_root.name:
+    if strict:
         example_schema = "example_strict_schema.yaml"
-        strict = True
     else:
         example_schema = "example_schema.yaml"
-        strict = False
 
     to_validate = [
         # (schema, metadata_glob)
@@ -259,9 +257,12 @@ def main():
         help="The folder that contains schema and metadata files.",
         required=False,
     )
+    parser.add_argument(
+        "--strict", default=True, help="Use strict schema.", required=False
+    )
     args = parser.parse_args()
 
-    errors = validate_metadata(Path(args.doc_gen), MetadataErrors())
+    errors = validate_metadata(Path(args.doc_gen), args.strict, MetadataErrors())
 
     if len(errors) == 0:
         print("Validation succeeded! 👍👍👍")

aws_doc_sdk_examples_tools/metadata_validator_test.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python3
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+from pathlib import Path
+
+import pytest
+
+from .metadata_errors import MetadataErrors
+from .metadata_validator import validate_metadata
+
+@pytest.mark.parametrize("strict", [True, False])
+def test_aws_entity_usage(strict):
+    errors = MetadataErrors()
+    validate_metadata(Path(Path(__file__).parent / "test_resources/doc_gen_test"), strict, errors)
+
+    e_str = str(errors)
+    assert "Title has AWS" in e_str
+    assert "Title Abbrev has AWS" in e_str
+    assert "Synopsis has AWS" in e_str
+    assert "Synopsis list has AWS" in e_str
+    assert "Description has AWS" in e_str
+
+    assert "Title has &AWS;" not in e_str
+    assert "Title Abbrev has &AWS;" not in e_str
+    assert "Synopsis programlisting has AWS" not in e_str
+    assert "Synopsis list code has <code>AWS" not in e_str
+    assert "Description programlisting has AWS" not in e_str
+

aws_doc_sdk_examples_tools/test_resources/doc_gen_test/.doc_gen/metadata/aws_entity_metadata.yaml

@@ -0,0 +1,38 @@
+sns_EntityFailures:
+  title: Title has AWS using an &AWS; SDK
+  title_abbrev: Title Abbrev has AWS in it
+  synopsis: "Synopsis has AWS in it."
+  synopsis_list:
+    - "Synopsis list has AWS in it."
+  category: Cat
+  languages:
+    Java:
+      versions:
+        - sdk_version: 1
+          github: java/example_code/svc_EntityFailures
+          sdkguide:
+          excerpts:
+            - description: Description has AWS in it.
+              snippet_tags:
+                - java.example_code.svc_EntityFailures.Test
+  services:
+    sns:
+sns_EntitySuccesses:
+  title: Title has &AWS; using an &AWS; SDK
+  title_abbrev: Title Abbrev has &AWS; in it
+  synopsis: "this <programlisting>Synopsis programlisting has AWS in it.</programlisting>."
+  synopsis_list:
+    - "Synopsis list code has <code>AWS</code> in it."
+  category: Cat
+  languages:
+    Java:
+      versions:
+        - sdk_version: 1
+          github: java/example_code/svc_EntityFailures
+          sdkguide:
+          excerpts:
+            - description: This <emphasis><programlisting>Description programlisting has AWS in it</programlisting></emphasis> doesn't it.
+              snippet_tags:
+                - java.example_code.svc_EntityFailures.Test
+  services:
+    sns: