:sparkles: using sinon to mock objection methods in tests | building mock for Schwifty model registration | working sample test for matchqueue

backend/lib/services/matchqueue.js

@@ -87,7 +87,6 @@ module.exports = class MatchQueueService extends Schmervice.Service {
                 is_deleted: false,
             })
         }
-
         return await this.getQueue(profileId)
     }
 }

backend/package.json

@@ -36,6 +36,7 @@
     "ava": "^3.15.0",
     "eslint": "^7.28.0",
     "nodemon": "^2.0.7",
-    "nyc": "^15.1.0"
+    "nyc": "^15.1.0",
+    "sinon": "^11.1.2"
   }
 }

backend/tests/brian.spec.js

@@ -1,44 +0,0 @@
-'use strict'
-
-const test = require('ava')
-const Hapi = require('@hapi/hapi')
-const Schwifty = require('@hapipal/schwifty')
-const Schmervice = require('@hapipal/schmervice')
-
-const MatchQueService = require('../lib/services/matchqueue')
-const MatchQueModel = require('../lib/models/matchqueue')
-
-test('path / should return ok on GET', async t => {
-    const server = Hapi.server()
-
-    await server.register({
-        plugin: Schwifty,
-        options: {
-            knex: {
-                client: 'mysql',
-                useNullAsDefault: true,
-                connection: {
-                    host: process.env.DB_HOST,
-                    user: process.env.DB_USER,
-                    password: process.env.DB_ROOT_PASSWORD,
-                    database: process.env.DB_NAME,
-                },
-            },
-        },
-    })
-
-    await server.register(Schmervice)
-    await server.registerModel(MatchQueModel)
-    await server.registerService(MatchQueService)
-
-    // I can't quite wrap my head around why this wouldn't at least reference this.server.models()
-    // returns TypeError {
-    // message: 'Cannot read properties of undefined (reading \ 'models\')'
-    // }
-
-    const matchQueService = new MatchQueService()
-    const potentials = await matchQueService.getQueue()
-    console.log(potentials)
-    t.is(payload, '{"test":"hello, world"}')
-    t.is(statusCode, 200)
-})

backend/tests/example.test.js

@@ -1,19 +0,0 @@
-'use strict'
-
-const test = require('ava')
-const Hapi = require('@hapi/hapi')
-
-const routeBase = '../lib/routes'
-
-const route = require(routeBase + '/example/base')
-
-test('path / should return ok on GET', async t => {
-    const server = Hapi.server()
-
-    server.route(route)
-
-    const { statusCode, payload } = await server.inject(route.path)
-
-    t.is(payload, '{"test":"hello, world"}')
-    t.is(statusCode, 200)
-})

backend/tests/matchqueue.spec.js

@@ -0,0 +1,76 @@
+'use strict'
+
+const test = require('ava')
+const { stub } = require('sinon')
+const Hapi = require('@hapi/hapi')
+
+const plugin = require('../lib/plugins/profile')
+
+const MatchQueue = require('../lib/models/matchqueue')
+
+test('path / should return ok on GET', async t => {
+    /**
+     * Create a new server and register services,
+     * models and routes for testing
+     * -
+     * NOTE: We use a mocked registerModel() and register
+     * models manually. Normally this is handled by
+     * Schwifty at runtime.
+     */
+    const server = Hapi.server()
+    server.registerModel = () => {}
+    server.models = () => ({ MatchQueue })
+    await plugin.register(server)
+
+    /**
+     * Route parameters
+     */
+    const profile_id = 1
+    const target_id = 2
+    const reinsert = true
+
+    /**
+     * Replace Objection model methods with our own custom functions
+     * !: Kinda janky - might be better to temp knex sqlite instance
+     */
+    stub(server.models()['MatchQueue'], 'query').returns({
+        // Mocked for markAsDeleted()
+        patch: () => ({
+            where: () => ({
+                andWhere: () => ({
+                    first: () => ({ patch: 'bop' }),
+                }),
+            }),
+        }),
+        insert: queueRecord => {
+            t.is(queueRecord.profile_id, profile_id)
+            t.is(queueRecord.target_id, target_id)
+            t.is(queueRecord.is_deleted, !reinsert)
+        },
+        // Mocked for getQueue()
+        where: () => ({
+            andWhere: (cmd, val) => {
+                return [
+                    { mocked_profile_id: 1, is_deleted: val },
+                    { mocked_profile_id: 2, is_deleted: val },
+                    { mocked_profile_id: 3, is_deleted: val },
+                ]
+            },
+        }),
+    })
+
+    /**
+     * Test the server with registered models and services
+     */
+    const { payload } = await server.inject({
+        method: 'PATCH',
+        url: `/${profile_id}/queue/${target_id}/delete?reinsert=${reinsert}`,
+    })
+    const res = JSON.parse(payload)
+
+    t.deepEqual(res, [
+        { mocked_profile_id: 1, is_deleted: false },
+        { mocked_profile_id: 2, is_deleted: false },
+        { mocked_profile_id: 3, is_deleted: false },
+    ])
+})