refactor(tests): Improved mock clients

KenEucker · Jan 10, 2022 · 927f465 · 927f465
1 parent 6d63bc9
commit 927f465
Show file tree

Hide file tree

Showing 11 changed files with 80 additions and 107 deletions.
diff --git a/test/src/mock/biketag/client.ts b/test/src/mock/biketag/client.ts
@@ -1,33 +1,14 @@
-import { BikeTagApiResponse, BikeTagClient } from 'biketag'
-import { getTagsResponse, getTagResponse } from './mock-data'
-import { Tag } from '#src/common/schema'
-
-/// ***************************  Types  *************************** ///
-
-export interface MockBikeTagClient extends BikeTagClient {
-  mockResponses: {
-    getTags: BikeTagApiResponse<Tag[]>
-    uploadTagImage: BikeTagApiResponse<Tag>
-  }
-}
+import * as mockData from './mock-data'
+import { exposeMocks } from '../helpers'
 
 /// ***************************  Utils  *************************** ///
 
 /**
  * Create mock BikeTag Client
- * Note: Alter mock responses using the `mockResponses` property
  */
-export function createMockClient(): MockBikeTagClient {
-  return {
-    mockResponses: {
-      getTags: getTagsResponse,
-      getTag: getTagResponse,
-    },
-    getTags: jest.fn(function () {
-      return getTagsResponse
-    }),
-    uploadTagImage: jest.fn(function () {
-      return getTagResponse
-    }),
-  } as unknown as MockBikeTagClient
+export function createMockClient() {
+  return exposeMocks({
+    getTags: jest.fn().mockResolvedValue(mockData.getTagsResponse),
+    getTag: jest.fn().mockResolvedValue(mockData.getTagResponse),
+  })
 }
diff --git a/test/src/mock/helpers.ts b/test/src/mock/helpers.ts
@@ -0,0 +1,34 @@
+/// ***************************  Mock Helpers  *************************** ///
+
+/**
+ * Takes a mock object and exposes the jest function in `mock` property
+ * @example
+ * const myClient = exposeMocks({
+ *   getTags: jest.fn(() => true)
+ * })
+ *
+ * // Use mock type to change response
+ * myClient.mocks.getTags.mockReturnValue(false);
+ *
+ * // Directly call function
+ * myClient.getTags();
+ */
+export function exposeMocks<T>(
+  obj: T
+): T & { mocks: Record<keyof T, jest.Mock> }
+export function exposeMocks(obj: any): any {
+  const keys = Object.keys(obj)
+
+  obj.mocks = {}
+  Object.defineProperties(
+    obj.mocks,
+    Object.fromEntries(
+      keys.map((k) => [
+        k,
+        { get: () => obj[k], enumerable: true, configurable: true },
+      ])
+    )
+  )
+
+  return obj
+}
diff --git a/test/src/mock/imgur/client.ts b/test/src/mock/imgur/client.ts
@@ -1,51 +1,16 @@
-import { ImgurApiResponse, ImgurClient } from 'imgur'
-import {
-  getAlbumResponse,
-  getImageResponse,
-  updateImageResponse,
-  uploadResponse,
-  getTagsResponse,
-} from './mock-data'
-import { AlbumData, ImageData } from 'imgur/lib/common/types'
-
-/// ***************************  Types  *************************** ///
-
-export interface MockImgurClient extends ImgurClient {
-  mockResponses: {
-    getAlbum: ImgurApiResponse<AlbumData>
-    getImage: ImgurApiResponse<ImageData>
-    updateImage: ImgurApiResponse<boolean>
-    upload: ImgurApiResponse<ImageData>
-  }
-}
+import * as mockData from './mock-data'
+import { exposeMocks } from '../helpers'
 
 /// ***************************  Utils  *************************** ///
 
 /**
  * Create mock Imgur Client
- * Note: Alter mock responses using the `mockResponses` property
  */
-export function createMockClient(): MockImgurClient {
-  const client = {} as MockImgurClient
-
-  return Object.assign(client, {
-    mockResponses: {
-      getAlbum: getAlbumResponse,
-      getImage: getImageResponse,
-      updateImage: updateImageResponse,
-      upload: uploadResponse,
-    },
-    getAlbum: jest.fn(async function () {
-      return client.mockResponses.getAlbum
-    }),
-    getImage: jest.fn(async function () {
-      return client.mockResponses.getImage
-    }),
-    updateImage: jest.fn(async function () {
-      return client.mockResponses.updateImage
-    }),
-    upload: jest.fn(async function () {
-      return client.mockResponses.upload
-    }),
+export function createMockClient() {
+  return exposeMocks({
+    getAlbum: jest.fn().mockResolvedValue(mockData.getAlbumResponse),
+    getImage: jest.fn().mockResolvedValue(mockData.getImageResponse),
+    updateImage: jest.fn().mockResolvedValue(mockData.updateImageResponse),
+    upload: jest.fn().mockResolvedValue(mockData.uploadResponse),
   })
 }
diff --git a/test/tests/imgur/deleteTag.test.ts b/test/tests/imgur/deleteTag.test.ts
@@ -1,6 +1,6 @@
 import { MockBikeTag, MockImgur, MockTag } from '#test-src'
-import * as imgurModule from '#src/imgur'
 import { HttpStatusCode } from '#src/common/enums'
+import * as imgurModule from '#src/imgur'
 
 /// ***************************  Config  *************************** ///
 
@@ -9,11 +9,11 @@ const imgurDeleteTagMethod = 'biketag.images.deleteTag'
 /// ***************************  Tests  *************************** ///
 
 describe(imgurDeleteTagMethod, () => {
-  const client = MockImgur.createMockClient()
-  const bikeTagClientMock = MockBikeTag.createMockClient()
+  const mockClient = MockImgur.createMockClient()
+  const mockBikeTagClient = MockBikeTag.createMockClient()
   const deleteTag = imgurModule.deleteTag.bind(
-    { getTags: bikeTagClientMock.getTags },
-    client
+    mockBikeTagClient,
+    <any>mockClient
   )
 
   test(`${imgurDeleteTagMethod} method requires ImgurHash from payload`, () => {

diff --git a/test/tests/imgur/deleteTags.test.ts b/test/tests/imgur/deleteTags.test.ts
@@ -1,4 +1,4 @@
-import * as deleteTagsModule from '#src/imgur'
+import * as imgurModule from '#src/imgur'
 import { HttpStatusCode } from '#src/common/enums'
 import { MockBikeTag, MockImgur, MockTag } from '#test-src'
 
@@ -9,11 +9,11 @@ const imgurDeleteTagsMethod = 'biketag.images.deleteTags'
 /// ***************************  Tests  *************************** ///
 
 describe(imgurDeleteTagsMethod, () => {
-  const client = MockImgur.createMockClient()
-  const bikeTagClientMock = MockBikeTag.createMockClient()
-  const deleteTags = deleteTagsModule.getTags.bind(
-    { getTags: bikeTagClientMock.getTags },
-    client
+  const mockClient = MockImgur.createMockClient()
+  const mockBikeTagClient = MockBikeTag.createMockClient()
+  const deleteTags = imgurModule.deleteTags.bind(
+    mockBikeTagClient,
+    <any>mockClient
   )
 
   test(`${imgurDeleteTagsMethod} method requires ImgurHash from payload`, () => {

diff --git a/test/tests/imgur/getPlayers.test.ts b/test/tests/imgur/getPlayers.test.ts
@@ -11,11 +11,11 @@ import { HttpStatusCode } from '#src/common/enums'
 /// ***************************  Test  *************************** ///
 
 describe(imgurGetPlayersMethod, () => {
-  const client = MockImgur.createMockClient()
-  const bikeTagClientMock = MockBikeTag.createMockClient()
+  const mockClient = MockImgur.createMockClient()
+  const mockBikeTagClient = MockBikeTag.createMockClient()
   const getPlayers = imgurModule.getPlayers.bind(
-    { getTags: bikeTagClientMock.getTags },
-    client
+    mockBikeTagClient,
+    <any>mockClient
   )
 
   test(`${imgurGetPlayersMethod} method requires ImgurHash from payload`, () => {

diff --git a/test/tests/imgur/getTags.test.ts b/test/tests/imgur/getTags.test.ts
@@ -1,7 +1,7 @@
 import * as imgurModule from '#src/imgur'
 import { isTag } from '#src/common/schema'
 import { HttpStatusCode } from '#src/common/enums'
-import { MockImgur, MockTag } from '#test-src'
+import { MockBikeTag, MockImgur, MockTag } from '#test-src'
 
 /// ***************************  Config  *************************** ///
 
@@ -10,8 +10,9 @@ const imgurGetTagsMethod = 'biketag.images.getTags'
 /// ***************************  Tests  *************************** ///
 
 describe(imgurGetTagsMethod, () => {
-  const client = MockImgur.createMockClient()
-  const getTags = imgurModule.getTags.bind(undefined, client)
+  const mockClient = MockImgur.createMockClient()
+  const mockBikeTagClient = MockBikeTag.createMockClient()
+  const getTags = imgurModule.getTags.bind(mockBikeTagClient, <any>mockClient)
 
   test(`${imgurGetTagsMethod} method requires ImgurHash from payload`, () => {
     return expect(getTags(<any>{})).rejects.toThrow()

diff --git a/test/tests/imgur/queueTag.test.ts b/test/tests/imgur/queueTag.test.ts
@@ -12,20 +12,15 @@ const imgurQueueTagMethod = 'biketag.images.queueTag'
 /// ***************************  Test  *************************** ///
 
 describe(imgurQueueTagMethod, () => {
-  const client = MockImgur.createMockClient()
-  const queueTag = imgurModule.queueTag.bind(undefined, client)
+  const mockClient = MockImgur.createMockClient()
+  const mockBikeTagClient = MockBikeTag.createMockClient()
+  const queueTag = imgurModule.queueTag.bind(mockBikeTagClient, <any>mockClient)
 
   test(`${imgurQueueTagMethod} method requires ImgurHash from payload`, () => {
     return expect(queueTag(<any>{})).rejects.toThrow()
   })
 
   test(`${imgurQueueTagMethod} method requires one of [hashes, tagnumbers, slugs] from payload`, () => {
-    const client = MockImgur.createMockClient()
-    const bikeTagClientMock = MockBikeTag.createMockClient()
-    const queueTag = imgurModule.queueTag.bind(
-      { getTags: bikeTagClientMock.getTags },
-      client
-    )
     const queuedTag = queueTag({} as queueTagPayload)
 
     expect(isTag(queuedTag)).toBeTruthy()

diff --git a/test/tests/imgur/updateTag.test.ts b/test/tests/imgur/updateTag.test.ts
@@ -11,14 +11,11 @@ const imgurUpdateTagsMethod = 'biketag.images.updateTags'
 /// ***************************  Tests  *************************** ///
 
 describe(imgurUpdateTagsMethod, () => {
-  const client = MockImgur.createMockClient()
-  const bikeTagClientMock = MockBikeTag.createMockClient()
+  const mockClient = MockImgur.createMockClient()
+  const mockBikeTagClient = MockBikeTag.createMockClient()
   const updateTag = imgurModule.updateTag.bind(
-    {
-      getTags: bikeTagClientMock.getTags,
-      uploadTagImage: bikeTagClientMock.uploadTagImage,
-    },
-    client
+    mockBikeTagClient,
+    <any>mockClient
   )
 
   test(`${imgurUpdateTagsMethod} method requires ImgurHash from payload`, () => {

diff --git a/test/tests/imgur/uploadTagImage.test.ts b/test/tests/imgur/uploadTagImage.test.ts
@@ -21,11 +21,11 @@ const img2 = {
 /// ***************************  Tests  *************************** ///
 
 describe(imgurUploadTagImageMethod, () => {
-  const client = MockImgur.createMockClient()
-  const bikeTagClientMock = MockBikeTag.createMockClient()
+  const mockClient = MockImgur.createMockClient()
+  const mockBikeTagClient = MockBikeTag.createMockClient()
   const uploadTagImage = imgurModule.uploadTagImage.bind(
-    { getTags: bikeTagClientMock.getTags },
-    client
+    mockBikeTagClient,
+    <any>mockClient
   )
 
   test(`${imgurUploadTagImageMethod} method requires ImgurHash from payload`, () => {

diff --git a/test/tsconfig.json b/test/tsconfig.json
@@ -4,7 +4,7 @@
   "compilerOptions": {
     "noEmit": true,
     "lib": ["esnext", "dom"],
-    "target": "es2015",
+    "target": "ES2019",
     "module": "CommonJS",
     "moduleResolution": "node",
     "strictBindCallApply": true,