Add Verify Keywords Check Without Tox (#43335)

* initial

* update

* update

* docs

* black and refactor

Author: JennyPng

doc/tool_usage_guide.md

@@ -24,6 +24,7 @@ This repo is currently migrating all checks from a slower `tox`-based framework,
 |`ruff`| Runs `ruff` checks. | `azpysdk ruff .` |
 |`verifywhl`| Verifies that the root directory in whl is azure, and verifies manifest so that all directories in source are included in sdist. | `azpysdk verifywhl .` |
 |`verifysdist`| Verify directories included in sdist and contents in manifest file. Also ensures that py.typed configuration is correct within the setup.py. | `azpysdk verifysdist .` |
+|`verify_keywords`| Verify that the keyword 'azure sdk' is present in the targeted package's keywords. | `azpysdk verify_keywords .` |
 |`import_all`| Installs the package w/ default dependencies, then attempts to `import *` from the base namespace. Ensures that all imports will resolve after a base install and import. | `azpysdk import_all .` |
 
 ## Common arguments

eng/tools/azure-sdk-tools/azpysdk/main.py

@@ -27,6 +27,7 @@
 from .verifytypes import verifytypes
 from .verify_whl import verify_whl
 from .verify_sdist import verify_sdist
+from .verify_keywords import verify_keywords
 
 from ci_tools.logging import configure_logging, logger
 
@@ -85,6 +86,7 @@ def build_parser() -> argparse.ArgumentParser:
     verifytypes().register(subparsers, [common])
     verify_sdist().register(subparsers, [common])
     verify_whl().register(subparsers, [common])
+    verify_keywords().register(subparsers, [common])
 
     return parser
 

eng/tools/azure-sdk-tools/azpysdk/verify_keywords.py

@@ -0,0 +1,58 @@
+import argparse
+
+from typing import Optional, List
+
+from ci_tools.variables import in_ci, set_envvar_defaults
+from ci_tools.environment_exclusions import is_check_enabled
+from ci_tools.logging import logger
+
+from .Check import Check
+
+KEYWORD = "azure sdk"
+
+
+class verify_keywords(Check):
+    def __init__(self) -> None:
+        super().__init__()
+
+    def register(
+        self,
+        subparsers: "argparse._SubParsersAction",
+        parent_parsers: Optional[List[argparse.ArgumentParser]] = None,
+    ) -> None:
+        """Register the `verify_keywords` check. The verify_keywords check checks the keywords of a targeted python package. If the keyword 'azure sdk' is not present, error."""
+        parents = parent_parsers or []
+        p = subparsers.add_parser(
+            "verify_keywords",
+            parents=parents,
+            help="Run the keyword verification check",
+        )
+        p.set_defaults(func=self.run)
+
+    def run(self, args: argparse.Namespace) -> int:
+        """Run the verify_keywords check command."""
+        logger.info("Running verify_keywords check...")
+
+        set_envvar_defaults()
+
+        targeted = self.get_targeted_directories(args)
+
+        results: List[int] = []
+
+        for parsed in targeted:
+            package_name = parsed.name
+
+            if in_ci():
+                if not is_check_enabled(args.target, "verify_keywords"):
+                    logger.info(f"Package {package_name} opts-out of keyword verification check.")
+                    continue
+
+            if KEYWORD not in parsed.keywords:
+                logger.error(
+                    f"Keyword '{KEYWORD}' not present in keywords for {package_name}. Before attempting publishing, ensure that package {package_name} has keyword '{KEYWORD}' present in the keyword array."
+                )
+                results.append(1)
+            else:
+                logger.info(f"Package {package_name} has keyword '{KEYWORD}' present in the keyword array.")
+
+        return max(results) if results else 0