libs: Add envoy.code.check[version_history]

Signed-off-by: Ryan Northey <ryan@synca.io>

Author: phlax

envoy.code.check/envoy/code/check/BUILD

@@ -7,6 +7,7 @@ pytooling_library(
         "//deps:aio.run.checker",
         "//deps:envoy.base.utils",
         "//deps:flake8",
+        "//deps:packaging",
         "//deps:yapf",
     ],
     sources=[
@@ -17,7 +18,9 @@ pytooling_library(
         "abstract/extensions.py",
         "abstract/flake8.py",
         "abstract/glint.py",
+        "abstract/project.py",
         "abstract/shellcheck.py",
+        "abstract/version_history.py",
         "abstract/yapf.py",
         "checker.py",
         "cmd.py",

envoy.code.check/envoy/code/check/__init__.py

@@ -8,13 +8,15 @@
     AFileCodeCheck,
     AGlintCheck,
     AShellcheckCheck,
+    AVersionHistoryCheck,
     AYapfCheck)
 from .checker import (
     CodeChecker,
     ExtensionsCheck,
     Flake8Check,
     GlintCheck,
     ShellcheckCheck,
+    VersionHistoryCheck,
     YapfCheck)
 from .cmd import run, main
 from . import checker
@@ -29,6 +31,7 @@
     "AFlake8Check",
     "AGlintCheck",
     "AShellcheckCheck",
+    "AVersionHistoryCheck",
     "AYapfCheck",
     "checker",
     "CodeChecker",
@@ -42,4 +45,5 @@
     "run",
     "ShellcheckCheck",
     "typing",
+    "VersionHistoryCheck",
     "YapfCheck")

envoy.code.check/envoy/code/check/abstract/__init__.py

@@ -5,6 +5,7 @@
 from .flake8 import AFlake8Check
 from .glint import AGlintCheck
 from .shellcheck import AShellcheckCheck
+from .version_history import AVersionHistoryCheck
 from .yapf import AYapfCheck
 from . import (
     base,
@@ -13,6 +14,7 @@
     flake8,
     glint,
     shellcheck,
+    version_history,
     yapf)
 
 
@@ -24,11 +26,13 @@
     "AFlake8Check",
     "AGlintCheck",
     "AShellcheckCheck",
+    "AVersionHistoryCheck",
     "AYapfCheck",
     "base",
     "checker",
     "flake8",
     "glint",
     "extensions",
     "shellcheck",
+    "version_history",
     "yapf")

envoy.code.check/envoy/code/check/abstract/checker.py

@@ -12,6 +12,7 @@
 from aio.core import directory as _directory, event, subprocess
 from aio.run import checker
 
+from envoy.base.utils import IProject
 from envoy.code.check import abstract, typing
 
 
@@ -51,13 +52,16 @@ class ACodeChecker(
     """Code checker."""
 
     checks = (
+        "changelogs_changes",
+        "changelogs_pending",
         "extensions_fuzzed",
         "extensions_metadata",
         "extensions_registered",
         "glint",
         "python_yapf",
         "python_flake8",
-        "shellcheck")
+        "shellcheck",
+        "version")
 
     @property
     def all_files(self) -> bool:
@@ -177,6 +181,15 @@ def grep_matching_re(self) -> Optional[Pattern[str]]:
     def path(self) -> pathlib.Path:
         return super().path
 
+    @cached_property
+    def project(self) -> IProject:
+        return self.project_class(self.path)
+
+    @property  # type:ignore
+    @abstracts.interfacemethod
+    def project_class(self) -> Type[IProject]:
+        raise NotImplementedError
+
     @cached_property
     def shellcheck(self) -> "abstract.AShellcheckCheck":
         """Shellcheck checker."""
@@ -192,6 +205,17 @@ def summary_class(self) -> Type[CodeCheckerSummary]:
         """CodeChecker's summary class."""
         return CodeCheckerSummary
 
+    @cached_property
+    def version_history(self) -> "abstract.AVersionHistoryCheck":
+        """VERSION_HISTORY checker."""
+        return self.version_history_class(
+            self.project, self.directory, fix=self.fix)
+
+    @property  # type:ignore
+    @abstracts.interfacemethod
+    def version_history_class(self) -> Type["abstract.AVersionHistoryCheck"]:
+        raise NotImplementedError
+
     @cached_property
     def yapf(self) -> "abstract.AYapfCheck":
         """YAPF checker."""
@@ -210,6 +234,45 @@ def add_arguments(self, parser: argparse.ArgumentParser) -> None:
         parser.add_argument("-s", "--since")
         parser.add_argument("--extensions_build_config")
 
+    async def check_changelogs_changes(self):
+        for changelog in self.project.changelogs.values():
+            errors = self.version_history.version_file(
+                self.project, changelog).run_checks()
+            if errors:
+                self.error("changelogs_changes", errors)
+            else:
+                self.succeed(
+                    "changelogs_changes",
+                    [f"{changelog.version}"])
+
+    async def check_changelogs_pending(self):
+        pending = [
+            k.base_version
+            for k, v in self.project.changelogs.items()
+            if v.release_date == "Pending"]
+        all_good = (
+            not pending
+            or (self.project.is_dev
+                and (pending
+                     == [self.project.version.base_version])))
+        if all_good:
+            self.succeed(
+                "changelog_pending",
+                ["No extraneous pending versions found"])
+            return
+        pending = [
+            x for x
+            in pending
+            if x != self.project.version.base_version]
+        if self.project.is_dev:
+            self.error(
+                "changelog_pending",
+                [f"Only current version should be pending, found: {pending}"])
+        else:
+            self.error(
+                "changelog_pending",
+                [f"Nothing should be pending, found: {pending}"])
+
     async def check_extensions_fuzzed(self) -> None:
         """Check for glint issues."""
         if self.extensions.all_fuzzed:
@@ -258,6 +321,44 @@ async def check_shellcheck(self) -> None:
         """Check for shellcheck issues."""
         await self._code_check(self.shellcheck)
 
+    async def check_version(self) -> None:
+        is_current = self.project.is_current(
+            self.project.changelogs.current)
+        if is_current:
+            self.succeed(
+                "version",
+                ["VERSION.txt version matches most recent changelog"])
+        else:
+            self.error(
+                "version",
+                ["VERSION.txt does not match most recent changelog"])
+        not_pending = (
+            self.project.is_dev
+            and not self.project.changelogs.is_pending)
+        not_dev = (
+            not self.project.is_dev
+            and self.project.changelogs.is_pending)
+        if not_pending:
+            self.error(
+                "version",
+                ["VERSION.txt is set to `-dev` but most recent changelog "
+                 "is not `Pending`"])
+        elif not_dev:
+            self.error(
+                "version",
+                ["VERSION.txt is not set to `-dev` but most recent changelog "
+                 "is `Pending`"])
+        elif self.project.is_dev:
+            self.succeed(
+                "version",
+                ["VERSION.txt is set to `-dev` and most recent changelog "
+                 "is `Pending`"])
+        else:
+            self.succeed(
+                "version",
+                ["VERSION.txt is not set to `-dev` and most recent "
+                 "changelog is not `Pending`"])
+
     @checker.preload(
         when=["python_flake8"],
         catches=[subprocess.exceptions.OSCommandError])