releases/openstack_releases/project_config.py
Doug Hellmann 33313ff757 provide a way to turn off the build-job validation check
Some projects want to tag repositories that do not have explicit build
artifacts. This patch adds a somewhat generic "flag" system for adding
this and similar settings on a per-repository basis.

Change-Id: I40d73987f91409e760177b573c1c300c091ef09e
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2016-06-06 13:12:21 -04:00

98 lines
3.5 KiB
Python

# 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.
"""Work with the project-config repository.
"""
import requests
import yaml
ZUUL_LAYOUT_URL = 'http://git.openstack.org/cgit/openstack-infra/project-config/plain/zuul/layout.yaml' # noqa
ZUUL_LAYOUT_FILENAME = 'openstack-infra/project-config/zuul/layout.yaml'
# We use this key to modify the data structure read from the zuul
# layout file. We don't control what are valid keys there, so make it
# easy to change the key we use, just in case.
_VALIDATE_KEY = 'validate-projects-by-name'
def get_zuul_layout_data(url=ZUUL_LAYOUT_URL):
"""Return the parsed data structure for the zuul/layout.yaml file.
:param url: Optional URL to the location of the file. Defaults to
the most current version in the public git repository.
"""
r = requests.get(url)
raw = yaml.safe_load(r.text)
# Add a mapping from repo name to repo settings, since that is how
# we access this most often.
raw[_VALIDATE_KEY] = {
p['name']: p
for p in raw['projects']
}
return raw
def require_release_jobs_for_repo(deliverable_info, zuul_layout, repo):
"""Check the repository for release jobs.
Returns a list of tuples containing a message and a boolean
indicating if the message is an error.
"""
errors = []
# Look up the flags for this repository.
all_settings = deliverable_info.get('repository-settings', {})
repo_settings = all_settings.get(repo, {})
flags = repo_settings.get('flags', [])
# If the repository is configured as not having an artifact to
# build, we don't need to check for any jobs.
if 'no-artifact-build-job' in flags:
return errors
if repo not in zuul_layout[_VALIDATE_KEY]:
errors.append(
('did not find %s in %s' % (repo, ZUUL_LAYOUT_FILENAME),
True)
)
else:
p = zuul_layout[_VALIDATE_KEY][repo]
templates = [
t['name']
for t in p.get('template', [])
]
# NOTE(dhellmann): We don't mess around looking for individual
# jobs, because we want projects to use the templates.
num_release_jobs = sum(('openstack-server-release-jobs' in templates,
'publish-to-pypi' in templates,
'puppet-tarball-jobs' in templates))
if num_release_jobs == 0:
errors.append(
('%s no release job specified, '
'should be one of openstack-server-release-jobs, '
'publish-to-pypi or puppet-tarball-jobs for %s '
'or no release will be published'
% (ZUUL_LAYOUT_FILENAME, repo), True)
)
elif num_release_jobs > 1:
errors.append(
('%s multiple release jobs specified, '
'should be *one* of openstack-server-release-jobs, '
'publish-to-pypi or puppet-tarball-jobs for %s '
% (ZUUL_LAYOUT_FILENAME, repo), False)
)
return errors