chore: logs and check list

Author: nbbeeken

test/integration/client-side-encryption/client_side_encryption.prose.test.js

@@ -2310,7 +2310,10 @@ describe('Client Side Encryption Prose Tests', metadata, function () {
       kmip: {},
       local: undefined
     };
-    let client1, client2;
+    /** @type {import('../../mongodb').MongoClient} */
+    let client1;
+    /** @type {import('../../mongodb').MongoClient} */
+    let client2;
 
     describe('Case 1: Rewrap with separate ClientEncryption', function () {
       /**
@@ -2341,12 +2344,16 @@ describe('Client Side Encryption Prose Tests', metadata, function () {
           `should rewrap data key from ${srcProvider} to ${dstProvider}`,
           metadata,
           async function () {
+            client1.mongoLogger?.trace('client', 'dropping datakeys collection');
+
             // Step 1. Drop the collection ``keyvault.datakeys``
             await client1
               .db('keyvault')
               .dropCollection('datakeys')
               .catch(() => null);
 
+            client1.mongoLogger?.trace('client', 'dropped datakeys collection');
+
             // Step 2. Create a ``ClientEncryption`` object named ``clientEncryption1``
             const clientEncryption1 = new ClientEncryption(client1, {
               keyVaultNamespace: 'keyvault.datakeys',
@@ -2361,17 +2368,24 @@ describe('Client Side Encryption Prose Tests', metadata, function () {
               bson: BSON
             });
 
+            client1.mongoLogger?.trace('client', 'clientEncryption1.createDataKey started');
+
             // Step 3. Call ``clientEncryption1.createDataKey`` with ``srcProvider``
             const keyId = await clientEncryption1.createDataKey(srcProvider, {
               masterKey: masterKeys[srcProvider]
             });
 
+            client1.mongoLogger?.trace('client', 'clientEncryption1.createDataKey finished');
+            client1.mongoLogger?.trace('client', 'clientEncryption1.encrypt started');
+
             // Step 4. Call ``clientEncryption1.encrypt`` with the value "test"
             const cipherText = await clientEncryption1.encrypt('test', {
               keyId,
               algorithm: 'AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic'
             });
 
+            client1.mongoLogger?.trace('client', 'clientEncryption1.encrypt finished');
+
             // Step 5. Create a ``ClientEncryption`` object named ``clientEncryption2``
             const clientEncryption2 = new ClientEncryption(client2, {
               keyVaultNamespace: 'keyvault.datakeys',
@@ -2386,6 +2400,8 @@ describe('Client Side Encryption Prose Tests', metadata, function () {
               bson: BSON
             });
 
+            client2.mongoLogger?.trace('client', 'clientEncryption2.rewrapManyDataKey started');
+
             // Step 6. Call ``clientEncryption2.rewrapManyDataKey`` with an empty ``filter``
             const rewrapManyDataKeyResult = await clientEncryption2.rewrapManyDataKey(
               {},
@@ -2395,16 +2411,25 @@ describe('Client Side Encryption Prose Tests', metadata, function () {
               }
             );
 
+            client2.mongoLogger?.trace('client', 'clientEncryption2.rewrapManyDataKey finished');
+
             expect(rewrapManyDataKeyResult).to.have.property('bulkWriteResult');
             expect(rewrapManyDataKeyResult.bulkWriteResult).to.have.property('modifiedCount', 1);
 
+            client1.mongoLogger?.trace('client', 'clientEncryption1.decrypt started');
+
             // 7. Call ``clientEncryption1.decrypt`` with the ``ciphertext``. Assert the return value is "test".
             const decryptResult1 = await clientEncryption1.decrypt(cipherText);
             expect(decryptResult1).to.equal('test');
 
+            client1.mongoLogger?.trace('client', 'clientEncryption1.decrypt finished');
+            client2.mongoLogger?.trace('client', 'clientEncryption2.decrypt started');
+
             // 8. Call ``clientEncryption2.decrypt`` with the ``ciphertext``. Assert the return value is "test".
             const decryptResult2 = await clientEncryption2.decrypt(cipherText);
             expect(decryptResult2).to.equal('test');
+
+            client2.mongoLogger?.trace('client', 'clientEncryption2.decrypt finished');
           }
         );
       }

test/tools/runner/hooks/configuration.ts

@@ -23,6 +23,7 @@ import { OSFilter } from '../filters/os_filter';
 import { ServerlessFilter } from '../filters/serverless_filter';
 import { type Filter } from '../filters/filter';
 import { type Context } from 'mocha';
+import { flakyTests } from '../flaky';
 
 // Default our tests to have auth enabled
 // A better solution will be tackled in NODE-3714
@@ -222,8 +223,26 @@ async function afterEachLogging(this: Context) {
   this.configuration.afterEachLogging(this);
 }
 
+function checkFlakyTestList(this: Context) {
+  const allTests: string[] = [];
+
+  const stack = [this.test.parent];
+  while (stack.length) {
+    const suite = stack.pop();
+    allTests.push(...suite.tests.map(test => test.fullTitle()));
+    stack.push(...suite.suites);
+  }
+  allTests.reverse(); // Doesn't matter but when debugging easier to see this in the expected order.
+
+  const flakyTestDoesNotExist = flakyTests.find(testName => !allTests.includes(testName));
+  if (flakyTestDoesNotExist != null) {
+    console.error('Flaky test:', flakyTestDoesNotExist, 'is not run at all');
+    process.exitCode = 1;
+  }
+}
+
 export const mochaHooks = {
-  beforeAll: [beforeAllPluginImports, testConfigBeforeHook],
+  beforeAll: [beforeAllPluginImports, testConfigBeforeHook, checkFlakyTestList],
   beforeEach: [testSkipBeforeEachHook, beforeEachLogging],
   afterEach: [afterEachLogging],
   afterAll: [cleanUpMocksAfterHook]