test(NODE-4323): add a unit test task with bson-ext installed (#3347)

Author: nbbeeken

.evergreen/config.in.yml

@@ -837,15 +837,19 @@ functions:
           - "${PROJECT_DIRECTORY}/.evergreen/run-snappy-version-test.sh"
 
   "run bson-ext test":
-    - command: shell.exec
+    - command: subprocess.exec
       type: test
       params:
         working_dir: "src"
         timeout_secs: 60
-        script: |
-          ${PREPARE_SHELL}
+        env:
+          PROJECT_DIRECTORY: ${PROJECT_DIRECTORY}
+          MONGODB_URI: ${MONGODB_URI}
+          TEST_NPM_SCRIPT: ${TEST_NPM_SCRIPT}
+        binary: bash
+        args:
+          - '${PROJECT_DIRECTORY}/.evergreen/run-bson-ext-test.sh'
 
-          MONGODB_URI="${MONGODB_URI}" bash ${PROJECT_DIRECTORY}/.evergreen/run-bson-ext-test.sh
 
   "upload test results":
     # Upload the xunit-format test results.

.evergreen/config.yml

@@ -800,15 +800,18 @@ functions:
         args:
           - ${PROJECT_DIRECTORY}/.evergreen/run-snappy-version-test.sh
   run bson-ext test:
-    - command: shell.exec
+    - command: subprocess.exec
       type: test
       params:
         working_dir: src
         timeout_secs: 60
-        script: |
-          ${PREPARE_SHELL}
-
-          MONGODB_URI="${MONGODB_URI}" bash ${PROJECT_DIRECTORY}/.evergreen/run-bson-ext-test.sh
+        env:
+          PROJECT_DIRECTORY: ${PROJECT_DIRECTORY}
+          MONGODB_URI: ${MONGODB_URI}
+          TEST_NPM_SCRIPT: ${TEST_NPM_SCRIPT}
+        binary: bash
+        args:
+          - ${PROJECT_DIRECTORY}/.evergreen/run-bson-ext-test.sh
   upload test results:
     - command: attach.xunit_results
       params:
@@ -1671,8 +1674,26 @@ tasks:
           VERSION: '5.0'
           TOPOLOGY: server
           AUTH: auth
-      - func: run custom snappy tests
-  - name: run-bson-ext-test
+      - name: run-custom-snappy-tests
+        func: run custom snappy tests
+  - name: run-bson-ext-integration
+    tags:
+      - run-custom-dependency-tests
+    commands:
+      - func: install dependencies
+        vars:
+          NODE_LTS_NAME: erbium
+      - func: bootstrap mongo-orchestration
+        vars:
+          VERSION: '5.0'
+          TOPOLOGY: server
+          AUTH: auth
+      - name: run-bson-ext-integration
+        func: run bson-ext test
+        vars:
+          NODE_LTS_NAME: erbium
+          TEST_NPM_SCRIPT: check:test
+  - name: run-bson-ext-unit
     tags:
       - run-custom-dependency-tests
     commands:
@@ -1684,9 +1705,11 @@ tasks:
           VERSION: '5.0'
           TOPOLOGY: server
           AUTH: auth
-      - func: run bson-ext test
+      - name: run-bson-ext-unit
+        func: run bson-ext test
         vars:
           NODE_LTS_NAME: erbium
+          TEST_NPM_SCRIPT: check:unit
   - name: run-custom-csfle-tests-mongocryptd-pinned-commit
     tags:
       - run-custom-dependency-tests
@@ -2308,7 +2331,8 @@ buildvariants:
     run_on: ubuntu1804-large
     tasks:
       - run-custom-snappy-tests
-      - run-bson-ext-test
+      - run-bson-ext-integration
+      - run-bson-ext-unit
       - run-custom-csfle-tests-mongocryptd-pinned-commit
       - run-custom-csfle-tests-mongocryptd-master
       - run-custom-csfle-shared-lib-tests-pinned-commit

.evergreen/generate_evergreen_tasks.js

@@ -5,7 +5,7 @@ const yaml = require('js-yaml');
 const LATEST_EFFECTIVE_VERSION = '6.0';
 const MONGODB_VERSIONS = ['latest', '6.0', '5.0', '4.4', '4.2', '4.0', '3.6'];
 const NODE_VERSIONS = ['erbium', 'fermium', 'gallium'];
-NODE_VERSIONS.sort()
+NODE_VERSIONS.sort();
 const LOWEST_LTS = NODE_VERSIONS[0];
 
 const TOPOLOGIES = ['server', 'replica_set', 'sharded_cluster'];
@@ -136,7 +136,7 @@ TASKS.push(
             VERSION: '5.0',
             TOPOLOGY: 'sharded_cluster',
             AUTH: 'auth',
-            LOAD_BALANCER: 'true',
+            LOAD_BALANCER: 'true'
           }
         },
         { func: 'start-load-balancer' },
@@ -155,7 +155,7 @@ TASKS.push(
             VERSION: '6.0',
             TOPOLOGY: 'sharded_cluster',
             AUTH: 'auth',
-            LOAD_BALANCER: 'true',
+            LOAD_BALANCER: 'true'
           }
         },
         { func: 'start-load-balancer' },
@@ -505,17 +505,30 @@ BUILD_VARIANTS.push({
 });
 
 const oneOffFuncs = [
-  { func: 'run custom snappy tests' },
   {
+    name: 'run-custom-snappy-tests',
+    func: 'run custom snappy tests'
+  },
+  {
+    name: 'run-bson-ext-integration',
+    func: 'run bson-ext test',
+    vars: {
+      NODE_LTS_NAME: LOWEST_LTS,
+      TEST_NPM_SCRIPT: 'check:test'
+    }
+  },
+  {
+    name: 'run-bson-ext-unit',
     func: 'run bson-ext test',
     vars: {
-      NODE_LTS_NAME: LOWEST_LTS
+      NODE_LTS_NAME: LOWEST_LTS,
+      TEST_NPM_SCRIPT: 'check:unit'
     }
   }
 ];
 
 const oneOffFuncAsTasks = oneOffFuncs.map(oneOffFunc => ({
-  name: `${oneOffFunc.func.split(' ').join('-')}`,
+  name: oneOffFunc.name,
   tags: ['run-custom-dependency-tests'],
   commands: [
     {

test/integration/node-specific/bson-options/utf8_validation.test.ts

@@ -21,7 +21,8 @@ describe('class BinMsg', () => {
   });
 
   afterEach(() => {
-    deserializeSpy.restore();
+    deserializeSpy?.restore();
+    // @ts-expect-error: Allow this to be garbage collected
     deserializeSpy = null;
   });
 

test/tools/utils.ts

@@ -489,3 +489,10 @@ export class UnifiedTestSuiteBuilder {
     return JSON.parse(JSON.stringify(this));
   }
 }
+
+/** Test whether the driver is using bson-ext */
+export function isBSONExtImported() {
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const driverBSON = require('../../src/bson');
+  return driverBSON.deserialize.toString().includes('[native code]');
+}

test/unit/bson.test.js

@@ -2,15 +2,7 @@
 
 const { expect } = require('chai');
 const BSON = require('../../src/bson');
-
-function isBSONExtInstalled() {
-  try {
-    require.resolve('bson-ext');
-    return true;
-  } catch (_) {
-    return false;
-  }
-}
+const { isBSONExtImported } = require('../tools/utils');
 
 describe('When importing BSON', function () {
   const types = [
@@ -57,7 +49,7 @@ describe('When importing BSON', function () {
 
   describe('bson-ext', function () {
     before(function () {
-      if (!isBSONExtInstalled()) {
+      if (!isBSONExtImported()) {
         this.skip();
       }
     });
@@ -73,7 +65,7 @@ describe('When importing BSON', function () {
 
   describe('js-bson', function () {
     before(function () {
-      if (isBSONExtInstalled()) {
+      if (isBSONExtImported()) {
         this.skip();
       }
     });