VhpddlmZmZmZeZdZdZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlZddlZddlmZmZddlmZddlmZmZmZddlmZGd d eZd Zed k(reyy) )absolute_importdivisionprint_functiona module: jira short_description: Create and modify issues in a JIRA instance description: - Create and modify issues in a JIRA instance. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: uri: type: str required: true description: - Base URI for the JIRA instance. operation: type: str required: true aliases: [command] choices: [attach, comment, create, edit, fetch, link, search, transition, update, worklog] description: - The operation to perform. - V(worklog) was added in community.general 6.5.0. username: type: str description: - The username to log-in with. - Must be used with O(password). Mutually exclusive with O(token). password: type: str description: - The password to log-in with. - Must be used with O(username). Mutually exclusive with O(token). token: type: str description: - The personal access token to log-in with. - Mutually exclusive with O(username) and O(password). version_added: 4.2.0 client_cert: type: path description: - Client certificate if required. - In addition to O(username) and O(password) or O(token). Not mutually exclusive. version_added: 10.4.0 client_key: type: path description: - Client certificate key if required. - In addition to O(username) and O(password) or O(token). Not mutually exclusive. version_added: 10.4.0 project: type: str required: false description: - The project for this operation. Required for issue creation. summary: type: str required: false description: - The issue summary, where appropriate. - Note that JIRA may not allow changing field values on specific transitions or states. description: type: str required: false description: - The issue description, where appropriate. - Note that JIRA may not allow changing field values on specific transitions or states. issuetype: type: str required: false description: - The issue type, for issue creation. issue: type: str required: false description: - An existing issue key to operate on. aliases: ['ticket'] comment: type: str required: false description: - The comment text to add. - Note that JIRA may not allow changing field values on specific transitions or states. comment_visibility: type: dict description: - Used to specify comment comment visibility. - See U(https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-comments/#api-rest-api-2-issue-issueidorkey-comment-post) for details. suboptions: type: description: - Use type to specify which of the JIRA visibility restriction types will be used. type: str required: true choices: [group, role] value: description: - Use value to specify value corresponding to the type of visibility restriction. For example name of the group or role. type: str required: true version_added: '3.2.0' status: type: str required: false description: - Only used when O(operation) is V(transition), and a bit of a misnomer, it actually refers to the transition name. - This is mutually exclusive with O(status_id). status_id: type: str required: false description: - Only used when O(operation) is V(transition), and refers to the transition ID. - This is mutually exclusive with O(status). version_added: 10.3.0 assignee: type: str required: false description: - Sets the the assignee when O(operation) is V(create), V(transition), or V(edit). - Recent versions of JIRA no longer accept a user name as a user identifier. In that case, use O(account_id) instead. - Note that JIRA may not allow changing field values on specific transitions or states. account_id: type: str description: - Sets the account identifier for the assignee when O(operation) is V(create), V(transition), or V(edit). - Note that JIRA may not allow changing field values on specific transitions or states. version_added: 2.5.0 linktype: type: str required: false description: - Set type of link, when action 'link' selected. inwardissue: type: str required: false description: - Set issue from which link will be created. outwardissue: type: str required: false description: - Set issue to which link will be created. fields: type: dict required: false description: - This is a free-form data structure that can contain arbitrary data. This is passed directly to the JIRA REST API (possibly after merging with other required data, as when passed to create). See examples for more information, and the JIRA REST API for the structure required for various fields. - When passed to comment, the data structure is merged at the first level since community.general 4.6.0. Useful to add JIRA properties for example. - Note that JIRA may not allow changing field values on specific transitions or states. default: {} jql: required: false description: - Query JIRA in JQL Syntax, for example V("CMDB Hostname" = test.example.com). type: str version_added: '0.2.0' maxresults: required: false description: - Limit the result of O(operation=search). If no value is specified, the default jira limit will be used. - Used when O(operation=search) only, ignored otherwise. type: int version_added: '0.2.0' timeout: type: float required: false description: - Set timeout, in seconds, on requests to JIRA API. default: 10 validate_certs: required: false description: - Require valid SSL certificates (set to V(false) if you would like to use self-signed certificates). default: true type: bool attachment: type: dict version_added: 2.5.0 description: - Information about the attachment being uploaded. suboptions: filename: required: true type: path description: - The path to the file to upload (from the remote node) or, if O(attachment.content) is specified, the filename to use for the attachment. content: type: str description: - The Base64 encoded contents of the file to attach. If not specified, the contents of O(attachment.filename) will be used instead. mimetype: type: str description: - The MIME type to supply for the upload. If not specified, best-effort detection will be done. notes: - Currently this only works with basic-auth, or tokens. - To use with JIRA Cloud, pass the login e-mail as the O(username) and the API token as O(password). author: - "Steve Smith (@tarka)" - "Per Abildgaard Toft (@pertoft)" - "Brandon McNama (@DWSR)" a # Create a new issue and add a comment to it: - name: Create an issue community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' project: ANS operation: create summary: Example Issue description: Created using Ansible issuetype: Task args: fields: customfield_13225: "test" customfield_12931: {"value": "Test"} register: issue - name: Comment on issue community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' issue: '{{ issue.meta.key }}' operation: comment comment: A comment added by Ansible - name: Comment on issue with restricted visibility community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' issue: '{{ issue.meta.key }}' operation: comment comment: A comment added by Ansible comment_visibility: type: role value: Developers - name: Comment on issue with property to mark it internal community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' issue: '{{ issue.meta.key }}' operation: comment comment: A comment added by Ansible fields: properties: - key: 'sd.public.comment' value: internal: true # Add an workog to an existing issue - name: Worklog on issue community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' issue: '{{ issue.meta.key }}' operation: worklog comment: A worklog added by Ansible fields: timeSpentSeconds: 12000 - name: Workflow on issue with comment restricted visibility community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' issue: '{{ issue.meta.key }}' operation: worklog comment: A worklog added by Ansible comment_visibility: type: role value: Developers fields: timeSpentSeconds: 12000 - name: Workflow on issue with comment property to mark it internal community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' issue: '{{ issue.meta.key }}' operation: worklog comment: A worklog added by Ansible fields: properties: - key: 'sd.public.comment' value: internal: true timeSpentSeconds: 12000 # Assign an existing issue using edit - name: Assign an issue using free-form fields community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' issue: '{{ issue.meta.key}}' operation: edit assignee: ssmith # Create an issue with an existing assignee - name: Create an assigned issue community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' project: ANS operation: create summary: Assigned issue description: Created and assigned using Ansible issuetype: Task assignee: ssmith # Edit an issue - name: Set the labels on an issue using free-form fields community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' issue: '{{ issue.meta.key }}' operation: edit args: fields: labels: - autocreated - ansible # Updating a field using operations: add, set & remove - name: Change the value of a Select dropdown community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' issue: '{{ issue.meta.key }}' operation: update args: fields: customfield_12931: ['set': {'value': 'Virtual'}] customfield_13820: ['set': {'value': 'Manually'}] register: cmdb_issue delegate_to: localhost # Retrieve metadata for an issue and use it to create an account - name: Get an issue community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' project: ANS operation: fetch issue: ANS-63 register: issue # Search for an issue # You can limit the search for specific fields by adding optional args. Note! It must be a dict, hence, lastViewed: null - name: Search for an issue community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' project: ANS operation: search maxresults: 10 jql: project=cmdb AND cf[13225]="test" args: fields: lastViewed: register: issue - name: Create a unix account for the reporter become: true user: name: '{{ issue.meta.fields.creator.name }}' comment: '{{ issue.meta.fields.creator.displayName }}' # You can get list of valid linktypes at /rest/api/2/issueLinkType # url of your jira installation. - name: Create link from HSP-1 to MKY-1 community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' operation: link linktype: Relates inwardissue: HSP-1 outwardissue: MKY-1 # Transition an issue - name: Resolve the issue community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' issue: '{{ issue.meta.key }}' operation: transition status: Resolve Issue account_id: 112233445566778899aabbcc fields: resolution: name: Done description: I am done! This is the last description I will ever give you. # Attach a file to an issue - name: Attach a file community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' issue: HSP-1 operation: attach attachment: filename: topsecretreport.xlsx # Use username, password and client certificate authentification - name: Create an issue community.general.jira: uri: '{{ server }}' username: '{{ user }}' password: '{{ pass }}' client_cert: '{{ path/to/client-cert }}' client_key: '{{ path/to/client-key }}' # Use token and client certificate authentification - name: Create an issue community.general.jira: uri: '{{ server }}' token: '{{ token }}' client_cert: '{{ path/to/client-cert }}' client_key: '{{ path/to/client-key }}' N)StateModuleHelper cause_changes) pathname2url)to_textto_bytes to_native) fetch_urlceZdZeedRidedeededded d eddd edgd d gddeddedddedddeddeddeddeddeddeddeddgdeddedeedddgd edd! d"edd#edd$edd%eid&d'edd(edd)edd*edd+ed,d-ed.d/0d1edd2&d3edddgddgd$d3gd"d#ggddgddggddggd d4ddgfd d5gd6fd dddgfd d7ddgfd d8dgfd d9dgfd d9d"d#gdfd d:gd;fd dZd=Zd Zd?Zed@AdBZ ed@AdCZ ed@AdDZ ed@AdEZ ed@AdFZ dGZdHZed@AdIZed@AdJZed@AdKZedSdMZ dTdNZdUdOZdPZdQZyL)VJIRA attachmentdictstr)typepathT)rrequired)contentfilenamemimetype)roptionsuri operation) attachcreatecommenteditupdatefetch transitionlinksearchworklogcommand)rchoicesaliasesrusernamepassword)rno_logtoken client_cert client_keyprojectsummary description issuetypeissueticket)rr'rcomment_visibilitygrouprole)rr&r)rvaluestatus status_idassigneefields)defaultrlinktype inwardissue outwardissuejql maxresultsinttimeoutfloat )rr<validate_certsbool account_idrr)r.r1r/workflowr r!r")r=r>r?r#F) argument_specmutually_exclusiverequired_togetherrequired_one_of required_ifsupports_check_modec4|jji|j_|jjr/d|jji|jjd<|jjr/d|jji|jjd<|jjj d|j_|jj d|jjdzy)Nnamer: accountId/restbasez /rest/api/2)varsr;r:rHrstripset)selfs j/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/general/plugins/modules/jira.py__init_module__zJIRA.__init_module__6s 99   #!DII  99  ,2DII4F4F+GDII  Z ( 99  ,79M9M+NDII  Z ( ++C0  j$))---"?@success)whencd|jji|jjd|jjid}|jjr|jj|d<|jj r%|j |jj d|i}|jjdz}|j|||j_ y)NkeyrQ)r.r/r1r0r;/issue/) rUr.r/r1r0r;rrTpostmeta)rX createfieldsdataurls rYoperation_createzJIRA.operation_create@styy001yy(( $))"5"568 99 *.))*?*?L ' 99      0 0 1,'ii  9,3- r[cd|jji}|jj|jj|d<|jjr%|j |jj|jj dz|jj zdz}|j|||j_y)Nbody visibilityr`z/comment rUrr4r;rrTr2rarbrXrdres rYoperation_commentzJIRA.operation_commentRs DII%%  99 ' ' 3!%!=!=D  99   KK (( )ii  9,tyy>K3- r[cd|jji}|jj|jj|d<|jjr%|j |jj|jj dz|jj zdz}|j|||j_y)Nrrir`z/worklogrjrks rYoperation_worklogzJIRA.operation_worklogbs tyy((  99 ' ' 3!%!=!=D  99   KK (( )ii  9,tyy>K3- r[cd|jji}|jjdz|jjz}|j |||j_y)Nr;r`rUr;rTr2putrbrks rYoperation_editzJIRA.operation_editrS dii&& ii  9,tyy>#t, r[cd|jji}|jjdz|jjz}|j |||j_y)Nrr`rprks rYoperation_updatezJIRA.operation_updatezrsr[c|jjdz|jjz}|j||j_y)Nr`)rUrTr2getrbrXres rYoperation_fetchzJIRA.operation_fetchs6ii  9,tyy># r[c |jjdzt|jjz}|jjrR|jjj }|dzdj |Dcgc] }t|c}z}|jjr%|dzt|jjz}|j||j_ ycc}w)Nz /search?jql=z&fields=z &maxResults=) rUrTrr@r;keysjoinrArrwrb)rXrer;fs rYoperation_searchzJIRA.operation_searchsii  >1L4OO 99  YY%%**,F "Z__v5V!l1o5V%WWC 99  &TYY-A-A)BBC#  6WsC> cv|jjdz|jjzdz}|j|}d}d}|jj%|jjj }n:|jj $|jj j }|dD]}||d|k(s|d}n*||dk(sn|td|ztd|zt|jj}|jj'|jd|jji|jj'|jd |jjid|i|d }|jj.|jd d d d|jjiigii|jjdz|jjzdz}|j|||j_y)Nr`z /transitions transitionsrQidz%Failed find valid transition for '%s'z(Failed find valid transition for ID '%s'r/r0)r!r;rraddrh)rUrTr2rwr8rVr9 ValueErrorrr;r/rr0rrarb) rXturltmetatidtargettr;rdres rYoperation_transitionzJIRA.operation_transitionsyy!!I- ?.P 99   'YY%%++-F YY ,))%%++-C}% SA!V9&D'C!D'> S! !H6!QRR !Kc!QRRdii&&' 99   ( MM9dii&7&78 9 99 , MM=$))*?*?@ A $Sk " 99   ( KKFDII$5$56$  ii  9,tyy>O3- r[cd|jjid|jjid|jjid}|jjdz}|j |||j_y)NrQr_)r inwardIssue outwardIssuez /issueLink/)rUr=r>r?rTrarbrks rYoperation_linkzJIRA.operation_linksmTYY//0!499#8#89"DII$:$:;  ii  =03- r[c|j}|jjd}|jjd}t||fs t d|jjd}t j j|st d|z|j|||\}}|jdz|jzdz}d|j|||d d i fS) Nrrz4at least one of filename or content must be providedrz(The provided filename does not exist: %sr`z /attachmentsTzX-Atlassian-Tokenzno-check) content_typeadditional_headers) rUrrwanyrosrisfile_prepare_attachmentrTr2ra)rXvrrmimerrdres rYoperation_attachzJIRA.operation_attachs II<<##J/,,""9-Hg&'ST T|| +ww~~h'G(RS S!55hN djj9$qww.?TYY LFY[eEf   r[Nc<d}djdtdD}ttjj |}|s# t j|xsdddxsd}|jd \}}}|s3|r1tt|d d 5} | j}dddn tj|}dj#|dj#||dj#dj#||dt%|dj#|dg} dj#|dj| fS#t$rd}YwxYw#1swYxYw#tj $r} td | zd} ~ wwxYw)Nc&|jddS)N"z\")replace)ss rY escape_quotesz/JIRA._prepare_attachment..escape_quotess99S%( (r[c3K|]8}tjtjtjz:ywN)randomchoicestringdigits ascii_letters).0dummys rY z+JIRA._prepare_attachment..s)fSX6==9M9M)MNfs>AF)strictrzapplication/octet-streamrSsurrogate_or_stricterrorsrbz(Unable to base64 decode file content: %sz--{0}z9Content-Disposition: form-data; name="file"; filename={0}zContent-Type: {0}z{0}/{1}z--{0}--z!multipart/form-data; boundary={0}z )r|ranger rrbasename mimetypes guess_type Exception partitionopenr readbase64 b64decodebinasciiErrorformatr ) rr mime_typerboundaryrQ main_typesepsub_typer}eliness rYrzJIRA._prepare_attachments )77f\abd\eff))(34 7%00RNqQoUo $-#6#6s#; 38hx0EFM #QR&&( # # P **73 NN8 $ G N N}]aOb c  & &y'7'7 8'L M  G    X &   0 6 6x @ KK   / 76  7  # # >> P JQ NOO Ps6"E"E)=E5 E&%E&)E25FFFc P|r|dk(rtj|}i}t|tr|j }|j j ,|j|d|j j zdnxttjtdj|j j|j jd}|j|d|zdt|j ||||j j"|\}} | d d vrd} tj$| d } | rg} dD]1} | j)| s| j3t-| | 3| r+|j j+dj5| |j j+t-| |j j+t-| d |j7} | r tj$t| dSiS#t&$rgd j| d | d | j)d ||} |j j+t-| t/j0YWwxYw)Napplication/jsonz Bearer %s)z Content-Type Authorizationz{0}:{1}rrzBasic %s)rdmethodrCheadersr8)rhzVThe request "{method} {url}" returned the unexpected status code {status} {msg} {body}msg)r8rrhrer)r exception) errorMessagesrz, )r)jsondumps isinstancercopyrUr+rr r b64encoder rr(r)r modulerCloadsrrw fail_jsonr traceback format_excappendr|r)rXrerdrrrrauthresponseinfoerrorrr_rhs rYrequestz JIRA.requestsZ L$66::d#D ($ /(--/G 99?? & NN ,!,tyy!>  6++HY5E5EdiiFXFXZ^ZcZcZlZl5m 0E \ 4<06:Cyy~ 9U3Z#89:KK))diin)= %%)E*:%; KK ! !iV &= ! >}} ::gd3HIJ J 1 \ovv>U &)! w %%)C.IDXDXDZ%[ \s5H55A,J%$J%c.|j||d||S)NPOST)rdrrrr)rXrerdrrs rYraz JIRA.postUs%||Cd6 /AC Cr[c*|j||dS)NPUT)rdrr)rXrerds rYrqzJIRA.putYs||Cd5|99r[c$|j|Srrrxs rYrwzJIRA.get\s||C  r[)NN)NNrN)rN)__name__ __module__ __qualname__rruse_old_vardict state_paramrZrrfrlrnrrruryr~rrr staticmethodrrrarqrwrr[rYrrs  ' %(6D95)2' %$/ ' }" d' u%' uT2' E$/' &)' (!' "e&#' $e&%' &%*'' (()' *EH:6+' ,e&-' . $uw.?$O5: /' 6U%7' 8(9' :u';' <0=' >u'?' @%*A' B5+C' D%"E' F'G' Hgr2I' J 6:K' L'M' R !  !  & { #   $ L )  ! (Wl$; < ($G H )gy%9 : *w &: ; 'G9 - , 2 ,;(? F &"M N (UG ,  "CBFFOKA ".#." " .# . " .# . "-#- "-#-'' "+.#+.Z ".#. " # >$ $ R+# DLC:!r[rc8t}|jyr)rrun)jiras rYmainr`s 6DHHJr[__main__) __future__rrrr __metaclass__ DOCUMENTATIONEXAMPLESrrrrrrrrHansible_collections.community.general.plugins.module_utils.module_helperrr-ansible.module_utils.six.moves.urllib.requestr+ansible.module_utils.common.text.convertersr r r ansible.module_utils.urlsr rrrrr[rYrswA@ ` Dj X  uFTT/n! n!b   zFr[