# Copyright (c) 2016 Red Hat, Inc. # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in all # copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. # # Written by Ralph Bean # Matt Prahl """ Utility functions for rida. """ from flask import request, url_for from datetime import datetime import re import functools import time from rida import log, models from rida.errors import ValidationError def retry(timeout=120, interval=30, wait_on=Exception): """ A decorator that allows to retry a section of code... ...until success or timeout. """ def wrapper(function): @functools.wraps(function) def inner(*args, **kwargs): start = time.time() while True: if (time.time() - start) >= timeout: raise # This re-raises the last exception. try: return function(*args, **kwargs) except wait_on as e: log.warn("Exception %r raised from %r. Retry in %rs" % ( e, function, interval)) time.sleep(interval) return inner return wrapper def start_next_build_batch(config, module, session, builder, components=None): """ Starts a next round of the build cycle for a module. """ import koji # Placed here to avoid py2/py3 conflicts... if any([c.state == koji.BUILD_STATES['BUILDING'] for c in module.component_builds ]): raise ValueError("Cannot start a batch when another is in flight.") # The user can either pass in a list of components to 'seed' the batch, or # if none are provided then we just select everything that hasn't # successfully built yet. unbuilt_components = components or [ c for c in module.component_builds if c.state != koji.BUILD_STATES['COMPLETE'] ] module.batch += 1 for c in unbuilt_components: c.batch = module.batch c.task_id = builder.build(artifact_name=c.package, source=c.scmurl) if not c.task_id: c.state = koji.BUILD_STATES["FAILED"] c.state_reason = "Failed to submit to Koji" module.transition(config, models.BUILD_STATES["failed"], "Failed to submit artifact %s to Koji" % (c.package)) session.add(module) break session.commit() def pagination_metadata(p_query): """ Returns a dictionary containing metadata about the paginated query. This must be run as part of a Flask request. :param p_query: flask_sqlalchemy.Pagination object :return: a dictionary containing metadata about the paginated query """ pagination_data = { 'page': p_query.page, 'per_page': p_query.per_page, 'total': p_query.total, 'pages': p_query.pages, 'first': url_for(request.endpoint, page=1, per_page=p_query.per_page, _external=True), 'last': url_for(request.endpoint, page=p_query.pages, per_page=p_query.per_page, _external=True) } if p_query.has_prev: pagination_data['prev'] = url_for(request.endpoint, page=p_query.prev_num, per_page=p_query.per_page, _external=True) if p_query.has_next: pagination_data['next'] = url_for(request.endpoint, page=p_query.next_num, per_page=p_query.per_page, _external=True) return pagination_data def filter_module_builds(flask_request): """ Returns a flask_sqlalchemy.Pagination object based on the request parameters :param request: Flask request object :return: flask_sqlalchemy.Pagination """ search_query = dict() state = flask_request.args.get('state', None) if state: if state.isdigit(): search_query['state'] = state else: if state in models.BUILD_STATES: search_query['state'] = models.BUILD_STATES[state] else: raise ValidationError('An invalid state was supplied') for key in ['name', 'owner']: if flask_request.args.get(key, None): search_query[key] = flask_request.args[key] query = models.ModuleBuild.query if search_query: query = query.filter_by(**search_query) # This is used when filtering the date request parameters, but it is here to avoid recompiling utc_iso_datetime_regex = re.compile(r'^(?P\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2})(?:\.\d+)?' r'(?:Z|[-+]00(?::00)?)?$') # Filter the query based on date request parameters for item in ('submitted', 'modified', 'completed'): for context in ('before', 'after'): request_arg = '%s_%s' % (item, context) # i.e. submitted_before iso_datetime_arg = request.args.get(request_arg, None) if iso_datetime_arg: iso_datetime_matches = re.match(utc_iso_datetime_regex, iso_datetime_arg) if not iso_datetime_matches or not iso_datetime_matches.group('datetime'): raise ValidationError('An invalid Zulu ISO 8601 timestamp was provided for the "%s" parameter' % request_arg) # Converts the ISO 8601 string to a datetime object for SQLAlchemy to use to filter item_datetime = datetime.strptime(iso_datetime_matches.group('datetime'), '%Y-%m-%dT%H:%M:%S') # Get the database column to filter against column = getattr(models.ModuleBuild, 'time_' + item) if context == 'after': query = query.filter(column >= item_datetime) elif context == 'before': query = query.filter(column <= item_datetime) page = flask_request.args.get('page', 1, type=int) per_page = flask_request.args.get('per_page', 10, type=int) return query.paginate(page, per_page, False)