Improve our approach for testing auth (part 1)

services/discord/discord.spec.js

@@ -1,38 +1,15 @@
-import { expect } from 'chai'
-import nock from 'nock'
-import { cleanUpNockAfterEach, defaultContext } from '../test-helpers.js'
+import { testAuth } from '../test-helpers.js'
 import Discord from './discord.service.js'
 
 describe('Discord', function () {
-  cleanUpNockAfterEach()
-
-  it('sends the auth information as configured', async function () {
-    const pass = 'password'
-    const config = {
-      private: {
-        discord_bot_token: pass,
-      },
-    }
-
-    const scope = nock('https://discord.com', {
-      // This ensures that the expected credential is actually being sent with the HTTP request.
-      // Without this the request wouldn't match and the test would fail.
-      reqheaders: { Authorization: 'Bot password' },
+  describe('auth', function () {
+    it('sends the auth information as configured', async function () {
+      return testAuth(
+        Discord,
+        'BearerAuthHeader',
+        { presence_count: 125 },
+        { bearerHeaderKey: 'Bot' },
+      )
     })
-      .get('/api/v6/guilds/12345/widget.json')
-      .reply(200, {
-        presence_count: 125,
-      })
-
-    expect(
-      await Discord.invoke(defaultContext, config, {
-        serverId: '12345',
-      }),
-    ).to.deep.equal({
-      message: '125 online',
-      color: 'brightgreen',
-    })
-
-    scope.done()
   })
 })

services/docker/docker-automated.spec.js

@@ -0,0 +1,15 @@
+import { testAuth } from '../test-helpers.js'
+import DockerAutomatedBuild from './docker-automated.service.js'
+
+describe('DockerAutomatedBuild', function () {
+  describe('auth', function () {
+    it('sends the auth information as configured', async function () {
+      return testAuth(
+        DockerAutomatedBuild,
+        'JwtAuth',
+        { is_automated: true },
+        { jwtLoginEndpoint: 'https://hub.docker.com/v2/users/login/' },
+      )
+    })
+  })
+})

services/obs/obs.spec.js

@@ -0,0 +1,16 @@
+import { testAuth } from '../test-helpers.js'
+import ObsService from './obs.service.js'
+
+describe('ObsService', function () {
+  describe('auth', function () {
+    it('sends the auth information as configured', async function () {
+      return testAuth(
+        ObsService,
+        'BasicAuth',
+        `<?xml version="1.0" encoding="UTF-8"?>
+        <status package="example" code="passed"></status>`,
+        { contentType: 'application/xml' },
+      )
+    })
+  })
+})

services/pepy/pepy-downloads.spec.js

@@ -0,0 +1,10 @@
+import { testAuth } from '../test-helpers.js'
+import PepyDownloads from './pepy-downloads.service.js'
+
+describe('PepyDownloads', function () {
+  describe('auth', function () {
+    it('sends the auth information as configured', async function () {
+      return testAuth(PepyDownloads, 'ApiKeyHeader', { total_downloads: 42 })
+    })
+  })
+})

services/stackexchange/stackexchange-monthlyquestions.spec.js

@@ -0,0 +1,17 @@
+import { testAuth } from '../test-helpers.js'
+import StackExchangeMonthlyQuestions from './stackexchange-monthlyquestions.service.js'
+
+describe('StackExchangeMonthlyQuestions', function () {
+  describe('auth', function () {
+    it('sends the auth information as configured', async function () {
+      return testAuth(
+        StackExchangeMonthlyQuestions,
+        'QueryStringAuth',
+        {
+          total: 8,
+        },
+        { queryPassKey: 'key' },
+      )
+    })
+  })
+})

services/stackexchange/stackexchange-reputation.spec.js

@@ -0,0 +1,17 @@
+import { testAuth } from '../test-helpers.js'
+import StackExchangeReputation from './stackexchange-reputation.service.js'
+
+describe('StackExchangeReputation', function () {
+  describe('auth', function () {
+    it('sends the auth information as configured', async function () {
+      return testAuth(
+        StackExchangeReputation,
+        'QueryStringAuth',
+        {
+          items: [{ reputation: 8 }],
+        },
+        { queryPassKey: 'key' },
+      )
+    })
+  })
+})

services/stackexchange/stackexchange-taginfo.spec.js

@@ -0,0 +1,17 @@
+import { testAuth } from '../test-helpers.js'
+import StackExchangeQuestions from './stackexchange-taginfo.service.js'
+
+describe('StackExchangeQuestions', function () {
+  describe('auth', function () {
+    it('sends the auth information as configured', async function () {
+      return testAuth(
+        StackExchangeQuestions,
+        'QueryStringAuth',
+        {
+          items: [{ count: 8 }],
+        },
+        { queryPassKey: 'key' },
+      )
+    })
+  })
+})