Skip to content

Latest commit

 

History

History
51 lines (42 loc) · 3.06 KB

GETTING-STARTED.md

File metadata and controls

51 lines (42 loc) · 3.06 KB
Raw

Running the application

Npm tasks are run via

npm run <TASK> -- RCTMAKE_ADDITIONAL_ARGUMENTS

Most tasks are rctmake wrappers.

Starting with docker

  1. dev - main task for running application in dev mode. The task prunes, builds and runs containers, one for the database and one for the application. Changes in the local repo force the application restart (see nodemon and the start:dev script, see also rctmake option --target-modifier). You can run multiple instances of application in dev mode simultaneously, see rctmake option --subtarget and --rct-http-port.
  2. idev - run node console with imported application instance (not running), should be run inside container see app:battach

Starting locally

  1. start:dev:local - run the RCT application locally, by default it fetches env vars from <ProjectDir>/docker/dev.env with exception that RCT_DB_HOST env var is substituted to localhost. If you want to make other substitutions, specify them as follows (bash) before the aplication start: (export FOO=bar; npm run start:dev:local)
  2. deploy:db:local - deploy the database locally with the use of <ProjectDir>/database/setup-db.sh script. It uses the same env as the upper task and follows the same env vars substitution logic.

Using grid certificates

Grid certificates need to be located in <ProjectDir>/security/. The certificate used by the application has to be named (TMP TODO filename convention) rct-alimonitor-cert.p12. It is also required to set ALIMONITOR_PASSPHRASE env var which holds the passphrase to that certificate.

Reaching CERN network

  1. By default, the application running on docker (var RUNNING_ENV is set to DOCKER) doesn't use proxy. Crucial functionalities (e.g. data synchronization) require access to the CERN network. If the host is not directly connected, a proxy configuration is needed. You can point proxy via env var CERN_SOCKS with value 'true' what will be evaluated to socks://172.200.200.1:12345, for which you should open ssh socket locally via command:
ssh -D 172.200.200.1:12345 <user>@<host>

or using script which opens defualt proxy (the same as above one)

./scripts/dev-sshopen.sh <USER>
  1. If you want to use proxy other than default (because e.g. the application is NOT running on docker) you need to specify the socket you are going to use on your own. First open the socket via ssh:
ssh -D localhost:12345 <user>@<host>

The address of the socket you've opened should be saved in CERN_SOCKS env var, e.g.:

export CERN_SOCKS='socks://localhost:12345'
  1. If you want to use proxy, set CERN_SOCKS to true:
export CERN_SOCKS='true'

Database dumps

Dumps are stored in <ProjectDir>/database/cache/dumps see rctmake help

Testing

  1. test - main testing task, run static analysis and codecov on docker containers, results are available in <ProjectDir>/reports/
  2. eslint - static analysis, results in <ProjectDir>/reports/static/static-analyzis.html
  3. reports:show - open reports, static analysis and codecov in browser