1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
#
# ============LICENSE_START==========================================
# org.onap.vvp/engagementmgr
# ===================================================================
# Copyright © 2017 AT&T Intellectual Property. All rights reserved.
# ===================================================================
#
# Unless otherwise specified, all software contained herein is licensed
# under the Apache License, Version 2.0 (the “License”);
# you may not use this software except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
#
#
# Unless otherwise specified, all documentation contained herein is licensed
# under the Creative Commons License, Attribution 4.0 Intl. (the “License”);
# you may not use this documentation except in compliance with the License.
# You may obtain a copy of the License at
#
# https://creativecommons.org/licenses/by/4.0/
#
# Unless required by applicable law or agreed to in writing, documentation
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# ============LICENSE_END============================================
#
# ECOMP is a trademark and service mark of AT&T Intellectual Property.
import jenkins
class JenkinsClient(object):
"""
Class for performing various operations with jenkins
like create jobs, web hooks, builds schedules etc.
References:-
* https://jenkinsapi.readthedocs.org/en/latest/
* https://python-jenkins.readthedocs.org/en/latest/index.html
* http://python-jenkins.readthedocs.org/en/latest/api.html
"""
def __init__(self, url, username, password):
# TODO: use Jenkins API Token instead of password
# https://wiki.jenkins-ci.org/display/JENKINS/Authenticating+scripted+clients
self.url = url
self.username = username
self.password = password
self.server = jenkins.Jenkins(
self.url, username=self.username, password=self.password)
def get_version(self):
"""
Function returns the Jenkins server version.
"""
return self.server.get_version()
def get_jobs(self):
"""
Function returns all the jobs of Jenkins server.
"""
return self.server.get_jobs()
def get_jobs_names(self):
"""
Function returns names of all the jobs on jenkins server
"""
return [job["name"] for job in self.server.get_jobs()]
def get_job_info(self, name, depth=0):
"""
Function returns a python dictionary containing job info
depth params is used for getting more details for information
"""
return self.server.get_job_info(name, depth)
def debug_job_info(self, job_name):
"""
Function prints job info for give njob name
"""
return self.server.debug_job_info(job_name)
def get_queue_info(self):
"""
Function returns a python list of job dictionaries
"""
return self.server.get_queue_info()
def get_all_jobs(self, folder_depth=None):
"""
Function gets a list of all jobs recursively to the given folder depth.
Each job is a dictionary with name, url, color and fullname keys.
Parameter folder_depth is the number of levels to search, int.
By default None, which will search all levels. 0 limits to toplevel.
"""
return self.server.get_all_jobs(folder_depth)
def is_job_disabled(self, name):
"""
Function returns True if a job is disabled,
False otherwise
"""
# FIXME dont check job color field !!!
return self.get_job_info(name)["color"] == "disabled"
def jobs_count(self):
"""
Function returns the count of jobs on jenkins server
"""
return self.server.jobs_count()
def job_exists(self, name):
"""
Function returns:
True if a job exists on jenkins server,
False otherwise
"""
return self.server.job_exists(name)
def create_empty_job(self, name):
"""
Function creates a job on jenkins server with empty config
"""
return self.server.create_job(name, jenkins.EMPTY_CONFIG_XML)
def create_job(self, name, config_xml):
"""
Function creates a job on jenkins server with given config xml
config_xml is the python string containing config's xml
Always returns None.
"""
return self.server.create_job(name, config_xml)
def create_empty_view(self, name):
"""
Function creates a view on jenkins server with empty config
"""
return self.server.create_view(name, jenkins.EMPTY_VIEW_CONFIG_XML)
def delete_view(self, name):
"""
Function deletes a view from jenkins server
"""
return self.server.delete_view(name)
def enable_job(self, name):
"""
Function enables a job of given name on jenkins server
"""
return self.server.enable_job(name)
def disable_job(self, name):
"""
function disables a job of given name on jenkins server
"""
return self.server.disable_job(name)
def build_job(self, name, parameters=None):
"""
function builds a job of given name on jenkins server
"""
return self.server.build_job(name, parameters)
def get_running_builds(self):
"""
function get list of all running builds on jenkins server
"""
return self.server.get_running_builds()
def rename_job(self, from_name, to_name):
"""
Function renames an existing Jenkins job
"""
if from_name == to_name:
raise Exception("to name cant be same as from")
return self.server.rename_job(from_name, to_name)
def get_last_build_info(self, name):
"""
Function gets last build info of a job for given name
"""
last = self.server.get_job_info(name)['lastCompletedBuild']['number']
return self.server.get_job_info(name, last)
def delete_job(self, name):
"""
Function delete a job of given name on jenkins server
"""
return self.server.delete_job(name)
def get_plugins(self, depth=2):
"""
Function retrieves information about all the installed plugins
"""
return self.server.get_plugins(depth)
def get_plugin_info(self, name, depth=2):
"""
Function retrieves information about a plugin with given name
depth params is used for getting more details for information
"""
return self.server.get_plugin_info(name, depth)
def get_plugin_names(self):
"""
Function returns a python list containig names of
all installed plugins on jenkins server
"""
return [n for _, n in self.server.get_plugins().keys()]
|
