VhqddlmZmZmZeZdZdZdZddl Z ddl Z ddl Z ddl Z ddl Z ddlmZmZddlmZddlmZdd lmZmZdd lmZmZdd lmZdd lmZGd de Z!Gdde"Z#dZ$e%dk(re$yy))absolute_importdivisionprint_functiona module: jenkins_plugin author: Jiri Tyr (@jtyr) short_description: Add or remove Jenkins plugin description: - Ansible module which helps to manage Jenkins plugins. attributes: check_mode: support: full diff_mode: support: none options: group: type: str description: - GID or name of the Jenkins group on the OS. default: jenkins jenkins_home: type: path description: - Home directory of the Jenkins user. default: /var/lib/jenkins mode: type: raw description: - File mode applied on versioned plugins. default: '0644' name: type: str description: - Plugin name. required: true owner: type: str description: - UID or name of the Jenkins user on the OS. default: jenkins state: type: str description: - Desired plugin state. - If set to V(latest), 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: type: int description: - Server connection timeout in secs. default: 30 updates_expiration: type: int description: - Number of seconds after which a new copy of the C(update-center.json) file is downloaded. This is used to avoid the need to download the plugin to calculate its checksum when O(state=latest) is specified. - Set it to V(0) if no cache file should be used. In that case, the plugin file will always be downloaded to calculate its checksum when O(state=latest) is specified. default: 86400 updates_url: type: list elements: str description: - A list of base URL(s) to retrieve C(update-center.json), and direct plugin files from. - This can be a list since community.general 3.3.0. default: ['https://updates.jenkins.io', 'http://mirrors.jenkins.io'] update_json_url_segment: type: list elements: str description: - A list of URL segment(s) to retrieve the update center JSON file from. default: ['update-center.json', 'updates/update-center.json'] version_added: 3.3.0 latest_plugins_url_segments: type: list elements: str description: - Path inside the O(updates_url) to get latest plugins from. default: ['latest'] version_added: 3.3.0 versioned_plugins_url_segments: type: list elements: str description: - Path inside the O(updates_url) to get specific version of plugins from. default: ['download/plugins', 'plugins'] version_added: 3.3.0 url: type: str description: - URL of the Jenkins server. default: http://localhost:8080 version: type: str 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 V(1.20) would be unquoted, it would become V(1.2). with_dependencies: description: - Defines whether to install plugin dependencies. - This option takes effect only if the O(version) is not defined. type: bool default: true 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 is necessary to notify the handler or call the M(ansible.builtin.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 O(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. extends_documentation_fragment: - ansible.builtin.url - ansible.builtin.files - community.general.attributes a$ - name: Install plugin community.general.jenkins_plugin: name: build-pipeline-plugin - name: Install plugin without its dependencies community.general.jenkins_plugin: name: build-pipeline-plugin with_dependencies: false - name: Make sure the plugin is always up-to-date community.general.jenkins_plugin: name: token-macro state: latest - name: Install specific version of the plugin community.general.jenkins_plugin: name: token-macro version: "1.15" - name: Pin the plugin community.general.jenkins_plugin: name: token-macro state: pinned - name: Unpin the plugin community.general.jenkins_plugin: name: token-macro state: unpinned - name: Enable the plugin community.general.jenkins_plugin: name: token-macro state: enabled - name: Disable the plugin community.general.jenkins_plugin: name: token-macro state: disabled - name: Uninstall plugin community.general.jenkins_plugin: name: build-pipeline-plugin state: absent # # Example of how to authenticate # - name: Install plugin community.general.jenkins_plugin: name: build-pipeline-plugin url_username: admin url_password: p4ssw0rd url: http://localhost:8888 # # Example of how to authenticate with serverless deployment # - name: Update plugins on ECS Fargate Jenkins instance community.general.jenkins_plugin: # plugin name and version name: ws-cleanup version: '0.45' # Jenkins home path mounted on ec2-helper VM (example) jenkins_home: "/mnt/{{ jenkins_instance }}" # matching the UID/GID to one in official Jenkins image owner: 1000 group: 1000 # Jenkins instance URL and admin credentials url: "https://{{ jenkins_instance }}.com/" url_username: admin url_password: p4ssw0rd # make module work from EC2 which has local access # to EFS mount as well as Jenkins URL delegate_to: ec2-helper vars: jenkins_instance: foobar # # 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: true build-pipeline-plugin: version: "1.4.9" pinned: false enabled: true tasks: - name: Install plugins without a specific version community.general.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 community.general.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 ansible.builtin.set_fact: jenkins_restart_required: false - name: Check if restart is required by any of the versioned plugins ansible.builtin.set_fact: jenkins_restart_required: true when: item.changed with_items: "{{ my_jenkins_plugin_versioned.results }}" - name: Check if restart is required by any of the unversioned plugins ansible.builtin.set_fact: jenkins_restart_required: true when: item.changed with_items: "{{ my_jenkins_plugin_unversioned.results }}" - name: Restart Jenkins if required ansible.builtin.service: name: jenkins state: restarted when: jenkins_restart_required - name: Wait for Jenkins to start up ansible.builtin.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 ansible.builtin.set_fact: jenkins_restart_required: false when: jenkins_restart_required - name: Plugin pinning community.general.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 community.general.jenkins_plugin: name: "{{ item.key }}" state: "{{ 'enabled' if item.value['enabled'] else 'disabled'}}" when: > 'enabled' in item.value with_dict: "{{ my_jenkins_plugins }}" z 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" N) AnsibleModuleto_bytes)http_cookiejar) urlencode) fetch_urlurl_argument_spec) text_type binary_type) to_native)download_updates_filec eZdZy)!FailedInstallingWithPluginManagerN)__name__ __module__ __qualname__t/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/general/plugins/modules/jenkins_plugin.pyrrIsrrceZdZdZdZdZddZ ddZdZdZ d Z d Z d Z d Z d ZdZdZdZdZdZdZdZdZdZdZdZy) JenkinsPlugincP||_|jj|_|jd|_|jd|_i|_d|_|j r.tj|_|j|_|jy)Nurltimeout) moduleparamsrrcrumbcookies _csrf_enabled cookiejar LWPCookieJar _get_crumb_get_installed_plugins)selfrs r__init__zJenkinsPlugin.__init__Ns kk(( ;;u%{{9-      $113DL*DJ ##%rc|j|jddd}d|vr|jjd||dS)N/zapi/jsonCSRF useCrumbsz1Required fields not found in the Crumbs response.msgdetails_get_json_datarr fail_json)r& csrf_datas rr!zJenkinsPlugin._csrf_enabledcsT''xx ,f6  i ' KK ! !G! " #%%rc |j||fi|} tjt|j }|S#t $r4}|j jd|zt|Yd}~Sd}~wwxYw)NzCannot parse %s JSON data.r,) _get_url_datajsonloadsrread Exceptionrr1)r&rwhatkwargsr json_dataes rr0zJenkinsPlugin._get_json_datans D  sD 3F 3 & 9QVVX#67I   & KK ! !047!!  " & &  &s,A B )A<<BNc |d|z}|d|z}i}|D]}d} |jjd|zt|j|f|j|j|j d|\} } | ddk(r)| |#|jj||||<cScS|d|d| d}| dd kDr |d | d }||jj||||<|jj|| y#t $r} |d|d t| }Yd} ~ dd} ~ wwxYw#|!|jj||||<wwxYw)N Cannot get %sRetrieval of %s failed.zfetching url: %srr headersstatusz. fetching url z failed. response code: iz. response body: bodyz failed. error msg: r,) rdebugr rr rr8rr1) r&urlsr9 msg_status msg_exceptionr:errorsrerr_msgresponseinfor=s r_get_urls_datazJenkinsPlugin._get_urls_data|s  (4/J  5S(#&KK%%g.")F3K' S]^acghpcqrGH~+=Dd6l"S&KK%%g.")F3K' *, -@ hISUXZcdeZfg h&KK%%g.")F3K's0A#D$D D,D'"D/'D,,D//%Ec |d|z}|d|z} t|j|f|j|j|jd|\}}|ddk7r0|rt |d|jj ||d|S#t$r>} |r t | |jj |t| Yd} ~ Sd} ~ wwxYw)Nr?r@rArCrDr-r,) r rrr rrr1r8r) r&rr9rHrI dont_failr:rLrMr=s rr4zJenkinsPlugin._get_url_datas  (4/J  5((a8"G 77>>+ & F MM$++ & >>vFI;;))++DDw( _5  66sL L L  L Lc g}|jdD]E}|jdD]1}|jdj|||jd3G|S)N updates_urllatest_plugins_url_segmentsz{0}/{1}/{2}.hpirZrappendformat)r&rGbase_urlupdate_segments rr|z%JenkinsPlugin._get_latest_plugin_urls`si M2 eH"&++.K"L e -44X~t{{[aObcd e e rc g}|jdD]S}|jdD]?}|jdj|||jd|jdAU|S)Nrversioned_plugins_url_segmentsz{0}/{1}/{2}/{3}/{2}.hpirZrrr)r&rGrversioned_segments rr}z(JenkinsPlugin._get_versioned_plugin_urlsgs M2 HH%)[[1Q%R H! 5<.>.@ +M+ HH]AFFH - *' ,  &(7;AJJLE::ajjl+D | + KK # #BGGOO4D$ErwwWcGd exx 2&**4;;v+>? KK ! !&T ! UIt{{6233i & KK ! !7!!  " & & &* * %%?BRR%aL&** * & KK ! !1EUYeEe\kmn!!  " & & & KK ! !DXhlxXx AB!!  " & & &sTF?GA H G%&GG H")HH J"0I J$0JJc*|j|ddS)NzPlugin not found.zPlugin download failed.r)rN)r&rs rr~zJenkinsPlugin._download_plugins%"" *3#5 5rc*tj\}}t|ttfrt j ||n$t j ||j t j||jjt jj|t jj|y#t$r3}|jjd|zt|Yd}~d}~wwxYw)Nz)Cannot close the temporal plugin file %s.r,)rr isinstancer r rirr7rrrr1rrrjr)r&rretmp_f_fdtmp_fr=s rrzJenkinsPlugin._write_files"**,% dY 4 5 HHXt $ HHXtyy{ + & HHX   68JK  & KK ! !?%G!!  " & & &s*C D)D  Dcvd}|jr*|jjs|jddd}|S)NF doUninstallUninstallationT)r]rrh _pm_query)r&rs r uninstallzJenkinsPlugin.uninstalls8   ;;))}.>?Grc$|jdS)Npin_pinningr&s rrzJenkinsPlugin.pins}}U##rc$|jdS)Nunpinrrs rrzJenkinsPlugin.unpins}}W%%rcd}|dk(r |jr|dk(rG|jr;|jjs#|j|d|j zd}|S)NFrrz%sningT)r^rrhr capitalizer&actionrs rrzJenkinsPlugin._pinningsY%'!dnn;;))vx&2C2C2E'EFGrc$|jdS)Nenable _enablingrs rrzJenkinsPlugin.enables~~h''rc$|jdS)Ndisablerrs rrzJenkinsPlugin.disables~~i((rcd}|dk(r |jr|dk(r[|jrO|jjs7|jd|j zd|ddj zd}|S)NFrrzmake%sdz%singT)r_rrhrrrs rrzJenkinsPlugin._enablingst("4??)#;;)) 1 1 33fSbk44668Grc|jdd|jdd|}|j|d|zd|zdy) Nrz/pluginManager/plugin/rZr)zPlugin not found. %sz%s has failed.POST)rHrImethod)rr4)r&rr-rs rrzJenkinsPlugin._pm_querysM KK  F 3V=  -3*S0  r)NNN)NNNF)rrrr'r!r0rNr4r$r%rprr|r}rrr~rrrrrrrrrrrrrrMs&* & ADBF: 4$BZx74r5L& $& ()$ rrct}|jtddtddtddtdd tddtgd d tddtddtddddgtddddgtdddgtddddgtdtd ttd dt|d d }d |jd < t |jd!|jd!<|jd$dk(rd |jd$<d|jd%<|jd&}|jd$}d'}t|}|d k(r|j}nm|d(k(r|j}nW|d)k(r|j}nA|d*k(r|j}n+|d+k(r|j}n|d,k(r|j}|j!|||-y#t $r7}|jd"|jd!zt|#Yd}~.d}~wwxYw).Nstrjenkins)typedefaultrjz/var/lib/jenkins0644raw)rrT)rrequired)presentabsentr[unpinnedr\disabledrsr)choicesrintiQlistzhttps://updates.jenkins.iozhttp://mirrors.jenkins.io)relementsrzupdate-center.jsonzupdates/update-center.jsonrszdownload/pluginsrWzhttp://localhost:8080)r)no_logbool)grouprfmoderZownerstaterrurrrrr url_passwordrrrc) argument_specadd_file_common_argssupports_check_modeforce_basic_authrzCannot convert %s to float.r,rrrrZFrr[rr\r)rpluginr)r rdictrrfloat ValueErrorr1rrrrrrrr exit_json)rrr=rZrrjps rmainrsa%'My1v/AB &u - ut ,y1 Re,E:fu?[?Z?\] $&5K_KgKi!j$(fuxj$Y'+%RdfoQp'q 0 1&t&97<#! F)-FMM$%"#(y)A#B i }}W)!* g#+ i  == D MM' "EG v B **, ( ,,. ( &&( * ((* ) ))+ * **, WT?G "- i0HHaL  " ""s%H I#,II__main__)& __future__rrrr __metaclass__ DOCUMENTATIONEXAMPLESRETURNrzrr5riransible.module_utils.basicrransible.module_utils.six.movesrr"+ansible.module_utils.six.moves.urllib.parser ansible.module_utils.urlsr r ansible.module_utils.sixr r +ansible.module_utils.common.text.convertersrBansible_collections.community.general.plugins.module_utils.jenkinsrr8robjectrrrrrrrsA@ w re N  >FAB;Ad  FDP@f zFr