dai^ddlZddlmZddlmZej eZGddeZy)N) HTTPError)AtlassianRestAPIcteZdZdZ dcdZ dddZ dedZdfdZdZdZ dgd Z dhd Z d Z did Z djd ZdZdZdZ dkdZ dedZdZ dfdZdldZ dmdZ dndZ dndZ dndZ dodZdpdZdZ dqdZdZ dgdZ d Z! dgd!Z"d"Z#d#Z$e%dgd$Z& d%Z'd&Z(d'Z)drd(Z*did)Z+d*Z,d+Z- dgd,Z.dgd-Z/d.Z0d/Z1d0Z2d1Z3dsd2Z4dtd3Z5dsd4Z6gd5fd6Z7d7Z8dsd8Z9gd5fd9Z:d:Z;dsd;Zdsd>Z?gd5fd?Z@d@ZA dAZBdudBZCdvdCZDdwdDZEdEZFdFZGdGZHdwdHZIdidIZJdxdJZKdKZLdldLZMdldMZN dydNZOdOZPdPZQdQZR dRZSdSZTdTZUdUZVdVZWdWZXdXZYdYZZdZZ[d[Z\d\Z]d]Z^d^Z_d_Z`d`ZadaZbdbZcy)zBamboozPrivate methodsNc #K|j|||||} |jr! | j| j} | |} d} | |kDs| ddk(ry| |D] } | dz } |  y#t$r&} t j d| | Yd} ~ Td} ~ wwxYw#t$rt j d| | YywxYww)a Generic method to return a generator with the results returned from Bamboo. It is intended to work for responses in the form: { 'results': { 'size': 5, 'start-index': 0, 'max-result': 5, 'result': [] }, ... } In this case we would have elements_key='results' element_key='result'. The only reason to use this generator is to abstract dealing with response pagination from the client :param path: URI for the resource :return: generator with the contents of response[elements_key][element_key] zBroken response: Nrsizer)get advanced_moderaise_for_statusjsonrloggingerror TypeError)selfpath elements_key element_keydataflagsparamsheaders max_resultsresponseeresultsr rs H/var/www/timesheet/venv/lib/python3.12/site-packages/atlassian/bamboo.py_get_generatorzBamboo._get_generators<88D$vw?    ))+#==? |,GDk!WV_%9[)     1!56   MM-hZ8 9N sX"C  A/B!C B!.C / B8BC BC !%C C C  C c Pg} d|i} |r|| d<|r| jd|r| jd|r|| d<| j|d|vr0d|vr,|j|j|| | |d|d|S|| d <|j |j|| | S) N max-resultsexpand favourite cloverEnabledlabelrr)rrrrr start-index)rr)appendupdater resource_urlr ) rresourcer"r#clover_enabledrr% start_indexkwargsrrs rbase_list_callzBamboo.base_list_callAs- %F8   LL %  LL ) #F7O f V # (?&&!!(+#N3"=1' ' !,}xx))(35xPPc 2|jd||||ddS)z Get all Projects :param expand: :param favourite: :param clover_enabled: :param max_results: :return: projectprojects)r"r#r+rrrr.)rr"r#r+rs rr2zBamboo.projectses1"" )##!#  r/c:d|}|j||||ddS)z Get a single project by the key :param project_key: :param expand: :param favourite: :param clover_enabled: :return: project/r)r*r"r#r+r,rr3)r project_keyr"r#r+r*s rr1zBamboo.project~s:k]+"") #  r/cNd|d}|j|j|S)zMethod used to retrieve information for project specified as project key. Possible expand parameters: plans, list of plans for project. plans.plan, list of plans with plan details (only plans visible - READ permission for user)r5z ?showEmptyr r)rr7r*s r get_projectzBamboo.get_projects,k]*5xx))(344r/cLd|}|j|j|S)zCMarks project for deletion. Project will be deleted by a batch job.r5deleter)r:s rdelete_projectzBamboo.delete_projects(k]+{{4,,X677r/c >d|}|j|ddd||ddS)z Get all build plans in a project Returns a generator with the plans in a given project. :param project_key: project key :param start_index: :param max_results: :return: Generator with plans r5plansFplanr"r#r+r,rrrr3)rr7r,rr*s r project_planszBamboo.project_planss@k]+""  ## #  r/c 4|jd|||||ddS)z Get all build plans :param expand: :param favourite: :param clover_enabled: :param start_index: :param max_results: :return: rBrArCr3)rr"r#r+r,rs rrAz Bamboo.planss4""" )## #  r/cLd|}|j|j|S)a7 Returns information about the directories where artifacts, build logs, and build results will be stored. Disabled by default. See https://confluence.atlassian.com/display/BAMBOO/Plan+directory+information+REST+API for more information. :param plan_key: :return: zplanDirectoryInfo/r9rplan_keyr*s rplan_directory_infozBamboo.plan_directory_infos*(z2xx))(344r/cDi}|r||d<d|}|j||S)zq Get plan information. :param plan_key: :param expand: optional :return: r"rest/api/latest/plan/rr )rrHr"rr*s rget_planzBamboo.get_plans5 %F8 *8*5xxx00r/c6d}|j|||||dS)z Search plans by name :param search_term: str :param fuzzy: bool optional :param start_index: optional :param max_results: optional :return: GET request zrest/api/latest/search/plans)fuzzy searchTermr!r&rLrM)r search_termrPr,rr*s r search_planszBamboo.search_planss/2xx "+kjuv  r/c.d|}|j|S)zy Marks plan for deletion. Plan will be deleted by a batch job. :param plan_key: :return: rKr>rGs r delete_planzBamboo.delete_plans +8*5{{8$$r/cNd|d}|j|j|S)zd Disable plan. :param plan_key: str TST-BLD :return: DELETE request plan//enabler=rGs r disable_planzBamboo.disable_plans, 8*G,{{4,,X677r/cNd|d}|j|j|S)za Enable plan. :param plan_key: str TST-BLD :return: POST request rXrYpostr)rGs r enable_planzBamboo.enable_plans, 8*G,yy**8455r/c#K||||d}d}|d|krO|j|jd|}|d}|dD]}||dxx|dz cc<|d|krNy y w) z Search Branches :param plan_key: :param include_default_branch: :param max_results: :param start: :return: ) max-resultr& masterPlanKeyincludeMasterBranchrr&zsearch/branchesrLr searchResultsr`Nr9) rrHinclude_default_branchrstartrr rrs rsearch_brancheszBamboo.search_branchess& %#9   ]#d*hht001BCFhSG6?D_-   = !W\%: : ! ]#d*s AA$"A$c >d|d}|j|||||ddS)z Get all plan Branches api/1.0/plan/{projectKey}-{buildKey}/branch :param plan_key: :param expand: :param favourite: :param clover_enabled: :param max_results: :return: rXz/branchbranchesbranch)rrr3)rrHr"r#r+rr*s r plan_brancheszBamboo.plan_branches*s?$8*G,""     # #  r/cRd|d|}|j|j|S)z{ Get information about a plan branch :param plan_key: :param branch_name: :return: rX/branch/r9)rrH branch_namer*s rget_branch_infozBamboo.get_branch_infoGs08*H[M:xx))(344r/cd|d|}i}|rt||rdnd|rdnd}|j|j||S)a, Method for creating branch for a specified plan. You can use vcsBranch query param to define which vcsBranch should newly created branch use. If not specified it will not override vcsBranch from the main plan. :param plan_key: str TST-BLD :param branch_name: str new-shiny-branch :param vcs_branch: str feature/new-shiny-branch, /refs/heads/new-shiny-branch :param enabled: bool :param cleanup_enabled: bool - enable/disable automatic cleanup of branch :return: PUT request rXrltruefalse) vcsBranchenabledcleanupEnabledrL)dictputr))rrHrm vcs_branchrscleanup_enabledr*rs r create_branchzBamboo.create_branchQsY(8*H[M: $")w)8vgF xx))(3FxCCr/c<d|d}|j|d|dddS)z Get all vcs names for the current plan :param plan_key: str TST-BLD :param max_results :return: rXz /vcsBranchesrN)r,rr+r"r#r3)rrHrr*s rget_vcs_brancheszBamboo.get_vcs_branchesos<8*L1"" # #  r/c d} |r|r|r|r| d|d|d|d|z } n/|r|r|r| d|d|d|z } n|r|r | d|d|z } n |r| d|zz } i}|r||d<| r| |d<|j| f|||| | dd| d|S)a Get results as generic method :param project_key: :param plan_key: :param job_key: :param build_number: :param expand: :param favourite: :param clover_enabled: :param issue_key: :param label: :param start_index: :param max_results: :param include_all_states: :return: result/-issueKeyincludeAllStatesr)r"r#r+r,rrrr%r3)rr7rHjob_key build_numberr"r#r+ issue_keyr%r,rinclude_all_statesr*rs rrzBamboo.resultss> 8L !K=(1WIQ|nM MH X, !K=(1\NC CH X !K=(4 4H  k) )H !*F:  );F% &"t""   )##"     r/c 4|j||||||||S)a Get the latest Results :param expand: :param favourite: :param clover_enabled: :param label: :param issue_key: :param start_index: :param max_results: :param include_all_states: :return: r"r#r+r%rr,rrr) rr"r#r+r%rr,rrs rlatest_resultszBamboo.latest_resultss2.||)##1  r/c 6|j|||||||||  S)a8 Get the latest Project Results :param project_key: :param expand: :param favourite: :param clover_enabled: :param label: :param issue_key: :param start_index: :param max_results: :param include_all_states: :return: rr) rr7r"r#r+r%rr,rrs rproject_latest_resultszBamboo.project_latest_resultss52|| )##1  r/c 8|j||||||||| |  S)aC Get Plan results :param project_key: :param plan_key: :param expand: :param favourite: :param clover_enabled: :param label: :param issue_key: :param start_index: :param max_results: :param include_all_states: :return: rr) rr7rHr"r#r+r%rr,rrs r plan_resultszBamboo.plan_resultss86||  )##1  r/c  t|jddd|}|j||dd|||S#t$rtd|dwxYw)au Returns details of a specific build result :param expand: expands build result details on request. Possible values are: artifacts, comments, labels, Jira Issues, stages. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. All expand parameters should contain results. Result prefix. :param build_key: Should be in the form XX-YY[-ZZ]-99, that is, the last token should be an integer representing the build number :param include_all_states :param start: :param max_results: rresult/Fr#r+r,rr The key "z'" does not correspond to a build result)intsplitr. ValueError)r build_keyr"rrerr*s r build_resultzBamboo.build_result,s& ]  $R( )  ,H&&$!'#5'  ]y 3Z[\ \ ]s 9<Ac x d|d}|j||dddd|S#t$rtd|dwxYw) a Returns details of the latest build result :param expand: expands build result details on request. Possible values are: artifacts, comments, labels, Jira Issues, stages. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. All expand parameters should contain results. Result prefix. :param plan_key: Should be in the form XX-YY[-ZZ] :param include_all_states: rz /latest.jsonFrr6rrz0" does not correspond to the latest build result)r.r)rrHr"rr*s rbuild_latest_resultzBamboo.build_latest_resultNsk e  ,7H&&$#5'  ey 2bcd d es 9cd}|jd}|dd|d}|d}||d}|j|||jS)z{ Deleting result for specific build :param build_key: Take full build key, example: PROJECT-PLAN-8 z%/build/admin/deletePlanResults.actionrrr)buildKey buildNumber)rr)rr]form_token_headers)rrcustom_resourcerHrrs rdelete_build_resultzBamboo.delete_build_resultes^ BOOC( l^1Yq\N3 | &|DyyAXAXyYYr/c d|}i}|rd}||d<|r||d<|rdnd|d<|r)t|jD] \}} | |d|<|j|j|| S) a Fire build execution for specified plan. !IMPORTANT! NOTE: for some reason, this method always execute all stages :param plan_key: str TST-BLD :param stage: str stage-name :param execute_all_stages: bool :param custom_revision: str revisionName :param bamboo_variables: dict {variable=value} :return: POST request zqueue/FstagecustomRevisionrprqexecuteAllStageszbamboo.variable.rL)listitemsr]r)) rrHrexecute_all_stagescustom_revisionbamboo_variablesr*rkeyvalues r execute_buildzBamboo.execute_buildqs$H:& !& #F7O '6F# $/AVw!" "#3#9#9#;< 9 U38)#/0 9yy**84VyDDr/cFd|}|j||jS)z Stop the build which is in progress at the moment. :param plan_key: str TST-BLD :return: GET request z%/build/admin/stopPlan.action?planKey=)rr)r]no_check_headersrGs r stop_buildzBamboo.stop_builds) ;8*Eyyh0E0EyFFr/chd|d|d|d}||d}|j|j||S)z Get comments for a specific build :param project_key: :param plan_key: :param build_number: :param start_index: :param max_results: :return: rr/commentr&r!rLr9rr7rHrr,rr*rs rcommentszBamboo.commentssF"[M8*Al^8L!,[Ixx))(3FxCCr/cfd|d|d|d}d|i}|j|j||S)z Create a comment for a specific build :param project_key: :param plan_key: :param build_number: :param comment: :return: rrrcontentrr\)rr7rHrcommentr* comment_datas rcreate_commentzBamboo.create_commentsJ[M8*Al^8L w yy**84 %F8 ]#d*hht00:6hJG6?DY'   = !W\%: : ! ]#d*s A*A/-A/cT|rd|nd}|j|j|S)z Returns the current status of each deployment environment If no project id is provided, returns all projects. zdeploy/dashboard/zdeploy/dashboardr9rs rdeployment_dashboardzBamboo.deployment_dashboard7s1 8B&zl3GYxx))(344r/c#nKd}d|i}|j|j||D]}|yw)zy Returns deployment projects associated with a build plan. :param plan_key: The key of the plan. zdeploy/project/forPlanplanKeyrLNr9)rrHr*rrs r get_deployment_projects_for_planz'Bamboo.get_deployment_projects_for_plan?sE ,X&"&((4+<+?r/cL|j|jd|dy)zq Disable agent :param agent_id: Bamboo agent ID (integer number) :return: None r7z/disableNr r;s r agent_disablezBamboo.agent_disables$ ""VH:X#>?@r/cJ|j|jdd|iS)z Provides a list of all agent authentication statuses. :param online: list only online agents (default False = all) :return: list of agent-describing dictionaries z agent/remoter3rLr9r4s r agent_remotezBamboo.agent_remotes'xx)).98VBTxUUr/c\d}|rd|i}|j|jd||S)z Provides details of an agent with given id. :param agent_id: Bamboo agent ID (integer number) :param expand: Expand fields (None, capabilities, executableEnvironments, executableJobs) :return: Nr"r7rLr9)rr8r"rs r agent_detailszBamboo.agent_detailss; 'Fxx))F8**=>vxNNr/cR|j|jd|dd|iS)z List agent's capabilities. :param agent_id: Bamboo agent ID (integer number) :param include_shared: Include shared capabilities :return: agents r7z /capability includeSharedrLr9)rr8include_shareds ragent_capabilitieszBamboo.agent_capabilitiess9xx   xj < =#^4  r/c$|jdS)Nz+build/admin/ajax/getDashboardSummary.actionrMr*s ractivityzBamboo.activitysxxEFFr/c.d|}|j|S)z Get list of all plans where user has admin permission and which override global expiry settings. If global expiry is not enabled it returns empty response. :param limit: z/rest/api/latest/admin/expiry/custom/plan?limit=rM)rrrs rget_custom_expiryzBamboo.get_custom_expirys @wGxx}r/cRd|i}|j|jddd|S)Nr!z chart/reportsreportsreport)rrr)rr))rrrs rrLzBamboo.reportss;-""   o ."  #  r/c |||| | d} |r|| d<|dk(r || d<|| d<|r|| d<|r|| d<|j|jd| S) a: Get chart data :param report_key: :param build_keys: :param group_by_period: :param date_filter: :param date_from: :param date_to: :param width: :param height: :param start_index: :param max_results: :return: ) reportKey buildKeys groupByPeriodr&r! dateFilterRANGEdateFromdateTowidthheightchartrLr9) r report_key build_keysgroup_by_period date_filter date_fromdate_torVrWr,rrs rrXz Bamboo.charts|8$#,&&   #.F< g%%.z"#*x #F7O %F8 xx))'26xBBr/cB|j|jdS)z Returns status of the current indexing operation. reindexInProgress - reindex is currently performed in background reindexPending - reindex is required (i.e. it failed before or some upgrade task asked for it) reindexr9r*s rr`zBamboo.reindexs xx)))455r/cB|j|jdS)za Kicks off a reindex. Requires system admin permissions to perform this reindex. r`r\r*s r stop_reindexzBamboo.stop_reindexsyy**9566r/cN|jd}|s|jd}|S)z Get health status https://confluence.atlassian.com/jirakb/how-to-retrieve-health-check-results-using-rest-api-867195158.html :return: zrest/troubleshooting/1.0/check/z"rest/supportHealthCheck/1.0/check/rMrrs r health_checkzBamboo.health_checks*88=>xx DEHr/cNd|d}|j|j|S)z\ Get logs from an EC2 instance :param instance_id: :return: z/elasticInstances/instance/z/logsr9)r instance_idr*s rget_elastic_instance_logsz Bamboo.get_elastic_instance_logss, 1 UCxx))(344r/cFd}|j|j|S)zI Get list of all elastic configurations :return: elasticConfigurationr9)rr*s rget_elastic_configurationsz!Bamboo.get_elastic_configurationss# *xx))(344r/cJd}|j|j||S)zW Create an elastic configuration :param json: :return: rj)r r\)rr r*s rcreate_elastic_configurationz#Bamboo.create_elastic_configuration&s' *yy**844y@@r/cLd|}|j|j|S)zo Get information of an elastic configuration :param configuration_id: :return: elasticConfiguration/r9rconfiguration_idr*s rget_elastic_configurationz Bamboo.get_elastic_configuration/s,++;*<=xx))(344r/cPd|}|j|j||S)zx Update an elastic configuration :param configuration_id: :param data: :return: rorr )rrqrr*s rupdate_elastic_configurationz#Bamboo.update_elastic_configuration9s0++;*<=xx))(3$x??r/cLd|}|j|j|S)zc Delete an elastic configuration :param configuration_id: :return: ror=rps rdelete_elastic_configurationz#Bamboo.delete_elastic_configurationDs,++;*<={{4,,X677r/c(|jd}|S)zC Get elastic bamboo configuration :return: rest/admin/latest/elastic/configrMrds rget_elastic_bamboozBamboo.get_elastic_bambooNs 88>?r/c,|jd|}|S)zC Set elastic bamboo configuration :return: rxrrv)rrrs rset_elastic_bamboozBamboo.set_elastic_bambooVs 88>T8Jr/cBd}|j||jdS)zR Provide plugins info :return a json of installed plugins rest/plugins/1.0/Trtrailingr rrrs rget_plugins_infozBamboo.get_plugins_info^s$ "xxT%:%:TxJJr/cJd|d}|j||jdS)zQ Provide plugin info :return a json of installed plugins r~-keyTrrr plugin_keyrs rget_plugin_infozBamboo.get_plugin_infofs- "*T2xxT%:%:TxJJr/cJd|d}|j||jdS)zb Provide plugin license information :return a json specific License query r~z -key/licenseTrrrs rget_plugin_license_infozBamboo.get_plugin_license_infons- "*\:xxT%:%:TxJJr/cdt|di}|jdd|jdjd}d|}|j |||j S) z Provide plugin path for upload into Jira e.g. useful for auto deploy :param plugin_path: :return: pluginrbGETr~T)methodrrrz upm-tokenzrest/plugins/1.0/?token=)filesr)openrequestrrr])r plugin_pathr upm_tokenrs r upload_pluginzBamboo.upload_pluginvsq 4 T23LL$)) ! '+  ) 4yyE43H3HyIIr/cHddd}d|d}ddi}|j|||S) zN Disable a plugin :param plugin_key: :return: no-check application/vnd.atl.plugins+jsonzX-Atlassian-Tokenz Content-Typer~rstatusdisabledrrr{rr app_headersrrs rdisable_pluginzBamboo.disable_plugins@",> "*T2*%xx$ x< "*T2)$xx$ x< Check plugin manager status :return: zrest/plugins/latest/safe-moder)rrr)rsafe_mode_headersrs rcheck_plugin_manager_statusz"Bamboo.check_plugin_manager_statuss$ .||5sD j\2k*xx$ x<r@rBrFrHrJrLrXr`rbrerhrkrmrrrtrvryr|rrrrrrrrrr/rrr so  1t QD  2 &58  .  8 5 1 %86;4  :5 D< " 9 z   J # R & V  ]De. Z E@G D* I( D* L 8058;(5% E , , )  * ,, ,"D"Lf J GD"Nh J GD"Nh J GD"Pj J G3@KO"@AV O  G +CZ67 55A5 @8KKKJ = = T =r/r) rrequests.exceptionsr rest_clientr getLoggerrlogrrr/rrs/))g!u= u=r/