FEMA SF-425 Prototype

Requirements

• Git - https://git-scm.com/downloads
• Docker - https://www.docker.com/community-edition
  • Docker Compose
  • Docker Machine (for deployment of DevOps pipeline and hosting environment)
• Git LFS (for Visual Regression Testing) - https://git-lfs.github.com/

Sandbox Instructions

Run the following:

git clone https://github.com/CivicActions/fema-grants.git
cd fema-grants
docker-compose up -d

The sandbox takes a minute or two to spin up (depending on your machine). You can follow progress by running docker-compose logs.

Once started the site should now be accessible on http://localhost:8118 - default credentials are admin/civicactions.

To stop the sandbox run:

docker-compose stop

To use CLI tools (composer, drush, drupal) run:

. bin/activate

If the database is not a functional Drupal site (e.g. on initial install or if a configuration import fails) then Drupal will be installed automatically and the configuration (in config/sync) loaded automatically.

To recreate your sandbox from scratch, run:

docker-compose stop
docker-compose rm -f
docker-compose up -d

Starting work

If you start work on a new change you will need to pull code from git and also sync your local database with the current configuration files. To do this:

git checkout master
git pull
drush -y config:import

You can verify that config is in sync by running drush config:status. If you have problems you can recreate your sandbox (see above) which will also import the latest config into a clean install.

Always create a new branch to work on each user story or change.

After you've done your coding work

• Make sure you export any configuration changes you've made to ensure that what you've done on your machine can be replicated on other machines. Do this by running drush -y config:export and commit those results before you submit your pull-request.
• If you have made changes to sample content or entity structures you should also update the sample content by running drush dcem fema_federal_financial_report and committing those results. It is expected that some timestamps will be updated when doing this.
• If you have added sample content look up the entity uuids for your new content: drush sqlq 'SELECT nid, uuid FROM node;' , then
• Add the UUIDs associated with the new NIDs to web/modules/custom/fema_federal_financial_report/fema_federal_financial_report.info.yml
• Run drush dcem fema_federal_financial_report and commit those results.
• Not sure if all your changes work? Test your work by recreating your sandbox with your current code (see above).

Testing

All testing tools run inside Docker, just make sure your terminial is activated (see above) and you should be good to go.

All of the test tools below are run for every pull request, and all tests must pass befor the code can be merged.

To run PHPunit unit tests:

phpunit

To run functional Behat behavior driven (BDD) tests:

behat

Visual Regression Testing

Visual regression testing checks pages and design components against a baseline of known good images, matrix tested to cover multiple browsers and device resolutions. Gemini is used to navigate pages and identify page components and (Selenium)[https://www.seleniumhq.org/] (Hub and WebDriver) to orchestrate tests across Chrome and Firefox browsers.

To start visual regression testing, install LFS from https://git-lfs.github.com/ and make sure you have LFS enabled for this repo:

git lfs install --local

To quickly run tests - note . on the end which will run all tests in the tests/visual directory:

gemini test .

To to use the Gemeni GUI to visually review test results, rerun failing tests to resolve issues and (if needed) approve changes to the baseline images:

gemini-gui

Accessibility Testing

A suite of WCAG 2.0 and Section 508 accessibility tests can by run using Pa11y:

pa11y

Security Testing

OWASP Zed Attack Proxy (ZAP) can run scans against the site. By default it will run a 1 minute baseline passive scan, but you can pass in arguments to run other scans as needed.

zap

Docker image development

Edit the Dockerfile, then rebuild using:

docker build -t fema-grants .

To test the image locally, create a docker-compose.override.yml file using:

echo -e 'version: "3"\nservices:\n  web:\n    image: fema-grants' > docker-compose.override.yml
docker-compose stop
docker-compose rm -f
docker-compose up -d

To revert to the shared image delete the override file:

rm docker-compose.override.yml

Deployment

A single command will deploy the entire namespaced open source DevSecOps infrastructure and a second command will deploy (or redeploy) the application into that infrastructure. Networking, DNS, SSL, centralized log aggregation, monitoring, CI/CD and secrets are all managed.

To get started you will need to provide API keys for Amazon Web Services, CloudFlare and Slack, as well as some default secrets and passwords for DevSecOps services. First copy the template cp .env.template .env, then edit .env and add the values following the links for additional instructions as needed. You will need Docker as well as Docker Machine and Docker Compose installed on your local system.

Then to deploy the DevSecOps infrastructure run:

. .env
./bin/deploy [subdomain] [domain]

In the above, [domain] is the name of a base domain managed on your CloudFlare account and [subdomain] is a subdomain and namespace (for EC2 servers) that will be used for this particular infrastructure deployment.

Once this has completed you should be able to access the following:

• traefik.[subdomain].[domain] - Traefik proxy indicating configuration and traffic metrics.
• drone.[subdomain].[domain] - Drone CI/CD automation server - you will need to log in with your Github credentials and enable the repository you want to build.
• graylog.[subdomain].[domain] - Graylog log aggregation and analysis server. You will need to log in with the username "admin" and the default password configured in your .env file and configure a GELF UDP input on 0.0.0.0 port 12201.
• cadvisor.[subdomain].[domain] - System monitoring and metrics.

To deploy the application to the server, run:

eval $(docker-machine env [subdomain].[domain])
docker-compose -f deploy/docker-compose.app.yaml up -d

To push an updated build, run:

eval $(docker-machine env [subdomain].[domain])
docker-compose -f deploy/docker-compose.app.yaml stop
docker-compose -f deploy/docker-compose.app.yaml rm -f
docker-compose -f deploy/docker-compose.app.yaml pull
docker-compose -f deploy/docker-compose.app.yaml up -d