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

config/custom-environment-variables.yml

@@ -31,6 +31,8 @@ public:
  __format: 'json'
 
  services:
+ bitbucket:
+ authorizedOrigins: 'BITBUCKET_ORIGINS'
  bitbucketServer:
  authorizedOrigins: 'BITBUCKET_SERVER_ORIGINS'
  drone:

config/default.yml

@@ -14,6 +14,8 @@ public:
  cors:
  allowedOrigin: []
  services:
+ bitbucket:
+ authorizedOrigins: 'https://bitbucket.org'
  github:
  baseUri: 'https://api.github.com'
  debug:

core/server/server.js

@@ -118,6 +118,7 @@ const publicConfigSchema = Joi.object({
  allowedOrigin: Joi.array().items(optionalUrl).required(),
  },
  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,35 @@
+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,
+ },
+ ],
+ },
+ {
+ exampleOverride: {
+ compact_message: undefined,
+ },
+ multipleRequests: true,
+ },
+ )
+ })
+ })
+})

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,
+ },
+ )
+ })
  })
 })

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 },
+ )
  })
  })
 })