mjia / taskotron / resultsdb

Forked from taskotron/resultsdb 6 years ago
Clone

ResultsDB

ResultsDB is a results store engine for (not only) Fedora QA tools. The API documentation can be found at http://docs.resultsdb20.apiary.io/.

Repositories

Quick development setup

First, clone the repository.

Then, setup a virtual environment for development:

$ sudo dnf install python-virtualenv python-pip
$ virtualenv --system-site-packages env_resultsdb
$ source env_resultsdb/bin/activate
$ pip install -r requirements.txt

If you encounter any installation issues, it's possible that you don't have gcc and necessary C development headers installed to compile C extensions from PyPI. Either install those based on the error messages, or install the necessary packages directly to your system. See requirements.txt to learn how.

Install the project:

$ python setup.py develop

Initialize your database:

$ DEV=true ./init_db.sh

Run the server:

$ DEV=true python runapp.py

The server is now running with a very simple frontend at http://localhost:5001. API calls can be sent to http://localhost:5001/api/v2.0. All data is stored inside /var/tmp/resultsdb_db.sqlite.

Adjusting configuration

You can configure this app by copying conf/settings.py.example into conf/setting.py and adjusting values as you see fit. It overrides default values in resultsdb/config.py.

Using with libtaskotron

You might want to use this tool together with libtaskotron. To use your own ResultsDB server in libtaskotron, edit /etc/taskotron/taskotron.yaml and set the following value::

resultsdb_server: http://localhost:5001/api/v2.0

You might also need to adjust reporting_enabled and report_to_resultsdb, depending on your local settings.

Running test suite

You can run the test suite with the following command (with virtualenv active)::

$ pytest