This repository includes scripts/tools for Checkmk developers.
While you can just clone and use the tools inside of course (they're just plain Python or Bash
scripts), the intended way to use it is via pip or inside a virtual environment.
Install it locally using pip:
[<PYTHON> -m] pip[3] install [--user] [--upgrade] checkmk-dev-tools
ci-artifactsci-artifacts is a tool for accessing and triggering (currently Jenkins only) CI job builds and
making build artifacts available locally in an efficient way (i.e. avoiding unnessessary builds by
comparing certain constraints like job parameters and time of already available builds).
Formerly it was only used to make artifacts available which is the reason for the name and some CLI desing desicions.
Run ci-artifacts --help in general to get more details about the usage of the tool.
If no API key, username and URL to Jenkins is provided in ~/.config/jenkins_jobs/jenkins_jobs.ini those parameters have to be specified explicitly.
This is a template of the jenkins_jobs.ini file
[jenkins]
user=carl.lama
# Get the APIKEY from the CI web UI, click top right Profile -> Configure -> Show API Key
# https://JENKINS_URL.tld/user/carl.lama/configure
password=API_KEY_NOT_YOUR_PASSWORD
url=https://JENKINS_URL.tld
query_plugins_info=False
Wait for an existing and specified build to finish. Nothing is downloaded.
ci-artifacts --log-level debug \
await-result checkmk/master/builders/build-cmk-distro-package:6066
The returned result is a JSON might look like
{"result": "SUCCESS", "artifacts": null}
Wait for an existing and specified build to finish and download the artifacts.
The destination of the artifacts can be specified with the optional argument --out-dir (defaults to out) and is relative to the base directory (--base-dir, defaults to current directory) used to fetch hashes of the downloaded artifacts.
The flag --no-remove-others can be used to keep additional files in the download directory which were not part of the download. This is like a built-in garbage collection.
ci-artifacts --log-level debug \
download checkmk/master/builders/build-cmk-distro-package:6066 \
--base-dir ~/my-git-projects/checkmk/master \
--out-dir package_download \
--no-remove-others
The returned result is a JSON might look like
{"result": "SUCCESS", "artifacts": ["check-mk-enterprise-2.4.0-2024.10.31_0.jammy_amd64.deb"]}
If there are no more constraints than a build has been completed successfully, fetch downloads a given jobs artifact, just like with download but for the latest build instead of a specified build number.
Pressing CTRL+C while the script is running will ask for confirmation, default answer is no and cancel the build.
ci-artifacts --log-level debug \
fetch checkmk/master/winagt-build
In contrast, this is what a more detailed call might look like
ci-artifacts --log-level debug \
fetch checkmk/master/winagt-build \
--params EDITION=raw,DISTRO="ubuntu-22.04",CUSTOM_GIT_REF=85fa488e0a32f6ea55d8875ab9c517bdc253a8e1 \
--params-no-check DISABLE_CACHE=false,CIPARAM_OVERRIDE_BUILD_NODE=fra001 \
--dependency-paths agents/wnx,agents/windows,packages/cmk-agent-ctl \
--time-constraints today \
--base-dir ~/my-git-projects/checkmk/master \
--out-dir package_download
--params <JOB-PARAMETERS>
Comma separated list of job-parameters used for identifying existing builds and to start new ones.
--params-no-check <JOB-PARAMETERS>
Comma separated list of job-parameters used only to start a new build. These parameters are ignored during the search of an already existing build.
--time-constraints <SPECIFIER>
Check for build date constraints when looking for existing builds - currently
only today is taken into account.
--dependency-paths <PATH,..>
Comma separated list of relative paths to files and directories checked for differences when looking for existing builds.
--omit-new-build
Don't start new builds, even when no matching build could be found.
--force-new-build
Don't look for existing builds, always start a new build instead.
Like fetch but with the optional parameter --passive which outputs the informations needed to trigger a build instead of triggering the build.
This is helpful in pipeline scripts to keep track of issuers of a build.
ci-artifacts --log-level debug \
request checkmk/master/winagt-build \
--params EDITION=raw,DISTRO="ubuntu-22.04",CUSTOM_GIT_REF=85fa488e0a32f6ea55d8875ab9c517bdc253a8e1 \
--params-no-check DISABLE_CACHE=false,CIPARAM_OVERRIDE_BUILD_NODE=fra001 \
--time-constraints today \
--base-dir ~/my-git-projects/checkmk/master \
--passive
{
"new_build":
{
"path": "checkmk/master/winagt-build",
"params":
{
"EDITION": "raw",
"DISTRO": "ubuntu-22.04",
"CUSTOM_GIT_REF": "85fa488e0a32f6ea55d8875ab9c517bdc253a8e1",
"DISABLE_CACHE": "false",
"CIPARAM_OVERRIDE_BUILD_NODE": "fra001"
}
}
}
Without the --passive flag the build is triggered if no matching one is found. If a matching build with the specified parameters was found the returned JSON might look like
{
"existing":
{
"path": "checkmk/master/winagt-build",
"number": 6066,
"url": "https://JENKINS_URL.tld/job/checkmk/job/master/job/winagt-build/6066/",
"result": "SUCCESS",
"new_build": false
}
}
The validate subcommand is a combination of several other commands. It requests, identifies a matching of triggers a new build while waiting for the build to complete. Nothing is downloaded. It has the same parameters as fetch.
This subcommand can be used to trigger a remote build with custom parameters or check if an existing build with these parameters passed or not.
ci-artifacts --log-level debug \
validate checkmk/master/winagt-build \
--params EDITION=raw,DISTRO="ubuntu-22.04",CUSTOM_GIT_REF=85fa488e0a32f6ea55d8875ab9c517bdc253a8e1 \
--params-no-check DISABLE_CACHE=false,CIPARAM_OVERRIDE_BUILD_NODE=fra001 \
--time-constraints today
{"result": "SUCCESS", "artifacts": []}
For active development you need to have poetry and pre-commit installed
python3 -m pip install --upgrade --user poetry pre-commit
git clone ssh://review.lan.tribe29.com:29418/checkmk_dev_tools
cd checkmk_dev_tools
pre-commit install
# if you need a specific version of Python inside your dev environment
poetry env use ~/.pyenv/versions/3.10.4/bin/python3
poetry install
# install "poetry-bumpversion" to easily bump package version later
# it is not enough to add it to the projects pyproject.toml file
poetry self add poetry-bumpversion
poetry config pypi-token.pypi pypi-<LONG-STRING>
(will write to ~/.config/pypoetry/auth.toml)pre-commit run --all-filespyproject.toml with# see section Setup
# poetry self add poetry-bumpversion
poetry version [patch, minor, major] [--dry-run]
poetry lock
poetry build && \
poetry run twine check dist/* &&
python3 -m pip uninstall -y checkmk_dev_tools && \
python3 -m pip install --user dist/checkmk_dev_tools-$(grep -E "^version.?=" pyproject.toml | cut -d '"' -f 2)-py3-none-any.whl
checkmk_dev_tools/+/88632/git add ...
git commit -m "cmk-dev-tools: bump version, update dependencies"
# merge
poetry publish --build [--repository checkmk_dev_tools]
git tag -a v<VERSION> <MERGE_COMMIT> -m "v<VERSION>"
git push --tags
FAQs
Checkmk DevOps tools
We found that checkmk-dev-tools demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.