husky-musher

A redirecting service for the Husky Coronavirus Testing study

Running locally

Run the Flask app with:

pipenv run flask run

The default is to use the production REDCap project (i.e. when FLASK_ENV is unset or FLASK_ENV=production). In this mode, the authenticated user and their information is expected to be provided in the request environment/context, i.e. by Apache/Shibboleth.

To use the testing/development REDCap project instead, set FLASK_ENV=development. In this mode, the "authenticated" user and their information is provided in the process environment as normal environment variables. For example:

FLASK_ENV=development \
[email protected] \
uid=trsibley \
givenName=Thomas \
surname=Sibley \
  pipenv run flask run

You will also need to setup a logfile at /var/log/husky_musher/husky_musher.log and make sure that the user running the application has write permissions to the file.

Requirements

See Pipfile for required libraries.

The required environment variables are:

• REDCAP_API_TOKEN_hct.redcap.rit.uw.edu_148 (production)
• REDCAP_API_TOKEN_hct.redcap.rit.uw.edu_139 (development)

Tests

Run doctests on the utils functions with:

FLASK_ENV=development envdir <path to redcap envdir> pipenv run python3 -m doctest lib/husky_musher/utils/*

Run unit tests with:

FLASK_ENV=development envdir <path to redcap envdir> pipenv run python -m unittest lib/husky_musher/tests/*

Note that although running the tests accesses the redcap envdir (specifically REDCAP_API_URL), it does not use these variables to connect to a project, so dummy environment variables can be used if desired.

Attributions

"Paw Print" icon By Humantech from the Noun Project.