219 lines
7.9 KiB
Python
219 lines
7.9 KiB
Python
# Copyright (c) 2015 Mirantis, Inc.
|
|
# All Rights Reserved.
|
|
#
|
|
# 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.
|
|
|
|
"""App factory."""
|
|
|
|
import json
|
|
import logging
|
|
import os
|
|
|
|
from beaker.middleware import SessionMiddleware
|
|
from oslo_config import cfg
|
|
from oslo_log import log
|
|
from oslo_log import loggers
|
|
import pecan
|
|
import webob
|
|
|
|
from refstack.api import utils as api_utils
|
|
from refstack.common import validators
|
|
|
|
LOG = log.getLogger(__name__)
|
|
|
|
PROJECT_ROOT = os.path.join(os.path.dirname(os.path.abspath(__file__)),
|
|
os.pardir)
|
|
UI_OPTS = [
|
|
cfg.StrOpt('ui_url',
|
|
default='http://refstack.net',
|
|
help='Url of user interface for Refstack. Need for redirects '
|
|
'after sign in and sign out.'
|
|
),
|
|
]
|
|
|
|
API_OPTS = [
|
|
cfg.StrOpt('api_url',
|
|
default='http://refstack.net',
|
|
help='Url of public Refstack API.'
|
|
),
|
|
cfg.StrOpt('static_root',
|
|
default='%(project_root)s/static',
|
|
help='The directory where your static files can '
|
|
'be found. Pecan comes with middleware that can be used '
|
|
'to serve static files (like CSS and Javascript files) '
|
|
'during development. %(project_root)s is special variable '
|
|
'that point to the root directory of Refstack project. '
|
|
'Value of this option must contain %(project_root)s '
|
|
'variable. Directory with static files specified relative '
|
|
'the project root.'
|
|
),
|
|
cfg.StrOpt('template_path',
|
|
default='%(project_root)s/templates',
|
|
help='Points to the directory where your template files live. '
|
|
'%(project_root)s is special variable that point to the '
|
|
'root directory of Refstack project. Value of this option '
|
|
'must contain %(project_root)s variable. Directory with '
|
|
'template files specified relative the project root.'
|
|
),
|
|
cfg.ListOpt('allowed_cors_origins',
|
|
default=[],
|
|
help='List of sites allowed cross-site resource access. If '
|
|
'this is empty, only same-origin requests are allowed.'
|
|
),
|
|
cfg.BoolOpt('app_dev_mode',
|
|
default=False,
|
|
help='Switch Refstack app into debug mode. Helpful for '
|
|
'development. In debug mode static file will be served '
|
|
'by pecan application. Also, server responses will '
|
|
'contain some details with debug information.'
|
|
),
|
|
cfg.StrOpt('test_results_url',
|
|
default='/#/results/%s',
|
|
help='Template for test result url.'
|
|
),
|
|
cfg.StrOpt('github_api_capabilities_url',
|
|
default='https://api.github.com'
|
|
'/repos/openstack/defcore/contents',
|
|
help='The GitHub API URL of the repository and location of '
|
|
'the DefCore capability files. This URL is used to get '
|
|
'a listing of all capability files.'
|
|
),
|
|
cfg.StrOpt('github_raw_base_url',
|
|
default='https://raw.githubusercontent.com'
|
|
'/openstack/defcore/master/',
|
|
help='This is the base URL that is used for retrieving '
|
|
'specific capability files. Capability file names will '
|
|
'be appended to this URL to get the contents of that file.'
|
|
)
|
|
]
|
|
|
|
CONF = cfg.CONF
|
|
|
|
opt_group = cfg.OptGroup(name='api',
|
|
title='Options for the Refstack API')
|
|
|
|
CONF.register_opts(UI_OPTS)
|
|
|
|
CONF.register_group(opt_group)
|
|
CONF.register_opts(API_OPTS, opt_group)
|
|
|
|
log.register_options(CONF)
|
|
|
|
|
|
class JSONErrorHook(pecan.hooks.PecanHook):
|
|
|
|
"""A pecan hook that translates webob HTTP errors into a JSON format."""
|
|
|
|
def __init__(self):
|
|
"""Hook init."""
|
|
self.debug = CONF.api.app_dev_mode
|
|
|
|
def on_error(self, state, exc):
|
|
"""Request error handler."""
|
|
if isinstance(exc, webob.exc.HTTPRedirection):
|
|
return
|
|
elif isinstance(exc, webob.exc.HTTPError):
|
|
status_code = exc.status_int
|
|
body = {'title': exc.title}
|
|
elif isinstance(exc, validators.ValidationError):
|
|
status_code = 400
|
|
body = {'title': exc.title}
|
|
else:
|
|
LOG.exception(exc)
|
|
status_code = 500
|
|
body = {'title': 'Internal Server Error'}
|
|
|
|
body['code'] = status_code
|
|
if self.debug:
|
|
body['detail'] = str(exc)
|
|
return webob.Response(
|
|
body=json.dumps(body),
|
|
status=status_code,
|
|
content_type='application/json'
|
|
)
|
|
|
|
|
|
class CORSHook(pecan.hooks.PecanHook):
|
|
|
|
"""A pecan hook that handles Cross-Origin Resource Sharing."""
|
|
|
|
def __init__(self):
|
|
"""Init the hook by getting the allowed origins."""
|
|
self.allowed_origins = getattr(CONF.api, 'allowed_cors_origins', [])
|
|
|
|
def after(self, state):
|
|
"""Add CORS headers to the response.
|
|
|
|
If the request's origin is in the list of allowed origins, add the
|
|
CORS headers to the response.
|
|
"""
|
|
origin = state.request.headers.get('Origin', None)
|
|
if origin in self.allowed_origins:
|
|
state.response.headers['Access-Control-Allow-Origin'] = origin
|
|
state.response.headers['Access-Control-Allow-Methods'] = \
|
|
'GET, OPTIONS, PUT, POST'
|
|
state.response.headers['Access-Control-Allow-Headers'] = \
|
|
'origin, authorization, accept, content-type'
|
|
state.response.headers['Access-Control-Allow-Credentials'] = 'true'
|
|
|
|
|
|
def setup_app(config):
|
|
"""App factory."""
|
|
# By default we expect path to oslo config file in environment variable
|
|
# REFSTACK_OSLO_CONFIG (option for testing and development)
|
|
# If it is empty we look up those config files
|
|
# in the following directories:
|
|
# ~/.${project}/
|
|
# ~/
|
|
# /etc/${project}/
|
|
# /etc/
|
|
|
|
default_config_files = ((os.getenv('REFSTACK_OSLO_CONFIG'), )
|
|
if os.getenv('REFSTACK_OSLO_CONFIG')
|
|
else cfg.find_config_files('refstack'))
|
|
CONF('',
|
|
project='refstack',
|
|
default_config_files=default_config_files)
|
|
|
|
log.setup(CONF, 'refstack')
|
|
CONF.log_opt_values(LOG, logging.DEBUG)
|
|
|
|
template_path = CONF.api.template_path % {'project_root': PROJECT_ROOT}
|
|
static_root = CONF.api.static_root % {'project_root': PROJECT_ROOT}
|
|
|
|
app_conf = dict(config.app)
|
|
app = pecan.make_app(
|
|
app_conf.pop('root'),
|
|
debug=CONF.api.app_dev_mode,
|
|
static_root=static_root,
|
|
template_path=template_path,
|
|
hooks=[JSONErrorHook(), CORSHook(), pecan.hooks.RequestViewerHook(
|
|
{'items': ['status', 'method', 'controller', 'path', 'body']},
|
|
headers=False, writer=loggers.WritableLogger(LOG, logging.DEBUG)
|
|
)]
|
|
)
|
|
|
|
beaker_conf = {
|
|
'session.key': 'refstack',
|
|
'session.type': 'memory',
|
|
'session.timeout': 604800,
|
|
'session.validate_key': api_utils.get_token(),
|
|
}
|
|
app = SessionMiddleware(app, beaker_conf)
|
|
|
|
if CONF.api.app_dev_mode:
|
|
LOG.debug('\n\n <<< Refstack UI is available at %s >>>\n\n',
|
|
CONF.ui_url)
|
|
|
|
return app
|