Improve our approach for testing auth (part 2) - basicAuth

config/custom-environment-variables.yml

@@ -26,6 +26,8 @@ public:
   rasterUrl: 'RASTER_URL'
 
   services:
+    bitbucket:
+      authorizedOrigins: 'BITBUCKET_ORIGINS'
     bitbucketServer:
       authorizedOrigins: 'BITBUCKET_SERVER_ORIGINS'
     drone:

config/default.yml

@@ -12,6 +12,8 @@ public:
   ssl:
     isSecure: false
   services:
+    bitbucket:
+      authorizedOrigins: 'https://bitbucket.org'
     github:
       baseUri: 'https://api.github.com'
       debug:

core/base-service/base-graphql.js

@@ -27,6 +27,8 @@ class BaseGraphqlService extends BaseService {
     return parseJson(buffer)
   }
 
+  static headers = { Accept: 'application/json' }
+
   /**
    * Request data from an upstream GraphQL API,
    * parse it and validate against a schema
@@ -76,7 +78,7 @@ class BaseGraphqlService extends BaseService {
     transformErrors = defaultTransformErrors,
   }) {
     const mergedOptions = {
-      ...{ headers: { Accept: 'application/json' } },
+      ...{ headers: this.constructor.headers },
       ...options,
     }
     mergedOptions.method = 'POST'

core/base-service/base-json.js

@@ -21,6 +21,8 @@ class BaseJsonService extends BaseService {
     return parseJson(buffer)
   }
 
+  static headers = { Accept: 'application/json' }
+
   /**
    * Request data from an upstream API serving JSON,
    * parse it and validate against a schema
@@ -54,7 +56,7 @@ class BaseJsonService extends BaseService {
     logErrors = [429],
   }) {
     const mergedOptions = {
-      ...{ headers: { Accept: 'application/json' } },
+      ...{ headers: this.constructor.headers },
       ...options,
     }
     const { buffer } = await this._request({

core/base-service/base-svg-scraping.js

@@ -42,6 +42,8 @@ class BaseSvgScrapingService extends BaseService {
     }
   }
 
+  static headers = { Accept: 'image/svg+xml' }
+
   /**
    * Request data from an endpoint serving SVG,
    * parse a value from it and validate against a schema
@@ -79,7 +81,7 @@ class BaseSvgScrapingService extends BaseService {
   }) {
     const logTrace = (...args) => trace.logTrace('fetch', ...args)
     const mergedOptions = {
-      ...{ headers: { Accept: 'image/svg+xml' } },
+      ...{ headers: this.constructor.headers },
       ...options,
     }
     const { buffer } = await this._request({

core/base-service/base-toml.js

@@ -14,6 +14,14 @@ import trace from './trace.js'
  * @abstract
  */
 class BaseTomlService extends BaseService {
+  static headers = {
+    Accept:
+      // the official header should be application/toml - see https://toml.io/en/v1.0.0#mime-type
+      // but as this is not registered here https://www.iana.org/assignments/media-types/media-types.xhtml
+      // some apps use other mime-type like application/x-toml, text/plain etc....
+      'text/x-toml, text/toml, application/x-toml, application/toml, text/plain',
+  }
+
   /**
    * Request data from an upstream API serving TOML,
    * parse it and validate against a schema
@@ -48,15 +56,7 @@ class BaseTomlService extends BaseService {
   }) {
     const logTrace = (...args) => trace.logTrace('fetch', ...args)
     const mergedOptions = {
-      ...{
-        headers: {
-          Accept:
-            // the official header should be application/toml - see https://toml.io/en/v1.0.0#mime-type
-            // but as this is not registered here https://www.iana.org/assignments/media-types/media-types.xhtml
-            // some apps use other mime-type like application/x-toml, text/plain etc....
-            'text/x-toml, text/toml, application/x-toml, application/toml, text/plain',
-        },
-      },
+      ...{ headers: this.constructor.headers },
       ...options,
     }
     const { buffer } = await this._request({

core/base-service/base-xml.js

@@ -15,6 +15,8 @@ import { InvalidResponse } from './errors.js'
  * @abstract
  */
 class BaseXmlService extends BaseService {
+  static headers = { Accept: 'application/xml, text/xml' }
+
   /**
    * Request data from an upstream API serving XML,
    * parse it and validate against a schema
@@ -53,7 +55,7 @@ class BaseXmlService extends BaseService {
   }) {
     const logTrace = (...args) => trace.logTrace('fetch', ...args)
     const mergedOptions = {
-      ...{ headers: { Accept: 'application/xml, text/xml' } },
+      ...{ headers: this.constructor.headers },
       ...options,
     }
     const { buffer } = await this._request({

core/base-service/base-yaml.js

@@ -14,6 +14,11 @@ import trace from './trace.js'
  * @abstract
  */
 class BaseYamlService extends BaseService {
+  static headers = {
+    Accept:
+      'text/x-yaml, text/yaml, application/x-yaml, application/yaml, text/plain',
+  }
+
   /**
    * Request data from an upstream API serving YAML,
    * parse it and validate against a schema
@@ -50,12 +55,7 @@ class BaseYamlService extends BaseService {
   }) {
     const logTrace = (...args) => trace.logTrace('fetch', ...args)
     const mergedOptions = {
-      ...{
-        headers: {
-          Accept:
-            'text/x-yaml, text/yaml, application/x-yaml, application/yaml, text/plain',
-        },
-      },
+      ...{ headers: this.constructor.headers },
       ...options,
     }
     const { buffer } = await this._request({

core/server/server.js

@@ -118,6 +118,7 @@ const publicConfigSchema = Joi.object({
     allowedOrigin: Joi.array().items(optionalUrl),
   },
   services: Joi.object({
+    bitbucket: defaultService,
     bitbucketServer: defaultService,
     drone: defaultService,
     github: {

services/azure-devops/azure-devops-coverage.spec.js

@@ -0,0 +1,33 @@
+import { testAuth } from '../test-helpers.js'
+import AzureDevOpsCoverage from './azure-devops-coverage.service.js'
+
+describe('AzureDevOpsCoverage', function () {
+  describe('auth', function () {
+    it('sends the auth information as configured', async function () {
+      return testAuth(
+        AzureDevOpsCoverage,
+        'BasicAuth',
+        {
+          coverageData: [
+            {
+              coverageStats: [
+                {
+                  label: 'Coverage',
+                  total: 95,
+                  covered: 93,
+                },
+              ],
+            },
+          ],
+          count: 1,
+          value: [
+            {
+              id: 90395,
+            },
+          ],
+        },
+        { multipleRequests: true },
+      )
+    })
+  })
+})

services/azure-devops/azure-devops-tests.spec.js

@@ -0,0 +1,32 @@
+import { testAuth } from '../test-helpers.js'
+import AzureDevOpsTests from './azure-devops-tests.service.js'
+
+describe('AzureDevOpsTests', function () {
+  describe('auth', function () {
+    it('sends the auth information as configured', async function () {
+      return testAuth(
+        AzureDevOpsTests,
+        'BasicAuth',
+        {
+          aggregatedResultsAnalysis: {
+            totalTests: 95,
+            resultsByOutcome: {
+              Passed: {
+                count: 93,
+              },
+            },
+          },
+          count: 1,
+          value: [
+            {
+              id: 90395,
+            },
+          ],
+        },
+        {
+          multipleRequests: true,
+        },
+      )
+    })
+  })
+})

services/jenkins/jenkins-build.spec.js

@@ -1,10 +1,18 @@
-import { expect } from 'chai'
-import nock from 'nock'
 import { test, forCases, given } from 'sazerac'
 import { renderBuildStatusBadge } from '../build-status.js'
-import { cleanUpNockAfterEach, defaultContext } from '../test-helpers.js'
+import { testAuth } from '../test-helpers.js'
 import JenkinsBuild from './jenkins-build.service.js'
 
+const authConfigOverride = {
+  public: {
+    services: {
+      jenkins: {
+        authorizedOrigins: ['https://ci.eclipse.org'],
+      },
+    },
+  },
+}
+
 describe('JenkinsBuild', function () {
   test(JenkinsBuild.prototype.transform, () => {
     forCases([
@@ -57,49 +65,13 @@ describe('JenkinsBuild', function () {
   })
 
   describe('auth', function () {
-    cleanUpNockAfterEach()
-
-    const user = 'admin'
-    const pass = 'password'
-    const config = {
-      public: {
-        services: {
-          jenkins: {
-            authorizedOrigins: ['https://jenkins.ubuntu.com'],
-          },
-        },
-      },
-      private: {
-        jenkins_user: user,
-        jenkins_pass: pass,
-      },
-    }
-
     it('sends the auth information as configured', async function () {
-      const scope = nock('https://jenkins.ubuntu.com')
-        .get('/server/job/curtin-vmtest-daily-x/api/json?tree=color')
-        // This ensures that the expected credentials are actually being sent with the HTTP request.
-        // Without this the request wouldn't match and the test would fail.
-        .basicAuth({ user, pass })
-        .reply(200, { color: 'blue' })
-
-      expect(
-        await JenkinsBuild.invoke(
-          defaultContext,
-          config,
-          {},
-          {
-            jobUrl:
-              'https://jenkins.ubuntu.com/server/job/curtin-vmtest-daily-x',
-          },
-        ),
-      ).to.deep.equal({
-        label: undefined,
-        message: 'passing',
-        color: 'brightgreen',
-      })
-
-      scope.done()
+      return testAuth(
+        JenkinsBuild,
+        'BasicAuth',
+        { color: 'blue' },
+        { configOverride: authConfigOverride },
+      )
     })
   })
 })

services/jenkins/jenkins-coverage.spec.js

@@ -0,0 +1,25 @@
+import { testAuth } from '../test-helpers.js'
+import JenkinsCoverage from './jenkins-coverage.service.js'
+
+const authConfigOverride = {
+  public: {
+    services: {
+      jenkins: {
+        authorizedOrigins: ['https://ci-maven.apache.org'],
+      },
+    },
+  },
+}
+
+describe('JenkinsCoverage', function () {
+  describe('auth', function () {
+    it('sends the auth information as configured', async function () {
+      return testAuth(
+        JenkinsCoverage,
+        'BasicAuth',
+        { instructionCoverage: { percentage: 93 } },
+        { configOverride: authConfigOverride },
+      )
+    })
+  })
+})

services/jenkins/jenkins-tests.spec.js

@@ -0,0 +1,27 @@
+import { testAuth } from '../test-helpers.js'
+import JenkinsTests from './jenkins-tests.service.js'
+
+const authConfigOverride = {
+  public: {
+    services: {
+      jenkins: {
+        authorizedOrigins: ['https://ci.eclipse.org'],
+      },
+    },
+  },
+}
+
+describe('JenkinsTests', function () {
+  describe('auth', function () {
+    it('sends the auth information as configured', async function () {
+      return testAuth(
+        JenkinsTests,
+        'BasicAuth',
+        { actions: [{ totalCount: 3, failCount: 2, skipCount: 1 }] },
+        {
+          configOverride: authConfigOverride,
+        },
+      )
+    })
+  })
+})