ch(git-action): set up git actions and tests

.github/workflows/main.yml

@@ -0,0 +1,28 @@
+name: Run Tests
+
+on:
+  push:
+    branches:
+        - '*'
+  pull_request:
+    branches:
+      - develop
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18'
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Run tests with coverage
+        run: npm run coverage

.gitignore

@@ -1,4 +1,6 @@
 node_modules
 .env
 yarn.lock
+.nyc_output
+coverage
 package-lock.json

package.json

@@ -4,7 +4,8 @@
   "description": "backend for phase II of pulse",
   "main": "src/index.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "mocha --parallel -r ts-node/register src/test/**/*.test.ts --recursive --exit --timeout 80000",
+    "coverage": "nyc npm run test",
     "start": "tsc && node dist/index",
     "dev": "nodemon src/index.ts",
     "seed": "ts-node-dev --transpile-only --no-notify --exit-child src/seeders/index.ts"
@@ -28,8 +29,16 @@
   },
   "homepage": "https://github.com/atlp-rwanda/atlp-devpulse-bn#readme",
   "devDependencies": {
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
+    "@types/chai": "^4.3.5",
+    "@types/mocha": "^10.0.1",
+    "@types/sinon": "^10.0.16",
     "apollo-server-core": "^3.11.1",
-    "nodemon": "^2.0.19",
+    "chai": "^4.3.7",
+    "mocha": "^10.2.0",
+    "nodemon": "^3.0.1",
+    "nyc": "^15.1.0",
+    "sinon": "^15.2.0",
     "ts-node": "^10.9.1",
     "typescript": "^4.8.3"
   },
@@ -45,5 +54,23 @@
     "jwt-decode": "^3.1.2",
     "mongoose": "^6.6.1",
     "ts-node-dev": "^2.0.0"
+  },
+  "nyc": {
+    "extends": "@istanbuljs/nyc-config-typescript",
+    "check-coverage": true,
+    "all": true,
+    "include": [
+      "src/**/!(*.test.*).[tj]s?(x)"
+    ],
+    "exclude": [
+      "src/_tests_/**/*.*"
+    ],
+    "reporter": [
+      "html",
+      "lcov",
+      "text",
+      "text-summary"
+    ],
+    "report-dir": "coverage"
   }
 }

src/test/index.test.ts

@@ -0,0 +1,8 @@
+import { assert, expect } from "chai";
+
+describe("This is a demo test", () => {
+      it("should return 5 when 2 is added to 3", () => {
+      const result = 2 +  3;
+      expect(result).eql(5);
+   });
+});