Introduction to AutoJenkins

AutoJenkins was written to handle automation (remote control) of Jenkins tasks. Includes a class autojenkins.Jenkins that you can use to drive Jenkins.

Things you can do with it:

• Copy a job (e.g. from a template job)
• Delete a job
• Obtain the config.xml file for that job
• Trigger building of a job
• Obtain latest execution results
• ...

AutoJenkins may be used as an API or as a command-line tool.

AutoJenkins as API

Sample use:

from autojenkins import Jenkins

j = Jenkins('http://jenkins.pe.local')

# trigger a manual build and check results
j.build('warehouse-screens-us544_login')
j.last_result('warehouse-screens-us544_login')

# get only the result string (one of 'SUCCESS', 'UNSTABLE', 'FAILURE'):
j.last_result('warehouse-screens-us544_login')['result']

# get the configuration file for a job:
j.get_config_xml('template')

# Create a new job from a job named 'template', replacing variables
j.create_copy('my-new-job', 'template',
              repo='mbf-warehouse-screens',
              branch='us544_login',
              package='warehouse_screens')

# build
j.build('my-new-job')

# check result and delete if successful:
result = j.last_result('my-new-job')['result']
if result == 'SUCCESS':
    j.delete('my-new-job')

AutoJenkins from the Command Line

Available commands:

• ajk-create - create a job in jenkins

Currently it creates a job from a template job, replacing variables that use the django/jinja2 syntax {{ variable }}.

Usage help:

$ ajk-create -h

Usage: ajk-create host jobname [options]

Run autojenkins to create a job.

Options:
  -h, --help            show this help message and exit
  -t TEMPLATE, --template=TEMPLATE
                        the template job to copy from
  -D PROP=VALUE         substitution variables for the template
  -b, --build           start a build right after creation

Sample command:

$ ajk-create http://my.server my-job -t template -Dbranch=my-branch

More Info

Sources can be found in Github at https://github.com/txels/autojenkins