Creates Test Plan for Running Integration Tests on Server API Endpoints

.github/workflows/tdm-server-tests.yml

@@ -0,0 +1,52 @@
+name: tdm-server-test
+run-name: ${{ github.actor }} is running tests for the server
+on:
+  pull_request:
+    branches:
+      - develop
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: '14'
+
+    - name: Change directory
+      run: cd server
+
+    - name: Install dependencies
+      run: npm install
+      working-directory: server
+
+    - name: Set up environment variables
+      run: |
+        echo "TEST_ENV=true" >> .env
+        echo "PORT=5002" >> .env
+        echo "NODE_OPTIONS=--trace-deprecation" >> .env
+        echo "JWT_SECRET_KEY=testingSecretKey" >> .env
+        echo "CLIENT_URL=http://localhost:3001" >> .env
+        echo "SERVER_URL=http://localhost:5002" >> .env
+        echo "SENDGRID_API_KEY=SG.testAPIkey" >> .env
+        echo "[email protected]" >> .env
+        echo "EMAIL_PUBLIC_COMMENT_LA_CITY=tdm+devpubliccommentplanning@test.org" >> .env
+        echo "[email protected]" >> .env
+        echo "APPLICATIONINSIGHTS_CONNECTION_STRING=InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://westus-0.in.applicationinsights.azure.com/;LiveEndpoint=https://westus.livediagnostics.monitor.azure.com/" >> .env
+        echo "[email protected]" >> .env
+        echo "SECURITY_ADMIN_PASSWORD=Dogfood1!" >> .env
+        echo "SQL_SERVER_NAME=localhost" >> .env
+        echo "SQL_SERVER_PORT=1434" >> .env
+        echo "SQL_DATABASE_NAME=tdmtestdb" >> .env
+        echo "SQL_USER_NAME=sa" >> .env
+        echo "SQL_PASSWORD=TestPassw0rd" >> .env
+        echo "SQL_ENCRYPT=false" >> .env
+      working-directory: server
+
+    - name: Run tests
+      run: npm test
+      working-directory: server

server/.eslintrc.json

@@ -1,7 +1,8 @@
 {
   "env": {
     "es6": true,
-    "node": true
+    "node": true,
+    "jest": true
   },
   "extends": ["eslint:recommended", "prettier", "plugin:prettier/recommended"],
   "plugins": ["prettier"],

server/.example.env

@@ -0,0 +1,97 @@
+# Instructions: Create a .env file in the server directory. Copy and paste values from Google Docs.
+
+# Node server settings
+PORT=
+NODE_OPTIONS=
+
+JWT_SECRET_KEY=
+
+# To support email interaction
+SENDGRID_API_KEY=
+EMAIL_PUBLIC_COMMENT_LA_CITY=
+EMAIL_PUBLIC_COMMENT_WEB_TEAM=
+
+# These env settings are specific to running the web api server and app on localhost.
+CLIENT_URL=
+SERVER_URL=
+
+# User Test Accounts for Shared AWS Development Environment
+#(Used by ThunderClient for API Endpoint testing)
+USERTEST_EMAIL=
+USERTEST_PASSWORD=
+ROLESTEST_EMAIL=
+ROLESTEST_PASSWORD=
+ADMINTEST_EMAIL=
+ADMINTEST_PASSWORD=
+
+# Shared Development Database - Azure
+SQL_SERVER_NAME=
+SQL_SERVER_PORT=
+SQL_DATABASE_NAME=
+SQL_USER_NAME=
+SQL_PASSWORD=
+SQL_ENCRYPT=
+SQL_TRUST_SERVER_CERTIFICATE=
+EMAIL_SENDER=
+APPLICATIONINSIGHTS_CONNECTION_STRING=
+
+#########################################
+## Local Development Database Settings ##
+#########################################
+
+## Local Development Database - Windows Native
+# SQL_SERVER_NAME=
+# SQL_SERVER_INSTANCE=
+# SQL_SERVER_PORT=
+# SQL_DATABASE_NAME=
+# SQL_USER_NAME=
+# SQL_PASSWORD=
+# SQL_ENCRYPT=
+# SQL_TRUST_SERVER_CERTIFICATE=
+# EMAIL_SENDER=
+# APPLICATIONINSIGHTS_CONNECTION_STRING=
+
+## Local Development Database - Docker Container
+## Example for SQL Server Express on Docker
+# SQL_SERVER_NAME=
+# SQL_SERVER_INSTANCE=
+# SQL_SERVER_PORT=
+# SQL_DATABASE_NAME=
+# SQL_USER_NAME=
+# SQL_PASSWORD=
+# SQL_ENCRYPT=
+# SQL_TRUST_SERVER_CERTIFICATE=
+# EMAIL_SENDER=
+# APPLICATIONINSIGHTS_CONNECTION_STRING=
+
+###############################################################
+##      Testing (Comment out ALL the above variables)        ##
+###############################################################
+# TEST_ENV=
+
+# PORT=
+# NODE_OPTIONS=
+
+# JWT_SECRET_KEY=
+
+# CLIENT_URL=
+# SERVER_URL=
+
+# SENDGRID_API_KEY=
+# EMAIL_SENDER=
+# EMAIL_PUBLIC_COMMENT_LA_CITY=
+# EMAIL_PUBLIC_COMMENT_WEB_TEAM=
+
+# APPLICATIONINSIGHTS_CONNECTION_STRING=
+
+## Server Test Accounts
+# SECURITY_ADMIN_EMAIL=
+# SECURITY_ADMIN_PASSWORD=
+
+## testingcontainer Environment Variables
+# SQL_SERVER_NAME=
+# SQL_SERVER_PORT=
+# SQL_DATABASE_NAME=
+# SQL_USER_NAME=
+# SQL_PASSWORD=
+# SQL_ENCRYPT =