Avram

Avram is a metadata manager that allows analysts to create and manage [meta]data entries that follow flexible, user-defined models.

Running tests

From avram root:

$ docker/run-postgres.sh start
$ APPENGINE_SDK_HOME=/Applications/appengine-java-sdk-1.9.65/ sbt clean compile test
$ docker/run-postgres.sh stop

To run tests from IntelliJ, add the APPENGINE_SDK_HOME environment variable to your test configuration.

Setting up local dev env

1. Setup git-secrets. See hooks/README.md
2. Download the appengine java sdk and follow the instructions for setting your path.
3. Setup the path to the appengine sdk by doing one of the following:
   • set the environment variable: APPENGINE_SDK_HOME
   • create the file appengine.properties in the avram directory and set the variable sdkHome
4. run docker run -v $PWD:/app -e GOOGLE_PROJ=broad-avram-dev -eSERVICE_VERSION=br1 -e INPUT_PATH=/app -e OUT_PATH=/app/src/main/resources -e VAULT_TOKEN=$(cat ~/.vault-token) -e ENVIRONMENT=dev broadinstitute/dsde-toolbox render-templates.sh
5. run sbt, then in sbt run appengineDevServer
6. test an endpoint locally

On the dev environment

Avram is in its own google project: broad-avram-dev.

To deploy to dev run the deploy.sh script

To execute one of the endpoints on the dev environment use openapi