/usr/lib/python3/dist-packages/gerritlib/gerrit.py is in python3-gerritlib 0.8.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 | # Copyright 2011 OpenStack, LLC.
# Copyright 2012 Hewlett-Packard Development Company, L.P.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file 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.
import json
import logging
import pprint
import select
import six.moves
import threading
import time
import paramiko
CONNECTED = 'connected'
CONNECTING = 'connecting'
CONSUMING = 'consuming'
DEAD = 'dead'
DISCONNECTED = 'disconnected'
IDLE = 'idle'
UPDATE_ALLOWED_KEYS = ['description', 'submit-type',
'contributor-agreements', 'signed-off-by',
'content-merge', 'change-id',
'project-state',
'max-object-size-limit']
class GerritWatcher(threading.Thread):
log = logging.getLogger("gerrit.GerritWatcher")
def __init__(
self, gerrit, username=None, hostname=None, port=None,
keyfile=None, connection_attempts=-1, retry_delay=5):
"""Create a GerritWatcher.
:param gerrit: A Gerrit instance to pass events to.
All other parameters are optional and if not supplied are sourced from
the gerrit instance.
"""
super(GerritWatcher, self).__init__()
assert retry_delay >= 0, "Retry delay must be >= 0"
self.username = username or gerrit.username
self.keyfile = keyfile or gerrit.keyfile
self.hostname = hostname or gerrit.hostname
self.port = port or gerrit.port
self.gerrit = gerrit
self.connection_attempts = int(connection_attempts)
self.retry_delay = float(retry_delay)
self.state = IDLE
def _read(self, fd):
l = fd.readline()
data = json.loads(l)
self.log.debug("Received data from Gerrit event stream: \n%s" %
pprint.pformat(data))
self.gerrit.addEvent(data)
def _listen(self, stdout, stderr):
poll = select.poll()
poll.register(stdout.channel)
while True:
ret = poll.poll()
for (fd, event) in ret:
if fd == stdout.channel.fileno():
if event == select.POLLIN:
self._read(stdout)
else:
raise Exception("event on ssh connection")
def _connect(self):
"""Attempts to connect and returns the connected client."""
def _make_client():
client = paramiko.SSHClient()
client.load_system_host_keys()
client.set_missing_host_key_policy(paramiko.WarningPolicy())
return client
def _attempt_gen(connection_attempts, retry_delay):
if connection_attempts <= 0:
attempt = 1
while True:
yield (attempt, retry_delay)
attempt += 1
else:
for attempt in range(1, connection_attempts + 1):
if attempt < connection_attempts:
yield (attempt, retry_delay)
else:
# No more attempts left after this one, (signal this by
# not returning a valid retry_delay).
yield (attempt, None)
for (attempt, retry_delay) in _attempt_gen(self.connection_attempts,
self.retry_delay):
self.log.debug("Connection attempt %s to %s:%s (retry_delay=%s)",
attempt, self.hostname, self.port, retry_delay)
client = None
try:
client = _make_client()
client.connect(self.hostname,
username=self.username,
port=self.port,
key_filename=self.keyfile)
return client
except (IOError, paramiko.SSHException) as e:
self.log.exception("Exception connecting to %s:%s",
self.hostname, self.port)
if client:
try:
client.close()
except (IOError, paramiko.SSHException):
self.log.exception("Failure closing broken client")
if retry_delay is not None:
if retry_delay > 0:
self.log.info("Trying again in %s seconds",
retry_delay)
time.sleep(retry_delay)
else:
raise e
def _consume(self, client):
"""Consumes events using the given client."""
stdin, stdout, stderr = client.exec_command("gerrit stream-events")
self.state = CONSUMING
self._listen(stdout, stderr)
ret = stdout.channel.recv_exit_status()
self.log.debug("SSH exit status: %s" % ret)
if ret:
raise Exception("Gerrit error executing stream-events:"
" return code %s" % ret)
def _run(self):
self.state = CONNECTING
client = self._connect()
self.state = CONNECTED
try:
self._consume(client)
except Exception:
# NOTE(harlowja): allow consuming failures to *always* be retryable
self.log.exception("Exception consuming ssh event stream:")
if client:
try:
client.close()
except (IOError, paramiko.SSHException):
self.log.exception("Failure closing broken client")
self.state = DISCONNECTED
if self.retry_delay > 0:
self.log.info("Delaying consumption retry for %s seconds",
self.retry_delay)
time.sleep(self.retry_delay)
def run(self):
try:
while True:
self.state = DISCONNECTED
self._run()
finally:
self.state = DEAD
class Gerrit(object):
log = logging.getLogger("gerrit.Gerrit")
def __init__(self, hostname, username, port=29418, keyfile=None):
self.username = username
self.hostname = hostname
self.port = port
self.keyfile = keyfile
self.watcher_thread = None
self.event_queue = None
self.installed_plugins = None
def startWatching(self, connection_attempts=-1, retry_delay=5):
self.event_queue = six.moves.queue.Queue()
watcher = GerritWatcher(self,
connection_attempts=connection_attempts,
retry_delay=retry_delay)
self.watcher_thread = watcher
self.watcher_thread.daemon = True
self.watcher_thread.start()
def addEvent(self, data):
return self.event_queue.put(data)
def getEvent(self):
return self.event_queue.get()
def createGroup(self, group, visible_to_all=True, owner=None):
cmd = 'gerrit create-group'
if visible_to_all:
cmd = '%s --visible-to-all' % cmd
if owner:
cmd = '%s --owner %s' % (cmd, owner)
cmd = '%s "%s"' % (cmd, group)
out, err = self._ssh(cmd)
return err
def listMembers(self, group, recursive=False):
cmd = 'gerrit ls-members'
if recursive:
cmd = '%s --recursive' % cmd
cmd = '%s "%s"' % (cmd, group)
out, err = self._ssh(cmd)
ret = []
rows = out.split('\n')
if len(rows) > 1:
keys = rows[0].split('\t')
for row in rows[1:]:
ret.append(dict(zip(keys, row.split('\t'))))
return ret
def _setMember(self, verb, group, member):
cmd = 'gerrit set-members'
if verb == 'add':
cmd = '%s --add "%s"' % (cmd, member)
elif verb == 'remove':
cmd = '%s --remove "%s"' % (cmd, member)
cmd = '%s "%s"' % (cmd, group)
out, err = self._ssh(cmd)
return err
def addMember(self, group, member):
self._setMember('add', group, member)
def removeMember(self, group, member):
self._setMember('remove', group, member)
def createProject(self, project, require_change_id=True, empty_repo=False,
description=None):
cmd = 'gerrit create-project'
if require_change_id:
cmd = '%s --require-change-id' % cmd
if empty_repo:
cmd = '%s --empty-commit' % cmd
if description:
cmd = "%s --description \"%s\"" % \
(cmd, description.replace('"', r'\"'))
version = None
try:
version = self.parseGerritVersion(self.getVersion())
except Exception:
# If no version then we know version is old and should use --name
pass
if not version or version < (2, 12):
cmd = '%s --name "%s"' % (cmd, project)
else:
cmd = '%s "%s"' % (cmd, project)
out, err = self._ssh(cmd)
return err
def updateProject(self, project, update_key, update_value):
# check for valid keys
if update_key not in UPDATE_ALLOWED_KEYS:
raise Exception("Trying to update a non-valid key %s" % update_key)
cmd = 'gerrit set-project %s ' % project
if update_key == 'description':
cmd += "--%s \"%s\"" % (update_key,
update_value.replace('"', r'\"'))
else:
cmd += '--%s %s' % (update_key, update_value)
out, err = self._ssh(cmd)
return err
def listProjects(self, show_description=False):
cmd = 'gerrit ls-projects'
if show_description:
# display projects alongs with descriptions
# separated by ' - ' sequence
cmd += ' --description'
out, err = self._ssh(cmd)
return filter(None, out.split('\n'))
def listGroups(self, verbose=False):
if verbose:
cmd = 'gerrit ls-groups -v'
else:
cmd = 'gerrit ls-groups'
out, err = self._ssh(cmd)
return filter(None, out.split('\n'))
def listPlugins(self):
plugins = self.getPlugins()
plugin_names = plugins.keys()
return plugin_names
# get installed plugins info returned is (name, version, status, file)
def getPlugins(self):
# command only available on gerrit verion >= 2.5
cmd = 'gerrit plugin ls --format json'
out, err = self._ssh(cmd)
return json.loads(out)
def getVersion(self):
# command only available on gerrit verion >= 2.6
cmd = 'gerrit version'
out, err = self._ssh(cmd)
out = out.split(' ')[2]
return out.strip('\n')
def parseGerritVersion(self, version):
# Adapted from gertty setRemoteVersion()
base = version.split('-')[0]
parts = base.split('.')
major = minor = micro = 0
if len(parts) > 0:
major = int(parts[0])
if len(parts) > 1:
minor = int(parts[1])
if len(parts) > 2:
micro = int(parts[2])
return (major, minor, micro)
def replicate(self, project='--all'):
cmd = 'replication start %s' % project
if self.installed_plugins is None:
try:
self.installed_plugins = self.listPlugins()
except Exception:
cmd = 'gerrit replicate %s' % project
out, err = self._ssh(cmd)
return out.split('\n')
def review(self, project, change, message, action={}):
cmd = 'gerrit review %s --project %s' % (change, project)
if message:
cmd += ' --message "%s"' % message
for k, v in action.items():
if v is True:
cmd += ' --%s' % k
else:
cmd += ' --%s %s' % (k, v)
out, err = self._ssh(cmd)
return err
def query(self, change, commit_msg=False, comments=False):
if commit_msg:
if comments:
cmd = ('gerrit query --format json --commit-message --comments'
' %s"' % change)
else:
cmd = 'gerrit query --format json --commit-message %s"' % (
change)
else:
if comments:
cmd = 'gerrit query --format json --comments %s"' % (change)
else:
cmd = 'gerrit query --format json %s"' % (change)
out, err = self._ssh(cmd)
if not out:
return False
lines = out.split('\n')
if not lines:
return False
data = json.loads(lines[0])
if not data:
return False
self.log.debug("Received data from Gerrit query: \n%s" % (
pprint.pformat(data)))
return data
def bulk_query(self, query):
cmd = 'gerrit query --format json %s"' % (
query)
out, err = self._ssh(cmd)
if not out:
return False
lines = out.split('\n')
if not lines:
return False
data = []
for line in lines:
if line:
data.append(json.loads(line))
if not data:
return False
self.log.debug("Received data from Gerrit query: \n%s" % (
pprint.pformat(data)))
return data
def _ssh(self, command):
client = paramiko.SSHClient()
client.load_system_host_keys()
client.set_missing_host_key_policy(paramiko.WarningPolicy())
client.connect(self.hostname,
username=self.username,
port=self.port,
key_filename=self.keyfile)
self.log.debug("SSH command:\n%s" % command)
stdin, stdout, stderr = client.exec_command(command)
out = stdout.read()
if type(out) == bytes:
out = out.decode()
self.log.debug("SSH received stdout:\n%s" % out)
ret = stdout.channel.recv_exit_status()
self.log.debug("SSH exit status: %s" % ret)
err = stderr.read()
if type(err) == bytes:
err = err.decode()
self.log.debug("SSH received stderr:\n%s" % err)
if ret:
raise Exception("Gerrit error executing %s" % command)
return (out, err)
|