pyjen.plugins.buildblocker module

Interfaces for interacting with Build Blockers job property plugin

class pyjen.plugins.buildblocker.BuildBlockerProperty(node)[source]

Bases: pyjen.utils.xml_plugin.XMLPlugin

Wrapper for Build Blocker job properties

https://wiki.jenkins-ci.org/display/JENKINS/Build+Blocker+Plugin

LEVEL_TYPES = ('GLOBAL', 'NODE')
QUEUE_SCAN_TYPES = ('DISABLED', 'ALL', 'BUILDABLE')
blockers

Gets the list of search criteria for blocking jobs

Returns

list of search criteria for blocking jobs

Return type

list

disable()[source]

Disables this set of build blockers

enable()[source]

Enables this set of build blockers

static get_jenkins_plugin_name()[source]

Gets the name of the Jenkins plugin associated with this PyJen plugin

This static method is used by the PyJen plugin API to associate this class with a specific Jenkins plugin, as it is encoded in the config.xml

Return type

str

classmethod instantiate(patterns)[source]

Factory method used to instantiate an instance of this plugin

Parameters

patterns (either list or str) – One or more names or regular expressions for jobs that block the execution of this one.

is_enabled

Checks to see whether this blockers property is currently enabled

Returns

True if these blocking jobs are enabled, False if not

Return type

str

level

Gets the scope of the blocked job settings

Returns

One of BuildBlockerProperty.LEVEL_TYPES

Return type

str

queue_scan

Checks to see whether build blocking scans the build queue or not

Returns

One of BuildBlockerProperty.QUEUE_SCAN_TYPES

Return type

str

pyjen.plugins.buildblocker.PluginClass

alias of pyjen.plugins.buildblocker.BuildBlockerProperty