Progress Report Service

The purpose of this service is to provide organization admins with a periodic update on their progress towards acceptable cyber hygiene. The service calculates a number of statistics, including:

1. Change in overall HTTPS and DMARC compliance (percentage + number of domains)
2. Change in overall domain count
3. Average change in HTTPS and DMARC compliance across verified organizations
4. Change in HTTPS and DMARC compliance for individual verified organizations
5. Change in domain count for individual verified organizations

Install dependencies

Like all other JavaScript applications, dependencies are installed with npm.

npm i

One time setup

This application uses the dotenv-safe library to enforce that the environment variables it is counting on actually exist. This makes the application fail immediately with a descriptive error if anything important is missing.

To set up the environment, duplicate the .env.example file and fill in the values. Example values are shown.

cp .env.example .env
cat .env
DB_PASS=test
DB_URL=http://localhost:8529
DB_NAME=track_dmarc

Testing

Local development

The tests require a copy of ArangoDB to be running locally. ArangoDB should have its own .env file, and the value of the root password should align with the value of DB_PASS in the services .env file.

# Write the arango test credentials into an env file:
echo ARANGO_ROOT_PASSWORD=test > arangodb.env
# Run a detached arangodb container using the root password from the env:
docker run -d -p=8529:8529 --env-file arangodb.env --name=arango arangodb
# Run the tests:
npm test

With ArangoDB running you will need to create a test.env file, with values to be used during the test run.

[mike@ouroboros org-footprint]$ cat test.env
DB_PASS=test
DB_URL=http://localhost:8529
DB_NAME=track_dmarc

Cloudbuild

Cloudbuild is used for CI, and one of the reasons for that is that it has great tooling for running jobs locally which is very helpful for debugging. To see how this will behave in CI you can run something like the following to run the tests with cloud-build-local.

cloud-build-local --config cloudbuild.yaml --substitutions=BRANCH_NAME=foo,SHORT_SHA=asdf1234,_DB_PASS=test,_DB_URL=http://arangodb:8529,_DB_NAME=track_dmarc --dryrun=false .

Because of the way the cloudbuild config spins up and detaches a copy of ArangoDB, you will need to run the following commands to clean up after.

docker stop $(docker ps -q)
docker rm arangodb