clockworksspheres/jenkinstools

Purpose and Runtime

jenkinsTools is a Python-based operator toolkit for administering a Jenkins server: managing agent nodes, creating/configuring/running/checking simple pipelines, and adding SSH-key credentials. It uses the external python-jenkins client library and targets Jenkins over its API. Dependencies are declared in requirements.txt and src/requirements.txt.

User Entry Points

Standalone command-line entry scripts expose the principal workflows:

• Node administration: src/jenkinsTools/jenkinsNodeTool.py

• Pipeline lifecycle operations: src/jenkinsTools/jenkinsPipelineTool.py

• SSH-key preparation/credential work: src/jenkinsTools/jenkinsSshKeyWrangling.py

• Desktop GUI launcher: src/jenkinsTools/jenkinsToolsGui.py

These are packaged as platform-native executables rather than operated as a web service.

Jenkins Domain Operations

The JenkinsTools package contains the Jenkins-facing operation layer. Node creation, update, status, and management are separated into focused commands in src/jenkinsTools/JenkinsTools/AddJenkinsNode.py, src/jenkinsTools/JenkinsTools/NodeManage.py, and src/jenkinsTools/JenkinsTools/update_node.py. This layer is the main boundary between local CLI/GUI inputs and Jenkins API calls.

Pipeline operations form a second domain group: pipeline creation/configuration, triggering, and result polling are represented by src/jenkinsTools/JenkinsTools/CreateJenkinsPipeline.py, src/jenkinsTools/JenkinsTools/RunJenkinsPipeline.py, and src/jenkinsTools/JenkinsTools/CheckJenkinsPipelineRun.py.

Configuration and Credentials

Shared Jenkins connection/configuration handling is centralized in src/jenkinsTools/ConfigFile.py. SSH credential operations are split between the user-facing workflow in src/jenkinsTools/sshKeyWrangling.py and Jenkins credential registration in src/jenkinsTools/JenkinsTools/AddSshKeyCredential.py. SSH keys must already exist; the tool adds their credentials to Jenkins rather than acting as a key-generation service.

Input and Interaction Boundary

CLI and GUI paths should converge on the domain operation layer after validation. Input validators are organized by workflow in src/jenkinsTools/lib/inputValidation/generalFieldsValidation.py, src/jenkinsTools/lib/inputValidation/nodesFieldsValidation.py, and src/jenkinsTools/lib/inputValidation/pipelinesFieldsValidation.py.

The optional Qt-style desktop interface is implemented in src/jenkinsTools/ux/main.py, with node and pipeline screens in src/jenkinsTools/ux/nodesMain.py and src/jenkinsTools/ux/pipelinesMain.py. Generated/UI-designer artifacts remain alongside these controllers.

Packaging and Cross-Platform Delivery

The repository builds native distributables for Debian-family Linux, Red Hat-family Linux, macOS, and Windows. Platform scripts/specifications live in src/BuildScripts/build.deb-based.sh, src/BuildScripts/build.rh-based.sh, src/BuildScripts/build.macos.sh, and src/BuildScripts/build.windows.ps1. Python packaging helpers produce Debian, RPM, and macOS package formats in src/BuildScripts/buildDeb.py, src/BuildScripts/buildRpm.py, and src/BuildScripts/buildMacosPkg.py.

CI and Test Infrastructure

Jenkins itself is also the project CI runtime, with cross-platform pipeline definitions in ci/Jenkinsfile, ci/Jenkinsfile.debbased, and ci/Jenkinsfile.rhelbased. Setup documentation describes a Jenkins controller plus platform-specific agents under src/docs/BasicSetUpJenkinsServerForTesting/ and src/docs/BasicSetUpJenkinsSlavesForTesting/. The project can pair with external mvm-managed VMs to exercise these platform boundaries.