The Gatekeeper, or a project gating system
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

187 lines
6.2 KiB

# Copyright 2014 Puppet Labs 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
# 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 re
import urllib
import logging
import time
import voluptuous as v
from zuul.source import BaseSource
from zuul.model import Project
from zuul.driver.github.githubmodel import GithubRefFilter
from zuul.driver.util import scalar_or_list, to_list
class GithubSource(BaseSource):
name = 'github'
log = logging.getLogger("zuul.source.GithubSource")
def __init__(self, driver, connection, config=None):
hostname = connection.canonical_hostname
super(GithubSource, self).__init__(driver, connection,
hostname, config)
def getRefSha(self, project, ref):
"""Return a sha for a given project ref."""
raise NotImplementedError()
def waitForRefSha(self, project, ref, old_sha=''):
"""Block until a ref shows up in a given project."""
raise NotImplementedError()
def isMerged(self, change, head=None):
"""Determine if change is merged."""
if not change.number:
# Not a pull request, considering merged.
return True
# We don't need to perform another query because the API call
# to perform the merge will ensure this is updated.
return change.is_merged
def canMerge(self, change, allow_needs, event=None, allow_refresh=False):
"""Determine if change can merge."""
if not change.number:
# Not a pull request, considering merged.
return True
return self.connection.canMerge(
change, allow_needs, event=event, allow_refresh=allow_refresh
def postConfig(self):
"""Called after configuration has been processed."""
def getChange(self, event, refresh=False):
return self.connection.getChange(event, refresh)
change_re = re.compile(r"/(.*?)/(.*?)/pull/(\d+)[\w]*")
def getChangeByURL(self, url, event):
parsed = urllib.parse.urlparse(url)
except ValueError:
return None
m = self.change_re.match(parsed.path)
if not m:
return None
org =
proj =
num = int(
except ValueError:
return None
pull, pr_obj = self.connection.getPull(
'%s/%s' % (org, proj), int(num), event=event)
if not pull:
return None
proj = pull.get('base').get('repo').get('full_name')
project = self.getProject(proj)
change = self.connection._getChange(
project, num,
return change
def getChangesDependingOn(self, change, projects, tenant):
return self.connection.getChangesDependingOn(change, projects, tenant)
def getCachedChanges(self):
return list(self.connection._change_cache.values())
def getProject(self, name):
p = self.connection.getProject(name)
if not p:
p = Project(name, self)
return p
def getProjectBranches(self, project, tenant):
return self.connection.getProjectBranches(project, tenant)
def getProjectOpenChanges(self, project):
"""Get the open changes for a project."""
raise NotImplementedError()
def updateChange(self, change, history=None):
"""Update information for a change."""
raise NotImplementedError()
def getGitUrl(self, project):
"""Get the git url for a project."""
return self.connection.getGitUrl(project)
def getGitwebUrl(self, project, sha=None):
"""Get the git-web url for a project."""
return self.connection.getGitwebUrl(project, sha)
def _ghTimestampToDate(self, timestamp):
return time.strptime(timestamp, '%Y-%m-%dT%H:%M:%SZ')
def getRequireFilters(self, config):
f = GithubRefFilter(
return [f]
def getRejectFilters(self, config):
f = GithubRefFilter(
return [f]
def getRefForChange(self, change):
return "refs/pull/%s/head" % change
review = v.Schema({'username': str,
'email': str,
'older-than': str,
'newer-than': str,
'type': str,
'permission': v.Any('read', 'write', 'admin'),
def getRequireSchema():
require = {'status': scalar_or_list(str),
'review': scalar_or_list(review),
'open': bool,
'merged': bool,
'current-patchset': bool,
'label': scalar_or_list(str)}
return require
def getRejectSchema():
reject = {'status': scalar_or_list(str),
'review': scalar_or_list(review),
'open': bool,
'merged': bool,
'current-patchset': bool,
'label': scalar_or_list(str)}
return reject