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.

116 lines
4.1 KiB

# Copyright 2013 OpenStack Foundation
# 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 voluptuous as v
# Several forms accept either a single item or a list, this makes
# specifying that in the schema easy (and explicit).
def toList(x):
return v.any([x], x)
class LayoutSchema(object):
include = {'python-file': str}
includes = [include]
manager = v.any('IndependentPipelineManager',
variable_dict = v.Schema({}, extra=True)
trigger = {v.required('event'): toList(v.any('patchset-created',
'comment_filter': toList(str),
'email_filter': toList(str),
'branch': toList(str),
'ref': toList(str),
'approval': toList(variable_dict),
pipeline = {v.required('name'): str,
v.required('manager'): manager,
'description': str,
'success-message': str,
'failure-message': str,
'trigger': toList(trigger),
'success': variable_dict,
'failure': variable_dict,
'start': variable_dict,
pipelines = [pipeline]
job = {v.required('name'): str,
'failure-message': str,
'success-message': str,
'failure-pattern': str,
'success-pattern': str,
'hold-following-changes': bool,
'voting': bool,
'parameter-function': str,
'branch': toList(str),
jobs = [job]
job_name = v.Schema(v.match("^\S+$"))
def validateJob(self, value, path=[]):
if isinstance(value, list):
for (i, v) in enumerate(value):
self.validateJob(v, path + [i])
elif isinstance(value, dict):
for k, v in value.items():
self.validateJob(v, path + [k])
self.job_name.validate(path, self.job_name.schema, value)
def getSchema(self, data):
pipelines = data.get('pipelines')
if not pipelines:
pipelines = []
pipelines = [p['name'] for p in pipelines if 'name' in p]
project = {'name': str,
'merge-mode': v.any('cherry-pick'),
for p in pipelines:
project[p] = self.validateJob
projects = [project]
schema = v.Schema({'includes': self.includes,
v.required('pipelines'): self.pipelines,
v.required('projects'): projects,
return schema
class LayoutValidator(object):
def checkDuplicateNames(self, data, path):
items = []
for i, item in enumerate(data):
if item['name'] in items:
raise v.Invalid("Duplicate name: %s" % item['name'],
path + [i])
def validate(self, data):
schema = LayoutSchema().getSchema(data)
self.checkDuplicateNames(data['pipelines'], ['pipelines'])
if 'jobs' in data:
self.checkDuplicateNames(data['jobs'], ['jobs'])
self.checkDuplicateNames(data['projects'], ['projects'])