�
�Udac @` s; d d l m Z m Z m Z e Z i d d 6d g d 6d d 6Z d Z d Z d
Z d d l
m Z m Z d d l
m Z d d
l m Z d d l m Z m Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d e f d � � YZ d � Z! e" d k r7e! � n d S( i ( t absolute_importt divisiont print_functions 1.1t metadata_versiont previewt statust communityt supported_bys-
---
module: jenkins_plugin
author: Jiri Tyr (@jtyr)
version_added: '2.2'
short_description: Add or remove Jenkins plugin
description:
- Ansible module which helps to manage Jenkins plugins.
options:
group:
description:
- Name of the Jenkins group on the OS.
default: jenkins
jenkins_home:
description:
- Home directory of the Jenkins user.
default: /var/lib/jenkins
mode:
description:
- File mode applied on versioned plugins.
default: '0644'
name:
description:
- Plugin name.
required: yes
owner:
description:
- Name of the Jenkins user on the OS.
default: jenkins
state:
description:
- Desired plugin state.
- If the C(latest) is set, the check for new version will be performed
every time. This is suitable to keep the plugin up-to-date.
choices: [absent, present, pinned, unpinned, enabled, disabled, latest]
default: present
timeout:
description:
- Server connection timeout in secs.
default: 30
updates_expiration:
description:
- Number of seconds after which a new copy of the I(update-center.json)
file is downloaded. This is used to avoid the need to download the
plugin to calculate its checksum when C(latest) is specified.
- Set it to C(0) if no cache file should be used. In that case, the
plugin file will always be downloaded to calculate its checksum when
C(latest) is specified.
default: 86400
updates_url:
description:
- URL of the Update Centre.
- Used as the base URL to download the plugins and the
I(update-center.json) JSON file.
default: https://updates.jenkins.io
url:
description:
- URL of the Jenkins server.
default: http://localhost:8080
version:
description:
- Plugin version number.
- If this option is specified, all plugin dependencies must be installed
manually.
- It might take longer to verify that the correct version is installed.
This is especially true if a specific version number is specified.
- Quote the version to prevent the value to be interpreted as float. For
example if C(1.20) would be unquoted, it would become C(1.2).
with_dependencies:
description:
- Defines whether to install plugin dependencies.
- This option takes effect only if the I(version) is not defined.
type: bool
default: yes
notes:
- Plugin installation should be run under root or the same user which owns
the plugin files on the disk. Only if the plugin is not installed yet and
no version is specified, the API installation is performed which requires
only the Web UI credentials.
- It's necessary to notify the handler or call the I(service) module to
restart the Jenkins service after a new plugin was installed.
- Pinning works only if the plugin is installed and Jenkins service was
successfully restarted after the plugin installation.
- It is not possible to run the module remotely by changing the I(url)
parameter to point to the Jenkins server. The module must be used on the
host where Jenkins runs as it needs direct access to the plugin files.
- "The C(params) option was removed in Ansible 2.5 due to circumventing Ansible's
option handling"
extends_documentation_fragment:
- url
s�
- name: Install plugin
jenkins_plugin:
name: build-pipeline-plugin
- name: Install plugin without its dependencies
jenkins_plugin:
name: build-pipeline-plugin
with_dependencies: no
- name: Make sure the plugin is always up-to-date
jenkins_plugin:
name: token-macro
state: latest
- name: Install specific version of the plugin
jenkins_plugin:
name: token-macro
version: "1.15"
- name: Pin the plugin
jenkins_plugin:
name: token-macro
state: pinned
- name: Unpin the plugin
jenkins_plugin:
name: token-macro
state: unpinned
- name: Enable the plugin
jenkins_plugin:
name: token-macro
state: enabled
- name: Disable the plugin
jenkins_plugin:
name: token-macro
state: disabled
- name: Uninstall plugin
jenkins_plugin:
name: build-pipeline-plugin
state: absent
#
# Example of how to authenticate
#
- name: Install plugin
jenkins_plugin:
name: build-pipeline-plugin
url_username: admin
url_password: p4ssw0rd
url: http://localhost:8888
#
# Example of a Play which handles Jenkins restarts during the state changes
#
- name: Jenkins Master play
hosts: jenkins-master
vars:
my_jenkins_plugins:
token-macro:
enabled: yes
build-pipeline-plugin:
version: "1.4.9"
pinned: no
enabled: yes
tasks:
- name: Install plugins without a specific version
jenkins_plugin:
name: "{{ item.key }}"
register: my_jenkins_plugin_unversioned
when: >
'version' not in item.value
with_dict: "{{ my_jenkins_plugins }}"
- name: Install plugins with a specific version
jenkins_plugin:
name: "{{ item.key }}"
version: "{{ item.value['version'] }}"
register: my_jenkins_plugin_versioned
when: >
'version' in item.value
with_dict: "{{ my_jenkins_plugins }}"
- name: Initiate the fact
set_fact:
jenkins_restart_required: no
- name: Check if restart is required by any of the versioned plugins
set_fact:
jenkins_restart_required: yes
when: item.changed
with_items: "{{ my_jenkins_plugin_versioned.results }}"
- name: Check if restart is required by any of the unversioned plugins
set_fact:
jenkins_restart_required: yes
when: item.changed
with_items: "{{ my_jenkins_plugin_unversioned.results }}"
- name: Restart Jenkins if required
service:
name: jenkins
state: restarted
when: jenkins_restart_required
- name: Wait for Jenkins to start up
uri:
url: http://localhost:8080
status_code: 200
timeout: 5
register: jenkins_service_status
# Keep trying for 5 mins in 5 sec intervals
retries: 60
delay: 5
until: >
'status' in jenkins_service_status and
jenkins_service_status['status'] == 200
when: jenkins_restart_required
- name: Reset the fact
set_fact:
jenkins_restart_required: no
when: jenkins_restart_required
- name: Plugin pinning
jenkins_plugin:
name: "{{ item.key }}"
state: "{{ 'pinned' if item.value['pinned'] else 'unpinned'}}"
when: >
'pinned' in item.value
with_dict: "{{ my_jenkins_plugins }}"
- name: Plugin enabling
jenkins_plugin:
name: "{{ item.key }}"
state: "{{ 'enabled' if item.value['enabled'] else 'disabled'}}"
when: >
'enabled' in item.value
with_dict: "{{ my_jenkins_plugins }}"
s�
plugin:
description: plugin name
returned: success
type: str
sample: build-pipeline-plugin
state:
description: state of the target, after execution
returned: success
type: str
sample: "present"
( t
AnsibleModulet to_bytes( t http_cookiejar( t urlencode( t fetch_urlt url_argument_spec( t to_nativet text_typet binary_typeNt
JenkinsPluginc B` s� e Z d � Z d � Z d � Z d d d d � Z d � Z d � Z d � Z d � Z
d � Z d � Z d
� Z
d � Z d � Z d
� Z d � Z d � Z d � Z d � Z RS( c C` s� | | _ | j j | _ | j d | _ | j d | _ i | _ d | _ | j � rw t j � | _ | j
� | _ n | j � d S( Nt urlt timeout( t modulet paramsR R t crumbt Nonet cookiest
_csrf_enabledt cookiejart LWPCookieJart
_get_crumbt _get_installed_plugins( t selfR ( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyt __init__ s c C` sO | j d | j d f d � } d | k rG | j j d d d | � n | d S( Ns %s/%ss api/jsont CSRFt useCrumbst msgs1 Required fields not found in the Crumbs response.t details( t _get_json_dataR R t fail_json( R t csrf_data( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyR - s
c K` sq | j | | | � } y t j t | j � � � } Wn6 t k
rl } | j j d d | d t | � � n X| S( NR" s Cannot parse %s JSON data.R# ( t
_get_url_datat jsont loadsR t readt ExceptionR R% ( R R t whatt kwargst rt json_datat e( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyR$ 8 s
c
K` s� | d k r d | } n | d k r2 d | } n yj t | j | d | j d | j d | j | �\ } } | d d k r� | j j d | d | d � n Wn2 t k
r� } | j j d | d t | � � n X| S(
Ns
Cannot get %ss Retrieval of %s failed.R R t headersR i� R" R# ( R R R R R R R% R+ R ( R R R, t
msg_statust
msg_exceptionR- t responset infoR0 ( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyR' F s
$#c C` sl | j d | j d f d � } d | k rO d | k rO i | d | d 6} n | j j d d d | � | S( Ns %s/%ss crumbIssuer/api/jsont Crumbt crumbRequestFieldR R" s/ Required fields not found in the Crum response.R# ( R$ R R R% ( R t
crumb_datat ret( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyR ] s c C` s� | j d | j d f d � } d | k rA | j j d d � n t | _ t | _ t | _ xb | d D]V } | d | j d k rg t | _ | d r� t | _ n | d
r� t | _ n Pqg qg Wd S( Ns %s/%ss pluginManager/api/json?depth=1s list of pluginst pluginsR" s No valid plugin data found.t shortNamet namet pinnedt enabled(
R$ R R R% t Falset is_installedt is_pinnedt
is_enabledR t True( R t plugins_datat p( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyR l s
c
C` s" t } d | j d | j d f } | j r| j d d k r| j j s d | j d } | j d r� d | j d | f } n i | d 6} t | � } | j d
| j d d d
d d | �} d | j d | j d f } t j
j | � r t j | � q n t
} n�t j
j | j d � sA| j j d d � n d } t j
j | � r�t | d � � } | j � }
Wd QXt j |
� j � } n | j d d k r�d | j d | j d f } n* d j | j d | j d | j d � } | j d d k s%| j d d k s%| d k r�| j | � } | d k rh| j j s_| j | | � n t
} q�| j � } t j | � j � } | | k r�| j j s�| j | | � n t
} q�n� | j d d k r�| j � }
y7 t | d � � } | j � } Wd QXt j | � } Wn2 t k
rJ} | j j d d d t | � � n Xt j | j � � } | t |
d � k r�| j j s�| j | � } | j | | � n t
} q�n t j
j | � r i | d 6} | j | j � | j j! | � } | j j s| j j" | | � } q t
} n | S( Ns %s/plugins/%s.jpit jenkins_homeR< t versiont latestsD d = Jenkins.instance.updateCenter.getPlugin("%s").deploy(); d.get();t with_dependenciess[ Jenkins.instance.updateCenter.getPlugin("%s").getNeededDependencies().each{it.deploy()}; %st scripts
%s/scriptTextR2 s Cannot install plugin.R3 s Plugin installation has failed.t datas %s/plugins/%s.hpiR" s% Jenkins home directory doesn't exist.t rbs %s/latest/%s.hpit updates_urls$ {0}/download/plugins/{1}/{2}/{1}.hpit updates_expirationi s( Cannot calculate SHA1 of the old plugin.R# t sha1t dest( NRH ( NRH ( NRH (# R? R R@ R R t
check_modeR R' R t ost patht isfilet removeRC t isdirR% t openR* t hashlibt md5t hexdigestt formatt _download_plugint _write_filet _download_updatesRO R+ R t base64t b64encodet digestR t updatet load_file_common_argumentst set_fs_attributes_if_different( R t changedt plugin_filet install_scriptt script_dataRK R. t hpi_filet
md5sum_oldt
md5_plugin_fht md5_plugin_contentt
plugin_urlt
md5sum_newt plugin_datat sha1_plugin_fht sha1_plugin_contentt sha1_oldR0 t sha1sum_oldR t file_args( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyt install� s�
c C` s� d } t j j d � } d | | f } t } t j j | � r� t j | � j } t j � } | | | j d k r� t } q� n | } | r.d | j d } | j
| d d d d
�} t j � \ }
} t j
|
| j � � y t j |
� Wq.t k
r*} | j j d d | d
t | � � q.Xn y t | � } Wn2 t k
rr} | j j d d d
t | � � n Xd }
xp | D]h } |
d k r�y t j | � } Wn2 t k
r�} | j j d d d
t | � � n XPn |
d 7}
q�W| rot j j | � sYy t j | t d d � � WqYt k
rU} | j j d d d
t | � � qYXn | j j | | � n d | k s�| j d | d k r�| j j d d � n | d | j d S( Ns jenkins-plugin-cache.jsons ~/.ansible/tmps %s/%sRN s %s/update-center.jsonRM R2 s Remote updates not found.R3 s Updates download failed.R" s% Cannot close the tmp updates file %s.R# s" Cannot open temporal updates file.i i s0 Cannot load JSON data from the tmp updates file.t 0700i s! Cannot create temporal directory.R: R< s, Cannot find plugin data in the updates file.( RR RS t
expanduserRC RT t statt st_mtimet timeR R? R' t tempfilet mkstempt writeR* t closet IOErrorR R% R RW R( R) R+ RV t makedirst intt OSErrort atomic_move( R t updates_filenamet updates_dirt updates_filet download_updatest ts_filet ts_nowt updates_file_origR R. t update_fdR0 t ft it lineRK ( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyR^ sl
#
c C` s | j | d d d d �} | S( NR2 s Plugin not found.R3 s Plugin download failed.( R' ( R Rm R. ( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyR\ a s
c C` s� t j � \ } } t | t t f � r: t j | | � n t j | | j � � y t j | � Wn6 t k
r� } | j
j d d | d t | � � n X| j
j
| | � d S( NR" s) Cannot close the temporal plugin file %s.R# ( R{ R| t
isinstanceR R RR R} R* R~ R R R% R R� ( R R� RK t tmp_f_fdt tmp_fR0 ( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyR] j s
c C` s; t } | j r7 | j j s. | j d d � n t } n | S( Nt doUninstallt Uninstallation( R? R@ R RQ t _pm_queryRC ( R Re ( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyt uninstall} s c C` s
| j d � S( Nt pin( t _pinning( R ( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyR� � s c C` s
| j d � S( Nt unpin( R� ( R ( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyR� � s c C` sg t } | d k r | j s1 | d k rc | j rc | j j sZ | j | d | j � � n t } n | S( NR� R� s %sning( R? RA R RQ R� t
capitalizeRC ( R t actionRe ( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyR� � s c C` s
| j d � S( Nt enable( t _enabling( R ( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyR� � s c C` s
| j d � S( Nt disable( R� ( R ( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyR� � s c C` su t } | d k r | j s1 | d k rq | j rq | j j sh | j d | j � d | d j � � n t } n | S( NR� R� s make%sds %singi����( R? RB R RQ R� R� RC ( R R� Re ( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyR� � s
c C` sF d | j d | j d | f } | j | d d | d d | �d S( Ns %s/pluginManager/plugin/%s/%sR R< R2 s Plugin not found. %sR3 s %s has failed.( R R' ( R R� R" R ( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyR� � s
N( t __name__t
__module__R R R$ R R' R R Ru R^ R\ R] R� R� R� R� R� R� R� R� ( ( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyR s$ � Q c ! C` s� t � } | j d t d d � d t d d � d t d d d d � d
t d t � d t d d � d
t d d � d t d d d d d d d d g d d � d t d d d d � d t d d d d � d t d d � d t d d � d! t d" t � d# t � d$ t d t d d% � � t d& | d' t d( t � } | j d
rM| j d) d* � n t | j d+ <y t | j d � | j d <Wn: t k
r�} | j d) d, | j d d- t | � � n X| j d d k r�d | j d <d | j d# <n | j d
} | j d } t
} t | � } | d k r,| j � } n� | d k rG| j
� } nl | d k rb| j � } nQ | d k r}| j � } n6 | d k r�| j � } n | d k r�| j � } n | j d. | d/ | d | � d S(0 Nt groupt defaultt jenkinsRF s /var/lib/jenkinst modet 0644t typet rawR< t requiredt ownerR t dictt statet choicest presentt absentR= t unpinnedR> t disabledRH R i R� RN i�Q RM s https://updates.jenkins.ioR s http://localhost:8080t url_passwordt no_logRG RI t boolt
argument_spect add_file_common_argst supports_check_modeR" sm The params option to jenkins_plugin was removed in Ansible 2.5 since it circumvents Ansible's option handlingt force_basic_auths Cannot convert %s to float.R# Re t plugin( R
Rb R� RC R R R% t floatt
ValueErrorR R? R Ru R� R� R� R� R� t exit_json( R� R R0 R< R� Re t jp( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyt main� sr
t __main__(# t
__future__R R R R� t
__metaclass__t ANSIBLE_METADATAt
DOCUMENTATIONt EXAMPLESt RETURNt ansible.module_utils.basicR R t ansible.module_utils.six.movesR
R t+ ansible.module_utils.six.moves.urllib.parseR t ansible.module_utils.urlsR R
t ansible.module_utils._textR R R R_ RX R( RR R{ Rz t objectR R� R� ( ( ( sU /usr/lib/python2.7/site-packages/ansible/modules/web_infrastructure/jenkins_plugin.pyt <module> s.
^�
� � T
Anons79 File Manager Version 1.0, Coded By Anons79
Email: [email protected]
Anons79 Mini Shell