test: update per suggestions

Author: durran

.evergreen/ci_matrix_constants.js

@@ -17,6 +17,7 @@ const DEFAULT_OS = 'rhel80-large';
 const WINDOWS_OS = 'windows-vsCurrent-large';
 const MACOS_OS = 'macos-1100';
 const UBUNTU_OS = 'ubuntu1804-large';
+const UBUNTU_20_OS = 'ubuntu1004-small'
 const DEBIAN_OS = 'debian11-small';
 
 module.exports = {
@@ -32,5 +33,6 @@ module.exports = {
   WINDOWS_OS,
   MACOS_OS,
   UBUNTU_OS,
+  UBUNTU_20_OS,
   DEBIAN_OS
 };

.evergreen/config.yml

@@ -4030,7 +4030,7 @@ buildvariants:
       - test-azurekms-fail-task
   - name: ubuntu20-test-azure-oidc
     display_name: Azure OIDC
-    run_on: ubuntu2004-small
+    run_on: ubuntu1004-small
     batchtime: 20160
     tasks:
       - testazureoidc_task_group

.evergreen/generate_evergreen_tasks.js

@@ -16,6 +16,7 @@ const {
   WINDOWS_OS,
   MACOS_OS,
   UBUNTU_OS,
+  UBUNTU_20_OS,
   DEBIAN_OS
 } = require('./ci_matrix_constants');
 
@@ -757,7 +758,7 @@ BUILD_VARIANTS.push({
 BUILD_VARIANTS.push({
   name: 'ubuntu20-test-azure-oidc',
   display_name: 'Azure OIDC',
-  run_on: 'ubuntu2004-small',
+  run_on: UBUNTU_20_OS,
   batchtime: 20160,
   tasks: ['testazureoidc_task_group']
 });

src/cmap/auth/mongodb_oidc/azure_service_workflow.ts

@@ -34,15 +34,7 @@ export interface AzureAccessToken {
  * @internal
  */
 export class AzureServiceWorkflow extends ServiceWorkflow {
-  cache: AzureTokenCache;
-
-  /**
-   * Instantiate the Azure service workflow.
-   */
-  constructor() {
-    super();
-    this.cache = new AzureTokenCache();
-  }
+  cache = new AzureTokenCache();
 
   /**
    * Get the token from the environment.
@@ -59,7 +51,7 @@ export class AzureServiceWorkflow extends ServiceWorkflow {
     } else {
       this.cache.deleteEntry(tokenAudience);
       const response = await getAzureTokenData(tokenAudience);
-      if (isEndpointResultInvalid(response)) {
+      if (!isEndpointResultValid(response)) {
         throw new MongoAzureError(ENDPOINT_RESULT_ERROR);
       }
       this.cache.addEntry(tokenAudience, response);
@@ -82,11 +74,13 @@ async function getAzureTokenData(tokenAudience: string): Promise<AzureAccessToke
 }
 
 /**
- * Determines if a result returned from the endpoint is invalid.
- * This means the result is nullish, doesn't contain the access_token required field,
- * the expires_in required field.
+ * Determines if a result returned from the endpoint is valid.
+ * This means the result is not nullish, contains the access_token required field
+ * and the expires_in required field.
  */
-function isEndpointResultInvalid(token: unknown): boolean {
-  if (token == null || typeof token !== 'object') return true;
-  return !('access_token' in token) && !('expires_in' in token);
+function isEndpointResultValid(
+  token: unknown
+): token is { access_token: unknown; expires_in: unknown } {
+  if (token == null || typeof token !== 'object') return false;
+  return 'access_token' in token && 'expires_in' in token;
 }

src/cmap/auth/mongodb_oidc/azure_token_cache.ts

@@ -1,5 +1,5 @@
 import type { AzureAccessToken } from './azure_service_workflow';
-import { AbstractCache, ExpiringCacheEntry } from './cache';
+import { Cache, ExpiringCacheEntry } from './cache';
 
 /** @internal */
 export class AzureTokenEntry extends ExpiringCacheEntry {
@@ -18,7 +18,7 @@ export class AzureTokenEntry extends ExpiringCacheEntry {
  * A cache of access tokens from Azure.
  * @internal
  */
-export class AzureTokenCache extends AbstractCache<AzureTokenEntry> {
+export class AzureTokenCache extends Cache<AzureTokenEntry> {
   /**
    * Add an entry to the cache.
    */

src/cmap/auth/mongodb_oidc/cache.ts

@@ -29,20 +29,10 @@ export abstract class ExpiringCacheEntry {
   }
 }
 
-/**
- * An OIDC token cache.
- */
-export interface Cache {
-  /**
-   * Implement the cache key for the token.
-   */
-  cacheKey(address: string, username: string, callbackHash: string): string;
-}
-
 /**
  * Base class for OIDC caches.
  */
-export abstract class AbstractCache<T> implements Cache {
+export abstract class Cache<T> {
   entries: Map<string, T>;
 
   /**

src/cmap/auth/mongodb_oidc/callback_lock_cache.ts

@@ -8,7 +8,7 @@ import type {
   OIDCRefreshFunction,
   OIDCRequestFunction
 } from '../mongodb_oidc';
-import { AbstractCache } from './cache';
+import { Cache } from './cache';
 
 /** Error message for when request callback is missing. */
 const REQUEST_CALLBACK_REQUIRED_ERROR =
@@ -34,7 +34,7 @@ interface CallbacksEntry {
 /**
  * A cache of request and refresh callbacks per server/user.
  */
-export class CallbackLockCache extends AbstractCache<CallbacksEntry> {
+export class CallbackLockCache extends Cache<CallbacksEntry> {
   /**
    * Get the callbacks for the connection and credentials. If an entry does not
    * exist a new one will get set.

src/cmap/auth/mongodb_oidc/token_entry_cache.ts

@@ -1,5 +1,5 @@
 import type { IdPServerInfo, IdPServerResponse } from '../mongodb_oidc';
-import { AbstractCache, ExpiringCacheEntry } from './cache';
+import { Cache, ExpiringCacheEntry } from './cache';
 
 /* Default expiration is now for when no expiration provided */
 const DEFAULT_EXPIRATION_SECS = 0;
@@ -23,7 +23,7 @@ export class TokenEntry extends ExpiringCacheEntry {
  * Cache of OIDC token entries.
  * @internal
  */
-export class TokenEntryCache extends AbstractCache<TokenEntry> {
+export class TokenEntryCache extends Cache<TokenEntry> {
   /**
    * Set an entry in the token cache.
    */

test/manual/mongodb_oidc_azure.prose.test.ts renamed to test/integration/auth/mongodb_oidc_azure.prose.test.ts

@@ -7,7 +7,7 @@ import {
   CommandSucceededEvent,
   MongoClient,
   OIDC_WORKFLOWS
-} from '../mongodb';
+} from '../../mongodb';
 
 describe('OIDC Auth Spec Prose Tests', function () {
   const callbackCache = OIDC_WORKFLOWS.get('callback').cache;
@@ -17,13 +17,20 @@ describe('OIDC Auth Spec Prose Tests', function () {
     let client: MongoClient;
     let collection: Collection;
 
+    beforeEach(function () {
+      if (!this.configuration.isAzureOIDC(process.env.MONGODB_URI)) {
+        this.currentTest?.skipReason = 'Azure OIDC prose tests require an Azure OIDC environment.';
+        this.skip();
+      }
+    });
+
     afterEach(async function () {
       await client?.close();
     });
 
     describe('3.1 Connect', function () {
-      before(function () {
-        client = new MongoClient(process.env.MONGODB_URI);
+      beforeEach(function () {
+        client = this.configuration.newClient(process.env.MONGODB_URI);
         collection = client.db('test').collection('test');
       });
 
@@ -37,8 +44,8 @@ describe('OIDC Auth Spec Prose Tests', function () {
     });
 
     describe('3.2 Allowed Hosts Ignored', function () {
-      before(function () {
-        client = new MongoClient(process.env.MONGODB_URI, {
+      beforeEach(function () {
+        client = this.configuration.newClient(process.env.MONGODB_URI, {
           authMechanismProperties: {
             ALLOWED_HOSTS: []
           }
@@ -57,9 +64,9 @@ describe('OIDC Auth Spec Prose Tests', function () {
     });
 
     describe('3.3 Main Cache Not Used', function () {
-      before(function () {
+      beforeEach(function () {
         callbackCache?.clear();
-        client = new MongoClient(process.env.MONGODB_URI);
+        client = this.configuration.newClient(process.env.MONGODB_URI);
         collection = client.db('test').collection('test');
       });
 
@@ -76,10 +83,10 @@ describe('OIDC Auth Spec Prose Tests', function () {
     });
 
     describe('3.4 Azure Cache is Used', function () {
-      before(function () {
+      beforeEach(function () {
         callbackCache?.clear();
         azureCache?.clear();
-        client = new MongoClient(process.env.MONGODB_URI);
+        client = this.configuration.newClient(process.env.MONGODB_URI);
         collection = client.db('test').collection('test');
       });
 
@@ -148,9 +155,9 @@ describe('OIDC Auth Spec Prose Tests', function () {
         });
       };
 
-      before(async function () {
+      beforeEach(async function () {
         azureCache?.clear();
-        client = new MongoClient(process.env.MONGODB_URI, { monitorCommands: true });
+        client = this.configuration.newClient(process.env.MONGODB_URI, { monitorCommands: true });
         await client.db('test').collection('test').findOne();
         addListeners();
         await setupFailPoint();

test/tools/runner/config.ts

@@ -153,6 +153,10 @@ export class TestConfiguration {
     return this.options.replicaSet;
   }
 
+  isAzureOIDC(uri: string): boolean {
+    return uri.indexOf('MONGODB-OIDC') > -1 && uri.indexOf('PROVIDER_NAME:azure') > -1;
+  }
+
   newClient(dbOptions?: string | Record<string, any>, serverOptions?: Record<string, any>) {
     serverOptions = Object.assign({}, getEnvironmentalOptions(), serverOptions);