Improve our approach for testing auth (part 1)

services/stackexchange/stackexchange-base.spec.js

@@ -1,12 +1,27 @@
 import Joi from 'joi'
 import { expect } from 'chai'
 import nock from 'nock'
+import { pathParams } from '../index.js'
 import { cleanUpNockAfterEach, defaultContext } from '../test-helpers.js'
 import { StackExchangeBase } from './stackexchange-base.js'
+import StackExchangeMonthlyQuestions from './stackexchange-monthlyquestions.service.js'
+import StackExchangeReputation from './stackexchange-reputation.service.js'
+import StackExchangeQuestions from './stackexchange-taginfo.service.js'
 
 class DummyStackExchangeService extends StackExchangeBase {
   static route = { base: 'fake-base' }
 
+  static openApi = {
+    '/fake-base': {
+      get: {
+        parameters: pathParams({
+          name: 'fakeparam',
+          example: 'fakeparam',
+        }),
+      },
+    },
+  }
+
   async handle() {
     const data = await this.fetch({
       schema: Joi.any(),
@@ -16,23 +31,47 @@ class DummyStackExchangeService extends StackExchangeBase {
   }
 }
 
-describe('StackExchangeBase', function () {
-  describe('auth', function () {
-    cleanUpNockAfterEach()
+// format is [class, example response from server]
+const testClasses = [
+  [DummyStackExchangeService, { message: 'fake message' }],
+  [StackExchangeMonthlyQuestions, { total: 8 }],
+  [StackExchangeReputation, { items: [{ reputation: 8 }] }],
+  [StackExchangeQuestions, { items: [{ count: 8 }] }],
+]
 
-    const config = { private: { stackapps_api_key: 'fake-key' } }
+for (const [serviceClass, dummyResponse] of testClasses) {
+  testAuth(serviceClass, dummyResponse)
+}
 
-    it('sends the auth information as configured', async function () {
-      const scope = nock('https://api.stackexchange.com')
-        .get('/2.2/tags/python/info')
-        .query({ key: 'fake-key' })
-        .reply(200, { message: 'fake message' })
+function testAuth(serviceClass, dummyResponse) {
+  describe(serviceClass.name, function () {
+    describe('auth', function () {
+      cleanUpNockAfterEach()
 
-      expect(
-        await DummyStackExchangeService.invoke(defaultContext, config, {}),
-      ).to.deep.equal({ message: 'fake message' })
+      const config = { private: { stackapps_api_key: 'fake-key' } }
+      const firstOpenapiPath = Object.keys(serviceClass.openApi)[0]
+      const exampleInvokeParams = serviceClass.openApi[
+        firstOpenapiPath
+      ].get.parameters.reduce((acc, obj) => {
+        acc[obj.name] = obj.example
+        return acc
+      }, {})
 
-      scope.done()
+      it('sends the auth information as configured', async function () {
+        const scope = nock('https://api.stackexchange.com')
+          .get(/.*/)
+          .query(queryObject => queryObject.key === 'fake-key')
+          .reply(200, dummyResponse)
+        expect(
+          await serviceClass.invoke(
+            defaultContext,
+            config,
+            exampleInvokeParams,
+          ),
+        ).to.not.have.property('isError')
+
+        scope.done()
+      })
     })
   })
-})
+}