checkmk-dev-tools 2.1.4__tar.gz → 2.3.0__tar.gz

{checkmk_dev_tools-2.1.4 → checkmk_dev_tools-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: checkmk-dev-tools
-Version: 2.1.4
+Version: 2.3.0
 Summary: Checkmk DevOps tools
 Author: Frans Fürst
 Author-email: frans.fuerst@checkmk.com
@@ -14,7 +14,7 @@ Requires-Dist: pydantic (>=2,<3)
 Requires-Dist: python-jenkins (>=1.8.3,<1.9.0)
 Requires-Dist: rich
 Requires-Dist: trickkiste (>=0.3.4,<0.4.0)
-Project-URL: Changelog, https://github.com/Checkmk/checkmk-dev-tools/blob/release/2.1.4/changelog.md
+Project-URL: Changelog, https://github.com/Checkmk/checkmk-dev-tools/blob/release/2.3.0/changelog.md
 Project-URL: Repository, https://github.com/Checkmk/checkmk-dev-tools
 Description-Content-Type: text/markdown
 

{checkmk_dev_tools-2.1.4 → checkmk_dev_tools-2.3.0}/cmk_dev/ci_artifacts.py

@@ -24,7 +24,7 @@ from datetime import datetime
 from itertools import chain
 from pathlib import Path
 from subprocess import check_output
-from typing import Any, List, Literal, cast
+from typing import Any, List, Literal, TypedDict, cast
 
 import requests
 from influxdb_client import InfluxDBClient  # type: ignore[attr-defined]
@@ -56,6 +56,12 @@ from .version import __version__
 
 PathHashes = Mapping[str, str]
 shared_build_info: asyncio.Queue[str] = asyncio.Queue(maxsize=1)
+
+
+class FetchResult(TypedDict):
+    result: None | JobResult
+    artifacts: list[str]
+
 MAX_RETRY_ATTEMPTS = 3
 
 
@@ -311,7 +317,7 @@ def download_artifacts(
     total_download_timeout: int = 240,
     no_remove_others: bool = False,
     no_raise: bool = False,
-) -> tuple[Sequence[str | None], Sequence[str | None]]:
+) -> tuple[Sequence[str], Sequence[str]]:
     """Downloads all artifacts listed for given job/build to @out_dir"""
     # pylint: disable=protected-access
     # pylint: disable=too-many-locals
@@ -733,6 +739,7 @@ async def _fn_request_build(args: Args) -> None:
                 path_hashes=compose_path_hashes(args.base_dir, args.dependency_paths),
                 time_constraints=args.time_constraints,
                 next_check_sleep=args.poll_queue_sleep,
+                ignore_build_queue=args.ignore_build_queue,
                 args=args,
             )
         ):
@@ -901,54 +908,72 @@ def query_matching_builds(
         return []
 
 
-async def _fn_fetch(args: Args) -> None:
-    """Entry point for fetching (request and download combined) artifacts"""
-    out_dir = compose_out_dir(args.base_dir, args.out_dir)
-    path_hashes = compose_path_hashes(args.base_dir, args.dependency_paths)
+async def fetch_artifacts(
+    job: str,
+    params: None | JobParams = None,
+    *,
+    out_dir: Path = Path("out"),
+    base_dir: Path = Path("."),
+    params_no_check: None | JobParams = None,
+    dependency_paths: None | Sequence[str] = None,
+    time_constraints: None | str = None,
+    force_new_build: bool = False,
+    omit_new_build: bool = False,
+    download: bool = True,
+    no_remove_others: bool = False,
+    no_raise: bool = False,
+    poll_queue_sleep: int = 30,
+    poll_sleep: int = 60,
+    timeout: int = 120,
+    total_download_timeout: int = 240,
+    credentials: None | Mapping[str, str] = None,
+    credentials_file: str = "~/.config/jenkins_jobs/jenkins_jobs.ini",
+) -> FetchResult:
+    """Find or trigger a matching build, wait for it, download artifacts, return result dict."""
+    resolved_out_dir = compose_out_dir(base_dir, out_dir)
+    path_hashes = compose_path_hashes(base_dir, dependency_paths or [])
     async with AugmentedJenkinsClient(
-        **extract_credentials(args.credentials), timeout=args.timeout
+        **extract_credentials(credentials, credentials_file=credentials_file), timeout=timeout
     ) as jenkins_client:
-        if not (job := await jenkins_client.job_info(args.job)).type == "WorkflowJob":
-            raise Fatal(f"{args.job} is not a WorkflowJob")
-        # In case we force a new build anyway we don't have to look for an existing one
+        if not (job_info := await jenkins_client.job_info(job)).type == "WorkflowJob":
+            raise Fatal(f"{job} is not a WorkflowJob")
         matching_build = (
             None
-            if args.force_new_build
+            if force_new_build
             else await identify_matching_build(
-                job,
+                job_info,
                 jenkins_client=jenkins_client,
-                params=flatten(args.params),
-                path_hashes=compose_path_hashes(args.base_dir, args.dependency_paths),
-                time_constraints=args.time_constraints,
-                next_check_sleep=args.poll_queue_sleep,
-                args=args,
+                params=params,
+                path_hashes=path_hashes,
+                time_constraints=time_constraints,
+                next_check_sleep=poll_queue_sleep,
             )
         )
-        if args.omit_new_build and not matching_build:
-            raise Fatal(f"No matching build found for job '{job.name}' but new builds are omitted.")
-
+        if omit_new_build and not matching_build:
+            raise Fatal(
+                f"No matching build found for job '{job_info.name}' but new builds are omitted."
+            )
         build_candidate = matching_build or await trigger_build(
             jenkins_client=jenkins_client,
-            job=job,
+            job=job_info,
             params=compose_build_params(
-                params=flatten(args.params),
-                params_no_check=flatten(args.params_no_check),
-                path_hashes=compose_path_hashes(args.base_dir, args.dependency_paths),
+                params=params,
+                params_no_check=params_no_check,
+                path_hashes=path_hashes,
             ),
-            next_check_sleep=args.poll_queue_sleep,
+            next_check_sleep=poll_queue_sleep,
         )
-
         for key, value in build_candidate.__dict__.items():
             log().debug("  %s: %s", key, value)
-
         completed_build = await await_build(
-            job.path,
+            job_info.path,
             build_candidate.number,
             jenkins_client=jenkins_client,
             check_result=True,
             path_hashes=path_hashes,
-            next_check_sleep=args.poll_sleep,
-            no_raise=args.no_raise,
+            next_check_sleep=poll_sleep,
+            no_raise=no_raise,
+            download=download,
         )
         downloaded_artifacts = (
             list(
@@ -956,25 +981,44 @@ async def _fn_fetch(args: Args) -> None:
                     *download_artifacts(
                         jenkins_client.client,
                         completed_build,
-                        out_dir,
-                        args.total_download_timeout,
-                        args.no_remove_others,
-                        args.no_raise,
+                        resolved_out_dir,
+                        total_download_timeout,
+                        no_remove_others,
+                        no_raise,
                     )
                 )
             )
-            if args.download
+            if download
             else []
         )
+        return {"result": completed_build.result, "artifacts": downloaded_artifacts}
 
-        print(
-            json.dumps(
-                {
-                    "result": completed_build.result,
-                    "artifacts": downloaded_artifacts,
-                }
+
+async def _fn_fetch(args: Args) -> None:
+    """Entry point for fetching (request and download combined) artifacts"""
+    print(
+        json.dumps(
+            await fetch_artifacts(
+                job=args.job,
+                params=flatten(args.params),
+                out_dir=args.out_dir,
+                base_dir=args.base_dir,
+                params_no_check=flatten(args.params_no_check),
+                dependency_paths=args.dependency_paths,
+                time_constraints=args.time_constraints,
+                force_new_build=args.force_new_build,
+                omit_new_build=args.omit_new_build,
+                download=args.download,
+                no_remove_others=args.no_remove_others,
+                no_raise=args.no_raise,
+                poll_queue_sleep=args.poll_queue_sleep,
+                poll_sleep=args.poll_sleep,
+                timeout=args.timeout,
+                total_download_timeout=args.total_download_timeout,
+                credentials=args.credentials,
             )
         )
+    )
 
 
 async def identify_matching_build(
@@ -985,6 +1029,7 @@ async def identify_matching_build(
     path_hashes: PathHashes,
     time_constraints: None | str,
     next_check_sleep: int = 30,
+    ignore_build_queue: bool = False,
     args: None | Args = None,
 ) -> None | Build:
     """Find an existing build (finished, still running or queued) which matches our
@@ -1093,13 +1138,16 @@ async def identify_matching_build(
             f"Got {len(matching_builds)} InfluxDB job history entries of today, generated {len(builds)} builds to check"
         )
 
+        log().info("Check for matching existing builds")
         # ugly code duplication incomming, rework this to a dedicated function
         for build in list(builds.values()):
             if meets_constraints(build, params, time_constraints, path_hashes):
                 log().info("found matching (may finished) build: %s (%s)", build.number, build.url)
                 return build
+        log().info("No matching builds found in the InfluxDB")
 
-        if hasattr(args, "ignore_build_queue") and not args.ignore_build_queue:
+        log().info("Check for matching queue items via Jenkins API")
+        if not ignore_build_queue:
             if matching_item := await find_matching_queue_item(
                 jenkins_client=jenkins_client,
                 job=job,
@@ -1107,33 +1155,40 @@ async def identify_matching_build(
                 path_hashes=path_hashes,
                 next_check_sleep=next_check_sleep,
             ):
-                log().debug("Found matching queued item %s", matching_item)
+                log().info("Found matching queued item %s", matching_item)
                 return await jenkins_client.build_info(job.path, matching_item)
+        log().info("No matching queue items found via Jenkins API")
 
         # exit here with no matching result if
         # - the InfluxDB connection was a success
         # - and some data was found by the query
         # otherwise fall back to the old Jenkins job history crawling
         if influx_client.health().status == "pass" and matching_builds:
+            log().info("Return None and schedule a new build")
             return None
 
-    log().debug("Start finding matching build via Jenkins API")
+    log().info("Start finding matching build via Jenkins API")
     # fetch a job's build history first
     await job.expand(jenkins_client)
 
+    log().info("Check for matching existing builds")
     # Look for finished builds
     for build in filter(lambda b: b.completed, job.build_infos.values()):
         if meets_constraints(build, params, time_constraints, path_hashes):
             log().info("found matching finished build: %s (%s)", build.number, build.url)
             return build
+    log().info("No matching builds found via the Jenkins API")
 
+    log().info("Check for matching non finished builds")
     # Look for still unfinished builds
     for build in filter(lambda b: not b.completed, job.build_infos.values()):
         if meets_constraints(build, params, time_constraints, path_hashes):
             log().info("found matching unfinished build: %s (%s)", build.number, build.url)
             return build
+    log().info("No matching non finished builds found via the Jenkins API")
 
-    if args and not args.ignore_build_queue:
+    log().info("Check for matching queue items via Jenkins API")
+    if not ignore_build_queue:
         if matching_item := await find_matching_queue_item(
             jenkins_client=jenkins_client,
             job=job,
@@ -1141,9 +1196,11 @@ async def identify_matching_build(
             path_hashes=path_hashes,
             next_check_sleep=next_check_sleep,
         ):
-            log().debug("Found matching queued item %s", matching_item)
+            log().info("Found matching queued item %s", matching_item)
             return await jenkins_client.build_info(job.path, matching_item)
+    log().info("No matching queue items found via Jenkins API")
 
+    log().info("Return None and schedule a new build")
     return None
 
 

{checkmk_dev_tools-2.1.4 → checkmk_dev_tools-2.3.0}/cmk_dev/version.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
 # -*- coding: UTF-8 -*-
 
-__version_info__ = ("2", "1", "4")
+__version_info__ = ("2", "3", "0")
 __version__ = '.'.join(__version_info__)

{checkmk_dev_tools-2.1.4 → checkmk_dev_tools-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "checkmk-dev-tools"
-version = "2.1.4" # will-be-updated-automatically
+version = "2.3.0" # will-be-updated-automatically
 description = "Checkmk DevOps tools"
 authors = [
     "Frans Fürst <frans.fuerst@checkmk.com>",
@@ -14,7 +14,7 @@ exclude = ["cmk_dev/out"]
 
 [tool.poetry.urls]
 Repository = "https://github.com/Checkmk/checkmk-dev-tools"
-Changelog = "https://github.com/Checkmk/checkmk-dev-tools/blob/release/2.1.4/changelog.md"
+Changelog = "https://github.com/Checkmk/checkmk-dev-tools/blob/release/2.3.0/changelog.md"
 
 [tool.poetry.scripts]
 activity-from-fs = 'cmk_dev.activity_from_fs:main'