pacifica/dispatcher-proxymod-backend repository overview

⁠Pacifica Dispatcher for proxymod

This is the Pacifica Notifications Service for proxymod⁠.

⁠The Parts

There are several parts to this code as it encompasses integrating several python libraries together.

• PeeWee⁠
• CherryPy⁠
• Celery⁠

For each major library we have integration points in specific modules to handle configuration of each library.

⁠PeeWee

The configuration of PeeWee is pulled from the DATABASE_URL environment variable, whose value is a database connection url⁠.

• proxymod PeeWee Model⁠

⁠CherryPy

The CherryPy configuration has two entry points for use. The WSGI interface and the embedded server through the main method.

• proxymod Main Method⁠
• proxymod WSGI API⁠

⁠Celery

The Celery tasks are located in their own module and have an entry point from the CherryPy REST objects. The tasks save state into a PeeWee database that is also accessed in the CherryPy REST objects.

The configuration of Celery is pulled from the BACKEND_URL and BROKER_URL environment variables, whose values are the connection URLs for the backend and message broker, respectively.

• proxymod Tasks⁠

⁠Start Up Process

The default way to start up this service is with a shared SQLite database. The database must be located in the current working directory of both the celery workers and the CherryPy web server. The messaging system in Travis⁠ and Appveyor⁠ is Redis, however the default is RabbitMQ.

There are three commands needed to start up the services. Perform these steps in three separate terminals.

1. docker-compose up rabbit
2. env DATABASE_URL="sqliteext:///db.sqlite3" celery -A "pacifica.dispatcher_proxymod.__main__:celery_app" worker -l info
3. env DATABASE_URL="sqliteext:///db.sqlite3" python3 -m "pacifica.dispatcher_proxymod.__main__"

⁠Testing

To test, perform these steps:

1. python3 -m unittest pacifica/dispatcher/proxymod/tests/test_*.py