Merge pull request #15 from bineetNaidu/issue#12

Issue#12

Author: bineetNaidu

packages/templates/gql-psql/ormconfig.json

@@ -0,0 +1,26 @@
+[
+  {
+    "name": "development",
+    "type": "postgres",
+    "host": "localhost",
+    "port": 5432,
+    "username": "postgres",
+    "password": "DB_PASSWORD",
+    "database": "DB_DEV_DATABASE",
+    "logging": true,
+    "synchronize": true,
+    "entities": ["src/entities/**/*.ts"]
+  },
+  {
+    "name": "test",
+    "type": "postgres",
+    "host": "localhost",
+    "port": 5432,
+    "username": "postgres",
+    "password": "DB_PASSWORD",
+    "database": "DB_DEV_DATABASE",
+    "logging": false,
+    "synchronize": true,
+    "entities": ["src/entities/**/*.ts"]
+  }
+]

packages/templates/gql-psql/package.json

@@ -4,11 +4,20 @@
   "description": "A Graphql + postgresql api bootstraped w/ create-ts-api",
   "main": "index.js",
   "scripts": {
-    "start": "node dist/index.js",
-    "dev": "nodemon dist/index.js",
-    "dev:api": "nodemon src/index.ts",
+    "start": "NODE_ENV=production node dist/index.js",
+    "dev": "NODE_ENV=development nodemon dist/index.js",
+    "dev:api": "NODE_ENV=development nodemon src/index.ts",
     "watch": "tsc -w",
-    "build": "tsc"
+    "build": "tsc",
+    "test": "NODE_ENV=test jest",
+    "test:watch": "NODE_ENV=test jest --watchAll --no-cache"
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node",
+    "setupFilesAfterEnv": [
+      "./src/test/setup.ts"
+    ]
   },
   "keywords": [],
   "author": "BineetNaidu (https://bineetnaidu.github.io/)",
@@ -24,7 +33,11 @@
     "typeorm": "^0.2.34"
   },
   "devDependencies": {
+    "@types/jest": "^26.0.24",
+    "apollo-server-testing": "^2.25.2",
+    "jest": "^27.0.6",
     "nodemon": "^2.0.7",
+    "ts-jest": "^27.0.4",
     "ts-node": "^10.0.0",
     "typescript": "^4.3.2"
   }

packages/templates/gql-psql/src/index.ts

@@ -3,10 +3,9 @@ import dotenv from 'dotenv';
 import { ApolloServer } from 'apollo-server';
 import { buildSchema } from 'type-graphql';
 import { HelloResolver } from './resolvers/Hello';
-import { Tweet } from './entities/Tweet';
-import { createConnection } from 'typeorm';
 import { ___prod___ } from './utils/contants';
 import { TweetResolvers } from './resolvers/tweets';
+import { createTypeORMConnection } from './utils/createTypeORMConnection';
 
 dotenv.config();
 
@@ -15,13 +14,7 @@ const bootstrap = async () => {
     throw new Error('??>> {" DATABASE_URI must be defined!! "} ');
   }
 
-  const conn = await createConnection({
-    type: 'postgres',
-    url: process.env.DATABASE_URI,
-    logging: true,
-    synchronize: !___prod___,
-    entities: [Tweet],
-  });
+  const conn = await createTypeORMConnection();
 
   if (!conn.isConnected) {
     throw new Error('Database Connection has not been established yet!');

packages/templates/gql-psql/src/resolvers/__test__/hello.test.ts

@@ -0,0 +1,32 @@
+/*
+
+* IMPORTANT:
+	IF YOU HAVE ANY BETTER GRAPHQL TESTS IMPLEMENTATIONS, 
+	THEN PLEASE SEND THEM TO ME VIA A GITHUB ISSUE OR PR, 
+	I'LL UPDATE THIS FILE
+
+*/
+
+import { gql } from 'apollo-server';
+import { ApolloServerTestClient } from 'apollo-server-testing';
+import { testServer } from '../../test/testServer';
+
+let server: ApolloServerTestClient;
+
+testServer()
+  .then((s) => {
+    return (server = s);
+  })
+  .catch((err) => {
+    console.error(err);
+  });
+
+it('should return a hello world message', async () => {
+  const query = gql`
+    query {
+      hello
+    }
+  `;
+  const result = await server.query({ query });
+  expect(result.data).toEqual({ hello: 'Hello World 👋🌎' });
+});

packages/templates/gql-psql/src/resolvers/__test__/tweets.test.ts

@@ -0,0 +1,56 @@
+/*
+
+* IMPORTANT:
+	IF YOU HAVE ANY BETTER GRAPHQL TESTS IMPLEMENTATIONS, 
+	THEN PLEASE SEND THEM TO ME VIA A GITHUB ISSUE OR PR, 
+	I'LL UPDATE THIS FILE
+
+*/
+
+import { gql } from 'apollo-server';
+import { ApolloServerTestClient } from 'apollo-server-testing';
+import { testServer } from '../../test/testServer';
+
+let server: ApolloServerTestClient;
+
+testServer()
+  .then((s) => {
+    return (server = s);
+  })
+  .catch((err) => {
+    console.error(err);
+  });
+
+it('should return all tweets', async () => {
+  const query = gql`
+    query Tweets {
+      tweets {
+        id
+        body
+        username
+      }
+    }
+  `;
+  const result = await server.query({ query });
+  expect(result.data.tweets).toBeInstanceOf(Array);
+});
+
+it('should create a tweet', async () => {
+  const mutation = gql`
+    mutation CreateTweet($body: String!, $username: String!) {
+      createTweet(body: $body, username: $username) {
+        id
+        body
+        username
+      }
+    }
+  `;
+  const variables = {
+    body: 'test tweet',
+    username: 'test_user',
+  };
+  const result = await server.mutate({ mutation, variables });
+  expect(result.data.createTweet).toBeDefined();
+  expect(result.data.createTweet.body).toEqual(variables.body);
+  expect(result.data.createTweet.username).toEqual(variables.username);
+});

packages/templates/gql-psql/src/test/setup.ts

@@ -0,0 +1,13 @@
+import { Connection } from 'typeorm';
+import { createTypeORMConnection } from '../utils/createTypeORMConnection';
+
+let conn: Connection;
+
+beforeAll(async () => {
+  conn = await createTypeORMConnection();
+});
+
+afterAll(async () => {
+  await conn.dropDatabase();
+  await conn.close();
+});

packages/templates/gql-psql/src/test/testServer.ts

@@ -0,0 +1,24 @@
+/*
+
+* IMPORTANT:
+	IF YOU HAVE ANY BETTER GRAPHQL TESTS IMPLEMENTATIONS, 
+	THEN PLEASE SEND THEM TO ME VIA A GITHUB ISSUE OR PR, 
+	I'LL UPDATE THIS FILE
+
+*/
+import 'reflect-metadata';
+import { ApolloServer } from 'apollo-server';
+import { buildSchema } from 'type-graphql';
+import path from 'path';
+import { createTestClient } from 'apollo-server-testing';
+
+export const testServer = async () => {
+  const server = new ApolloServer({
+    schema: await buildSchema({
+      validate: false,
+      resolvers: [path.join(__dirname, '../resolvers/**/*.ts')],
+    }),
+  });
+
+  return createTestClient(server);
+};

packages/templates/gql-psql/src/utils/createTypeORMConnection.ts

@@ -0,0 +1,6 @@
+import { createConnection, getConnectionOptions } from 'typeorm';
+
+export const createTypeORMConnection = async () => {
+  const options = await getConnectionOptions(process.env.NODE_ENV);
+  return createConnection({ ...options, name: 'default' });
+};

packages/templates/gql/package.json

@@ -6,9 +6,15 @@
   "scripts": {
     "start": "node dist/index.js",
     "dev": "nodemon dist/index.js",
-    "dev:api": "nodemon src/index.ts",
+    "dev:ts": "nodemon src/index.ts",
     "watch": "tsc -w",
-    "build": "tsc"
+    "build": "tsc",
+    "test": "NODE_ENV=test jest",
+    "test:watch": "NODE_ENV=test jest --watchAll --no-cache"
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node"
   },
   "keywords": [],
   "author": "BineetNaidu (https://bineetnaidu.github.io/)",
@@ -21,7 +27,11 @@
     "type-graphql": "^1.1.1"
   },
   "devDependencies": {
+    "@types/jest": "^26.0.24",
+    "apollo-server-testing": "^2.25.2",
+    "jest": "^27.0.6",
     "nodemon": "^2.0.7",
+    "ts-jest": "^27.0.4",
     "ts-node": "^10.0.0",
     "typescript": "^4.3.2"
   }

packages/templates/gql/src/resolvers/__test__/hello.test.ts

@@ -0,0 +1,32 @@
+/*
+
+* IMPORTANT:
+	IF YOU HAVE ANY BETTER GRAPHQL TESTS IMPLEMENTATIONS, 
+	THEN PLEASE SEND THEM TO ME VIA A GITHUB ISSUE OR PR, 
+	I'LL UPDATE THIS FILE
+
+*/
+
+import { gql } from 'apollo-server';
+import { ApolloServerTestClient } from 'apollo-server-testing';
+import { testServer } from '../../test/testServer';
+
+let server: ApolloServerTestClient;
+
+testServer()
+  .then((s) => {
+    return (server = s);
+  })
+  .catch((err) => {
+    console.error(err);
+  });
+
+it('should return a hello world message', async () => {
+  const query = gql`
+    query {
+      hello
+    }
+  `;
+  const result = await server.query({ query });
+  expect(result.data).toEqual({ hello: 'Hello World 👋🌎' });
+});