SPRINT 3 RELEASE

.circleci/config.yml

@@ -1,52 +1,51 @@
 version: 2.1
 jobs:
   test-backend:
-    working_directory: ~/tdp-be
-    docker:
-      - image: circleci/python:3.8
-        user : root
+    machine: true
     branches:
     steps:
-      - setup_remote_docker: 
-         docker_layer_caching: true 
       - checkout
       - run:
           name: 'Ensure docker-compose exists,otherwise install it.'
           command: "./scripts/docker-compose-check.sh"
       - run:
           name: "Test: Build and Spin-up Django API Service"
-          command: "cd tdrs-backend; docker-compose build "
+          command: "cd tdrs-backend; docker-compose up -d --build"
       - run:
           name: "Tear Down Django API Service"
           command: "cd tdrs-backend; docker-compose down "
       - run:
-          name:  "Test: Execute Python Unit Tests"
-          command: "cd tdrs-backend; docker-compose run web sh -c \"pytest\""
+          name: "Test: Run Unit Tests And Create Code Coverage Report"
+          command: "cd tdrs-backend; docker-compose run web sh -c \"pytest && pytest --cov-report=xml\""
+      - run:
+          name: "Upload Backend Coverage Report to CodeCov If On Target Branch"
+          command: |
+            if [ "$CIRCLE_BRANCH" == "main" ] ; then
+              cd tdrs-backend; bash <(curl -s https://codecov.io/bash)  -f ./coverage.xml -F main-backend
+            elif [ "$CIRCLE_BRANCH" == "raft-tdp-main" ] ; then
+              cd tdrs-backend; bash <(curl -s https://codecov.io/bash)  -f ./coverage.xml -F dev-backend
+            fi
       - run:
           name:  "Test: Execute Python Linting Test"
           command: "cd tdrs-backend; docker-compose run --rm web bash -c \"flake8 .\""
       - run:
           name:  "Test: Execute Python OWASP ZAP Vulnerability Scan"
           command: "cd tdrs-backend; ./zap-scanner.sh"
-      - snyk/scan:
-          target-file: tdrs-backend/requirements.txt
-          severity-threshold: medium
-          additional-arguments: "--allow-missing --skip-unresolved --package-manager=pip --command=python3"
-  test-ui:
+  test-frontend:
     working_directory: ~/tdp-apps
     docker:
       - image: cypress/base:10
         user : root
     steps:
-      - setup_remote_docker: 
-         docker_layer_caching: true 
+      - setup_remote_docker:
+         docker_layer_caching: true
       - checkout
       - run:
           name: 'Ensure docker exists,otherwise install it.'
           command: "./scripts/docker-check.sh"
       - run:
           name: 'Ensure docker-compose exists,otherwise install it.'
-          command: "./scripts/docker-compose-check.sh"     
+          command: "./scripts/docker-compose-check.sh"
       - run:
           name: "Install Package Dependencies"
           command: "cd tdrs-frontend; yarn"
@@ -59,27 +58,28 @@ jobs:
       - run:
           name: "Run Jest Unit Tests"
           command: "cd tdrs-frontend; yarn test:ci"
+      - run:
+          name: "Upload Frontend Coverage Report to CodeCov If Target Branch"
+          command: |
+            if [ "$CIRCLE_BRANCH" == "main" ] ; then
+              cd tdrs-frontend; bash <(curl -s https://codecov.io/bash)  -f ./coverage/lcov.info -F main-frontend
+            elif [ "$CIRCLE_BRANCH" == "raft-tdp-main" ] ; then
+              cd tdrs-frontend; bash <(curl -s https://codecov.io/bash)  -f ./coverage/lcov.info -F dev-frontend
+            fi
       - run:
           name: "Run Cypress Integration Tests"
-          command: "cd tdrs-frontend; yarn cy:run:ci"  
+          command: "cd tdrs-frontend; yarn cy:run:ci"
       - run:
           name:  "Test: Execute Frontend  OWASP ZAP Vulnerability Scan"
           command: "cd tdrs-frontend; ./zap-scanner.sh"  
-      - run:
-          name: 'Ensure sudo is installed, otherwise install it.'
-          command: "./scripts/sudo-check.sh"
-      - snyk/scan:
-          target-file: tdrs-frontend/yarn.lock
-          severity-threshold: low
-          additional-arguments: "--trust-policies"
   deploy:
     working_directory: ~/tdp-deploy
     docker:
       - image: circleci/python:3.8
         user : root
     steps:
-      - setup_remote_docker: 
-         docker_layer_caching: true 
+      - setup_remote_docker:
+         docker_layer_caching: true
       - checkout
       - run:
           name: 'Ensure sudo is installed, otherwise install it.'
@@ -89,7 +89,7 @@ jobs:
           command: "./scripts/cf-check.sh"
       - run:
           name: "Log Into Docker"
-          command: "echo $DOCKER_PASSWORD | docker login --username $DOCKER_USERNAME --password-stdin"    
+          command: "echo $DOCKER_PASSWORD | docker login --username $DOCKER_USERNAME --password-stdin"
       - run:
           name:  "Build Backend Docker image"
           command: "cd tdrs-backend; docker build -t goraftdocker/tdp-backend:$CIRCLE_BRANCH . -f ./docker/Dockerfile.dev"
@@ -98,7 +98,7 @@ jobs:
           command: "docker push goraftdocker/tdp-backend:$CIRCLE_BRANCH"
       - run:
           name:  "Build Frontend Docker image"
-          command: "cd tdrs-frontend; docker build -t goraftdocker/tdp-frontend:$CIRCLE_BRANCH . -f ./docker/Dockerfile.dev"
+          command: "cd tdrs-frontend; docker build -t goraftdocker/tdp-frontend:$CIRCLE_BRANCH . -f Dockerfile.dev"
       - run:
           name:  "Push Frontend Image to Docker Hub"
           command: "docker push goraftdocker/tdp-frontend:$CIRCLE_BRANCH"
@@ -120,8 +120,8 @@ jobs:
               export CF_SPACE="tanf-staging"
               export CF_USERNAME="$CF_USERNAME_STAGING"
               export CF_PASSWORD="$CF_PASSWORD_STAGING"
-              export CGHOSTNAME_BACKEND="$CGHOSTNAME_BACKEND_STAGIN"
-              export CGHOSTNAME_FRONTEND="$CGHOSTNAME_FRONTEND_STAGIN"
+              export CGHOSTNAME_BACKEND="$CGHOSTNAME_BACKEND_STAGING"
+              export CGHOSTNAME_FRONTEND="$CGHOSTNAME_FRONTEND_STAGING"
             elif [ "$CIRCLE_BRANCH" == "dev" ] ; then
               export CF_SPACE="tanf-dev"
               export CF_USERNAME="$CF_USERNAME_DEV"
@@ -146,18 +146,16 @@ jobs:
             cf auth "$CF_USERNAME" "$CF_PASSWORD"
             cf target -o $CF_ORG -s "$CF_SPACE"
             ./deploy-cloudgov-docker.sh rolling test $CGHOSTNAME_BACKEND $CGHOSTNAME_FRONTEND $DOCKER_IMAGE_BACKEND $DOCKER_IMAGE_FRONTEND $CIRCLE_BRANCH
-orbs:
-  snyk: snyk/[email protected]
 workflows:
   build-and-test:
     jobs:
       - test-backend
-      - test-ui
+      - test-frontend
       - deploy:
           requires:
             - test-backend
-            - test-ui
+            - test-frontend
           filters:
             branches:
               only:
-                - raft-tdp-main
+                - raft-tdp-main

.github/ISSUE_TEMPLATE/dev-issue-template.md

@@ -2,44 +2,47 @@
 name: Development issue template
 about: Template for development issues
 title: ''
-labels: ''
+labels: dev
 assignees: ''
 
 ---
 
-Description:
-(please define the reason as to why this issue is being created )
+**Description:**
+_Provide a brief background and justification for this issue_
 
 
+**Acceptance Criteria:** 
+_Create a list of functional outcomes that must be achieved to complete this issue_
 
-AC: 
+- [ ] _Outcome 1_
+- [ ] _Outcome 2_
+- [ ] _Outcome 3_
+- [ ] Testing Checklist has been run and all tests pass
 
-- [ ] Sample acceptance criteria
+**Tasks:**
+_Create a list of granular, specific work items that must be completed to deliver the desired outcomes of this issue_ 
 
+- [ ] _Task 1_
+- [ ] _Task 2_
+- [ ] _Task 3_
+- [ ] Run Testing Checklist and confirm all tests pass
 
+**Notes:**
+_Add additional useful information, such as related issues and functionality that isn't covered by this specific issue, and other considerations that will be helpful for anyone reading this_ 
 
-Tasks: 
+- _Note 1_
+- _Note 2_
+- _Note 3_
 
-- [ ] Sample tasks
 
+**Supporting Documentation:**
+_Please include any relevant log snippets/files/screen shots_
 
+- _Doc 1_
+- _Doc 2_
 
-DoD: 
- - [ ] minimum 90% code coverage test
- - [ ] 0 linting errors and warnings
- - [ ] 0 accessibility errors
- - [ ] deployed to a dev environment
- - [ ] all significant changes have been documented
- - [ ] free of high and medium security vulnerabilities
- - [ ] @lauraGgit has reviewed and signed off
-
-
+**Open Questions:**
+_Please include any questions or decisions that must be made before beginning work or to confidently call this issue complete_ 
 
-Supporting Documentation:
-
-(please include any relevant log snippets/ files/ screen shots here.)
-
-
-Open Questions:
-
-(any clarifying questions in support of the issue)
+- _Open Question 1_
+- _Open Question 2_

.gitignore

@@ -1,31 +1,24 @@
-# API
-venv
-*.sqlite3
-*.sqlite3-journal
-**/__pycache__
-tmp
-*.pem
-*.rsa
-*.txt
-compliance/opencontrols/
-compliance/exports/
-
 # UI
 tdrs-frontend/node_modules/
 tdrs-frontend/build/
 tdrs-frontend/coverage/
 tdrs-frontend/cypress/videos/
 tdrs-frontend/cypress/support/
 tdrs-frontend/cypress/screenshots/
+tdrs-frontend/cypress/fixtures/example.json
 tdrs-frontend/npm-debug.log*
 tdrs-frontend/yarn-debug.log*
 tdrs-frontend/yarn-error.log*
 tdrs-frontend/vars-frontend.yml
+tdrs-frontend/pa11y-screenshots/*
+tdrs-frontend/.env*
+
 
 #BACKEND
 tdrs-backend/*/env_vars/*.env*
 tdrs-backend/*/env_vars/*.env*.*
 tdrs-backend/vars-backend.yml
+tdrs-backend/coverage.xml
 *.pyc
 /backend/db.sqlite3
 .DS_Store
@@ -34,6 +27,16 @@ tdrs-backend/vars-backend.yml
 /mediafiles/*
 __pycache__/
 /.vscode/
+venv
+*.sqlite3
+*.sqlite3-journal
+**/__pycache__
+tmp
+*.pem
+*.rsa
+*.txt
+compliance/opencontrols/
+compliance/exports/
 
 # coverage result
 .coverage
@@ -70,10 +73,10 @@ boilerplate.zip
 # Spritesmith
 spritesmith-generated/
 spritesmith.scss
- 
+
 
 # Testing files
 htmlcov/*
 
 # Commmon
-.DS_Store
+.DS_Store

README.md

@@ -1,3 +1,16 @@
+
+
+
+|| Raft-Tech(raft-tdp-main) |  HHS(main) |
+|---|---|---|
+|**Build**| [![CircleCI-Dev](https://circleci.com/gh/raft-tech/TANF-app/tree/raft-tdp-main.svg?style=shield)](https://circleci.com/gh/raft-tech/TANF-app/tree/raft-tdp-main) | [![CircleCI-HHS](https://circleci.com/gh/HHS/TANF-app/tree/main.svg?style=shield)](https://circleci.com/gh/HHS/TANF-app/tree/main)|
+|**Security Frontend**| [![Security-Frontend-Dev](https://snyk.io/test/github/raft-tech/TANF-app/badge.svg)](https://snyk.io/test/github/raft-tech/TANF-app)  | [![Security-Frontend-HHS](https://snyk.io/test/github/HHS/TANF-app/badge.svg)](https://snyk.io/test/github/HHS/TANF-app)|
+|**Security Backend**| [![Security-Backend-Dev](https://snyk.io/test/github/raft-tech/TANF-app/badge.svg?targetFile=tdrs-backend/requirements.txt)](https://snyk.io/test/github/raft-tech/TANF-app) | [![Security-Backend-HHS](https://snyk.io/test/github/HHS/TANF-app/badge.svg?targetFile=tdrs-backend/requirements.txt)](https://snyk.io/test/github/HHS/TANF-app)
+|**Frontend Coverage**| [![Codecov-Frontend-Dev](https://codecov.io/gh/raft-tech/TANF-app/branch/raft-tdp-main/graph/badge.svg?flag=dev-frontend)](https://codecov.io/gh/raft-tech/TANF-app?flag=dev-frontend) | [![Codeco-Frontend-HHS](https://codecov.io/gh/HHS/TANF-app/branch/main/graph/badge.svg?flag=main-frontend)](https://codecov.io/gh/HHS/TANF-app?flag=main-frontend)   |
+|**Backend Coverage**|  [![Codecov-Backend-Dev](https://codecov.io/gh/raft-tech/TANF-app/branch/raft-tdp-main/graph/badge.svg?flag=dev-backend)](https://codecov.io/gh/raft-tech/TANF-app/branch/raft-tdp-main?flag=dev-backend)|   [![Codecov-Backend-HHS]( https://codecov.io/gh/HHS/TANF-app/branch/main/graph/badge.svg?flag=main-backend)](https://codecov.io/gh/HHS/TANF-app/branch/main?flag=main-backend) |
+
+***Due to limitations imposed by Github and occasional slow server response times, some badges may require a page refresh to load.**
+
 # TANF Data Reporting Prototype
 
 This repo has a prototype for a TANF Data Reporting system, where States,