Differential D433

simplify setting up development instance
ClosedPublic
Actions

Authored by kparal on Jul 13 2015, 1:00 PM.

Details

Reviewers
lbrabec
tflink
mkrizek
jskladan
Maniphest Tasks
T523: Simplify set up of Taskotron development environment
Commits
rRSFE14fe417c0f0c: simplify setting up development instance
Summary
  • Improve documentation in readme
  • Default to DEV profile
  • Default to port 5002 (to avoid clashes with our other projects)
  • Default to port 5001 for ResultsDB server (its own default)
  • Add important options to settings.py.example
  • Add missing simplejson dep to requirements.txt
  • Do not require settings.py, use defaults if missing
Test Plan

manually tested, seems to work

Diff Detail

Repository
rRSFE resultsdb_frontend
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
kparal retitled this revision from to simplify setting up development instance.Jul 13 2015, 1:00 PM
kparal updated this object.
kparal edited the test plan for this revision. (Show Details)
kparal added a task: T523: Simplify set up of Taskotron development environment.
kparal added reviewers: jskladan, lbrabec, mkrizek, tflink.
kparal updated this revision to Diff 1144.Jul 13 2015, 1:13 PM
  • readme: add "using with libtaskotron" instructions
jskladan accepted this revision.Jul 13 2015, 1:35 PM
This revision is now accepted and ready to land.Jul 13 2015, 1:35 PM
Closed by commit rRSFE14fe417c0f0c: simplify setting up development instance (authored by kparal). · Explain WhyJul 14 2015, 8:52 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathPackages
M.gitignore (2 lines)
MREADME.md (37 lines)
Mconf/settings.py.example (10 lines)
Mrequirements.txt (1 line)
Mresultsdb_frontend/__init__.py (26 lines)
Mresultsdb_frontend/config.py (8 lines)

Diff 1152

View Options

.gitignore

1*.pyc 1​*.pyc
2*.pyo 2​*.pyo
3*.swp 3​*.swp
4*__pycache__* 4​*__pycache__*
5.ropeproject/ 5​.ropeproject/
6conf/settings.py 6​conf/settings.py
7*.sqlite 7​*.sqlite
8*.sass-cache 8​*.sass-cache
9*build/ 9​*build/
10*dist/ 10​*dist/
11*.egg* 11​*.egg*
12/env 12​/env*/
View Options

README.md

1# ResultsDB frontend 1​# ResultsDB frontend
2 2​
3ResultsDB fronted is a simple application that allows browsing the data stored inside ResultsDB. 3​ResultsDB fronted is a simple application that allows browsing the data stored inside ResultsDB.
4 4​
5## Repositories 5​## Repositories
6 6​
7* ResultsDB - [Bitbucket GIT repo](https://bitbucket.org/fedoraqa/resultsdb) 7​* ResultsDB - [Bitbucket GIT repo](https://bitbucket.org/fedoraqa/resultsdb)
8* ResultsDB Client Library - [Bitbucket GIT repo](https://bitbucket.org/fedoraqa/resultsdb_api) 8​* ResultsDB Client Library - [Bitbucket GIT repo](https://bitbucket.org/fedoraqa/resultsdb_api)
9 9​
10## Hacking 10​## Quick development setup
11 11​
12You'll need to stand up an instance of the core 12​You'll need to stand up an instance of the core
13[resultsdb](https://bitbucket.org/rajcze/resultsdb) alongside this frontend for 13​[resultsdb](https://bitbucket.org/fedoraqa/resultsdb) alongside this frontend
14it to work. 14​for it to work.
15 15​
16First, clone the repository. 16​First, clone the repository.
17 17​
18Then, setup a virtual environment for development. 18​Then, setup a virtual environment for development:
19 19​
20 $ sudo yum install python-virtualenv 20​ $ sudo dnf install python-virtualenv
21 $ virtualenv resultsdb_frontend 21​ $ virtualenv env_resultsdb_frontend
22 $ source resultsdb_frontend/bin/activate 22​ $ source env_resultsdb_frontend/bin/activate
23 $ pip install -r requirements.txt 23​ $ pip install -r requirements.txt
24 $ python setup.py install ​
25 24​
26Setup a config file: 25​Run the server:
27 26​
28 $ cp conf/settings.py.example conf/settings.py 27​ $ DEV=true python runapp.py
29 $ # edit conf/settings.py accordingly ​
30 28​
31Initialize your database: 29​The ResultsDB frontend is now running at <http://localhost:5002>. It expects
30​the ResultsDB server to be available at <http://localhost:5001/api/v1.0>.
32 31​
33 $ ./init_db.sh 32​## Adjusting configuration
34 33​
35Run the server 34​You can configure this app by copying `conf/settings.py.example` into
35​`conf/setting.py` and adjusting values as you see fit. It overrides default
36​values in `resultsdb_frontend/config.py`.
36 37​
37 $ python runapp.py 38​## Using with libtaskotron
39​
40​You might want to use this tool together with libtaskotron. To use your own
41​*ResultsDB frontend* in libtaskotron, edit `/etc/taskotron/taskotron.yaml` and
42​set the following value::
43​
44​ resultsdb_frontend: http://localhost:5002
View Options

conf/settings.py.example

1# while you can use this as a template, we recommend that you use the blockerbugs 1​# Copy this file to `conf/settings.py` to put it into effect. It overrides the
2# cli to generate a config file 2​# values defined in `resultsdb_frontend/config.py`.
3RDB_URL = 'http://localhost:5000/api/v1.0' 3​RDB_URL = 'http://localhost:5001/api/v1.0'
4SECRET_KEY = 'not-really-a-secret' 4​SECRET_KEY = 'replace-me-with-something-random'
5FILE_LOGGING = False 5​FILE_LOGGING = False
6LOGFILR = '/var/log/resultsdb_frontend/resultsdb_frontend.log' 6​LOGFILR = '/var/log/resultsdb_frontend/resultsdb_frontend.log'
7SYSLOG_LOGGING = False 7​SYSLOG_LOGGING = False
8STREAM_LOGGING = True 8​STREAM_LOGGING = True
9​RUN_HOST= '0.0.0.0'
10​RUN_PORT = 5002
View Options

requirements.txt

1Flask>=0.9 1​Flask>=0.9
2WTForms>1.0 2​WTForms>1.0
3#FIXME: change Flask-WTF to >= 0.8 (?) there seems to be a bug now (see below), or it might be connected to the Flask version - find out! 3​#FIXME: change Flask-WTF to >= 0.8 (?) there seems to be a bug now (see below), or it might be connected to the Flask version - find out!
4# File "/home/jskladan/flask_virtualenv/lib/python2.7/site-packages/Flask_WTF-0.9.0-py2.7.egg/flask_wtf/recaptcha/widgets.py", line 5, in <module> 4​# File "/home/jskladan/flask_virtualenv/lib/python2.7/site-packages/Flask_WTF-0.9.0-py2.7.egg/flask_wtf/recaptcha/widgets.py", line 5, in <module>
5# from flask.json import dumps, JSONEncoder 5​# from flask.json import dumps, JSONEncoder
6Flask-WTF==0.8 6​Flask-WTF==0.8
7resultsdb_api 7​resultsdb_api
8​simplejson==3.7.3
View Options

resultsdb_frontend/__init__.py

Show All 25 Lines
26import logging 26​import logging
27import os 27​import os
28 28​
29# the version as used in setup.py 29​# the version as used in setup.py
30__version__ = "1.1.5" 30​__version__ = "1.1.5"
31 31​
32# Flask App 32​# Flask App
33app = Flask(__name__) 33​app = Flask(__name__)
34app.secret_key = 'not-really-a-secret' 34​app.secret_key = 'replace-me-with-something-random'
35 35​
36app.wsgi_app = proxy.ReverseProxied(app.wsgi_app) 36​app.wsgi_app = proxy.ReverseProxied(app.wsgi_app)
37 37​
38# Expose the __version__ variable in templates 38​# Expose the __version__ variable in templates
39app.jinja_env.globals['app_version'] = __version__ 39​app.jinja_env.globals['app_version'] = __version__
40 40​
41# Load default config, then override that with a config file 41​# Load default config, then override that with a config file
42if os.getenv('PROD') == 'true': 42​if os.getenv('DEV') == 'true':
43 default_config_obj = 'resultsdb_frontend.config.ProductionConfig' 43​ default_config_obj = 'resultsdb_frontend.config.DevelopmentConfig'
44 default_config_file = '/etc/resultsdb/settings.py' 44​ default_config_file = os.getcwd() + '/conf/settings.py'
45elif os.getenv('TEST') == 'true': 45​elif os.getenv('TEST') == 'true':
46 default_config_obj = 'resultsdb_frontend.config.TestingConfig' 46​ default_config_obj = 'resultsdb_frontend.config.TestingConfig'
47 default_config_file = os.getcwd() + '/conf/settings.py' 47​ default_config_file = os.getcwd() + '/conf/settings.py'
48else: 48​else:
49 default_config_obj = 'resultsdb_frontend.config.DevelopmentConfig' 49​ default_config_obj = 'resultsdb_frontend.config.ProductionConfig'
50 default_config_file = os.getcwd() + '/conf/settings.py' 50​ default_config_file = '/etc/resultsdb/settings.py'
51 51​
52config_file = os.environ.get('RESULTSDB_FRONTEND_CONFIG', default_config_file) 52​app.config.from_object(default_config_obj)
53 53​
54if not os.path.exists(config_file): 54​config_file = os.environ.get('RESULTSDB_FRONTEND_CONFIG', default_config_file)
55 raise RuntimeError("config file %r does not exist" % config_file) ​
56 55​
57app.config.from_object(default_config_obj) 56​if os.path.exists(config_file):
58app.config.from_pyfile(config_file) 57​ app.config.from_pyfile(config_file)
59 58​
60if app.secret_key == 'not-really-a-secret': 59​if app.config['PRODUCTION']:
61 raise Warning("You need to change the app.secret_key value for production") 60​ if app.secret_key == 'replace-me-with-something-random':
61​ raise Warning("You need to change the app.secret_key value for production")
62 62​
63# setup logging 63​# setup logging
64fmt = '[%(filename)s:%(lineno)d] ' if app.debug else '%(module)-12s ' 64​fmt = '[%(filename)s:%(lineno)d] ' if app.debug else '%(module)-12s '
65fmt += '%(asctime)s %(levelname)-7s %(message)s' 65​fmt += '%(asctime)s %(levelname)-7s %(message)s'
66datefmt = '%Y-%m-%d %H:%M:%S' 66​datefmt = '%Y-%m-%d %H:%M:%S'
67loglevel = logging.DEBUG if app.debug else logging.INFO 67​loglevel = logging.DEBUG if app.debug else logging.INFO
68formatter = logging.Formatter(fmt=fmt, datefmt=datefmt) 68​formatter = logging.Formatter(fmt=fmt, datefmt=datefmt)
69 69​
Show All 34 Lines
View Options

resultsdb_frontend/config.py

Show All 17 Lines
18# Tim Flink <tflink@redhat.com> 18​# Tim Flink <tflink@redhat.com>
19# Josef Skladanka <jskladan@redhat.com> 19​# Josef Skladanka <jskladan@redhat.com>
20# Ralph Bean <rbean@redhat.com> 20​# Ralph Bean <rbean@redhat.com>
21 21​
22 22​
23class Config(object): 23​class Config(object):
24 DEBUG = True 24​ DEBUG = True
25 25​
26 RDB_URL = 'http://localhost:5000/api/v1.0' 26​ RDB_URL = 'http://localhost:5001/api/v1.0'
27 27​
28 LOGFILE = '/var/log/resultsdb_frontend/resultsdb_frontend.log' 28​ LOGFILE = '/var/log/resultsdb_frontend/resultsdb_frontend.log'
29 FILE_LOGGING = False 29​ FILE_LOGGING = False
30 SYSLOG_LOGGING = False 30​ SYSLOG_LOGGING = False
31 STREAM_LOGGING = True 31​ STREAM_LOGGING = True
32 32​
33 HOST = None 33​ HOST = '0.0.0.0'
34 PORT = None 34​ PORT = 5002
35 35​
36 PRODUCTION = False 36​ PRODUCTION = False
37 37​
38 38​
39class ProductionConfig(Config): 39​class ProductionConfig(Config):
40 DEBUG = False 40​ DEBUG = False
41 PRODUCTION = True 41​ PRODUCTION = True
42 42​
43 43​
44class DevelopmentConfig(Config): 44​class DevelopmentConfig(Config):
45 TRAP_BAD_REQUEST_ERRORS = True 45​ TRAP_BAD_REQUEST_ERRORS = True
46 HOST = '0.0.0.0' ​
47 PORT = 5001 ​
48 46​
49 47​
50class TestingConfig(Config): 48​class TestingConfig(Config):
51 TRAP_BAD_REQUEST_ERRORS = True 49​ TRAP_BAD_REQUEST_ERRORS = True
52 TESTING = True 50​ TESTING = True