jjb/python-jenkins
Code Issues Proposed changes
Python API for managing jobs and nodes in a Jenkins CI instance
274 Commits 2 Branches 38 Tags 3.6 MiB
Python 100%
b5a8b7035e
Go to file
Tomas Janousek b5a8b7035e Request multiple folder levels at once in get_all_jobs 
On our Jenkins instance with almost a hundred folders, JJB update
stalls for quite a while because it calls get_all_jobs. When invoked
locally at the Jenkins master, it's a matter of seconds, on a fast
broadband link and VPN, it's 2 minutes, and on a train it's easily 10
minutes.

But there's trick!

    curl \
        --show-error --silent --fail \
        --user : --negotiate \
        --get \
        --data-urlencode \
            tree=jobs\[url\,name\,jobs\[url\,name\,jobs\[url\,name\,\
            jobs\[url\,name\,jobs\[url\,name\,jobs\[url\,name\,\
            jobs\[url\,name\,jobs\[url\,name\,jobs\[url\,name\,\
            jobs\[url\,name\,jobs\]\]\]\]\]\]\]\]\]\]
        https://jenkins.example.com/api/json

This returns almost instantly.

And it gets better: if we fail to correctly guess the nesting level
necessary, Jenkins returns

    …, "jobs": [{}, {}, …], …

so we can easily detect that we need to recurse deeper.

Change-Id: I7268259149e4bc8939c512a112c7e6ec1908224f
2018-10-17 18:06:56 +02:00
doc Adopt use of pre-commit hooks 2018-06-22 13:37:30 +01:00
jenkins Request multiple folder levels at once in get_all_jobs 2018-10-17 18:06:56 +02:00
tests Request multiple folder levels at once in get_all_jobs 2018-10-17 18:06:56 +02:00
.coveragerc Use standard cover setup 2016-12-20 22:17:24 +01:00
.gitignore Replace testr with stestr 2018-04-04 23:25:21 +01:00
.gitreview Update .gitreview for new namespace 2015-10-17 22:37:18 +00:00
.pre-commit-config.yaml Adopt use of pre-commit hooks 2018-06-22 13:37:30 +01:00
.stestr.conf Replace testr with stestr 2018-04-04 23:25:21 +01:00
.zuul.yaml Adopt use of pre-commit hooks 2018-06-22 13:37:30 +01:00
bindep.txt Added pypy-dev to bindep.txt 2018-06-16 21:17:34 +01:00
COPYING Added tags 2011-06-30 17:54:54 +01:00
MANIFEST.in Add MANIFEST.in 2014-08-22 11:29:08 -05:00
README.rst Adopt use of pre-commit hooks 2018-06-22 13:37:30 +01:00
requirements.txt Migration to using requests 2018-02-12 11:16:54 +00:00
setup.cfg Adopt use of pre-commit hooks 2018-06-22 13:37:30 +01:00
setup.py Use pbr, pep8 checks & fixes, add "doc" tox target 2014-07-02 14:12:31 -07:00
test-requirements.txt Adopt use of pre-commit hooks 2018-06-22 13:37:30 +01:00
tox.ini Adopt use of pre-commit hooks 2018-06-22 13:37:30 +01:00

README.rst

README

Python Jenkins is a python wrapper for the Jenkins REST API which aims to provide a more conventionally pythonic way of controlling a Jenkins server. It provides a higher-level API containing a number of convenience functions.

We like to use python-jenkins to automate our Jenkins servers. Here are some of the things you can use it for:

  • Create new jobs
  • Copy existing jobs
  • Delete jobs
  • Update jobs
  • Get a job's build information
  • Get Jenkins master version information
  • Get Jenkins plugin information
  • Start a build on a job
  • Create nodes
  • Enable/Disable nodes
  • Get information on nodes
  • Create/delete/reconfig views
  • Put server in shutdown mode (quiet down)
  • List running builds
  • Delete builds
  • Wipeout job workspace
  • Create/delete/update folders1
  • Set the next build number2
  • Install plugins
  • and many more..

To install:

$ sudo python setup.py install

Online documentation:

Developers

Bug report:

Repository:

Cloning:

Patches are submitted via Gerrit at:

Please do not submit GitHub pull requests, they will be automatically closed.

The python-jenkins developers communicate in the #openstack-jjb channel on Freenode's IRC network.

More details on how you can contribute is available on our wiki at:

Writing a patch

Be sure that you lint code before created an code review. The easiest way to do this is to install git pre-commit hooks.

Installing without setup.py

Then install the required python packages using pip:

$ sudo pip install python-jenkins

Footnotes

  1. The free Cloudbees Folders Plugin provides support for a subset of the full folders functionality. For the complete capabilities you will need the paid for version of the plugin.↩︎

  2. The Next Build Number Plugin provides support for setting the next build number.↩︎