Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 1.86 KB

README.md

File metadata and controls

43 lines (29 loc) · 1.86 KB
Raw

microsetta-interface

The Microsetta participant facing user interface

Installation

Create a new conda environment containing flask and other necessary packages:

conda create --yes -n microsetta-interface python=3.7
conda install --yes -n microsetta-interface --file ci/conda_requirements.txt
conda activate microsetta-interface
pip install -r ci/pip_requirements.txt

Then install the microsetta-interface in editable mode:

pip install -e .

Test Usage

In the activated conda environment, start the microservice using flask's built-in server by running, e.g.,

python microsetta_interface/server.py

which will start the server on http://localhost:8083. Note that this usage is suitable for development ONLY--real use of the service would require a production-level server.

In order for the interface to be functional, it needs to be able to communicate with an instance of microsetta_private_api. Details for installing and running the private API can be found here.

Integration tests

An integration test suite is available which exercises the interaction between microsetta-interface and microsetta-private-api. These tests are only run if the private API appears online and accessible, and if custom public/private keys are available for managing JWTs.

To execute the integration suite:

  • modify the server_config.json of microsetta-private-api, adding "disable_authentication": true".
  • start microsetta-private-api
  • construct new public/private keys and make them available with source keys_for_testing.sh
  • run the integration suite with python microsetta_interface/tests/test_integration.py.

If communication with the private API is working, and if public/private keys are accessible, the tests will run. Otherwise, the test suite will skip all tests.