-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
config: add application factory and blueprint
Signed-off-by: Diego Rodriguez <diego.rodriguez@cern.ch>
- Loading branch information
Diego Rodriguez
committed
Jun 8, 2017
1 parent
a45335b
commit 12fc845
Showing
8 changed files
with
281 additions
and
214 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,15 @@ | ||
REST API | ||
======== | ||
|
||
GET /workflows | ||
-------------- | ||
GET /api/workflows | ||
------------------ | ||
|
||
.. autofunction:: reana_workflow_controller.app.get_workflows | ||
.. autofunction:: reana_workflow_controller.api.get_workflows | ||
|
||
|
||
POST /yadage | ||
------------ | ||
POST /api/yadage | ||
---------------- | ||
|
||
.. autofunction:: reana_workflow_controller.app.yadage_endpoint | ||
.. autofunction:: reana_workflow_controller.api.yadage_endpoint | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,202 @@ | ||
# -*- coding: utf-8 -*- | ||
# | ||
# This file is part of REANA. | ||
# Copyright (C) 2017 CERN. | ||
# | ||
# REANA is free software; you can redistribute it and/or modify it under the | ||
# terms of the GNU General Public License as published by the Free Software | ||
# Foundation; either version 2 of the License, or (at your option) any later | ||
# version. | ||
# | ||
# REANA is distributed in the hope that it will be useful, but WITHOUT ANY | ||
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR | ||
# A PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
# | ||
# You should have received a copy of the GNU General Public License along with | ||
# REANA; if not, write to the Free Software Foundation, Inc., 59 Temple Place, | ||
# Suite 330, Boston, MA 02111-1307, USA. | ||
# | ||
# In applying this license, CERN does not waive the privileges and immunities | ||
# granted to it by virtue of its status as an Intergovernmental Organization or | ||
# submit itself to any jurisdiction. | ||
|
||
"""REANA Workflow Controller Rest API.""" | ||
|
||
import os | ||
import traceback | ||
|
||
from flask import Blueprint, abort, jsonify, redirect, request | ||
|
||
from .app import db | ||
from .fsdb import get_all_workflows | ||
from .models import Tenant | ||
from .tasks import run_yadage_workflow | ||
|
||
experiment_to_queue = { | ||
'alice': 'alice-queue', | ||
'atlas': 'atlas-queue', | ||
'lhcb': 'lhcb-queue', | ||
'cms': 'cms-queue', | ||
'recast': 'recast-queue' | ||
} | ||
|
||
api = Blueprint('api', __name__) | ||
|
||
|
||
@api.before_request | ||
def before_request(): | ||
"""Retrieve organization from request.""" | ||
org = request.args.get('organization') | ||
if org: | ||
db.choose_organization(org) | ||
|
||
|
||
@api.route('/workflows', methods=['GET']) | ||
def get_workflows(): | ||
"""Get all workflows. | ||
.. http:get:: /api/workflows | ||
Returns a JSON list with all the workflows. | ||
**Request**: | ||
.. sourcecode:: http | ||
GET /api/workflows HTTP/1.1 | ||
Content-Type: apilication/json | ||
Host: localhost:5000 | ||
:reqheader Content-Type: apilication/json | ||
:query organization: organization name. It finds workflows | ||
inside a given organization. | ||
:query tenant: tenant uuid. It finds workflows inside a given | ||
organization owned by tenant. | ||
**Responses**: | ||
.. sourcecode:: http | ||
HTTP/1.1 200 OK | ||
Content-Length: 22 | ||
Content-Type: apilication/json | ||
{ | ||
"workflows": [ | ||
{ | ||
"id": "256b25f4-4cfb-4684-b7a8-73872ef455a1", | ||
"organization": "default_org", | ||
"status": "running", | ||
"tenant": "default_tenant" | ||
}, | ||
{ | ||
"id": "3c9b117c-d40a-49e3-a6de-5f89fcada5a3", | ||
"organization": "default_org", | ||
"status": "finished", | ||
"tenant": "default_tenant" | ||
}, | ||
{ | ||
"id": "72e3ee4f-9cd3-4dc7-906c-24511d9f5ee3", | ||
"organization": "default_org", | ||
"status": "waiting", | ||
"tenant": "default_tenant" | ||
}, | ||
{ | ||
"id": "c4c0a1a6-beef-46c7-be04-bf4b3beca5a1", | ||
"organization": "default_org", | ||
"status": "waiting", | ||
"tenant": "default_tenant" | ||
} | ||
] | ||
} | ||
:resheader Content-Type: apilication/json | ||
:statuscode 200: no error - the list has been returned. | ||
.. sourcecode:: http | ||
HTTP/1.1 500 Internal Error | ||
Content-Length: 22 | ||
Content-Type: apilication/json | ||
{ | ||
"msg": "Either organization or tenant doesn't exist." | ||
} | ||
:resheader Content-Type: apilication/json | ||
:statuscode 500: error - the list couldn't be returned. | ||
""" | ||
org = request.args.get('organization', 'default') | ||
tenant = request.args['tenant'] | ||
try: | ||
if Tenant.query.filter(Tenant.id_ == tenant).count() < 1: | ||
return jsonify({'msg': 'Tenant {} does not exist'.format(tenant)}) | ||
|
||
return jsonify({"workflows": get_all_workflows(org, tenant)}), 200 | ||
except Exception as e: | ||
return jsonify({"msg": str(e)}), 500 | ||
|
||
|
||
@api.route('/yadage', methods=['POST']) | ||
def yadage_endpoint(): | ||
"""Create a new job. | ||
.. http:post:: /api/yadage | ||
This resource is expecting JSON data with all the necessary | ||
information to run a yadage workflow. | ||
**Request**: | ||
.. sourcecode:: http | ||
POST /api/yadage HTTP/1.1 | ||
Content-Type: apilication/json | ||
Host: localhost:5000 | ||
{ | ||
"experiment": "atlas", | ||
"toplevel": "from-github/testing/scriptflow", | ||
"workflow": "workflow.yml", | ||
"nparallel": "100", | ||
"preset_pars": {} | ||
} | ||
:reqheader Content-Type: apilication/json | ||
:json body: JSON with the information of the yadage workflow. | ||
**Responses**: | ||
.. sourcecode:: http | ||
HTTP/1.0 200 OK | ||
Content-Length: 80 | ||
Content-Type: apilication/json | ||
{ | ||
"msg", "Workflow successfully launched", | ||
"workflow_id": "cdcf48b1-c2f3-4693-8230-b066e088c6ac" | ||
} | ||
:resheader Content-Type: apilication/json | ||
:statuscode 200: no error - the workflow was created | ||
:statuscode 400: invalid request - problably a malformed JSON | ||
""" | ||
if request.method == 'POST': | ||
try: | ||
if request.json: | ||
queue = experiment_to_queue[request.json['experiment']] | ||
resultobject = run_yadage_workflow.apily_async( | ||
args=[request.json], | ||
queue='yadage-{}'.format(queue) | ||
) | ||
if 'redirect' in request.args: | ||
return redirect('{}/{}'.format( | ||
os.environ['YADAGE_MONITOR_URL']), | ||
resultobject.id) | ||
return jsonify({'msg': 'Workflow successfully launched', | ||
'workflow_id': resultobject.id}) | ||
|
||
except (KeyError, ValueError): | ||
traceback.print_exc() | ||
abort(400) |
Oops, something went wrong.