3bf36b7128
When creating a new election we need to add a directory per project (including the 'TC' as a pseudo project) we can't just create an empty directory in git so we add a '.placeholder' file. We have recently added a voting job that will run try to validate all candidate files added in a review. This includes the placeholder file. CLearly this file will not pass validation and cause the job to fail. Adding .placeholder to the zuul irrelevant-files variable wont work, so instead filter .placeholder from the interesting files. Change-Id: Ibd2224a5479d4ab9afbac227bac38080359a98bf
144 lines
4.8 KiB
Python
Executable File
144 lines
4.8 KiB
Python
Executable File
# 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.
|
|
|
|
from __future__ import absolute_import
|
|
from __future__ import print_function
|
|
from __future__ import unicode_literals
|
|
|
|
import argparse
|
|
import os
|
|
import subprocess
|
|
|
|
from openstack_election import check_candidacy
|
|
from openstack_election import utils
|
|
|
|
|
|
def validate_release(release):
|
|
print('Validate Release')
|
|
print('----------------')
|
|
|
|
release_path = os.path.join(utils.CANDIDATE_PATH, release)
|
|
is_valid = (os.path.exists(release_path) and os.path.isdir(release_path))
|
|
|
|
print('Release: %s [%s] %s' % (release, release_path,
|
|
{True: 'PASS', False: 'FAIL'}[is_valid]))
|
|
print('')
|
|
return is_valid
|
|
|
|
|
|
def validate_filename(filepath):
|
|
print('Validate file name looks like an email address')
|
|
print('----------------------------------------------')
|
|
|
|
file_name = utils.get_email(filepath)
|
|
is_valid = '@' in file_name
|
|
|
|
print('Filename: %s [%s] %s' % (file_name, filepath,
|
|
{True: 'PASS', False: 'FAIL'}[is_valid]))
|
|
print('')
|
|
return is_valid
|
|
|
|
|
|
def validate_member(filepath):
|
|
print('Validate email address is OSF member')
|
|
print('------------------------------------')
|
|
|
|
email = utils.get_email(filepath)
|
|
member = utils.lookup_member(email)
|
|
is_valid = member.get('data', []) != []
|
|
|
|
print('Email address: %s %s' % (email,
|
|
{True: 'PASS', False: 'FAIL'}[is_valid]))
|
|
print('')
|
|
return is_valid
|
|
|
|
|
|
def check_for_changes(projects, filepath, limit):
|
|
print('Looking for validating changes')
|
|
print('------------------------------')
|
|
|
|
email = utils.get_email(filepath)
|
|
project_name = os.path.basename(os.path.dirname(filepath))
|
|
project_name = utils.dir2name(project_name, projects)
|
|
|
|
changes_found = check_candidacy.check_candidate(project_name, email,
|
|
projects, limit)
|
|
print('')
|
|
return bool(changes_found)
|
|
|
|
|
|
def find_modified_candidate_files():
|
|
"Return a list of files modified by the most recent commit."
|
|
results = subprocess.check_output(
|
|
['git', 'diff', '--name-only', '--pretty=format:', 'HEAD^']
|
|
).decode('utf-8')
|
|
filenames = [
|
|
l.strip()
|
|
for l in results.splitlines()
|
|
if (l.startswith(utils.CANDIDATE_PATH + '/') and
|
|
not l.endswith('.placeholder'))
|
|
]
|
|
return filenames
|
|
|
|
|
|
def main():
|
|
description = ('Check all files under the current open election are valid')
|
|
parser = argparse.ArgumentParser(description)
|
|
|
|
parser.add_argument('--limit', dest='limit', type=int, default=1,
|
|
help=('How many validating changes to report. '
|
|
'A negative value means report many. '
|
|
'Default: %(default)s'))
|
|
parser.add_argument('--tag', dest='tag', default=utils.conf['tag'],
|
|
help=('The governance tag to validate against. '
|
|
'Default: %(default)s'))
|
|
parser.add_argument('--release', dest='release',
|
|
default=utils.conf['release'],
|
|
help=('The relase to validate candidates against. '
|
|
'Default: %(default)s'))
|
|
parser.add_argument('--HEAD',
|
|
dest='head_only',
|
|
action='store_true',
|
|
default=False,
|
|
help='Validate all candidates.')
|
|
parser.add_argument('files',
|
|
nargs='*',
|
|
help='Candidate files to validate.')
|
|
|
|
args = parser.parse_args()
|
|
errors = False
|
|
|
|
if not validate_release(args.release):
|
|
return 1
|
|
|
|
projects = utils.get_projects(tag=args.tag, fallback_to_master=True)
|
|
|
|
if args.files:
|
|
to_process = args.files
|
|
elif args.head_only:
|
|
to_process = find_modified_candidate_files()
|
|
else:
|
|
to_process = utils.find_candidate_files(election=args.release)
|
|
|
|
for filepath in to_process:
|
|
candidate_ok = True
|
|
|
|
candidate_ok &= validate_filename(filepath)
|
|
candidate_ok &= validate_member(filepath)
|
|
|
|
if candidate_ok and not utils.is_tc_election():
|
|
candidate_ok &= check_for_changes(projects, filepath, args.limit)
|
|
|
|
errors |= not candidate_ok
|
|
|
|
return 1 if errors else 0
|