init documentation and other tweaks

docker-compose.test.yml

@@ -2,7 +2,7 @@ version: '3'
 
 services:
   cms:
-    container_name: stem-c-cms-dev
+    container_name: stem-c-cms-test
     image: strapi/strapi
     environment: 
       - DATABASE_HOST=db
@@ -13,13 +13,13 @@ services:
     depends_on:
       - db
   compile:
-    container_name: stem-c-compile-dev
+    container_name: stem-c-compile-test
     build: ./compile
     restart: always
     ports:
       - 8080:8080
   db:
-    container_name: stem-c-db-dev
+    container_name: stem-c-db-test
     image: postgres
     restart: always
     ports:

test/README.md

@@ -1,3 +1,38 @@
 # Tests
 
-> Full stack test suite
+> Full stack test suite
+
+<br/>
+
+## Setup
+
+1. Install dependencies `yarn`
+
+2. Run the service `yarn start` 
+
+   > Make sure to delete the db container to make sure it rebuilds for testing
+
+<br/>
+
+## Testing
+
+### Functional 
+
+- Framework – Jest
+- Usage – Test UI w/ snapshots and mocking
+- Run  `coming soon`
+
+### Integration
+
+- Framework – Jest
+- Usage – Test all the API endpoints for roles, data access, and function
+- Run `yarn integration`
+
+### Performance
+
+- Framework – K6
+- Usage – Stress and Load test the application
+- Run `coming soon`
+
+
+

test/package.json

@@ -7,7 +7,7 @@
   },
   "scripts": {
     "start": "docker-compose -f ../docker-compose.test.yml up",
-    "test": "jest */*.test.js"
+    "integration": "jest */*.test.js"
   },
   "type": "module"
 }