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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
|
# Copyright 2018, 2019 Red Hat, Inc.
#
# 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 logging
import hmac
import hashlib
import threading
import time
import re
import json
import requests
import cherrypy
import voluptuous as v
from zuul.connection import BaseConnection
from zuul.lib.logutil import get_annotated_logger
from zuul.web.handler import BaseWebController
from zuul.model import Ref, Branch, Tag
from zuul.lib import dependson
from zuul.zk.change_cache import AbstractChangeCache, ConcurrentUpdateError
from zuul.zk.event_queues import ConnectionEventQueue
from zuul.driver.pagure.paguremodel import PagureTriggerEvent, PullRequest
# Minimal Pagure version supported 5.3.0
#
# Pagure is similar to Github as it handles PullRequest where PR is a branch
# composed of one or more commits. A PR can be commented, evaluated, updated,
# CI flagged, and merged. A PR can be flagged (success/failure/pending) and
# this driver uses that capability.
#
# PR approval can be driven by (evaluation). This is done via comments that
# contains a :thumbsup: or :thumbsdown:. Pagure computes a score based on
# that and allows or not the merge of PR if the "minimal score to merge" is
# set in repository settings.
#
# PR approval can be also driven via PR metadata flag.
#
# This driver expects to receive repository events via webhooks and
# do event validation based on the source IP address of the event.
#
# The driver connection needs an user's API token with
# - "Merge a pull-request"
# - "Flag a pull-request"
# - "Comment on a pull-request"
#
# On each project to be integrated with Zuul needs:
#
# The web hook target must be (in repository settings):
# - http://<zuul-web>/zuul/api/connection/<conn-name>/payload
#
# Repository settings (to be checked):
# - Minimum score to merge pull-request = 0 or -1
# - Pull requests
# - Open metadata access to all (unchecked if approval)
#
# To define the connection in /etc/zuul/zuul.conf:
# [connection pagure.io]
# driver=pagure
# server=pagure.io
# baseurl=https://pagure.io
# api_token=QX29SXAW96C2CTLUNA5JKEEU65INGWTO2B5NHBDBRMF67S7PYZWCS0L1AKHXXXXX
# source_whitelist=8.43.85.75
#
# Current Non blocking issues:
# - Pagure does not reset the score when a PR code is updated
# https://pagure.io/pagure/issue/3985
# - CI status flag updated field unit is second, better to have millisecond
# unit to avoid unpossible sorting to get last status if two status set the
# same second.
# https://pagure.io/pagure/issue/4402
# - Zuul needs to be able to search commits that set a dependency (depends-on)
# to a specific commit to reset jobs run when a dependency is changed. On
# Gerrit and Github search through commits message is possible and used by
# Zuul. Pagure does not offer this capability.
# Side notes
# - Idea would be to prevent PR merge by anybody else than Zuul.
# Pagure project option: "Activate Only assignee can merge pull-request"
# https://docs.pagure.org/pagure/usage/project_settings.html?highlight=score#activate-only-assignee-can-merge-pull-request
def _sign_request(body, secret):
signature = hmac.new(
secret.encode('utf-8'), body, hashlib.sha1).hexdigest()
return signature, body
class PagureChangeCache(AbstractChangeCache):
log = logging.getLogger("zuul.driver.PagureChangeCache")
CHANGE_TYPE_MAP = {
"Ref": Ref,
"Tag": Tag,
"Branch": Branch,
"PullRequest": PullRequest,
}
def _getChangeClass(self, change_type):
return self.CHANGE_TYPE_MAP[change_type]
def _getChangeType(self, change):
return type(change).__name__
class PagureEventConnector(threading.Thread):
"""Move events from Pagure into the scheduler"""
log = logging.getLogger("zuul.PagureEventConnector")
def __init__(self, connection):
super(PagureEventConnector, self).__init__()
self.daemon = True
self.connection = connection
self.event_queue = connection.event_queue
self._stopped = False
self._process_event = threading.Event()
self.metadata_notif = re.compile(
r"^\*\*Metadata Update", re.MULTILINE)
self.event_handler_mapping = {
'pull-request.comment.added': self._event_issue_comment,
'pull-request.closed': self._event_pull_request_closed,
'pull-request.new': self._event_pull_request,
'pull-request.flag.added': self._event_flag_added,
'pull-request.flag.updated': self._event_flag_added,
'git.receive': self._event_ref_updated,
'git.branch.creation': self._event_ref_created,
'git.branch.deletion': self._event_ref_deleted,
'pull-request.initial_comment.edited':
self._event_issue_initial_comment,
'pull-request.tag.added':
self._event_pull_request_tags_changed,
'git.tag.creation': self._event_tag_created,
}
def stop(self):
self._stopped = True
self._process_event.set()
self.event_queue.election.cancel()
def _onNewEvent(self):
self._process_event.set()
# Stop the data watch in case the connector was stopped
return not self._stopped
def run(self):
self.event_queue.registerEventWatch(self._onNewEvent)
while not self._stopped:
try:
self.event_queue.election.run(self._run)
except Exception:
self.log.exception("Exception handling Pagure event:")
def _run(self):
while not self._stopped:
for event in self.event_queue:
try:
self._handleEvent(event)
finally:
self.event_queue.ack(event)
if self._stopped:
return
self._process_event.wait(10)
self._process_event.clear()
def _handleEvent(self, connection_event):
if self._stopped:
return
timestamp = time.time()
json_body = connection_event["payload"]
event_type = json_body['topic']
self.log.info(
"Received event id: %s, topic: %s",
json_body["msg_id"], event_type
)
# self.log.debug("Event payload: %s " % json_body)
if event_type not in self.event_handler_mapping:
message = "Unhandled X-Pagure-Event: %s" % event_type
self.log.info(message)
return
if event_type in self.event_handler_mapping:
self.log.debug("Handling event: %s" % event_type)
try:
event = self.event_handler_mapping[event_type](json_body)
except Exception:
self.log.exception(
'Exception when handling event: %s' % event_type)
event = None
if event:
event.timestamp = timestamp
if event.change_number:
project = self.connection.source.getProject(event.project_name)
self.connection._getChange(project,
event.change_number,
event.patch_number,
refresh=True,
url=event.change_url,
event=event)
event.project_hostname = self.connection.canonical_hostname
self.connection.logEvent(event)
self.connection.sched.addTriggerEvent(
self.connection.driver_name, event
)
def _event_base(self, body, pull_data_field='pullrequest'):
event = PagureTriggerEvent()
event.connection_name = self.connection.connection_name
if pull_data_field in body['msg']:
data = body['msg'][pull_data_field]
data['tags'] = body['msg'].get('tags', [])
data['flag'] = body['msg'].get('flag')
event.title = data.get('title')
event.project_name = data.get('project', {}).get('fullname')
event.change_number = data.get('id')
event.updated_at = data.get('date_created')
event.branch = data.get('branch')
event.tags = data.get('tags', [])
event.change_url = self.connection.getPullUrl(event.project_name,
event.change_number)
event.ref = "refs/pull/%s/head" % event.change_number
# commit_stop is the tip of the PR branch
event.patch_number = data.get('commit_stop')
event.type = 'pg_pull_request'
else:
data = body['msg']
event.type = 'pg_push'
return event, data
def _event_issue_initial_comment(self, body):
""" Handles pull request initial comment change """
event, _ = self._event_base(body)
event.action = 'changed'
return event
def _event_pull_request_tags_changed(self, body):
""" Handles pull request metadata change """
# pull-request.tag.added/removed use pull_request in payload body
event, _ = self._event_base(body, pull_data_field='pull_request')
event.action = 'tagged'
return event
def _event_issue_comment(self, body):
""" Handles pull request comments """
# https://fedora-fedmsg.readthedocs.io/en/latest/topics.html#pagure-pull-request-comment-added
event, data = self._event_base(body)
last_comment = data.get('comments', [])[-1]
if (last_comment.get('notification') is True and
not self.metadata_notif.match(
last_comment.get('comment', ''))):
# An updated PR (new commits) triggers the comment.added
# event. A message is added by pagure on the PR but notification
# is set to true.
event.action = 'changed'
else:
if last_comment.get('comment', '').find(':thumbsup:') >= 0:
event.action = 'thumbsup'
event.type = 'pg_pull_request_review'
elif last_comment.get('comment', '').find(':thumbsdown:') >= 0:
event.action = 'thumbsdown'
event.type = 'pg_pull_request_review'
else:
event.action = 'comment'
# Assume last comment is the one that have triggered the event
event.comment = last_comment.get('comment')
return event
def _event_pull_request(self, body):
""" Handles pull request opened event """
# https://fedora-fedmsg.readthedocs.io/en/latest/topics.html#pagure-pull-request-new
event, data = self._event_base(body)
event.action = 'opened'
return event
def _event_pull_request_closed(self, body):
""" Handles pull request closed event """
event, data = self._event_base(body)
event.action = 'closed'
return event
def _event_flag_added(self, body):
""" Handles flag added event """
# https://fedora-fedmsg.readthedocs.io/en/latest/topics.html#pagure-pull-request-flag-added
event, data = self._event_base(body)
event.status = data['flag']['status']
event.action = 'status'
return event
def _event_tag_created(self, body):
event, data = self._event_base(body)
event.project_name = data.get('project_fullname')
event.tag = data.get('tag')
event.ref = 'refs/tags/%s' % event.tag
event.oldrev = None
event.newrev = data.get('rev')
return event
def _event_ref_updated(self, body):
""" Handles ref updated """
# https://fedora-fedmsg.readthedocs.io/en/latest/topics.html#pagure-git-receive
event, data = self._event_base(body)
event.project_name = data.get('project_fullname')
event.branch = data.get('branch')
event.ref = 'refs/heads/%s' % event.branch
event.newrev = data.get('end_commit')
event.oldrev = data.get('old_commit')
event.branch_updated = True
return event
def _event_ref_created(self, body):
""" Handles ref created """
event, data = self._event_base(body)
event.project_name = data.get('project_fullname')
event.branch = data.get('branch')
event.ref = 'refs/heads/%s' % event.branch
event.newrev = data.get('rev')
event.oldrev = '0' * 40
event.branch_created = True
self.connection.project_branch_cache[
event.project_name].append(event.branch)
return event
def _event_ref_deleted(self, body):
""" Handles ref deleted """
event, data = self._event_base(body)
event.project_name = data.get('project_fullname')
event.branch = data.get('branch')
event.ref = 'refs/heads/%s' % event.branch
event.oldrev = data.get('rev')
event.newrev = '0' * 40
event.branch_deleted = True
self.connection.project_branch_cache[
event.project_name].remove(event.branch)
return event
class PagureAPIClientException(Exception):
pass
class PagureAPIClient():
log = logging.getLogger("zuul.PagureAPIClient")
def __init__(
self, baseurl, api_token, project):
self.session = requests.Session()
self.base_url = '%s/api/0/' % baseurl
self.api_token = api_token
self.project = project
self.headers = {'Authorization': 'token %s' % self.api_token}
def _manage_error(self, data, code, url, verb):
if code < 400:
return
else:
raise PagureAPIClientException(
"Unable to %s on %s (code: %s) due to: %s" % (
verb, url, code, data
))
def get(self, url):
self.log.debug("Getting resource %s ..." % url)
ret = self.session.get(url, headers=self.headers)
self.log.debug("GET returned (code: %s): %s" % (
ret.status_code, ret.text))
return ret.json(), ret.status_code, ret.url, 'GET'
def post(self, url, params=None):
self.log.info(
"Posting on resource %s, params (%s) ..." % (url, params))
ret = self.session.post(url, data=params, headers=self.headers)
self.log.debug("POST returned (code: %s): %s" % (
ret.status_code, ret.text))
return ret.json(), ret.status_code, ret.url, 'POST'
def whoami(self):
path = '-/whoami'
resp = self.post(self.base_url + path)
self._manage_error(*resp)
return resp[0]['username']
def get_project_branches(self):
path = '%s/git/branches' % self.project
resp = self.get(self.base_url + path)
self._manage_error(*resp)
return resp[0].get('branches', [])
def get_pr(self, number):
path = '%s/pull-request/%s' % (self.project, number)
resp = self.get(self.base_url + path)
self._manage_error(*resp)
return resp[0]
def get_pr_diffstats(self, number):
path = '%s/pull-request/%s/diffstats' % (self.project, number)
resp = self.get(self.base_url + path)
self._manage_error(*resp)
return resp[0]
def get_pr_flags(self, number, owner, last=False):
path = '%s/pull-request/%s/flag' % (self.project, number)
resp = self.get(self.base_url + path)
self._manage_error(*resp)
data = resp[0]
owned_flags = [
flag for flag in data['flags']
if flag['user']['name'] == owner]
if last:
if owned_flags:
return owned_flags[0]
else:
return {}
else:
return owned_flags
def set_pr_flag(
self, number, status, url, description, app_name, username):
flag_uid = "%s-%s-%s" % (username, number, self.project)
params = {
"username": app_name,
"comment": "Jobs result is %s" % status,
"uid": flag_uid[:32],
"status": status,
"url": url}
path = '%s/pull-request/%s/flag' % (self.project, number)
resp = self.post(self.base_url + path, params)
self._manage_error(*resp)
return resp[0]
def comment_pull(self, number, message):
params = {"comment": message}
path = '%s/pull-request/%s/comment' % (self.project, number)
resp = self.post(self.base_url + path, params)
self._manage_error(*resp)
return resp[0]
def merge_pr(self, number):
path = '%s/pull-request/%s/merge' % (self.project, number)
resp = self.post(self.base_url + path)
self._manage_error(*resp)
return resp[0]
def get_webhook_token(self):
""" A project collaborator's api token must be used with that endpoint
"""
path = '%s/webhook/token' % self.project
resp = self.get(self.base_url + path)
self._manage_error(*resp)
return resp[0]['webhook']['token']
class PagureConnection(BaseConnection):
driver_name = 'pagure'
log = logging.getLogger("zuul.PagureConnection")
def __init__(self, driver, connection_name, connection_config):
super(PagureConnection, self).__init__(
driver, connection_name, connection_config)
self.project_branch_cache = {}
self.projects = {}
self.server = self.connection_config.get('server', 'pagure.io')
self.canonical_hostname = self.connection_config.get(
'canonical_hostname', self.server)
self.git_ssh_key = self.connection_config.get('sshkey')
self.api_token = self.connection_config.get('api_token')
self.app_name = self.connection_config.get(
'app_name', 'Zuul')
self.username = None
self.baseurl = self.connection_config.get(
'baseurl', 'https://%s' % self.server).rstrip('/')
self.cloneurl = self.connection_config.get(
'cloneurl', self.baseurl).rstrip('/')
self.source_whitelist = self.connection_config.get(
'source_whitelist', '').split(',')
self.webhook_tokens = {}
self.source = driver.getSource(self)
self.metadata_notif = re.compile(
r"^\*\*Metadata Update", re.MULTILINE)
self.sched = None
def onLoad(self):
self.log.info('Starting Pagure connection: %s', self.connection_name)
self.log.info('Creating Zookeeper event queue')
self.event_queue = ConnectionEventQueue(
self.sched.zk_client, self.connection_name
)
self.log.debug('Creating Zookeeper change cache')
self._change_cache = PagureChangeCache(self.sched.zk_client, self)
self.log.info('Starting event connector')
self._start_event_connector()
def _start_event_connector(self):
self.pagure_event_connector = PagureEventConnector(self)
self.pagure_event_connector.start()
def _stop_event_connector(self):
if self.pagure_event_connector:
self.pagure_event_connector.stop()
self.pagure_event_connector.join()
def onStop(self):
if hasattr(self, 'pagure_event_connector'):
self._stop_event_connector()
def set_my_username(self, client):
self.log.debug("Fetching my username ...")
self.username = client.whoami()
self.log.debug("My username is %s" % self.username)
def get_project_api_client(self, project):
self.log.debug("Building project %s api_client" % project)
client = PagureAPIClient(self.baseurl, self.api_token, project)
if not self.username:
self.set_my_username(client)
return client
def get_project_webhook_token(self, project, force_refresh=False):
token = self.webhook_tokens.get(project)
if token and not force_refresh:
self.log.debug(
"Fetching project %s webhook token from cache" % project)
return token
else:
pagure = self.get_project_api_client(project)
token = pagure.get_webhook_token()
self.webhook_tokens[project] = token
self.log.debug(
"Fetching project %s webhook token from API" % project)
return token
def maintainCache(self, relevant):
for change in self._change_cache:
if change not in relevant:
self._change_cache.delete(change.cache_stat.key)
# TODO: remove entries older than X
self._change_cache.cleanup()
def updateChangeAttributes(self, change, **attrs):
def _update_attrs(c):
for name, value in attrs.items():
setattr(c, name, value)
self._change_cache.updateChangeWithRetry(change.cache_stat.key,
change, _update_attrs)
def getWebController(self, zuul_web):
return PagureWebController(zuul_web, self)
def getEventQueue(self):
return getattr(self, "event_queue", None)
def validateWebConfig(self, config, connections):
return True
def getProject(self, name):
return self.projects.get(name)
def addProject(self, project):
self.projects[project.name] = project
def getPullUrl(self, project, number):
return '%s/pull-request/%s' % (self.getGitwebUrl(project), number)
def getGitwebUrl(self, project, sha=None):
url = '%s/%s' % (self.baseurl, project)
if sha is not None:
url += '/c/%s' % sha
return url
def getProjectBranches(self, project, tenant):
branches = self.project_branch_cache.get(project.name)
if branches is not None:
return branches
pagure = self.get_project_api_client(project.name)
branches = pagure.get_project_branches()
self.project_branch_cache[project.name] = branches
self.log.info("Got branches for %s" % project.name)
return branches
def getGitUrl(self, project):
return '%s/%s' % (self.cloneurl, project.name)
def getChange(self, event, refresh=False):
project = self.source.getProject(event.project_name)
if event.change_number:
self.log.info("Getting change for %s#%s" % (
project, event.change_number))
change = self._getChange(
project, event.change_number, event.patch_number,
refresh=refresh, event=event)
else:
self.log.info("Getting change for %s ref:%s" % (
project, event.ref))
change = self._getNonPRRef(project, event)
return change
def _getChange(self, project, number, patchset=None,
refresh=False, url=None, event=None):
key = str((project.name, number, patchset))
change = self._change_cache.get(key)
if change and not refresh:
self.log.debug("Getting change from cache %s" % str(key))
return change
if not change:
change = PullRequest(project.name)
change.project = project
change.number = number
# patchset is the tips commit of the PR
change.patchset = patchset
change.url = url
change.uris = [
'%s/%s/pull/%s' % (self.baseurl, project, number),
]
try:
self.log.debug("Getting change pr#%s from project %s" % (
number, project.name))
self.log.info("Updating change from pagure %s" % change)
pull = self.getPull(change.project.name, change.number)
def _update_change(c):
self._updateChange(c, event, pull)
change = self._change_cache.updateChangeWithRetry(key, change,
_update_change)
if self.sched:
self.sched.onChangeUpdated(change, event)
except Exception:
self.log.warning("Deleting cache key %s due to exception", key)
self._change_cache.delete(key)
raise
return change
def _getNonPRRef(self, project, event):
key = str((project.name, event.ref, event.newrev))
change = self._change_cache.get(key)
if change:
return change
if event.ref and event.ref.startswith('refs/tags/'):
change = Tag(project)
change.tag = event.tag
elif event.ref and event.ref.startswith('refs/heads/'):
change = Branch(project)
change.branch = event.branch
else:
change = Ref(project)
change.ref = event.ref
change.oldrev = event.oldrev
change.newrev = event.newrev
change.url = self.getGitwebUrl(project, sha=event.newrev)
# Pagure does not send files details in the git-receive event.
# Explicitly set files to None and let the pipelines processor
# call the merger asynchronuously
change.files = None
try:
self._change_cache.set(key, change)
except ConcurrentUpdateError:
change = self._change_cache.get(key)
return change
def _hasRequiredStatusChecks(self, change):
pagure = self.get_project_api_client(change.project.name)
flag = pagure.get_pr_flags(change.number, self.username, last=True)
return True if flag.get('status', '') == 'success' else False
def canMerge(self, change, allow_needs, event=None):
log = get_annotated_logger(self.log, event)
pagure = self.get_project_api_client(change.project.name)
pr = pagure.get_pr(change.number)
mergeable = False
if pr.get('cached_merge_status') in ('FFORWARD', 'MERGE'):
mergeable = True
ci_flag = False
if self._hasRequiredStatusChecks(change):
ci_flag = True
# By default project get -1 in "Minimum score to merge pull-request"
# But this makes the API to return None for threshold_reached. We need
# to handle this case as threshold_reached: True because it means
# no minimal score configured.
threshold = pr.get('threshold_reached')
if threshold is None:
threshold = True
log.debug(
'PR %s#%s mergeability details mergeable: %s '
'flag: %s threshold: %s', change.project.name, change.number,
mergeable, ci_flag, threshold)
can_merge = mergeable and ci_flag and threshold
log.info('Check PR %s#%s mergeability can_merge: %s',
change.project.name, change.number, can_merge)
return can_merge
def getPull(self, project_name, number, event=None):
log = get_annotated_logger(self.log, event=event)
pagure = self.get_project_api_client(project_name)
pr = pagure.get_pr(number)
diffstats = pagure.get_pr_diffstats(number)
pr['files'] = list(diffstats.keys())
log.info('Got PR %s#%s', project_name, number)
return pr
def getStatus(self, project, number):
return self.getCommitStatus(project.name, number)
def getScore(self, pr):
score_board = {}
last_pr_code_updated = 0
# First get last PR updated date
for comment in pr.get('comments', []):
# PR updated are reported as comment but with the notification flag
if comment['notification']:
# Ignore metadata update such as assignee and tags
if self.metadata_notif.match(comment.get('comment', '')):
continue
date = int(comment['date_created'])
if date > last_pr_code_updated:
last_pr_code_updated = date
# Now compute the score
# TODO(fbo): Pagure does not reset the score when a PR code is updated
# This code block computes the score based on votes after the last PR
# update. This should be proposed upstream
# https://pagure.io/pagure/issue/3985
for comment in pr.get('comments', []):
author = comment['user']['fullname']
date = int(comment['date_created'])
# Only handle score since the last PR update
if date >= last_pr_code_updated:
score_board.setdefault(author, 0)
# Use the same strategy to compute the score than Pagure
if comment.get('comment', '').find(':thumbsup:') >= 0:
score_board[author] += 1
if comment.get('comment', '').find(':thumbsdown:') >= 0:
score_board[author] -= 1
return sum(score_board.values())
def _updateChange(self, change, event, pull):
change.pr = pull
change.ref = "refs/pull/%s/head" % change.number
change.branch = change.pr.get('branch')
change.is_current_patchset = (change.pr.get('commit_stop') ==
change.patchset)
change.files = change.pr.get('files')
change.title = change.pr.get('title')
change.tags = change.pr.get('tags')
change.open = change.pr.get('status') == 'Open'
change.is_merged = change.pr.get('status') == 'Merged'
change.status = self.getStatus(change.project, change.number)
change.score = self.getScore(change.pr)
change.message = change.pr.get('initial_comment') or ''
# last_updated seems to be touch for comment changed/flags - that's OK
change.updated_at = change.pr.get('last_updated')
self.log.info("Updated change from pagure %s" % change)
return change
def commentPull(self, project, number, message):
pagure = self.get_project_api_client(project)
pagure.comment_pull(number, message)
self.log.info("Commented on PR %s#%s", project, number)
def setCommitStatus(self, project, number, state, url='',
description='', context=''):
pagure = self.get_project_api_client(project)
pagure.set_pr_flag(
number, state, url, description, self.app_name, self.username)
self.log.info("Set pull-request CI flag status : %s" % description)
# Wait for 1 second as flag timestamp is by second
time.sleep(1)
def getCommitStatus(self, project, number):
pagure = self.get_project_api_client(project)
flag = pagure.get_pr_flags(number, self.username, last=True)
self.log.info(
"Got pull-request CI status for PR %s on %s status: %s" % (
number, project, flag.get('status')))
return flag.get('status')
def getChangeByKey(self, key):
return self._change_cache.get(key)
def getChangesDependingOn(self, change, projects, tenant):
""" Reverse lookup of PR depending on this one
"""
# TODO(fbo) No way to Query pagure to search accross projects' PRs for
# a the depends-on string in PR initial message. Not a blocker
# for now, let's workaround using the local change cache !
changes_dependencies = []
for cached_change in self._change_cache:
for dep_header in dependson.find_dependency_headers(
cached_change.message):
if change.url in dep_header:
changes_dependencies.append(cached_change)
return changes_dependencies
def mergePull(self, project, number):
pagure = self.get_project_api_client(project)
pagure.merge_pr(number)
self.log.debug("Merged PR %s#%s", project, number)
class PagureWebController(BaseWebController):
log = logging.getLogger("zuul.PagureWebController")
def __init__(self, zuul_web, connection):
self.connection = connection
self.zuul_web = zuul_web
self.event_queue = ConnectionEventQueue(
self.zuul_web.zk_client,
self.connection.connection_name
)
def _source_whitelisted(self, remote_ip, forwarded_ip):
if remote_ip and remote_ip in self.connection.source_whitelist:
return True
if forwarded_ip and forwarded_ip in self.connection.source_whitelist:
return True
def _validate(self, body, token, request_signature):
signature, payload = _sign_request(body, token)
if not hmac.compare_digest(str(signature), str(request_signature)):
self.log.info(
"Missmatch (Payload Signature: %s, Request Signature: %s)" % (
signature, request_signature))
return False
return True
def _validate_signature(self, body, headers):
try:
request_signature = headers['x-pagure-signature']
except KeyError:
raise cherrypy.HTTPError(
401, 'x-pagure-signature header missing.')
project = headers['x-pagure-project']
token = self.connection.get_project_webhook_token(project)
if not self._validate(body, token, request_signature):
# Give a second attempt as a token could have been
# re-generated server side. Refresh the token then retry.
self.log.info(
"Refresh cached webhook token and re-check signature")
token = self.connection.get_project_webhook_token(
project, force_refresh=True)
if not self._validate(body, token, request_signature):
raise cherrypy.HTTPError(
401,
'Request signature does not match calculated payload '
'signature. Check that secret is correct.')
@cherrypy.expose
@cherrypy.tools.json_out(content_type='application/json; charset=utf-8')
def payload(self):
# https://docs.pagure.org/pagure/usage/using_webhooks.html
headers = dict()
for key, value in cherrypy.request.headers.items():
headers[key.lower()] = value
body = cherrypy.request.body.read()
if not self._source_whitelisted(
getattr(cherrypy.request.remote, 'ip'),
headers.get('x-forwarded-for')):
self._validate_signature(body, headers)
else:
self.log.info(
"Payload origin IP address whitelisted. Skip verify")
json_payload = json.loads(body.decode('utf-8'))
data = {'payload': json_payload}
self.event_queue.put(data)
return data
def getSchema():
pagure_connection = v.Any(str, v.Schema(dict))
return pagure_connection
|