Merge pull request #11 from gobeam/fix/update_docs

docs: add workflow test badge in README.md and add e2e test command o…

Author: gobeam

.github/actions/setvars/action.yml

@@ -0,0 +1,13 @@
+name: 'Set environment variables'
+description: 'Configures environment variables for a workflow'
+inputs:
+  varFilePath:
+    description: 'File path to variable file or directory. Defaults to ./.github/variables/* if none specified and runs against each file in that directory.'
+    required: false
+    default: ./.github/variables/*
+runs:
+  using: "composite"
+  steps:
+    - run: |
+        sed "" ${{ inputs.varFilePath }} >> $GITHUB_ENV
+      shell: bash

.github/variables/myvars.env

@@ -0,0 +1,7 @@
+NODE_ENV=test
+DB_TYPE=postgres
+DB_HOST=localhost
+DB_PORT=5432
+DB_DATABASE_NAME=truthy_db
+DB_USERNAME=truthy_user
+DB_PASSWORD=truthypwd

.github/workflows/test.yml

@@ -2,7 +2,7 @@ name: test
 
 on: push
 
-jobs:
+jobs:   
   test:
     runs-on: ubuntu-latest
 
@@ -15,13 +15,16 @@ jobs:
           POSTGRES_PASSWORD: truthypwd
         ports:
           - 5432:5432
+
       redis:
         image: redis
         options: >-
           --health-cmd "redis-cli ping"
           --health-interval 10s
           --health-timeout 5s
           --health-retries 5
+        ports:
+          - 6379:6379
 
     steps:
       - uses: actions/checkout@v2
@@ -31,15 +34,10 @@ jobs:
         with:
           node-version: 14.3.0
 
-      - name: Set environment variables
-        uses: allenevans/set-env@v2.0.0
+      - name: Set Environment Variables
+        uses: ./.github/actions/setvars
         with:
-          NODE_ENV: test
-          DATABASE_HOST: 127.0.0.1
-          DATABASE_PORT: ${{ job.services.postgres.ports[5432] }}
-          DATABASE_NAME: truthy_db
-          DATABASE_USER: truthy_user
-          DATABASE_PASSWORD: truthypwd
+          varFilePath: ./.github/variables/myvars.env
 
       - name: Install dependencies
         run: npm install
@@ -48,4 +46,7 @@ jobs:
         run: npm run lint
 
       - name: Run unit test
-        run: npm run test:unit
+        run: npm run test:unit
+
+      - name: Run e2e test
+        run: npm run test:e2e

README.md

@@ -9,6 +9,7 @@
 <br>
 <p align="center">
 <img alt="GitHub package.json version" src="https://img.shields.io/github/package-json/v/gobeam/truthy">
+<img alt="Workflow test" src="https://github.com/gobeam/truthy/actions/workflows/test.yml/badge.svg">
 <img alt="GitHub" src="https://img.shields.io/github/license/gobeam/truthy">
 <img alt="Lines of code" src="https://img.shields.io/tokei/lines/github/gobeam/truthy">
 <img src='https://www.codetriage.com/gobeam/truthy/badges/users.svg' alt='Open Source Helpers' />

package.json

@@ -20,7 +20,7 @@
     "test:watch": "jest --config ./test/unit/jest-unit.json --watch",
     "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --config ./test/e2e/jest-e2e.json",
+    "test:e2e": "jest --config ./test/e2e/jest-e2e.json --runInBand --detectOpenHandles",
     "test:unit": "jest --config ./test/unit/jest-unit.json --runInBand",
     "typeorm": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js --config src/config/ormconfig.ts",
     "orm-create": "npm run typeorm migration:create -- -n",

test/factories/app.ts

@@ -114,7 +114,10 @@ export class AppFactory {
 }
 
 const setupRedis = async () => {
-  const redis = new Redis({});
+  const redis = new Redis({
+    host: process.env.REDIS_HOST || 'localhost',
+    port: parseInt(process.env.REDIS_PORT) || 6379
+  });
   await redis.flushall();
   return redis;
 };