prcommands.py

import os
import json
import re
import requests
import pprint
import logging
import time
import functools
import hmac
import hashlib


log = logging.getLogger(__name__)


uri = os.environ.get('JENKINS_URI', 'https://jenkinsci.saltstack.com/api/json')
user = os.environ['JENKINS_USER']
password = os.environ['JENKINS_PASS']
github_secret = os.environ['GITHUB_SECRET']
log_level = os.environ.get('LOG_LEVEL', 'INFO')


class ValidationError(Exception):
    '''
    Raised when an invalid request is encountered
    '''


def validate_github_request(signature, payload, secret=github_secret):
    digest = hmac.new(secret.encode(), payload.encode(), hashlib.sha1).hexdigest()
    if digest == signature:
        return True
    raise ValidationError("Signature did not validate")


def timedcache(method, timeout=300):
    '''
    Cache the return value of a function for the the specified amount of
    seconds.
    '''
    argsmap = {}
    @functools.wraps(method)
    def wrapper(*args, **kwargs):
        key = (repr(args), repr(kwargs))
        if key not in argsmap:
            value = method(*args, **kwargs)
            argsmap[key] = (value, time.time())
        elif time.time() - argsmap[key][1] >= timeout:
            value = method(*args, **kwargs)
            argsmap[key] = (value, time.time())
        else:
            value = argsmap[key][0]
        return value
    return wrapper


def parse_body(body):
    '''
    Parse the body of a github issue comment and look for 're-run' test
    commands.
    '''
    for line in body.lower().split('\n'):
        words = line.split()
        try:
            idx = words.index('re-run')
        except ValueError:
            continue
        if words[idx+1] == 'full':
            yield words[idx:idx+3]
        else:
            yield words[idx:idx+2]


def get_pr_jobs():
    '''
    Get all Jenkins jobs associated with pull requests
    '''
    res = requests.get(
        'https://jenkinsci.saltstack.com/view/Pull%20Requests/api/json',
            headers={'accept': 'application/json'},
            auth=requests.auth.HTTPBasicAuth(user, password),
        )
    if res.status_code != 200:
        raise RuntimeError("Received non 200 status code from jenkins")
    data = res.json()
    for job in data['jobs']:
        yield job


# TODO: This won't work until all branches have the params config merged
# forward?
@timedcache
def job_has_params(job_url):
    res = requests.get(
        '{}/api/json'.format(job_url.rstrip('/'))
    )
    if res.status_code != 200:
        raise RuntimeError("Received non 200 status code from jenkins")
    data = res.json()
    data['jobs'][-1]['url']
    res = requests.get(
        '{}/api/json'.format(data['jobs'][-1]['url'])
    )
    if res.status_code != 200:
        raise RuntimeError("Received non 200 status code from jenkins")
    data = res.json()
    for d in data['property']:
        if d['_class'] == 'hudson.model.ParametersDefinitionProperty':
            return True
    return False


def job_has_params(job_url):
    '''
    Determin weather a Jenkins job accepts build parameters
    '''
    name = job_url.rstrip('/').rsplit('/')[-1]
    if name in ('pr-doc', 'pr-lint',):
        return False
    else:
        return True


def filter_jobs(jobs, keyword):
    '''
    Filter jobs by a keyword. When the keyword is 'all' every job is returned
    '''
    for job in jobs:
        if keyword == 'all':
            yield job
        elif job['name'].find(keyword) != -1:
            yield job


def build_job(job_url, pr_number, run_full, has_params):
    '''
    Request jenkins to build a job
    '''
    log.debug("job_url: %s pr_num: %s run_full: %s has_params: %s",
        job_url, pr_number, run_full, has_params)
    if has_params:
        pr_url = '{}/job/PR-{}/buildWithParameters?runFull={}'.format(
            job_url.rstrip('/'),
            pr_number,
            'true' if run_full else 'false'
        )
    else:
        pr_url = '{}/job/PR-{}/build'.format(
            job_url.rstrip('/'),
            pr_number,
        )
    res = requests.get(
        'https://jenkinsci.saltstack.com/crumbIssuer/api/json',
        auth=requests.auth.HTTPBasicAuth(user, password),
    )
    if res.status_code != 200:
        raise Exception("Jenkins returned non 200 response")
    data = res.json()
    res = requests.post(
        pr_url,
        headers={
            'Content-Type': 'application/x-www-form-urlencoded',
            data['crumbRequestField']: data['crumb']
        },
        auth=requests.auth.HTTPBasicAuth(user, password),
    )
    if res.status_code == 201:
        log.info("Build started: %s", pr_url)
    else:
        log.info("Build request received non 201 status: %s", res.status_code)


def run_cmd(cmd, pr_number):
    '''
    Run a PR command
    '''
    for job in filter_jobs(get_pr_jobs(), cmd[-1]):
        has_params = job_has_params(job['url'])
        if cmd[1] == 'full':
           run_full = True
        else:
           run_full = False
        build_job(job['url'], pr_number, run_full, has_params)