Skip to content

DEVNOTES.md

Latest commit

 

History

History
136 lines (94 loc) · 4.54 KB

DEVNOTES.md

File metadata and controls

136 lines (94 loc) · 4.54 KB

Development

Dev Container

If you are using Visual Studio Code (VSCode) and Docker, consider using the Dev Container configuration. This will automatically setup and configure DUOS on your behalf. When opening the project in VSCode, a notification will appear in the bottom right corner to use the Dev Container. Click "Reopen in container".

Next, the terminal will install the dependencies. Once installed, the terminal will prompt to authenticate with Google Cloud. Do this by following the link and signing in with your broadinstitute.org account. Copy and paste the auth code in the terminal and press enter to complete setup.

Local Setup

Alternatively, you may install DUOS locally.

  1. Install Node LTS, but verify the version of Node declared in the Dockerfile and install that when setting up. You can install it with Volta or NVM.
volta install [email protected]
  1. Next, install the project dependencies.
npm install
  1. Ensure you are connected to the Broad VPN. Copy the configuration files and certificates locally by running the render-configs.sh script. By default, the DUOS UI points to the dev environment.
./scripts/render-configs.sh --write_env true --write_config true

Notes on render-configs:

  • Ensure that HOST is not set in your shell environment, as it will override the value in .env.local. You can check like so: env | grep HOST=.
  • Development against other envs: If you want to point to other envs, you can populate public/config.json with the values from any environment by looking at the deployed configs in https://duos-k8s.dsde-{%ENV%}.broadinstitute.org/config.json where {%ENV%} is any of dev, staging, alpha, or prod. Remember to set the env value appropriately, for example, dev. Certain features are available only in specific environments. Setting the env value to the desired environment will simulate it for local development.
  • Refresh certs on rotation: render-config.sh populates local certificate files. The certificates are rotated every 3 months and can be repopulated by re-running the script. Again, you'll need to be on the broad VPN.
./scripts/render-configs.sh
  1. Ensure that your /etc/hosts file has an entry for local.dsde-dev.broadinstitute.org
127.0.0.1	local.dsde-dev.broadinstitute.org

  1. Create a site.conf file in the project root directory using https://github.com/broadinstitute/terra-helmfile/blob/master/charts/duos/templates/_site.conf.tpl as a model.

  2. Start the development server:

npm start

Running using Docker Compose

Update your local docker-compose.yaml file to mount the preferred config.json file in app volumes. Remember to set the env value appropriately, for example, dev. Certain features are available only in specific environments. Setting the env value to the desired environment will simulate it for local development.

    volumes:
      - ./public/config.json:/usr/share/nginx/html/config.json

Build and run:

docker build . -t duos
docker compose up -d

Visit https://local.dsde-dev.broadinstitute.org/ to see the instance running under docker.

Testing

Cypress Tests

We use Cypress for all component and integration testing. Each suite of tests is run separately for all PRs via github actions. Local testing can be run headless or viewed interactively.

Cypress integration (e2e) tests run locally require a different baseUrl than those run in GitHub Actions. Create a cypress.env.json file in the root of your local repo that looks like this:

{
  "baseUrl": "https://local.dsde-dev.broadinstitute.org:3000/"
}

Cypress will use these values in cypress.config.js and cypress/support/commands.js files instead of the default values.

Headless

To run cypress integration tests, first start up the app in one terminal and in another terminal window, spin up the tests headless:

npm start
npm run cypress:run

To run cypress component tests headless:

npm run cypress:run:component

Interactive

To run cypress integration tests, first start up the app in one terminal and in another terminal window, spin up the tests for viewing:

npm start
npm run cypress:open

To run cypress component tests in a browser:

npm run cypress:open:component

To run a single test suite:

npm run cypress:open:component --spec "**/data_access_governance.spec.js"