Updates for UpdateMirror snippet_file consistency (#29)

Author: DavidSouther

aws_doc_sdk_examples_tools/doc_gen.py

@@ -36,6 +36,7 @@ class DocGenMergeWarning(MetadataError):
 class DocGen:
     root: Path
     errors: MetadataErrors
+    prefix: Optional[str] = None
     validation: ValidationConfig = field(default_factory=ValidationConfig)
     sdks: Dict[str, Sdk] = field(default_factory=dict)
     services: Dict[str, Service] = field(default_factory=dict)
@@ -55,7 +56,11 @@ def collect_snippets(
             snippets_root = self.root
         snippets, errs = collect_snippets(snippets_root, prefix)
         collect_snippet_files(
-            self.examples.values(), snippets=snippets, errors=errs, root=self.root
+            self.examples.values(),
+            prefix=prefix,
+            snippets=snippets,
+            errors=errs,
+            root=self.root,
         )
         self.snippets = snippets
         self.errors.extend(errs)
@@ -114,6 +119,10 @@ def extend_examples(self, examples: Iterable[Example]):
     def empty(cls, validation: ValidationConfig = ValidationConfig()) -> "DocGen":
         return DocGen(root=Path("/"), errors=MetadataErrors(), validation=validation)
 
+    @classmethod
+    def default(cls) -> "DocGen":
+        return DocGen.empty().for_root(Path(__file__).parent)
+
     def clone(self) -> "DocGen":
         return DocGen(
             root=self.root,

aws_doc_sdk_examples_tools/metadata.py

@@ -395,7 +395,11 @@ def check_id_format(
     if len(rest) == 0:
         errors.append(metadata_errors.NameFormat(id=id))
     elif service not in parsed_services and service not in ["cross", "serverless"]:
-        errors.append(metadata_errors.NameFormat(id=id))
+        errors.append(
+            metadata_errors.ServiceNameFormat(
+                id=id, svc=service, svcs=[*parsed_services.keys()]
+            )
+        )
     elif check_action and (
         len(rest) > 1 or rest[0] not in parsed_services.get(service, {})
     ):

aws_doc_sdk_examples_tools/metadata_errors.py

@@ -3,9 +3,8 @@
 
 from __future__ import annotations
 
-import os.path
 import re
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from typing import Optional, Iterator, Iterable, List, TypeVar
 
 
@@ -124,6 +123,18 @@ def message(self):
         return "name does not match the required format of 'svc_Operation', 'svc_Operation_Specialization', or 'cross_Title'"
 
 
+@dataclass
+class ServiceNameFormat(NameFormat):
+    svc: str = ""
+    svcs: list[str] = field(default_factory=list)
+
+    def message(self):
+        return (
+            NameFormat.message(self)
+            + f" (service {self.svc}, services {', '.join(self.svcs)})"
+        )
+
+
 @dataclass
 class ActionNameFormat(MetadataParseError):
     def message(self):

aws_doc_sdk_examples_tools/metadata_test.py

@@ -488,9 +488,11 @@ def test_verify_load_successful():
                     file="empty_metadata.yaml",
                     id="sns_EmptyExample",
                 ),
-                metadata_errors.NameFormat(
+                metadata_errors.ServiceNameFormat(
                     file="empty_metadata.yaml",
                     id="sns_EmptyExample",
+                    svc="sns",
+                    svcs=[],
                 ),
             ],
         ),
@@ -525,9 +527,11 @@ def test_verify_load_successful():
                     language="Perl",
                     sdk_version=None,
                 ),
-                metadata_errors.NameFormat(
+                metadata_errors.ServiceNameFormat(
                     file="errors_metadata.yaml",
                     id="sqs_WrongServiceSlug",
+                    svc="sqs",
+                    svcs=["sns"],
                 ),
                 metadata_errors.MissingField(
                     field="versions",

aws_doc_sdk_examples_tools/snippets.py

@@ -179,6 +179,7 @@ def collect_snippets(
 def collect_snippet_files(
     examples: Iterable[Example],
     snippets: Dict[str, Snippet],
+    prefix: str,
     errors: MetadataErrors,
     root: Path,
 ):
@@ -207,15 +208,15 @@ def collect_snippet_files(
                                 )
                             )
                             continue
-                        name = str(snippet_file).replace("/", ".")
+                        name = prefix + str(snippet_file).replace("/", ".")
                         with open(root / snippet_file, encoding="utf8") as file:
                             code = file.readlines()
                             snippets[name] = Snippet(
                                 id=name,
                                 file=str(snippet_file),
                                 line_start=0,
                                 line_end=len(code),
-                                code="\n".join(file),
+                                code="\n".join(code),
                             )
 
 
@@ -290,12 +291,6 @@ def write_snippets(root: Path, snippets: Dict[str, Snippet], check: bool = False
     return errors
 
 
-def write_snippet_file(folder: Path, snippet_file: Path):
-    name = str(snippet_file).replace("/", ".")
-    dest = folder / f"{name}.txt"
-    copyfile(folder / snippet_file, dest)
-
-
 def main():
     from argparse import ArgumentParser