Merge pull request #265 from necusjz/data-verification

`aaz-dev command-model verify`: Add command to verify aaz metadata

requirements.txt

@@ -12,3 +12,4 @@ packaging>=21.3
 Jinja2~=3.0.3
 MarkupSafe~=2.0.1
 jsonschema~=4.17.1
+click~=8.1.2

src/aaz_dev/command/api/_cmds.py

@@ -1,8 +1,13 @@
 import click
+import json
 import logging
-from flask import Blueprint
+import os
+import re
 import sys
+from flask import Blueprint
 
+from command.controller.specs_manager import AAZSpecsManager
+from command.templates import get_templates
 from swagger.utils.tools import swagger_resource_path_to_resource_id
 from utils.config import Config
 
@@ -145,3 +150,109 @@ def generate_command_models_from_swagger(swagger_tag, workspace_path=None):
     except ValueError as err:
         logger.error(err)
         sys.exit(1)
+
+
+@bp.cli.command("verify", short_help="Verify data consistency within `aaz` repository.")
+@click.option(
+    "--aaz-path", "-a",
+    type=click.Path(file_okay=False, dir_okay=True, writable=True, readable=True, resolve_path=True),
+    default=Config.AAZ_PATH,
+    required=not Config.AAZ_PATH,
+    callback=Config.validate_and_setup_aaz_path,
+    expose_value=False,
+    help="Path of `aaz` repository."
+)
+def verify():
+    def verify_command(cmd_path, node):
+        with open(cmd_path, "r") as f:
+            cmd_content = f.read()
+
+        paths = re.findall(r"]\(([^)]+)\)", cmd_content)
+        for path in paths:
+            json_path = os.path.join(Config.AAZ_PATH, os.path.splitext(path)[0][1:] + ".json")
+            json_path = os.path.normpath(json_path)
+            if not os.path.exists(json_path):
+                raise Exception(f"{json_path} defined in {file_path} is missing.")
+
+            with open(json_path, "r", encoding="utf-8") as fp:
+                model = json.load(fp)
+            group, command = " ".join(node.names[:-1]), node.names[-1]
+            for g in model["commandGroups"]:
+                if g["name"] == group:
+                    if not any(cmd["name"] == command for cmd in g["commands"]):
+                        raise Exception(f"There is no {command} command info in {json_path}.")
+
+                    break
+
+            model_set.add(json_path)
+
+        tmpl = get_templates()["command"]
+        if not tmpl.render(command=node) == cmd_content:
+            raise Exception(f"{file_path} cannot be rendered correctly.")
+
+    model_set = set()
+    aaz = AAZSpecsManager()
+    stack = [(aaz.commands_folder, aaz.tree.root)]  # root nodes
+
+    while stack:
+        curr_path, curr_node = stack.pop()
+        if os.path.isdir(curr_path):
+            readme_path = os.path.join(curr_path, "readme.md")
+            if not os.path.exists(readme_path):
+                raise Exception(f"Missing `readme.md` under {curr_path}.")
+
+            with open(readme_path, "r", encoding="utf-8") as fp:
+                content = fp.read()
+
+            matches = re.findall(r"## (.+)\n\n(((?!\n##)[\s\S])+)", content)
+            for match in matches:
+                level = match[0]
+                items = re.findall(r"- \[([^[\]]+)]", match[1])
+
+                if level == "Commands":
+                    if len(items) != len(set(items)):
+                        raise Exception(f"{readme_path} has duplicate command names.")
+
+                    items = set(items)
+
+                    files = {i for i in os.listdir(curr_path) if os.path.isfile(os.path.join(curr_path, i))}
+                    files.remove("readme.md")
+
+                    if (cmd_set := set(map(lambda x: x[1:-3], files))) != items:  # _<command_name>.md
+                        diff = cmd_set - items or items - cmd_set
+                        raise Exception(f"Command info {diff} doesn't match in {readme_path}.")
+
+                    groups = set(curr_node.commands.keys())
+                    if groups != items:
+                        diff = groups - items or items - groups
+                        raise Exception(f"Command info {diff} in tree.json doesn't match in {readme_path}.")
+
+                    for file in files:
+                        verify_command(os.path.join(curr_path, file), curr_node.commands[file[1:-3]])
+                else:
+                    if len(items) != len(set(items)):
+                        raise Exception(f"{readme_path} has duplicate command group names.")
+
+                    items = set(items)
+
+                    folders = {i for i in os.listdir(curr_path) if os.path.isdir(os.path.join(curr_path, i))}
+                    if folders != items:
+                        diff = folders - items or items - folders
+                        raise Exception(f"Command group info {diff} doesn't match in {readme_path}.")
+
+                    groups = set(curr_node.command_groups.keys())
+                    if groups != set(items):
+                        diff = groups - items or items - groups
+                        raise Exception(f"Command group info {diff} in tree.json doesn't match in {readme_path}.")
+
+                    for folder in folders:
+                        stack.append((os.path.join(curr_path, folder), curr_node.command_groups[folder]))
+
+    for root, dirs, files in os.walk(aaz.resources_folder):
+        for file in files:
+            if not file.endswith(".json"):
+                continue
+
+            file_path = os.path.join(root, file)
+            if file_path not in model_set:
+                raise Exception(f"{file_path} is redundant.")