Current File : //usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyc
�
���^c @@ sk d Z d d l m Z m Z m Z d d l Z d d l Z y d d l Z e Z
Wn e k
ri e Z
n Xd d l
Z d d l m Z m Z e j e � Z d Z d � Z d � Z d � Z d � Z d
� Z d � Z d d � Z d d
� Z d d d � Z d d d d � Z d d d d � Z d d � Z! d d � Z" d d � Z# d d � Z$ d d � Z% d � Z& d S( u=
Module for controlling Jenkins
:depends: python-jenkins
.. versionadded:: 2016.3.0
:depends: python-jenkins_ Python module (not to be confused with jenkins_)
.. _python-jenkins: https://pypi.python.org/pypi/python-jenkins
.. _jenkins: https://pypi.python.org/pypi/jenkins
:configuration: This module can be used by either passing an api key and version
directly or by specifying both in a configuration profile in the salt
master/minion config.
For example:
.. code-block:: yaml
jenkins:
api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15
i ( t absolute_importt print_functiont unicode_literalsN( t CommandExecutionErrort SaltInvocationErroru jenkinsc C@ s0 t r& t t d � r t St d f Sn t d f S( uZ
Return virtual name of the module.
:return: The virtual name of the module.
u Jenkinsut The wrong Python module appears to be installed. Please make sure that 'python-jenkins' is installed, not 'jenkins'.uO The jenkins execution module cannot be loaded: python-jenkins is not installed.( t HAS_JENKINSt hasattrt jenkinst __virtualname__t False( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyt __virtual__3 s
c C@ s� t d d � p- t d d � p- t d d � } t d d � p] t d d � p] t d d � } t d d � p� t d d � p� t d d � } | s� t d � � n t j | d
| d | �S( uw
Return server object used to interact with Jenkins.
:return: server object used to interact with Jenkins
u
config.getu jenkins.urlu jenkins:urlu
pillar.getu jenkins.useru jenkins:useru jenkins.passwordu jenkins:passwordu No Jenkins URL found.t usernamet password( t __salt__R R t Jenkins( t jenkins_urlt jenkins_usert jenkins_password( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyt _connectE s c C@ s5 t d | | � } | s1 t d j | � � � n | S( u�
Helper to cache the config XML and raise a CommandExecutionError if we fail
to do so. If we successfully cache the file, return the cached path.
u
cp.cache_fileu Failed to retrieve {0}( R
R t format( t
config_xmlt saltenvt ret( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyt _retrieve_config_xml_ s c C@ s t � } | j | � S( u�
.. versionadded:: 2017.7.0
Execute a script on the jenkins master
:param script: The script
CLI Example:
.. code-block:: bash
salt '*' jenkins.run 'Jenkins.instance.doSafeRestart()'
( R t
run_script( t scriptt server( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyt runl s c C@ s# t � } | j � } | r | St S( u�
Return version of Jenkins
:return: The version of Jenkins
CLI Example:
.. code-block:: bash
salt '*' jenkins.get_version
( R t get_versionR ( R t version( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyR � s
c C@ s# t � } | j � } | r | Si S( u�
Return the currently configured jobs.
:return: The currently configured jobs.
CLI Example:
.. code-block:: bash
salt '*' jenkins.get_jobs
( R t get_jobs( R t jobs( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyR � s
c C@ s9 | s t d � � n t � } | j | � r1 t St Sd S( u
Check whether the job exists in configured Jenkins jobs.
:param name: The name of the job is check if it exists.
:return: True if job exists, False if job does not exist.
CLI Example:
.. code-block:: bash
salt '*' jenkins.job_exists jobname
u$ Required parameter 'name' is missingN( R R t
job_existst TrueR ( t nameR ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyR � s c C@ s_ | s t d � � n t � } t | � sB t d j | � � � n | j | � } | r[ | St S( u�
Return information about the Jenkins job.
:param name: The name of the job is check if it exists.
:return: Information about the Jenkins job.
CLI Example:
.. code-block:: bash
salt '*' jenkins.get_job_info jobname
u$ Required parameter 'name' is missingu Job '{0}' does not exist( R R R R R t get_job_infoR ( R" R t job_info( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyR# � s c C@ s� | s t d � � n t � } t | � sB t d j | � � � n y | j | | � Wn. t j k
r� } t d j | | � � � n Xt S( u;
Initiate a build for the provided job.
:param name: The name of the job is check if it exists.
:param parameters: Parameters to send to the job.
:return: True is successful, otherwise raise an exception.
CLI Example:
.. code-block:: bash
salt '*' jenkins.build_job jobname
u$ Required parameter 'name' is missingu Job '{0}' does not exist.u) Encountered error building job '{0}': {1}( R R R R R t build_jobR t JenkinsExceptionR! ( R" t
parametersR t err( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyR% � s u basec C@ s� | s t d � � n t | � r9 t d j | � � � n | sK t j } nH t | | � } t j j j
| � �" } t j j j | j
� � } Wd QXt � } y | j | | � Wn. t j k
r� } t d j | | � � � n X| S( u�
Return the configuration file.
:param name: The name of the job is check if it exists.
:param config_xml: The configuration file to use to create the job.
:param saltenv: The environment to look for the file in.
:return: The configuration file used for the job.
CLI Example:
.. code-block:: bash
salt '*' jenkins.create_job jobname
salt '*' jenkins.create_job jobname config_xml='salt://jenkins/config.xml'
u$ Required parameter 'name' is missingu Job '{0}' already existsNu) Encountered error creating job '{0}': {1}( R R R R R t EMPTY_CONFIG_XMLR t saltt utilst filest fopent stringutilst
to_unicodet readR t
create_jobR& ( R" R R t config_xml_filet _fpR R( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyR1 � s ! c C@ s� | s t d � � n | s' t j } nH t | | � } t j j j | � �" } t j j j | j
� � } Wd QXt � } y | j | | � Wn. t j
k
r� } t d j | | � � � n X| S( u�
Return the updated configuration file.
:param name: The name of the job is check if it exists.
:param config_xml: The configuration file to use to create the job.
:param saltenv: The environment to look for the file in.
:return: The configuration file used for the job.
CLI Example:
.. code-block:: bash
salt '*' jenkins.update_job jobname
salt '*' jenkins.update_job jobname config_xml='salt://jenkins/config.xml'
u$ Required parameter 'name' is missingNu) Encountered error updating job '{0}': {1}( R R R) R R* R+ R, R- R. R/ R0 R t reconfig_jobR& R R ( R" R R R2 R3 R R( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyt
update_job* s ! c C@ s� | s t d � � n t � } t | � sB t d j | � � � n y | j | � Wn. t j k
r� } t d j | | � � � n Xt S( u�
Return true is job is deleted successfully.
:param name: The name of the job to delete.
:return: Return true if job is deleted successfully.
CLI Example:
.. code-block:: bash
salt '*' jenkins.delete_job jobname
u$ Required parameter 'name' is missingu Job '{0}' does not existu) Encountered error deleting job '{0}': {1}( R R R R R t
delete_jobR R& R! ( R" R R( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyR6 S s c C@ s� | s t d � � n t � } t | � sB t d j | � � � n y | j | � Wn. t j k
r� } t d j | | � � � n Xt S( u�
Return true is job is enabled successfully.
:param name: The name of the job to enable.
:return: Return true if job is enabled successfully.
CLI Example:
.. code-block:: bash
salt '*' jenkins.enable_job jobname
u$ Required parameter 'name' is missingu Job '{0}' does not existu) Encountered error enabling job '{0}': {1}( R R R R R t
enable_jobR R& R! ( R" R R( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyR7 r s c C@ s� | s t d � � n t � } t | � sB t d j | � � � n y | j | � Wn. t j k
r� } t d j | | � � � n Xt S( u�
Return true is job is disabled successfully.
:param name: The name of the job to disable.
:return: Return true if job is disabled successfully.
CLI Example:
.. code-block:: bash
salt '*' jenkins.disable_job jobname
u$ Required parameter 'name' is missingu Job '{0}' does not existu* Encountered error disabling job '{0}': {1}( R R R R R t disable_jobR R& R! ( R" R R( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyR8 � s c C@ sS | s t d � � n t � } t | � sB t d j | � � � n | j d � d S( u
Return the current status, enabled or disabled, of the job.
:param name: The name of the job to return status for
:return: Return true if enabled or false if disabled.
CLI Example:
.. code-block:: bash
salt '*' jenkins.job_status jobname
u$ Required parameter 'name' is missingu Job '{0}' does not existu emptyu buildable( R R R R R R# ( R" R ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyt
job_status� s c C@ sU | s t d � � n t � } t | � sB t d j | � � � n | j | � } | S( u
Return the current job configuration for the provided job.
:param name: The name of the job to return the configuration for.
:return: The configuration for the job specified.
CLI Example:
.. code-block:: bash
salt '*' jenkins.get_job_config jobname
u$ Required parameter 'name' is missingu Job '{0}' does not exist( R R R R R t get_job_config( R" R R$ ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyR: � s c C@ sR t � } | j � } g | j � D] } | | k r" | ^ q" } | rJ t St Sd S( uV
.. versionadded:: 2016.11.0
Return if the plugin is installed for the provided plugin name.
:param name: The name of the parameter to confirm installation.
:return: True if plugin exists, False if plugin does not exist.
CLI Example:
.. code-block:: bash
salt '*' jenkins.plugin_installed pluginName
N( R t get_pluginst keysR! R ( R" R t pluginst plugint exists( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyt plugin_installed� s +(' t __doc__t
__future__R R R t loggingt salt.utils.stringutilsR* R R! R t ImportErrorR t salt.utils.filest salt.exceptionsR R t getLoggert __name__t logR R
R R R R R t NoneR R# R% R1 R5 R6 R7 R8 R9 R: R@ ( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jenkinsmod.pyt <module> sB
* '
Mini Shell