def clean_all_failed_jobs(context, token="without"): """Perform API call to clean up all failed jobs.""" url = "{url}api/v1/jobs/clean-failed".format(url=context.jobs_api_url) use_token = parse_token_clause(token) if use_token: context.response = requests.delete( url, headers=jobs_api_authorization(context)) else: context.response = requests.delete(url)
def logout_from_the_jobs_service(context, token='without'): """Call API to logout from the job service.""" url = "{jobs_api_url}api/v1/logout".format( jobs_api_url=context.jobs_api_url) use_token = parse_token_clause(token) if use_token: headers = jobs_api_authorization(context) context.response = requests.put(url, headers) else: context.response = requests.put(url)
def set_job_status(context, job_id, status, token="without"): """Perform API call to set job status.""" endpoint = job_endpoint(context, job_id) url = "{endpoint}?state={status}".format(endpoint=endpoint, status=status) use_token = parse_token_clause(token) if use_token: context.response = requests.put( url, headers=jobs_api_authorization(context)) else: context.response = requests.put(url)
def delete_job(context, job_id=None, token="without"): """Perform API call to delete a job with given ID.""" job_id = get_unique_job_id(context, job_id) endpoint = job_endpoint(context, job_id) use_token = parse_token_clause(token) if use_token: context.response = requests.delete( endpoint, headers=jobs_api_authorization(context)) else: context.response = requests.delete(endpoint)
def list_of_jobs(context, type=None, token=None): """Read list of jobs via job API.""" endpoint = job_endpoint(context) if type is not None: endpoint += "?job_type=" + type use_token = parse_token_clause(token) if use_token: context.response = requests.get( endpoint, headers=jobs_api_authorization(context)) else: context.response = requests.get(endpoint)
def send_json_file_to_job_api(context, endpoint, filename, use_token): """Send the given file to the selected job API endpoints. If the use_token is set, send the 'auth-token' header with the token taken from the context environment. """ if use_token: headers = jobs_api_authorization(context) context.response = context.send_json_file(endpoint, filename, headers) else: context.response = context.send_json_file(endpoint, filename)
def set_job_service_status(context, status=None, token="without"): """Perform API call to set or reset job service status.""" url = "{jobs_api_url}api/v1/service/state".format( jobs_api_url=context.jobs_api_url) use_token = parse_token_clause(token) if status is not None: url = "{url}?state={status}".format(url=url, status=status) if use_token: context.response = requests.put( url, headers=jobs_api_authorization(context)) else: context.response = requests.put(url)
def access_analyses_report(context, ecosystem, from_date=None, to_date=None, token="without"): """Perform API call to get analyses report for selected ecosystem.""" use_token = parse_token_clause(token) url = "{url}api/v1/debug/analyses-report?ecosystem={ecosystem}".format( url=context.jobs_api_url, ecosystem=ecosystem) if from_date is not None: url += "&from_date=" + from_date if to_date is not None: url += "&to_date=" + to_date if use_token: headers = jobs_api_authorization(context) context.response = requests.get(url, headers=headers) else: context.response = requests.get(url)
def jobs_api_url_with_authorization_token(context, url): """Access the jobs service API using the HTTP GET method.""" context.response = requests.get(context.jobs_api_url + url, headers=jobs_api_authorization(context))