Add bitbucket tests with authoverride

part of Improve our approach for testing auth badges#9493
seperated from PR badges#9983 for work in a later time

Author: jNullj

services/bitbucket/bitbucket-pull-request.service.js

@@ -32,6 +32,20 @@ function pullRequestClassGenerator(raw) {
       queryParamSchema,
     }
 
+    static auth = {
+      userKey: 'bitbucket_username',
+      passKey: 'bitbucket_password',
+      serviceKey: 'bitbucket',
+      isRequired: true,
+    }
+
+    static authServer = {
+      userKey: 'bitbucket_server_username',
+      passKey: 'bitbucket_server_password',
+      serviceKey: 'bitbucketServer',
+      isRequired: true,
+    }
+
     static get openApi() {
       const key = `/bitbucket/${routePrefix}/{user}/{repo}`
       const route = {}
@@ -71,27 +85,16 @@ function pullRequestClassGenerator(raw) {
     constructor(context, config) {
       super(context, config)
 
-      this.bitbucketAuthHelper = new AuthHelper(
-        {
-          userKey: 'bitbucket_username',
-          passKey: 'bitbucket_password',
-          authorizedOrigins: ['https://bitbucket.org'],
-        },
-        config,
-      )
+      // can only be set here as we must get config
       this.bitbucketServerAuthHelper = new AuthHelper(
-        {
-          userKey: 'bitbucket_server_username',
-          passKey: 'bitbucket_server_password',
-          serviceKey: 'bitbucketServer',
-        },
+        BitbucketPullRequest.authServer,
         config,
       )
     }
 
     async fetchCloud({ user, repo }) {
       return this._requestJson(
-        this.bitbucketAuthHelper.withBasicAuth({
+        this.authHelper.withBasicAuth({
           url: `https://bitbucket.org/api/2.0/repositories/${user}/${repo}/pullrequests/`,
           schema,
           options: { searchParams: { state: 'OPEN', limit: 0 } },
@@ -103,7 +106,7 @@ function pullRequestClassGenerator(raw) {
     // https://docs.atlassian.com/bitbucket-server/rest/5.16.0/bitbucket-rest.html#idm46229602363312
     async fetchServer({ server, user, repo }) {
       return this._requestJson(
-        this.bitbucketServerAuthHelper.withBasicAuth({
+        this.authHelper.withBasicAuth({
           url: `${server}/rest/api/1.0/projects/${user}/repos/${repo}/pull-requests`,
           schema,
           options: {
@@ -121,6 +124,7 @@ function pullRequestClassGenerator(raw) {
 
     async fetch({ server, user, repo }) {
       if (server !== undefined) {
+        this.authHelper = this.bitbucketServerAuthHelper
         return this.fetchServer({ server, user, repo })
       } else {
         return this.fetchCloud({ user, repo })

services/bitbucket/bitbucket-pull-request.spec.js

@@ -1,73 +1,91 @@
-import { expect } from 'chai'
-import nock from 'nock'
-import { cleanUpNockAfterEach, defaultContext } from '../test-helpers.js'
-import { BitbucketRawPullRequests } from './bitbucket-pull-request.service.js'
+import { testAuth } from '../test-helpers.js'
+import {
+  BitbucketRawPullRequests,
+  BitbucketNonRawPullRequests,
+} from './bitbucket-pull-request.service.js'
 
-describe('BitbucketPullRequest', function () {
-  cleanUpNockAfterEach()
+const serverConfigOverride = {
+  public: {
+    services: {
+      bitbucketServer: {
+        authorizedOrigins: ['https://bitbucket.mydomain.net'],
+      },
+      bitbucket: {
+        authorizedOrigins: ['https://bitbucket.org'],
+      },
+    },
+  },
+  private: {
+    bitbucket_username: 'must-be-set-for-class-constructor',
+    bitbucket_password: 'must-be-set-for-class-constructor',
+  },
+}
 
-  const user = 'admin'
-  const pass = 'password'
+const cloudConfigOverride = {
+  public: {
+    services: {
+      bitbucket: {
+        authorizedOrigins: ['https://bitbucket.org'],
+      },
+      bitbucketServer: {
+        authorizedOrigins: [],
+      },
+    },
+  },
+}
 
-  it('Sends auth headers to Bitbucket as configured', async function () {
-    const scope = nock('https://bitbucket.org/api/2.0/repositories/')
-      .get(/.*/)
-      .basicAuth({ user, pass })
-      .reply(200, { size: 42 })
-
-    expect(
-      await BitbucketRawPullRequests.invoke(
-        defaultContext,
+describe('BitbucketRawPullRequests', function () {
+  describe('auth', function () {
+    it('sends the auth information to Bitbucket cloud as configured', async function () {
+      return testAuth(
+        BitbucketRawPullRequests,
+        'BasicAuth',
+        { size: 42 },
         {
-          public: {
-            services: {
-              bitbucketServer: {
-                authorizedOrigins: [],
-              },
-            },
-          },
-          private: { bitbucket_username: user, bitbucket_password: pass },
+          exampleOverride: { server: undefined },
+          configOverride: cloudConfigOverride,
         },
-        { user: 'shields-io', repo: 'test-repo' },
-      ),
-    ).to.deep.equal({
-      message: '42',
-      color: 'yellow',
+      )
     })
 
-    scope.done()
+    it('sends the auth information to Bitbucket instence as configured', async function () {
+      return testAuth(
+        BitbucketRawPullRequests,
+        'BasicAuth',
+        { size: 42 },
+        {
+          authOverride: BitbucketRawPullRequests.authServer,
+          configOverride: serverConfigOverride,
+        },
+      )
+    })
   })
+})
 
-  it('Sends auth headers to Bitbucket Server as configured', async function () {
-    const scope = nock('https://bitbucket.example.test/rest/api/1.0/projects')
-      .get(/.*/)
-      .basicAuth({ user, pass })
-      .reply(200, { size: 42 })
-
-    expect(
-      await BitbucketRawPullRequests.invoke(
-        defaultContext,
+describe('BitbucketNonRawPullRequests', function () {
+  describe('auth', function () {
+    it('sends the auth information to Bitbucket cloud as configured', async function () {
+      return testAuth(
+        BitbucketNonRawPullRequests,
+        'BasicAuth',
+        { size: 42 },
         {
-          public: {
-            services: {
-              bitbucketServer: {
-                authorizedOrigins: ['https://bitbucket.example.test'],
-              },
-            },
-          },
-          private: {
-            bitbucket_server_username: user,
-            bitbucket_server_password: pass,
-          },
+          exampleOverride: { server: undefined },
+          configOverride: cloudConfigOverride,
         },
-        { user: 'project', repo: 'repo' },
-        { server: 'https://bitbucket.example.test' },
-      ),
-    ).to.deep.equal({
-      message: '42',
-      color: 'yellow',
+      )
     })
 
-    scope.done()
+    it('sends the auth information to Bitbucket instence as configured', async function () {
+      return testAuth(
+        BitbucketNonRawPullRequests,
+        'BasicAuth',
+        { size: 42 },
+        {
+          authOverride: BitbucketNonRawPullRequests.authServer,
+          configOverride: serverConfigOverride,
+        },
+      )
+    })
   })
 })