lennybot 1.0.28__tar.gz → 1.0.33__tar.gz

{lennybot-1.0.28 → lennybot-1.0.33}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: lennybot
-Version: 1.0.28
+Version: 1.0.33
 Summary: Automatic Updates for Kustomize Resources
 Home-page: http://github.com/raynigon/lennybot
 Author: Simon Schneider
@@ -23,6 +23,7 @@ Requires-Dist: yamlpath
 Requires-Dist: requests
 Requires-Dist: GitPython
 Requires-Dist: PyGithub
+Requires-Dist: jsonpath-ng
 Provides-Extra: dev
 Requires-Dist: setuptools; extra == "dev"
 Requires-Dist: wheel; extra == "dev"
@@ -30,6 +31,19 @@ Requires-Dist: black; extra == "dev"
 Provides-Extra: test
 Requires-Dist: coverage; extra == "test"
 Requires-Dist: pytest; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 [![PyPI](https://badge.fury.io/py/lennybot.svg)](https://pypi.org/project/lennybot/)
 # lennybot
@@ -64,7 +78,13 @@ The lennybot allows to define multiple applications.
 Each application has to have a version source, which can be queried to determine the latest version.
 If a newer version is available, the lennybot executes multiple pre defined actions per application.
 E.g. Update Docker Image Tags.
-The applications, sources and actions can be configured in the `config.yml` file.
+Sometimes there are conditions which need to be fulfilled before the action can be executed.
+These conditions can be specified as checks.
+E.g. Check if the docker image is available in the registry, because sometimes a new version of an applications gets released, but the docker image is not available yet.
+
+![A graph showing the process of updating applications by the lennybot](./docs/LennyBot-Execution.drawio.png)
+
+The applications, sources, checks and actions can be configured in the `config.yml` file.
 For more information see below.
 
 ## Configuration
@@ -85,19 +105,16 @@ Each section represents a configuration object.
 
 | Path                                       | Description                                                            |
 |--------------------------------------------|------------------------------------------------------------------------|
-| state.file                                 | The state file which is used to store the version of each application  |
 | state.pr.enabled                           | Toggle PR creation in CI mode. Has to be either true or false          |
 | state.pr.repository                        | The name of the repository in github on which the PR should be created |
 | state.pr.branchPrefix                      | Prefix for the branch name which should be used to create the PRs      |
 
 ### Applications
 
-| Path                                       | Description                                                                                                                                |
+| Property                                   | Description                                                                                                                                |
 |--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
 | applications[*].name                       | The name of the application which should be updated                                                                                        |
-| applications[*].source.type                | The source has to be either of the type "github" or of the type "github-query". See below for details. |
-| applications[*].source.repository          | The GitHub Repository which should be used to determine the latest version                    |
-| applications[*].source.regex               | The regex pattern which is used to extract the semver version code from the tag value         |
+| applications[*].source                     | The configuration for the source of the latest version. This is specific to the type of source, see below for the diffrent source types.   |
 | applications[\*].actions[\*].type          | The action has to be one of these types "image-tag-update", "download-resources" or "update-yaml". See below for details. |
 | applications[\*].actions[\*].url           |                                                                                                                                            |
 | applications[\*].actions[\*].target        |                                                                                                                                            |
@@ -108,21 +125,61 @@ Each section represents a configuration object.
 | applications[\*].actions[\*].yamlPath      |                                                                                                                                            |
 | applications[\*].actions[\*].valuePattern  |                                                                                                                                            |
 
+### Sources
+
 #### GitHub Source
+
 <TODO>
 
+| Property             | Description                                                                                                                                |
+|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
+| .type                | The source has to be either of the type "github" or of the type "github-query". See below for details.                                     |
+| .repository          | The GitHub Repository which should be used to determine the latest version                                                                 |
+| .regex               | The regex pattern which is used to extract the semver version code from the tag value                                                      |
+
+
 #### GitHub Query Source
+
+<TODO>
+
+| Property             | Description                                                                                                                                |
+|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
+| .type                | The source has to be either of the type "github" or of the type "github-query". See below for details.                                     |
+| .repository          | The GitHub Repository which should be used to determine the latest version                                                                 |
+| .regex               | The regex pattern which is used to extract the semver version code from the tag value                                                      |
+
+
+### Checks
+
 <TODO>
 
+
+### Actions
+
 #### Image Tag Update Action
 <TODO>
 
+| Property                                   | Description                                                                                                                                |
+|--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
+| .type          | The action has to be one of these types "image-tag-update", "download-resources" or "update-yaml". See below for details. |
+| .url           |                                                                                                                                            |
+| .target        |                                                                                                                                            |
+| .image         |                                                                                                                                            |
+| .kustomizePath |                                                                                                                                            |
+| .tagPattern    |                                                                                                                                            |
+| .targetFile    |                                                                                                                                            |
+| .yamlPath      |                                                                                                                                            |
+| .valuePattern  |                                                                                                                                            |
+
 #### Download Resource Action
 <TODO>
 
 #### Update YAML Action
 <TODO>
 
+#### Update JSON Action
+<TODO>
+
 #### Update Dockerfile Action
 <TODO>
 

{lennybot-1.0.28 → lennybot-1.0.33}/README.md

@@ -31,7 +31,13 @@ The lennybot allows to define multiple applications.
 Each application has to have a version source, which can be queried to determine the latest version.
 If a newer version is available, the lennybot executes multiple pre defined actions per application.
 E.g. Update Docker Image Tags.
-The applications, sources and actions can be configured in the `config.yml` file.
+Sometimes there are conditions which need to be fulfilled before the action can be executed.
+These conditions can be specified as checks.
+E.g. Check if the docker image is available in the registry, because sometimes a new version of an applications gets released, but the docker image is not available yet.
+
+![A graph showing the process of updating applications by the lennybot](./docs/LennyBot-Execution.drawio.png)
+
+The applications, sources, checks and actions can be configured in the `config.yml` file.
 For more information see below.
 
 ## Configuration
@@ -52,19 +58,16 @@ Each section represents a configuration object.
 
 | Path                                       | Description                                                            |
 |--------------------------------------------|------------------------------------------------------------------------|
-| state.file                                 | The state file which is used to store the version of each application  |
 | state.pr.enabled                           | Toggle PR creation in CI mode. Has to be either true or false          |
 | state.pr.repository                        | The name of the repository in github on which the PR should be created |
 | state.pr.branchPrefix                      | Prefix for the branch name which should be used to create the PRs      |
 
 ### Applications
 
-| Path                                       | Description                                                                                                                                |
+| Property                                   | Description                                                                                                                                |
 |--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
 | applications[*].name                       | The name of the application which should be updated                                                                                        |
-| applications[*].source.type                | The source has to be either of the type "github" or of the type "github-query". See below for details. |
-| applications[*].source.repository          | The GitHub Repository which should be used to determine the latest version                    |
-| applications[*].source.regex               | The regex pattern which is used to extract the semver version code from the tag value         |
+| applications[*].source                     | The configuration for the source of the latest version. This is specific to the type of source, see below for the diffrent source types.   |
 | applications[\*].actions[\*].type          | The action has to be one of these types "image-tag-update", "download-resources" or "update-yaml". See below for details. |
 | applications[\*].actions[\*].url           |                                                                                                                                            |
 | applications[\*].actions[\*].target        |                                                                                                                                            |
@@ -75,21 +78,61 @@ Each section represents a configuration object.
 | applications[\*].actions[\*].yamlPath      |                                                                                                                                            |
 | applications[\*].actions[\*].valuePattern  |                                                                                                                                            |
 
+### Sources
+
 #### GitHub Source
+
 <TODO>
 
+| Property             | Description                                                                                                                                |
+|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
+| .type                | The source has to be either of the type "github" or of the type "github-query". See below for details.                                     |
+| .repository          | The GitHub Repository which should be used to determine the latest version                                                                 |
+| .regex               | The regex pattern which is used to extract the semver version code from the tag value                                                      |
+
+
 #### GitHub Query Source
+
+<TODO>
+
+| Property             | Description                                                                                                                                |
+|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
+| .type                | The source has to be either of the type "github" or of the type "github-query". See below for details.                                     |
+| .repository          | The GitHub Repository which should be used to determine the latest version                                                                 |
+| .regex               | The regex pattern which is used to extract the semver version code from the tag value                                                      |
+
+
+### Checks
+
 <TODO>
 
+
+### Actions
+
 #### Image Tag Update Action
 <TODO>
 
+| Property                                   | Description                                                                                                                                |
+|--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
+| .type          | The action has to be one of these types "image-tag-update", "download-resources" or "update-yaml". See below for details. |
+| .url           |                                                                                                                                            |
+| .target        |                                                                                                                                            |
+| .image         |                                                                                                                                            |
+| .kustomizePath |                                                                                                                                            |
+| .tagPattern    |                                                                                                                                            |
+| .targetFile    |                                                                                                                                            |
+| .yamlPath      |                                                                                                                                            |
+| .valuePattern  |                                                                                                                                            |
+
 #### Download Resource Action
 <TODO>
 
 #### Update YAML Action
 <TODO>
 
+#### Update JSON Action
+<TODO>
+
 #### Update Dockerfile Action
 <TODO>
 

{lennybot-1.0.28 → lennybot-1.0.33}/pyproject.toml

@@ -22,3 +22,6 @@ executionEnvironments = [
   { root = "src/test", extraPaths = ["src/test/config", "src/test/grafana" ]},
   { root = "src" }
 ]
+
+[tool.ruff]
+ignore = ["F401"]

{lennybot-1.0.28 → lennybot-1.0.33}/requirements.txt

@@ -3,3 +3,4 @@ yamlpath
 requests
 GitPython
 PyGithub
+jsonpath-ng

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot/__init__.py

@@ -91,6 +91,6 @@ def main() -> int:
         result = app.apply(plan)
         app.ci_finalize(plan, result)
     else:
-        logging.error("Unexpected Arguments", args)
+        logging.error("Unexpected Arguments: %s", args)
         return 1
     return 0

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot/actions/__init__.py

@@ -1,8 +1,9 @@
-from .download_resources import DownloadResourcesAction
+from .download_resources import DownloadResourceAction
 from .iaction import IAction
 from .remove_checksums import RemoveChecksumsAction
 from .update_dockerfile import UpdateDockerfileAction
 from .update_image_tag import UpdateImageTagAction
+from .update_json import UpdateJsonAction
 from .update_yaml import UpdateYamlAction
 
 
@@ -10,8 +11,10 @@ def create_action(name, source_version, latest_version, config) -> IAction:
     action_type = config.type
     if action_type == "image-tag-update":
         return UpdateImageTagAction(name, source_version, latest_version, config)
-    if action_type == "download-resources":
-        return DownloadResourcesAction(name, source_version, latest_version, config)
+    if action_type in ["download-resource", "download-resources"]:
+        return DownloadResourceAction(name, source_version, latest_version, config)
+    if action_type == "update-json":
+        return UpdateJsonAction(name, source_version, latest_version, config)
     if action_type == "update-yaml":
         return UpdateYamlAction(name, source_version, latest_version, config)
     if action_type == "update-dockerfile":

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot/actions/download_resources.py

@@ -1,11 +1,14 @@
+import logging
+
 import requests
 
 from ..config.config import LennyBotActionConfig
 from .iaction import IAction
 
 
-class DownloadResourcesAction(IAction):
+class DownloadResourceAction(IAction):
     def __init__(self, name, source_version, target_version, config: LennyBotActionConfig) -> None:
+        self._log = logging.getLogger(self.__class__.__name__)
         self._name = name
         self._source_version = source_version
         self._target_version = target_version
@@ -30,8 +33,14 @@ class DownloadResourcesAction(IAction):
 
     def run(self):
         download_url = self._url.replace("{{version}}", self._target_version)
+        self._log.debug("Downloading resource from %s to %s", download_url, self._target_path)
         response = requests.get(download_url)
         if response.status_code != 200:
-            raise Exception("Unable to download resources")
+            self._log.error(
+                "Unable to download resource, received status code: %d\n%s", response.status_code, response.text
+            )
+            raise Exception("Unable to download resource, received status code: " + str(response.status_code))
+        self._log.debug("Downloaded resources successfully")
         with open(self._target_path, "w", encoding="utf-8") as file_ptr:
             file_ptr.write(response.text)
+        self._log.debug("Saved resource to %s", self._target_path)

lennybot-1.0.33/src/lennybot/actions/update_json.py

@@ -0,0 +1,48 @@
+import json
+
+from jsonpath_ng import parse
+
+from ..config.config import LennyBotActionConfig
+from .iaction import IAction
+
+
+class UpdateJsonAction(IAction):
+    def __init__(self, name, source_version, target_version, config: LennyBotActionConfig) -> None:
+        self._name = name
+        self._source_version = source_version
+        self._target_version = target_version
+        if config.target_file is None:
+            raise Exception("Target file is not set for application " + name)
+        self._target_file = config.target_file
+        if config.json_path is None:
+            raise Exception("JSON Path is not set for application " + name)
+        self._json_path = parse(config.json_path)
+        if config.value_pattern is not None:
+            self._value_pattern = config.value_pattern
+        else:
+            self._value_pattern = "{{version}}"
+
+    @property
+    def application(self) -> str:
+        return self._name
+
+    @property
+    def source_version(self) -> str:
+        return self._source_version
+
+    @property
+    def target_version(self) -> str:
+        return self._target_version
+
+    def run(self):
+        # Read the JSON data from the file
+        with open(self._target_file, "r", encoding="utf-8") as file_ptr:
+            json_data = json.load(file_ptr)
+        # Update the value in the JSON data
+        self._json_path.update(json_data, self._create_value())
+        # Write the updated JSON data back to the file
+        with open(self._target_file, "w", encoding="utf-8") as file_ptr:
+            json.dump(json_data, fp=file_ptr, indent=4)
+
+    def _create_value(self):
+        return self._value_pattern.replace("{{version}}", self._target_version)

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot/check/__init__.py

@@ -1,5 +1,4 @@
-from lennybot.config.config import LennyBotConfig
-
+from ..config.config import LennyBotConfig
 from .docker_image_available import DockerImageAvailableCheck
 from .icheck import ICheck
 

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot/check/docker_image_available.py

@@ -5,10 +5,10 @@ from urllib.parse import urlencode
 
 import requests
 
-from ..config.config import LennyBotCheckConfig, LennyBotConfigContainerConfig, LennyBotConfigContainerRegistry
+from ..config.config import LennyBotCheckConfig, LennyBotConfigContainerConfig
 from .icheck import ICheck
 
-PATTERN = r"(?:([\-\_\.\w]+)$)|(?:([\-\_\.\w]+)/([\-\_\.\w]+)$)|(?:([\-\.A-z0-9]+)/([\-\_\.\w]+)/([\-\_\.\w]+)$)|(?:([\-\.A-z0-9]+)/([\-\_\.\w]+)/([\-\_\.\w]+)/([\-\_\.\w]+)$)"
+PATTERN = r"(?:([\-\_\.\w]+)$)|(?:([\-\_\.\w]+)/([\-\_\.\w]+)$)|(?:([\-\.A-z0-9]+)/([\-\_\.\w]+)/([\-\_\.\w]+)$)|(?:([\-\.A-z0-9]+)/([\-\_\.\w]+)/([\-\_\.\w]+)/([\-\_\.\w]+)$)|(?:([\-\.A-z0-9]+)/([\-\.A-z0-9]+)/([\-\_\.\w]+)/([\-\_\.\w]+)/([\-\_\.\w]+)$)"
 
 
 class DockerImage:
@@ -34,6 +34,7 @@ class WwwAuthenticateHeader:
 
 
 class DockerImageAvailableCheck(ICheck):
+    # pylint: disable=too-many-positional-arguments
     def __init__(
         self,
         application_name,
@@ -103,9 +104,27 @@ class DockerImageAvailableCheck(ICheck):
                 + image_tag
             )
             return DockerImage(match.group(4), match.group(5) + "/" + match.group(6), image_tag)
+        if match.group(7) is not None:
+            logging.debug(
+                "regex matched following pattern: "
+                + match.group(7)
+                + "/"
+                + match.group(8)
+                + "/"
+                + match.group(9)
+                + "/"
+                + match.group(10)
+                + " "
+                + image_tag
+            )
+            return DockerImage(
+                match.group(7),
+                match.group(8) + "/" + match.group(9) + "/" + match.group(10),
+                image_tag,
+            )
         return DockerImage(
-            match.group(7),
-            match.group(8) + "/" + match.group(9) + "/" + match.group(10),
+            match.group(11),
+            match.group(12) + "/" + match.group(13) + "/" + match.group(14) + "/" + match.group(15),
             image_tag,
         )
 

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot/config/config.py

@@ -1,6 +1,6 @@
 import logging
 import os
-from typing import Any, Dict, List, Optional
+from typing import Dict, List, Optional
 
 import yaml
 
@@ -67,6 +67,7 @@ CONFIGURATION_OPTIONS = {
                         "required": True,
                         "attribute": "_repository",
                     },
+                    "ltsOnly": {"type": "bool", "required": False, "attribute": "_lts_only"},
                     "regex": {"type": "string", "attribute": "_regex"},
                 },
             },
@@ -92,6 +93,7 @@ CONFIGURATION_OPTIONS = {
                     "target": {"type": "string", "attribute": "_target"},
                     "targetFile": {"type": "string", "attribute": "_target_file"},
                     "yamlPath": {"type": "string", "attribute": "_yaml_path"},
+                    "jsonPath": {"type": "string", "attribute": "_json_path"},
                     "valuePattern": {"type": "string", "attribute": "_value_pattern"},
                 },
             },
@@ -105,6 +107,8 @@ class LennyBotSourceConfig:
         self._type = None
         self._repository = None
         self._regex = None
+        self._source_url = None
+        self._lts_only = None
 
     @property
     def type(self) -> str:
@@ -118,6 +122,18 @@ class LennyBotSourceConfig:
     def regex(self) -> str:
         return str(self._regex)
 
+    @property
+    def source_url(self) -> str:
+        return str(self._source_url)
+
+    @property
+    def lts_only(self) -> bool:
+        return bool(self._lts_only)
+
+    @lts_only.setter
+    def lts_only(self, value: bool) -> None:
+        self._lts_only = value
+
 
 class LennyBotCheckConfig:
     def __init__(self) -> None:
@@ -143,6 +159,7 @@ class LennyBotActionConfig:
         self._url = None
         self._target_file = None
         self._yaml_path = None
+        self._json_path = None
         self._value_pattern = None
 
     @property
@@ -173,6 +190,10 @@ class LennyBotActionConfig:
     def target_file(self) -> str | None:
         return self._target_file
 
+    @property
+    def json_path(self) -> str | None:
+        return self._json_path
+
     @property
     def yaml_path(self) -> str | None:
         return self._yaml_path

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot/helper/__init__.py

@@ -4,5 +4,5 @@ def semver_2_vc(version):
     parts = version.split(".")
     version_code = 0
     for part in parts:
-        version_code = version_code * 100 + int(part)
+        version_code = version_code * 1000 + int(part)
     return version_code

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot/lennybot.py

@@ -47,7 +47,7 @@ class LennyBot:
             pickle.dump(plan, file_ptr)
 
     def ci_setup(self):
-        self._log.debug(f"Setup CI")
+        self._log.debug("Setup CI")
         now = datetime.now().strftime("%Y%m%d%H%M%S")
         self._branch_name = f"{self._config.github_pr.branch_prefix}"
         if not self._branch_name.endswith("-"):
@@ -58,14 +58,14 @@ class LennyBot:
         if result != 0:
             self._log.error("Unexpected return code from git config")
         self._repo = Repo("./", odbt=GitDB)  # type: ignore
-        self._log.debug(f"Initialized repository")
+        self._log.debug("Initialized repository")
         head = self._repo.create_head(self._branch_name)
-        self._log.debug(f"Created Head")
+        self._log.debug("Created Head")
         head.checkout()
         self._log.info(f"Working branch is {self._branch_name}")
 
     def ci_finalize(self, plan: LennyBotPlan, result):
-        self._log.debug(f"Finalize CI")
+        self._log.debug("Finalize CI")
         if self._repo is None:
             raise Exception("Repository is non, ci_setup was not called")
         if not self._repo.index.diff(None) and not self._repo.untracked_files:

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot/model/plan.py

@@ -1,4 +1,4 @@
-from typing import Any, List
+from typing import List
 
 from ..actions.iaction import IAction
 from ..model.state import LennyBotState

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot/service/apply.py

@@ -1,5 +1,4 @@
 import logging
-from typing import List
 
 from ..model.plan import LennyBotPlan
 

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot/service/github.py

@@ -34,7 +34,9 @@ class GitHubService:
         if self._github is None:
             raise Exception("GitHub is not configured")
         repo = self._github.get_repo(self._config.github_pr.repository)
-        new_pull = repo.create_pull(repo.default_branch, branch_name, title=title, body=body)
+        new_pull = repo.create_pull(
+            repo.default_branch, branch_name, title=title, body=body
+        )  # pyright: ignore [reportCallIssue]
         labels = self._get_or_create_labels(repo)
         new_pull.add_to_labels(*labels)
         pulls = self._find_own_pulls()
@@ -59,7 +61,7 @@ class GitHubService:
         return result
 
     def _headers(self) -> Dict:
-        headers = {}
+        headers = {"X-GitHub-Api-Version": "2022-11-28"}
         if self._token is not None:
             headers["Authorization"] = f"Bearer {self._token}"
         return headers

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot/service/plan.py

@@ -1,9 +1,8 @@
 import logging
 from typing import List
 
-from lennybot.check import create_check
-
 from ..actions import IAction, create_action
+from ..check import create_check
 from ..config import LennyBotAppConfig, LennyBotConfig
 from ..helper import semver_2_vc
 from ..model import LennyBotPlan, LennyBotState
@@ -49,6 +48,12 @@ class LennyBotApplication:
         latest_vc = semver_2_vc(self._latest_version)
 
         if current_vc >= latest_vc:
+            self._log.warning(
+                "For '%s' the current version '%s' is greater than '%s'. Downgrades are not supported",
+                self._name,
+                self._current_version,
+                self._latest_version,
+            )
             return False
 
         for check in self._checks:

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot/service/source/__init__.py

@@ -2,6 +2,7 @@ from ...config import LennyBotSourceConfig
 from .isource import ISource
 from .source_github import GithubSource
 from .source_github_query import GithubQuerySource
+from .source_nodejs import NodeJSVersionSource
 
 
 def create_source(name, config: LennyBotSourceConfig, github) -> ISource:
@@ -10,4 +11,6 @@ def create_source(name, config: LennyBotSourceConfig, github) -> ISource:
         return GithubSource(name, config, github)
     if source_type == "github-query":
         return GithubQuerySource(name, config, github)
+    if source_type == "nodejs-version":
+        return NodeJSVersionSource(name, config)
     raise Exception(f"Unknown Source Type: {source_type}")

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot/service/source/source_github.py

@@ -1,7 +1,5 @@
 import re
 
-import requests
-
 from ...config import LennyBotSourceConfig
 from ..github import GitHubService
 from .isource import ISource

lennybot-1.0.33/src/lennybot/service/source/source_nodejs.py

@@ -0,0 +1,57 @@
+from typing import Any
+
+import requests
+
+from ...config import LennyBotSourceConfig
+from .isource import ISource
+
+NODEJS_ORG_VERSIONS_URL = "https://nodejs.org/dist/index.json"
+
+
+class NodeJSVersionNotFoundException(Exception):
+    def __init__(self, data: Any, *args: object) -> None:
+        super().__init__(*args)
+        self._data = data
+
+
+class NodeJSFormatException(Exception):
+    def __init__(self, *args: object) -> None:
+        super().__init__(*args)
+
+
+class NodeJSVersionSource(ISource):
+    def __init__(self, name, config: LennyBotSourceConfig) -> None:
+        self._name = name
+        self._lts_only = config.lts_only
+        self._source_url = config.source_url
+
+    @property
+    def application(self) -> str:
+        return self._name
+
+    def latest_version(self) -> str:
+        headers = {"user-agent": "lennybot/0.0.1"}
+        response = requests.get(NODEJS_ORG_VERSIONS_URL, headers=headers)
+        response.raise_for_status()
+
+        releases = response.json()
+        sorted(releases, key=lambda x: x["version"])
+        for release in releases:
+            if not self._lts_only:
+                return self._extract_semver_version(release)
+            if release["lts"]:
+                return self._extract_semver_version(release)
+
+        raise NodeJSVersionNotFoundException(releases)
+
+    def _extract_semver_version(self, release) -> str:
+        if "version" not in release.keys():
+            raise NodeJSFormatException("Missing version field in release")
+        version = release["version"]
+
+        if not version.startswith("v"):
+            raise NodeJSFormatException("Invalid version format")
+
+        version = version.replace("v", "")
+
+        return version

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: lennybot
-Version: 1.0.28
+Version: 1.0.33
 Summary: Automatic Updates for Kustomize Resources
 Home-page: http://github.com/raynigon/lennybot
 Author: Simon Schneider
@@ -23,6 +23,7 @@ Requires-Dist: yamlpath
 Requires-Dist: requests
 Requires-Dist: GitPython
 Requires-Dist: PyGithub
+Requires-Dist: jsonpath-ng
 Provides-Extra: dev
 Requires-Dist: setuptools; extra == "dev"
 Requires-Dist: wheel; extra == "dev"
@@ -30,6 +31,19 @@ Requires-Dist: black; extra == "dev"
 Provides-Extra: test
 Requires-Dist: coverage; extra == "test"
 Requires-Dist: pytest; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 [![PyPI](https://badge.fury.io/py/lennybot.svg)](https://pypi.org/project/lennybot/)
 # lennybot
@@ -64,7 +78,13 @@ The lennybot allows to define multiple applications.
 Each application has to have a version source, which can be queried to determine the latest version.
 If a newer version is available, the lennybot executes multiple pre defined actions per application.
 E.g. Update Docker Image Tags.
-The applications, sources and actions can be configured in the `config.yml` file.
+Sometimes there are conditions which need to be fulfilled before the action can be executed.
+These conditions can be specified as checks.
+E.g. Check if the docker image is available in the registry, because sometimes a new version of an applications gets released, but the docker image is not available yet.
+
+![A graph showing the process of updating applications by the lennybot](./docs/LennyBot-Execution.drawio.png)
+
+The applications, sources, checks and actions can be configured in the `config.yml` file.
 For more information see below.
 
 ## Configuration
@@ -85,19 +105,16 @@ Each section represents a configuration object.
 
 | Path                                       | Description                                                            |
 |--------------------------------------------|------------------------------------------------------------------------|
-| state.file                                 | The state file which is used to store the version of each application  |
 | state.pr.enabled                           | Toggle PR creation in CI mode. Has to be either true or false          |
 | state.pr.repository                        | The name of the repository in github on which the PR should be created |
 | state.pr.branchPrefix                      | Prefix for the branch name which should be used to create the PRs      |
 
 ### Applications
 
-| Path                                       | Description                                                                                                                                |
+| Property                                   | Description                                                                                                                                |
 |--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
 | applications[*].name                       | The name of the application which should be updated                                                                                        |
-| applications[*].source.type                | The source has to be either of the type "github" or of the type "github-query". See below for details. |
-| applications[*].source.repository          | The GitHub Repository which should be used to determine the latest version                    |
-| applications[*].source.regex               | The regex pattern which is used to extract the semver version code from the tag value         |
+| applications[*].source                     | The configuration for the source of the latest version. This is specific to the type of source, see below for the diffrent source types.   |
 | applications[\*].actions[\*].type          | The action has to be one of these types "image-tag-update", "download-resources" or "update-yaml". See below for details. |
 | applications[\*].actions[\*].url           |                                                                                                                                            |
 | applications[\*].actions[\*].target        |                                                                                                                                            |
@@ -108,21 +125,61 @@ Each section represents a configuration object.
 | applications[\*].actions[\*].yamlPath      |                                                                                                                                            |
 | applications[\*].actions[\*].valuePattern  |                                                                                                                                            |
 
+### Sources
+
 #### GitHub Source
+
 <TODO>
 
+| Property             | Description                                                                                                                                |
+|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
+| .type                | The source has to be either of the type "github" or of the type "github-query". See below for details.                                     |
+| .repository          | The GitHub Repository which should be used to determine the latest version                                                                 |
+| .regex               | The regex pattern which is used to extract the semver version code from the tag value                                                      |
+
+
 #### GitHub Query Source
+
+<TODO>
+
+| Property             | Description                                                                                                                                |
+|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
+| .type                | The source has to be either of the type "github" or of the type "github-query". See below for details.                                     |
+| .repository          | The GitHub Repository which should be used to determine the latest version                                                                 |
+| .regex               | The regex pattern which is used to extract the semver version code from the tag value                                                      |
+
+
+### Checks
+
 <TODO>
 
+
+### Actions
+
 #### Image Tag Update Action
 <TODO>
 
+| Property                                   | Description                                                                                                                                |
+|--------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
+| .type          | The action has to be one of these types "image-tag-update", "download-resources" or "update-yaml". See below for details. |
+| .url           |                                                                                                                                            |
+| .target        |                                                                                                                                            |
+| .image         |                                                                                                                                            |
+| .kustomizePath |                                                                                                                                            |
+| .tagPattern    |                                                                                                                                            |
+| .targetFile    |                                                                                                                                            |
+| .yamlPath      |                                                                                                                                            |
+| .valuePattern  |                                                                                                                                            |
+
 #### Download Resource Action
 <TODO>
 
 #### Update YAML Action
 <TODO>
 
+#### Update JSON Action
+<TODO>
+
 #### Update Dockerfile Action
 <TODO>
 

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot.egg-info/SOURCES.txt

@@ -19,6 +19,7 @@ src/lennybot/actions/iaction.py
 src/lennybot/actions/remove_checksums.py
 src/lennybot/actions/update_dockerfile.py
 src/lennybot/actions/update_image_tag.py
+src/lennybot/actions/update_json.py
 src/lennybot/actions/update_yaml.py
 src/lennybot/check/__init__.py
 src/lennybot/check/docker_image_available.py
@@ -37,4 +38,12 @@ src/lennybot/service/source/__init__.py
 src/lennybot/service/source/isource.py
 src/lennybot/service/source/source_github.py
 src/lennybot/service/source/source_github_query.py
-test/test_docker_image_available.py
+src/lennybot/service/source/source_nodejs.py
+test/test_config.py
+test/test_config_validation.py
+test/test_docker_image_available.py
+test/test_source_nodejs.py
+test/test_update_dockerfile.py
+test/test_update_image_tag.py
+test/test_update_json.py
+test/test_update_yaml.py

{lennybot-1.0.28 → lennybot-1.0.33}/src/lennybot.egg-info/requires.txt

@@ -3,6 +3,7 @@ yamlpath
 requests
 GitPython
 PyGithub
+jsonpath-ng
 
 [dev]
 setuptools

lennybot-1.0.33/test/test_config.py

@@ -0,0 +1,11 @@
+import os
+import unittest
+
+from lennybot.config import LennyBotConfig
+
+
+class TestLennyBotConfig(unittest.TestCase):
+    def test_XXX(self):
+        os.environ["LB_CONTAINER_REGISTRY_ghcr.io_USERNAME"] = "USERNAME"
+        config = LennyBotConfig("test/lennybot.yaml")
+        self.assertEqual("USERNAME", config._container.registries["ghcr.io"].username)

lennybot-1.0.33/test/test_config_validation.py

@@ -0,0 +1,41 @@
+import unittest
+
+import yaml
+
+
+class TestConfigValidation(unittest.TestCase):
+    def setUp(self) -> None:
+        with open("test/config.yaml", encoding="utf-8") as f:
+            self.config = yaml.safe_load(f)
+
+    def test_update_dockerfile_target_contains_image_name(self):
+        for app in self.config.get("applications", []):
+            for action in app.get("actions", []):
+                if action.get("type") != "update-dockerfile":
+                    continue
+                image = action.get("image")
+                target = action.get("targetFile")
+                # If image is present and a target file is set, the target file should contain the image base name
+                if image is not None and target is not None:
+                    image_base = image.split("/")[-1]
+                    self.assertIn(
+                        image_base,
+                        target,
+                        f"targetFile '{target}' does not contain image base '{image_base}' for app {app.get('name')}",
+                    )
+
+    def test_actions_have_required_keys(self):
+        requirements = {
+            "update-dockerfile": ["image", "targetFile"],
+            "update-image-tag": ["image", "kustomizePath"],
+            "update-yaml": ["targetFile", "yamlPath"],
+            "update-json": ["targetFile", "jsonPath"],
+        }
+        for app in self.config.get("applications", []):
+            for action in app.get("actions", []):
+                a_type = action.get("type")
+                if a_type in requirements:
+                    for req in requirements[a_type]:
+                        self.assertIn(
+                            req, action, f"Action {a_type} in app {app.get('name')} missing required key '{req}'"
+                        )

{lennybot-1.0.28 → lennybot-1.0.33}/test/test_docker_image_available.py

@@ -39,8 +39,14 @@ class TestParseImage(unittest.TestCase):
         check = DockerImageAvailableCheck("test-app", "2.7.6", "2.7.7", self.config, self.container_config)
         self.assertRaises(Exception, check.check)
 
+    def test_given_image_path_with_5_segments(self):
+        # private.azurecr.io/public-ecr-aws/docker/library/redis:{{version}}-alpine
+        self.config._image_pattern = "private.azurecr.io/public-ecr-aws/docker/library/redis:{{version}}-alpine"
+        check = DockerImageAvailableCheck("test-app", "2.7.6", "2.7.7", self.config, self.container_config)
+        self.assertRaises(Exception, check.check)
+
     def test_given_toolong_image_path(self):
-        self.config._image_pattern = "quay.io/argo/proj/argo/argocd:v{{version}}"
+        self.config._image_pattern = "quay.io/argo/proj/argo/argo/argo/argocd:v{{version}}"
         check = DockerImageAvailableCheck("test-app", "2.7.6", "2.7.7", self.config, self.container_config)
         self.assertRaises(Exception, check.check)
 

lennybot-1.0.33/test/test_source_nodejs.py

@@ -0,0 +1,45 @@
+import unittest
+from unittest.mock import MagicMock, patch
+
+from lennybot.config.config import LennyBotSourceConfig
+from lennybot.service.source.source_nodejs import NodeJSVersionSource
+
+
+class TestParseImage(unittest.TestCase):
+
+    def setUp(self) -> None:
+        self.config = LennyBotSourceConfig()
+
+    @patch("lennybot.service.source.source_nodejs.requests.get")
+    def test_lts_only_false(self, mock_get):
+        # returns first release when lts_only is False
+        mock_resp = MagicMock()
+        mock_resp.raise_for_status.return_value = None
+        mock_resp.json.return_value = [
+            {"version": "v25.0.0", "lts": False},
+            {"version": "v24.13.0", "lts": "Gallium"},
+        ]
+        mock_get.return_value = mock_resp
+
+        self.config.lts_only = False
+        release = NodeJSVersionSource("test-node-version", self.config)
+        version = release.latest_version()
+
+        self.assertEqual(version, "25.0.0")
+
+    @patch("lennybot.service.source.source_nodejs.requests.get")
+    def test_lts_only_true(self, mock_get):
+        # returns first LTS release when lts_only is True
+        mock_resp = MagicMock()
+        mock_resp.raise_for_status.return_value = None
+        mock_resp.json.return_value = [
+            {"version": "v25.0.0", "lts": False},
+            {"version": "v24.13.0", "lts": "Gallium"},
+        ]
+        mock_get.return_value = mock_resp
+
+        self.config.lts_only = True
+        lts_release = NodeJSVersionSource("test-node-version", self.config)
+        version = lts_release.latest_version()
+
+        self.assertEqual(version, "24.13.0")

lennybot-1.0.33/test/test_update_dockerfile.py

@@ -0,0 +1,60 @@
+import tempfile
+import unittest
+from pathlib import Path
+from test.utils import create_sample_dockerfile, read_file
+
+from lennybot.actions.update_dockerfile import UpdateDockerfileAction
+from lennybot.config.config import LennyBotActionConfig
+
+
+class TestUpdateDockerfileAction(unittest.TestCase):
+    def test_constructor_raises_when_target_file_missing(self):
+        config = LennyBotActionConfig()
+        setattr(config, "_target_file", None)
+        setattr(config, "_image", "nginx")
+        with self.assertRaises(Exception):
+            UpdateDockerfileAction("app", "1.0", "2.0", config)
+
+    def test_run_replaces_from_line_with_default_pattern(self):
+        with tempfile.TemporaryDirectory() as tmpdir:
+            dockerfile = Path(tmpdir) / "Dockerfile"
+            create_sample_dockerfile(dockerfile, ["nginx:1.2", "redis:3.0"])
+            config = LennyBotActionConfig()
+            setattr(config, "_target_file", str(dockerfile))
+            setattr(config, "_image", "nginx")
+
+            action = UpdateDockerfileAction("app", "1.2", "2.0", config)
+            action.run()
+
+            content = read_file(dockerfile)
+            self.assertIn("FROM nginx:2.0\n", content)
+            self.assertIn("FROM redis:3.0\n", content)
+
+    def test_run_respects_value_pattern(self):
+        with tempfile.TemporaryDirectory() as tmpdir:
+            dockerfile = Path(tmpdir) / "Dockerfile"
+            create_sample_dockerfile(dockerfile, ["redis:9.9-alpine"])
+            config = LennyBotActionConfig()
+            setattr(config, "_target_file", str(dockerfile))
+            setattr(config, "_image", "redis")
+            setattr(config, "_value_pattern", "v{{version}}-alpine")
+
+            action = UpdateDockerfileAction("app", "9.9", "3.4", config)
+            action.run()
+
+            content = read_file(dockerfile)
+            self.assertIn("FROM redis:v3.4-alpine\n", content)
+
+    def test_run_leaves_file_unchanged_when_image_not_found(self):
+        with tempfile.TemporaryDirectory() as tmpdir:
+            dockerfile = Path(tmpdir) / "Dockerfile"
+            create_sample_dockerfile(dockerfile, ["busybox:1.0"])
+            config = LennyBotActionConfig()
+            setattr(config, "_target_file", str(dockerfile))
+            setattr(config, "_image", "nginx")
+
+            action = UpdateDockerfileAction("app", "1.0", "2.0", config)
+            action.run()
+
+            content = read_file(dockerfile)
+            self.assertIn("FROM busybox:1.0\n", content)

lennybot-1.0.33/test/test_update_image_tag.py

@@ -0,0 +1,48 @@
+import tempfile
+import unittest
+from pathlib import Path
+from test.utils import create_kustomization, read_file
+
+import yaml
+
+from lennybot.actions.update_image_tag import UpdateImageTagAction
+from lennybot.config.config import LennyBotActionConfig
+
+
+class TestUpdateImageTagAction(unittest.TestCase):
+    def test_constructor_raises_without_kustomize_path(self):
+        config = LennyBotActionConfig()
+        setattr(config, "_image", "node")
+        setattr(config, "_kustomize_path", None)
+        with self.assertRaises(Exception):
+            UpdateImageTagAction("app", "1.0", "2.0", config)
+
+    def test_run_updates_new_tag(self):
+        with tempfile.TemporaryDirectory() as tmpdir:
+            kustomize_file = Path(tmpdir) / "kustomization.yaml"
+            create_kustomization(kustomize_file, [{"name": "node", "newTag": "old"}, {"name": "other", "newTag": "x"}])
+
+            config = LennyBotActionConfig()
+            setattr(config, "_image", "node")
+            setattr(config, "_kustomize_path", str(kustomize_file))
+            setattr(config, "_tag_pattern", "v{{version}}")
+
+            action = UpdateImageTagAction("app", "1.0", "3.2.1", config)
+            action.run()
+
+            content = yaml.safe_load(read_file(kustomize_file))
+            found = [img for img in content["images"] if img["name"] == "node"][0]
+            self.assertEqual(found["newTag"], "v3.2.1")
+
+    def test_run_raises_when_image_not_found(self):
+        with tempfile.TemporaryDirectory() as tmpdir:
+            kustomize_file = Path(tmpdir) / "kustomization.yaml"
+            create_kustomization(kustomize_file, [{"name": "other", "newTag": "x"}])
+
+            config = LennyBotActionConfig()
+            setattr(config, "_image", "node")
+            setattr(config, "_kustomize_path", str(kustomize_file))
+
+            action = UpdateImageTagAction("app", "1.0", "3.2.1", config)
+            with self.assertRaises(Exception):
+                action.run()

lennybot-1.0.33/test/test_update_json.py

@@ -0,0 +1,40 @@
+import json
+import tempfile
+import unittest
+from pathlib import Path
+from test.utils import create_json_file, read_file
+
+from lennybot.actions.update_json import UpdateJsonAction
+from lennybot.config.config import LennyBotActionConfig
+
+
+class TestUpdateJsonAction(unittest.TestCase):
+    def test_constructor_raises_when_target_file_missing(self):
+        config = LennyBotActionConfig()
+        setattr(config, "_target_file", None)
+        setattr(config, "_json_path", "$.a.b")
+        with self.assertRaises(Exception):
+            UpdateJsonAction("app", "1.0", "2.0", config)
+
+    def test_constructor_raises_when_json_path_missing(self):
+        config = LennyBotActionConfig()
+        setattr(config, "_target_file", "somefile")
+        setattr(config, "_json_path", None)
+        with self.assertRaises(Exception):
+            UpdateJsonAction("app", "1.0", "2.0", config)
+
+    def test_run_updates_json_value(self):
+        with tempfile.TemporaryDirectory() as tmpdir:
+            json_file = Path(tmpdir) / "file.json"
+            create_json_file(json_file, {"a": {"b": "old"}})
+
+            config = LennyBotActionConfig()
+            setattr(config, "_target_file", str(json_file))
+            setattr(config, "_json_path", "$.a.b")
+            setattr(config, "_value_pattern", "v{{version}}")
+
+            action = UpdateJsonAction("app", "1.0", "3.3.3", config)
+            action.run()
+
+            content = json.loads(read_file(json_file))
+            self.assertEqual(content["a"]["b"], "v3.3.3")

lennybot-1.0.33/test/test_update_yaml.py

@@ -0,0 +1,42 @@
+import tempfile
+import unittest
+from pathlib import Path
+from test.utils import create_yaml_file, read_file
+
+import yaml
+
+from lennybot.actions.update_yaml import UpdateYamlAction
+from lennybot.config.config import LennyBotActionConfig
+
+
+class TestUpdateYamlAction(unittest.TestCase):
+    def test_constructor_raises_when_target_file_missing(self):
+        config = LennyBotActionConfig()
+        setattr(config, "_target_file", None)
+        setattr(config, "_yaml_path", "spec.imageTag")
+        with self.assertRaises(Exception):
+            UpdateYamlAction("app", "1.0", "2.0", config)
+
+    def test_constructor_raises_when_yaml_path_missing(self):
+        config = LennyBotActionConfig()
+        setattr(config, "_target_file", "somefile")
+        setattr(config, "_yaml_path", None)
+        with self.assertRaises(Exception):
+            UpdateYamlAction("app", "1.0", "2.0", config)
+
+    def test_run_sets_value_in_yaml(self):
+        with tempfile.TemporaryDirectory() as tmpdir:
+            yaml_file = Path(tmpdir) / "file.yaml"
+            create_yaml_file(yaml_file, {"spec": {"imageTag": "old"}})
+
+            config = LennyBotActionConfig()
+            setattr(config, "_target_file", str(yaml_file))
+            setattr(config, "_yaml_path", "spec.imageTag")
+            setattr(config, "_value_pattern", "v{{version}}")
+
+            action = UpdateYamlAction("app", "1.0", "3.3.3", config)
+            action.run()
+
+            content = yaml.safe_load(read_file(yaml_file))
+            # Expect value to be replaced; YAML path syntax may vary depending on yamlpath library
+            self.assertEqual(content["spec"]["imageTag"], "v3.3.3")

lennybot-1.0.33/version.txt

@@ -0,0 +1 @@
+1.0.33

lennybot-1.0.28/version.txt

@@ -1 +0,0 @@
-1.0.28