envoy.code.check 0.5.13__tar.gz → 0.6.0__tar.gz

envoy_code_check-0.6.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: envoy.code.check
+Version: 0.6.0
+Summary: Code checker used in Envoy proxy's CI
+Home-page: https://github.com/envoyproxy/toolshed/tree/main/py/envoy.code.check
+Author: Ryan Northey
+Author-email: ryan@synca.io
+Maintainer: Ryan Northey
+Maintainer-email: ryan@synca.io
+License: Apache Software License 2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: abstracts==0.2.0
+Requires-Dist: abstracts>=0.2.0
+Requires-Dist: aio-core==0.11.0
+Requires-Dist: aio-run-checker==0.6.0
+Requires-Dist: aio.core>=0.11.0
+Requires-Dist: aio.run.checker>=0.6.0
+Requires-Dist: envoy-base-utils==0.6.0
+Requires-Dist: envoy.base.utils>=0.6.0
+Requires-Dist: flake8==7.3.0
+Requires-Dist: flake8>=6.1.0
+Requires-Dist: packaging==26.2
+Requires-Dist: packaging>=23.0
+Requires-Dist: pep8-naming>=0.13.3
+Requires-Dist: types-pyyaml==6.0.12.20260508
+Requires-Dist: yamllint==1.38.0
+Requires-Dist: yamllint>=1.32.0
+Requires-Dist: yapf==0.43.0
+Requires-Dist: yapf>=0.40.2
+Provides-Extra: test
+Requires-Dist: pytest>=7.4.0; extra == "test"
+Requires-Dist: pytest-asyncio>=0.23.3; extra == "test"
+Requires-Dist: pytest-coverage; extra == "test"
+Requires-Dist: pytest-iters>=0.1.0; extra == "test"
+Requires-Dist: pytest-patches>=0.1.0; extra == "test"
+Provides-Extra: lint
+Requires-Dist: flake8>=6.1.0; extra == "lint"
+Provides-Extra: types
+Requires-Dist: mypy>=1.6.0; extra == "types"
+Requires-Dist: mypy-abstracts>=0.1.0; extra == "types"
+Provides-Extra: publish
+Requires-Dist: wheel>=0.41.0; extra == "publish"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+
+envoy.code.check
+================
+
+Code checker used in Envoy proxy's CI.
+
+This package provides an async checker that runs source-code checks against an
+Envoy (or Envoy-like) checkout. Registered checks include:
+
+- ``python_flake8`` and ``python_yapf`` for Python style
+- ``yamllint`` for YAML files
+- ``shellcheck`` for shell scripts
+- ``glint`` for file hygiene checks
+- ``gofmt`` for Go formatting
+- ``runtime_guards`` consistency checks
+- extension metadata, registration, owner, and fuzz-coverage checks
+- changelog validation, including RST sanity checks
+
+Usage
+-----
+
+Installed as a console script:
+
+.. code-block:: console
+
+   $ envoy.code.check --help
+
+Run a subset of checks against a checkout:
+
+.. code-block:: console
+
+   $ envoy.code.check --check python_flake8 python_yapf --path /path/to/envoy
+
+Run only against files changed since a given ref:
+
+.. code-block:: console
+
+   $ envoy.code.check --since main --path /path/to/envoy
+
+See ``envoy.code.check --help`` for the full set of options.
+
+Links
+-----
+
+- Source: https://github.com/envoyproxy/toolshed/tree/main/py/envoy.code.check
+- Issues: https://github.com/envoyproxy/toolshed/issues

{envoy.code.check-0.5.13 → envoy_code_check-0.6.0}/backend_shim.py

@@ -1,12 +1,13 @@
 
 # DO NOT EDIT THIS FILE -- AUTOGENERATED BY PANTS
 
+import errno
 import os
 import setuptools.build_meta
 
 backend = setuptools.build_meta.__legacy__
 
-dist_dir = "dist"
+dist_dir = "dist/"
 build_wheel = True
 build_sdist = True
 wheel_config_settings = {
@@ -14,7 +15,13 @@ wheel_config_settings = {
 sdist_config_settings = {
 }
 
-os.makedirs(dist_dir, exist_ok=True)
+# Python 2.7 doesn't have the exist_ok arg on os.makedirs().
+try:
+    os.makedirs(dist_dir)
+except OSError as e:
+    if e.errno != errno.EEXIST:
+        raise
+
 wheel_path = backend.build_wheel(dist_dir, wheel_config_settings) if build_wheel else None
 sdist_path = backend.build_sdist(dist_dir, sdist_config_settings) if build_sdist else None
 

{envoy.code.check-0.5.13 → envoy_code_check-0.6.0}/envoy/code/check/__init__.py

@@ -69,8 +69,6 @@ __all__ = (
     "interface",
     "main",
     "run",
-    "main",
-    "run",
     "RuntimeGuardsCheck",
     "ShellcheckCheck",
     "typing",

{envoy.code.check-0.5.13 → envoy_code_check-0.6.0}/envoy/code/check/abstract/base.py

@@ -1,7 +1,6 @@
 
 import asyncio
 from concurrent import futures
-from typing import Dict, List, Optional, Set
 
 import abstracts
 
@@ -10,7 +9,7 @@ from aio.core.directory import ADirectory
 from aio.core.functional import async_property
 
 from envoy.base import utils
-from envoy.code.check import interface
+from envoy.code.check import interface, typing
 
 
 @abstracts.implementer(event.IExecutive)
@@ -20,18 +19,20 @@ class ACodeCheck(event.AExecutive, metaclass=abstracts.Abstraction):
             self,
             directory: ADirectory,
             fix: bool = False,
-            binaries: Optional[Dict[str, str]] = None,
-            loop: Optional[asyncio.AbstractEventLoop] = None,
-            pool: Optional[futures.Executor] = None) -> None:
+            binaries: dict[str, str] | None = None,
+            config: typing.YAMLConfigDict | None = None,
+            loop: asyncio.AbstractEventLoop | None = None,
+            pool: futures.Executor | None = None) -> None:
         self.directory = directory
+        self.config = config
         self._fix = fix
         self._loop = loop
         self._pool = pool
         self._binaries = binaries
 
     @property
-    def binaries(self):
-        return self._binaries
+    def binaries(self) -> dict[str, str]:
+        return self._binaries or {}
 
 
 @abstracts.implementer(interface.IFileCodeCheck)
@@ -39,11 +40,11 @@ class AFileCodeCheck(ACodeCheck, metaclass=abstracts.Abstraction):
 
     @async_property
     @abstracts.interfacemethod
-    async def checker_files(self) -> Set[str]:
+    async def checker_files(self) -> set[str]:
         raise NotImplementedError
 
     @async_property(cache=True)
-    async def files(self) -> Set[str]:
+    async def files(self) -> set[str]:
         files = await self.directory.files
         return (
             files & await self.checker_files
@@ -56,13 +57,13 @@ class AFileCodeCheck(ACodeCheck, metaclass=abstracts.Abstraction):
 
     @async_property
     @abstracts.interfacemethod
-    async def problem_files(self) -> Dict[str, List[str]]:
-        """Discovered files with flake8 errors."""
+    async def problem_files(self) -> dict[str, list[str]]:
+        """Discovered files with errors."""
         raise NotImplementedError
 
 
 @abstracts.implementer(interface.IProjectCodeCheck)
-class AProjectCodeCheck(ACodeCheck,  metaclass=abstracts.Abstraction):
+class AProjectCodeCheck(ACodeCheck, metaclass=abstracts.Abstraction):
 
     def __init__(
             self,

{envoy.code.check-0.5.13 → envoy_code_check-0.6.0}/envoy/code/check/abstract/changelog.py

@@ -2,7 +2,7 @@
 import itertools
 from datetime import datetime
 from functools import cached_property
-from typing import Iterator, Optional, Tuple, Type
+from collections.abc import Iterator
 
 from packaging import version as _version
 
@@ -30,7 +30,7 @@ class AChangelogChangesChecker(metaclass=abstracts.Abstraction):
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def change_checkers(self) -> Tuple[interface.IRSTCheck, ...]:
+    def change_checkers(self) -> tuple[interface.IRSTCheck, ...]:
         raise NotImplementedError
 
     @cached_property
@@ -41,7 +41,7 @@ class AChangelogChangesChecker(metaclass=abstracts.Abstraction):
             self,
             version: _version.Version,
             section: str,
-            entry: utils.typing.ChangeDict) -> Tuple[str, ...]:
+            entry: utils.typing.ChangeDict) -> tuple[str, ...]:
         change = entry["change"].strip()
         errors = [
             checker(change)
@@ -61,7 +61,7 @@ class AChangelogChangesChecker(metaclass=abstracts.Abstraction):
             self,
             version: _version.Version,
             section: str,
-            data: Optional[utils.typing.ChangeList]) -> Tuple[str, ...]:
+            data: utils.typing.ChangeList | None) -> tuple[str, ...]:
         name_error = self.check_section_name(version, section)
         return (
             *((name_error, )
@@ -76,7 +76,7 @@ class AChangelogChangesChecker(metaclass=abstracts.Abstraction):
             self,
             version: _version.Version,
             sections: utils.typing.ChangelogChangeSectionsDict) -> (
-                Tuple[str, ...]):
+                tuple[str, ...]):
         return tuple(
             itertools.chain.from_iterable(
                 self.check_section(version, section, data)  # type:ignore
@@ -86,7 +86,7 @@ class AChangelogChangesChecker(metaclass=abstracts.Abstraction):
     def check_section_name(
             self,
             version: _version.Version,
-            section: str) -> Optional[str]:
+            section: str) -> str | None:
         invalid_changes = (
             section == "changes"
             and version > self.max_version_for_changes_section)
@@ -137,7 +137,7 @@ class AChangelogStatus(metaclass=abstracts.Abstraction):
                 self.version).exists())
 
     @async_property(cache=True)
-    async def errors(self) -> Tuple[str, ...]:
+    async def errors(self) -> tuple[str, ...]:
         try:
             return (
                 *self.check_version(),
@@ -147,7 +147,7 @@ class AChangelogStatus(metaclass=abstracts.Abstraction):
             return (f"{self.version}: {e}", )
 
     @async_property
-    async def invalid_date(self) -> Optional[str]:
+    async def invalid_date(self) -> str | None:
         if await self.is_pending:
             return None
         date = await self.date
@@ -194,7 +194,7 @@ class AChangelogStatus(metaclass=abstracts.Abstraction):
             self.version
             > _version.Version(self.project.version.base_version))
 
-    async def check_date(self) -> Tuple[str, ...]:
+    async def check_date(self) -> tuple[str, ...]:
         errors = []
         if invalid_date := await self.invalid_date:
             errors.append(f"Format not recognized \"{invalid_date}\"")
@@ -207,7 +207,7 @@ class AChangelogStatus(metaclass=abstracts.Abstraction):
             for e
             in errors)
 
-    async def check_sections(self) -> Tuple[str, ...]:
+    async def check_sections(self) -> tuple[str, ...]:
         # Runs checker in executor, uncomment following line for debugging
         # return self.checker.check_sections(self.version, await self.sections)
         return await self.project.execute(
@@ -215,7 +215,7 @@ class AChangelogStatus(metaclass=abstracts.Abstraction):
             self.version,
             await self.sections)
 
-    def check_version(self) -> Tuple[str, ...]:
+    def check_version(self) -> tuple[str, ...]:
         errors = []
         if self.duplicate_current:
             errors.append(
@@ -245,7 +245,7 @@ class AChangelogCheck(
     @property  # type:ignore
     @abstracts.interfacemethod
     def changes_checker_class(
-            self) -> Type[interface.IChangelogChangesChecker]:
+            self) -> type[interface.IChangelogChangesChecker]:
         raise NotImplementedError
 
     @cached_property
@@ -255,11 +255,11 @@ class AChangelogCheck(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def changelog_status_class(self) -> Type[interface.IChangelogStatus]:
+    def changelog_status_class(self) -> type[interface.IChangelogStatus]:
         raise NotImplementedError
 
     @cached_property
-    def changelogs(self) -> Tuple[interface.IChangelogStatus, ...]:
+    def changelogs(self) -> tuple[interface.IChangelogStatus, ...]:
         return tuple(
             self.changelog_status_class(self, changelog)
             for changelog

{envoy.code.check-0.5.13 → envoy_code_check-0.6.0}/envoy/code/check/abstract/checker.py

@@ -4,8 +4,10 @@ import abc
 import argparse
 import pathlib
 import re
+from collections.abc import Mapping
 from functools import cached_property
-from typing import Dict, Mapping, Optional, Pattern, Set, Type
+
+import yaml
 
 from yamllint.config import YamlLintConfigError  # type:ignore
 
@@ -73,7 +75,7 @@ class ACodeChecker(
         return self.args.all_files
 
     @cached_property
-    def binaries(self) -> Dict[str, str]:
+    def binaries(self) -> dict[str, str]:
         return dict(
             binary.split(":")
             for binary
@@ -91,7 +93,7 @@ class ACodeChecker(
         return disabled
 
     @property
-    def changed_since(self) -> Optional[str]:
+    def changed_since(self) -> str | None:
         return self.args.since
 
     @cached_property
@@ -103,7 +105,7 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def changelog_class(self) -> Type["interface.IChangelogCheck"]:
+    def changelog_class(self) -> type["interface.IChangelogCheck"]:
         raise NotImplementedError
 
     @cached_property
@@ -114,6 +116,23 @@ class ACodeChecker(
             loop=self.loop,
             pool=self.pool)
 
+    @cached_property
+    def config(self) -> typing.YAMLConfigDict:
+        return (
+            yaml.safe_load(self.config_path.read_text())
+            if self.config_path
+            else {})
+
+    @property
+    def config_path(self) -> pathlib.Path | None:
+        if not self.args.config:
+            return None
+        path = pathlib.Path(self.args.config)
+        if not path.exists():
+            raise exceptions.ConfigurationError(
+                f"Config specified but not found: {path}")
+        return path
+
     @cached_property
     def directory(self) -> "_directory.ADirectory":
         """Greppable directory - optionally in a git repo, depending on whether
@@ -122,8 +141,8 @@ class ACodeChecker(
         return self.project.directory.filtered(**self.directory_kwargs)
 
     @property
-    def directory_kwargs(self) -> Dict:
-        kwargs: Dict = dict(
+    def directory_kwargs(self) -> dict:
+        kwargs: dict = dict(
             exclude_matcher=self.grep_excluding_re,
             path_matcher=self.grep_matching_re,
             untracked=self.all_files)
@@ -144,7 +163,7 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def extensions_class(self) -> Type["interface.IExtensionsCheck"]:
+    def extensions_class(self) -> type["interface.IExtensionsCheck"]:
         raise NotImplementedError
 
     @cached_property
@@ -154,17 +173,17 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def flake8_class(self) -> Type["interface.IFlake8Check"]:
+    def flake8_class(self) -> type["interface.IFlake8Check"]:
         raise NotImplementedError
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def fs_directory_class(self) -> Type["_directory.ADirectory"]:
+    def fs_directory_class(self) -> type["_directory.ADirectory"]:
         raise NotImplementedError
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def git_directory_class(self) -> Type["_directory.AGitDirectory"]:
+    def git_directory_class(self) -> type["_directory.AGitDirectory"]:
         raise NotImplementedError
 
     @cached_property
@@ -174,7 +193,7 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def glint_class(self) -> Type["interface.IGlintCheck"]:
+    def glint_class(self) -> type["interface.IGlintCheck"]:
         raise NotImplementedError
 
     @cached_property
@@ -184,15 +203,15 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def gofmt_class(self) -> Type["interface.IGofmtCheck"]:
+    def gofmt_class(self) -> type["interface.IGofmtCheck"]:
         raise NotImplementedError
 
     @property
-    def grep_excluding_re(self) -> Optional[Pattern[str]]:
+    def grep_excluding_re(self) -> re.Pattern[str] | None:
         return self._grep_re(self.args.excluding)
 
     @property
-    def grep_matching_re(self) -> Optional[Pattern[str]]:
+    def grep_matching_re(self) -> re.Pattern[str] | None:
         return self._grep_re(self.args.matching)
 
     @property
@@ -206,19 +225,19 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def project_class(self) -> Type[IProject]:
+    def project_class(self) -> type[IProject]:
         raise NotImplementedError
 
     @cached_property
     def runtime_guards(self) -> "interface.IRuntimeGuardsCheck":
-        """Shellcheck checker."""
+        """Runtime guards checker."""
         return self.runtime_guards_class(
             self.project,
             **self.check_kwargs)
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def runtime_guards_class(self) -> Type["interface.IRuntimeGuardsCheck"]:
+    def runtime_guards_class(self) -> type["interface.IRuntimeGuardsCheck"]:
         raise NotImplementedError
 
     @cached_property
@@ -228,11 +247,11 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def shellcheck_class(self) -> Type["interface.IShellcheckCheck"]:
+    def shellcheck_class(self) -> type["interface.IShellcheckCheck"]:
         raise NotImplementedError
 
     @property
-    def summary_class(self) -> Type[CodeCheckerSummary]:
+    def summary_class(self) -> type[CodeCheckerSummary]:
         """CodeChecker's summary class."""
         return CodeCheckerSummary
 
@@ -243,7 +262,7 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def yamllint_class(self) -> Type[interface.IYamllintCheck]:
+    def yamllint_class(self) -> type[interface.IYamllintCheck]:
         raise NotImplementedError
 
     @cached_property
@@ -253,7 +272,7 @@ class ACodeChecker(
 
     @property  # type:ignore
     @abstracts.interfacemethod
-    def yapf_class(self) -> Type[interface.IYapfCheck]:
+    def yapf_class(self) -> type[interface.IYapfCheck]:
         raise NotImplementedError
 
     def add_arguments(self, parser: argparse.ArgumentParser) -> None:
@@ -263,6 +282,11 @@ class ACodeChecker(
         parser.add_argument("-x", "--excluding", action="append")
         parser.add_argument("-b", "--binary", action="append")
         parser.add_argument("-s", "--since")
+        parser.add_argument(
+            "--config",
+            default="./tools/code/config.yaml",
+            help=("specify the config path. "
+                  "Default './tools/code/config.yaml'."))
         parser.add_argument("--codeowners")
         parser.add_argument("--owners")
         parser.add_argument("--extensions_build_config")
@@ -278,7 +302,7 @@ class ACodeChecker(
                     [f"{changelog.version}"])
 
     async def check_extensions_fuzzed(self) -> None:
-        """Check for glint issues."""
+        """Check that all fuzzed extensions are accounted for."""
         if await self.extensions.all_fuzzed:
             self.succeed(
                 "extensions_fuzzed",
@@ -291,7 +315,7 @@ class ACodeChecker(
                  f"in {self.extensions.fuzz_test_path}"])
 
     async def check_extensions_metadata(self) -> None:
-        """Check for glint issues."""
+        """Check extensions metadata."""
         errors = await self.extensions.metadata_errors
         for extension, errors in errors.items():
             if errors:
@@ -300,7 +324,7 @@ class ACodeChecker(
                 self.succeed("extensions_metadata", [f"{extension}"])
 
     async def check_extensions_owners(self) -> None:
-        """Check for glint issues."""
+        """Check extensions owners."""
         checks = await self.extensions.owners_errors
         for extension, errors in sorted(checks.items()):
             if errors:
@@ -309,7 +333,7 @@ class ACodeChecker(
                 self.succeed("extensions_owners", [f"{extension}"])
 
     async def check_extensions_registered(self) -> None:
-        """Check for glint issues."""
+        """Check extensions are registered."""
         if errors := await self.extensions.registration_errors:
             self.error("extensions_registered", errors)
         else:
@@ -335,7 +359,8 @@ class ACodeChecker(
         await self._code_check(self.yapf)
 
     async def check_runtime_guards(self) -> None:
-        """Check for shellcheck issues."""
+        """Check runtime guards."""
+
         async for guard, status in self.runtime_guards.status:
             if status is None:
                 self.log.info(f"Ignoring runtime guard: {guard}")
@@ -427,7 +452,7 @@ class ACodeChecker(
 
     def _check_output(
             self,
-            check_files: Set[str],
+            check_files: set[str],
             problem_files: typing.ProblemDict) -> None:
         # This can be slow/blocking for large result sets, run
         # in a separate thread
@@ -453,7 +478,7 @@ class ACodeChecker(
             await check.files,
             await check.problem_files)
 
-    def _grep_re(self, arg: Optional[str]) -> Optional[Pattern[str]]:
+    def _grep_re(self, arg: str | None) -> re.Pattern[str] | None:
         # When using system `grep` we want to filter out at least some
         # of the files that .gitignore would.
         # TODO: use globs on cli and covert to re here