Skip to content

Latest commit

 

History

History
157 lines (96 loc) · 5.29 KB

README.md

File metadata and controls

157 lines (96 loc) · 5.29 KB
Raw

raft-tdp-main

Backend API Service for TDP. Deployed to Cloud.gov at https://tdp-backend.app.cloud.gov/ .

Prerequisites

Contents

Testing the Local Backend Service:

Login is dependent on the tdrs-frontend service. You will need a local instance of that application running.

This project uses a Pipfile for dependency management. However, due to the limitations of the Snyk Github Integration Supported Files we must continue to support a requirements.txt for the time being.

Local Development Options

Commands are to be executed from within the tdrs-backend directory

1.) For configuration of the JWT_KEY and JWT_CERT_TEST environment variables for local development/testing documentation is forthcoming. For configuration of a superuser for admin tasks please refer to the user_role_management.md guide.

2.) Configure your local environment variables via the .env.local file found in this path:

tdpservice/settings/env_vars/.env.local

3.)Build and start the backend via docker-compose:

$ docker-compose up -d --build

This command will start the following containers: tdrs-backend_web_1 (webserver) on port 8080, tdrs-backend_postgres_1 (postgresql DB) on port 5432, and tdrs-backend_zaproxy_1 (OWASP ZAP).

4.) The backend service will now be available via the following URL:

http://localhost:8080

5.) To get an OpenAPI compliant schema of all the API endpoints, do a GET on http://localhost:8080/api-scehma.json or go to http://localhost:8080/apidocs/ in the browser to view all API endpoints.

6.) To exec into the PostgreSQL database in the container.

$ docker exec -it tdrs-backend_postgres_1 psql -U tdpuser -d tdrs_test

7.) Backend project tear down:

 $ docker-compose down --remove-orphans

Code Unit Test, Linting Test, and Vulnerability Scan

  1. Run local unit tests by executing the following command.
$ docker-compose run web sh -c "pytest"
  1. Run local linting tests by executing the following command:
$ docker-compose run --rm web bash -c "flake8 ."

The flake8 linter is configured to check the formatting of the source against this setup.cfg file.

  1. Run local penetration tests by executing the following shell script:
$ ./zap-scanner.sh

This will spin up a local instance of the backend service and execute a penetration test via open source tool OWASP Zed Attack Proxy .

Manual Cloud.gov Deployments:

Although CircleCi is set up to auto deploy frontend and backend to Cloud.gov, if there is a need to do a manual deployment, the instructions below can be followed:

1.) Build and push a tagged docker image while on the the target Github branch:

$ docker build -t lfrohlich/tdp-backend:local . -f docker/Dockerfile.dev

$ docker push lfrohlich/tdp-backend:local

2.) Log into your cloud.gov account and set your space and organization:

$ cf login -a api.fr.cloud.gov --sso
$ cf target -o <ORG> -s <SPACE>

You may be prompted to select from a list of spaces under the selected organization. Please follow the prompt to select your intended deployment space

Example Prompt:

Targeted org hhs-acf-prototyping.

Select a space:
1. <SPACE-1>
2. <SPACE-2>

Space (enter to skip): 1
Targeted space <SPACE-1>.

3.) Push the image to Cloud.gov (you will need to be in the same directory astdrs-backend/manifest.yml):

( The --var parameter ingests a value into the ((docker-frontend)) environment variable in the manifest.yml)

 $ cf push tdp-backend -f manifest.yml --var docker-backend=lfrohlich/tdp-backend:local

Steps 4 and 5 are reserved for deployments to new environments

4.) You will then have to set all required environment variables via the cloud.gov GUI or the Cloud Foundry CLI via commands like the following:

$ cf set-env tdp-backend JWT_KEY "$(cat key.pem)"
  • **For the list of required environment variables please defer to the .env.local file

5.) After this step you will need to bind the application to a Postgres RDS service if it has not been bound already:

$ cf bind-service tdp-backend tdp-db
  • If a Postgres Service does not exist, create it using cf create-service aws-rds shared-psql tdp-db

6.) To apply this newly bound service or apply any changes made to environment variables you will need to restage the application:

$ cf restage tdp-backend