Adding API endpoint & API testing core.

Author: leonardorb

README.md

@@ -1,4 +1,4 @@
-# PostgreSQL, TypeScript,  Node.js and Express.js Stack
+# PostgreSQL, TypeScript, Node.js and Express.js Stack
 
 ## Overview
 
@@ -16,10 +16,9 @@ This repo is a boilerplate project starter built with TypeScript for a PostgreSQ
 
 - [PostgreSQL Audit Trail](https://github.com/leonardorb/backend-postgres-typescript-node-express/blob/master/src/packages/database/helpers/installDatabaseAudit.ts)
 - Test Coverage
-![](https://leo.d.pr/kmVY0g+)
+  ![](https://leo.d.pr/kmVY0g+)
 - [Decorators and more](https://github.com/leonardorb/backend-postgres-typescript-node-express/blob/master/src/packages/database/models/user.ts)
 
-
 ## Folders / Files Structure
 
 Here is a high-level overview of our file structure.
@@ -78,4 +77,5 @@ SERVER_PORT=""
 ![](https://leo.d.pr/CYYAre+)
 
 ### License
-This project is open-sourced software licensed under the [MIT license](https://github.com/busayo/meanmap/blob/master/LICENSE).
+
+This project is an open-sourced software licensed under the [MIT license](https://github.com/busayo/meanmap/blob/master/LICENSE).

jest.config.js

@@ -1,16 +1,15 @@
+/* eslint-disable no-undef */
 process.env.NODE_ENV = 'test'
 
 module.exports = {
   coveragePathIgnorePatterns: ['/node_modules/', '/migrations/'],
   globalSetup: './src/__tests__/config/setup.ts',
   globalTeardown: './src/__tests__/config/teardown.ts',
   moduleNameMapper: {
-    "^~(.*)$": "<rootDir>/src/$1"
+    '^~(.*)$': '<rootDir>/src/$1',
   },
   preset: 'ts-jest',
-  setupFilesAfterEnv: [
-    './src/__tests__/config/database.ts',
-  ],
+  setupFilesAfterEnv: ['./src/__tests__/config/database.ts'],
   testEnvironment: 'node',
   testMatch: ['<rootDir>/**/*.test.ts'],
 }

src/__tests__/config/helpers.ts

@@ -0,0 +1,4 @@
+import app from '../../server'
+import * as request from 'supertest'
+
+export const server = request(app)

src/__tests__/config/setup.ts

@@ -4,7 +4,7 @@ require('tsconfig-paths/register')
 import * as http from 'http'
 import app from '../../server'
 
-module.exports = async () => {
+module.exports = async (): Promise<any> => {
   const server = http.createServer(app)
   server.listen(3000)
   global.__appServer__ = server

src/__tests__/packages/api/resources/users/controller.test.ts

@@ -0,0 +1,10 @@
+import { server } from '~/__tests__/config/helpers'
+
+describe('Users Controller', () => {
+  it('should list Users', async () => {
+    const res = await server.get('/users')
+
+    expect(res.status).toBe(200)
+    expect(res.body.length).not.toBe(0)
+  })
+})

src/packages/api/resources/users/controller.ts

@@ -1,6 +1,21 @@
 import { NextFunction, Request, Response } from 'express'
 import * as httpStatus from 'http-status'
-import { Forbidden } from '../../helpers/exceptions/forbidden'
+import { getConnection } from 'typeorm'
+import { User } from '~/packages/database/models/user'
+// import { Forbidden } from '../../helpers/exceptions/forbidden'
+
+export const list = async (req: Request, res: Response, next: NextFunction): Promise<any> => {
+  try {
+    const users = await getConnection()
+      .getRepository(User)
+      .createQueryBuilder('user')
+      .getMany()
+
+    return res.status(200).send(users)
+  } catch (error) {
+    return res.status(500).send(error)
+  }
+}
 
 export const login = async (req: Request, res: Response, next: NextFunction) => {
   res.status(httpStatus.OK).json({ hello: 'world' })

src/packages/api/resources/users/index.ts

@@ -1,8 +1,9 @@
 import Router from 'express-promise-router'
-import { login } from '~/packages/api/resources/users/controller'
+import { list, login } from '~/packages/api/resources/users/controller'
 
 const router = Router()
 
+router.route('/').get(list)
 router.route('/login').get(login)
 
 export default router

src/packages/database/index.ts

@@ -3,7 +3,7 @@ import { Connection, createConnection } from 'typeorm'
 
 let connection: Connection
 
-export async function getConnection() {
+export async function getConnection(): Promise<Connection> {
   if (connection) {
     return connection
   }
@@ -13,7 +13,7 @@ export async function getConnection() {
   return connection
 }
 
-export async function closeConnection() {
+export async function closeConnection(): Promise<void> {
   if (connection) {
     return connection.close()
   }