add shared mongocryptd spawn and lifecycle management hooks

Author: baileympearson

test/integration/client-side-operations-timeout/client_side_operations_timeout.prose.test.ts

@@ -1,11 +1,8 @@
 /* Specification prose tests */
 
-import { type ChildProcess, spawn } from 'node:child_process';
 import { Readable } from 'node:stream';
 
 import { expect } from 'chai';
-import * as os from 'os';
-import * as path from 'path';
 import * as semver from 'semver';
 import * as sinon from 'sinon';
 import { pipeline } from 'stream/promises';
@@ -27,6 +24,7 @@ import {
 import {
   clearFailPoint,
   configureFailPoint,
+  configureMongocryptdSpawnHooks,
   type FailCommandFailPoint,
   makeMultiBatchWrite,
   measureDuration
@@ -127,28 +125,16 @@ describe('CSOT spec prose tests', function () {
 
     let client: MongoClient;
     const mongocryptdTestPort = '23000';
-    let childProcess: ChildProcess;
+    configureMongocryptdSpawnHooks({ port: mongocryptdTestPort });
 
     beforeEach(async function () {
-      const pidFile = path.join(os.tmpdir(), new ObjectId().toHexString());
-      childProcess = spawn(
-        'mongocryptd',
-        ['--port', mongocryptdTestPort, '--ipv6', '--pidfilepath', pidFile],
-        {
-          stdio: 'ignore',
-          detached: true
-        }
-      );
-
-      childProcess.on('error', error => console.warn(this.currentTest?.fullTitle(), error));
       client = new MongoClient(`mongodb://localhost:${mongocryptdTestPort}/?timeoutMS=1000`, {
         monitorCommands: true
       });
     });
 
     afterEach(async function () {
       await client.close();
-      childProcess.kill('SIGKILL');
       sinon.restore();
     });
 

test/integration/node-specific/client_close.test.ts

@@ -1,7 +1,4 @@
-import { type ChildProcess, spawn } from 'node:child_process';
 import * as events from 'node:events';
-import { tmpdir } from 'node:os';
-import { join } from 'node:path';
 
 import { expect } from 'chai';
 
@@ -10,9 +7,9 @@ import {
   type Collection,
   type CommandStartedEvent,
   type FindCursor,
-  type MongoClient,
-  ObjectId
+  type MongoClient
 } from '../../mongodb';
+import { configureMongocryptdSpawnHooks } from '../../tools/utils';
 import { filterForCommands } from '../shared';
 import { runScriptAndGetProcessInfo } from './resource_tracking_script_builder';
 
@@ -520,25 +517,10 @@ describe('MongoClient.close() Integration', () => {
 
       describe('when sessions are not supported', function () {
         const mongocryptdTestPort = '27022';
-        let childProcess: ChildProcess;
         let client: MongoClient;
         const commands: Array<CommandStartedEvent> = [];
 
-        beforeEach(async function () {
-          const pidFile = join(tmpdir(), new ObjectId().toHexString());
-          childProcess = spawn(
-            'mongocryptd',
-            ['--port', mongocryptdTestPort, '--ipv6', '--pidfilepath', pidFile],
-            {
-              stdio: 'ignore',
-              detached: true
-            }
-          );
-
-          childProcess.on('error', err => {
-            console.warn('Sessions prose mongocryptd error:', err);
-          });
-        });
+        configureMongocryptdSpawnHooks({ port: mongocryptdTestPort });
 
         beforeEach('configure cryptd client and prepopulate session pool', async function () {
           client = this.configuration.newClient(`mongodb://localhost:${mongocryptdTestPort}`, {
@@ -553,10 +535,6 @@ describe('MongoClient.close() Integration', () => {
           expect(client.s.sessionPool.sessions).to.have.length.greaterThan(0);
         });
 
-        afterEach(() => {
-          childProcess.kill();
-        });
-
         it('does not execute endSessions', async function () {
           await client.close();
 

test/integration/server-discovery-and-monitoring/server_description.test.ts

@@ -1,35 +1,20 @@
-import { type ChildProcess, spawn } from 'node:child_process';
-
 import { expect } from 'chai';
-import * as os from 'os';
-import * as path from 'path';
 
-import { MongoClient, ObjectId } from '../../mongodb';
+import { MongoClient } from '../../mongodb';
+import { configureMongocryptdSpawnHooks } from '../../tools/utils';
 
 describe('class ServerDescription', function () {
   describe('when connecting to mongocryptd', { requires: { mongodb: '>=4.4' } }, function () {
     let client: MongoClient;
-    const mongocryptdTestPort = '27022';
-    let childProcess: ChildProcess;
+
+    const { port: mongocryptdTestPort } = configureMongocryptdSpawnHooks();
 
     beforeEach(async function () {
-      const pidFile = path.join(os.tmpdir(), new ObjectId().toHexString());
-      childProcess = spawn(
-        'mongocryptd',
-        ['--port', mongocryptdTestPort, '--ipv6', '--pidfilepath', pidFile],
-        {
-          stdio: 'ignore',
-          detached: true
-        }
-      );
-
-      childProcess.on('error', error => console.warn(this.currentTest?.fullTitle(), error));
       client = new MongoClient(`mongodb://localhost:${mongocryptdTestPort}`);
     });
 
     afterEach(async function () {
       await client?.close();
-      childProcess.kill('SIGKILL');
     });
 
     it('iscryptd is set to true ', async function () {

test/integration/sessions/sessions.prose.test.ts

@@ -1,15 +1,11 @@
-import { ObjectId } from 'bson';
 import { expect } from 'chai';
-import { type ChildProcess, spawn } from 'child_process';
 import { once } from 'events';
-import * as os from 'os';
-import * as path from 'path';
 
 import { type CommandStartedEvent } from '../../../src/cmap/command_monitoring_events';
 import { type Collection } from '../../../src/collection';
 import { MongoDriverError, MongoInvalidArgumentError } from '../../../src/error';
 import { MongoClient } from '../../../src/mongo_client';
-import { sleep } from '../../tools/utils';
+import { configureMongocryptdSpawnHooks, sleep } from '../../tools/utils';
 
 describe('Sessions Prose Tests', () => {
   describe('5. Session argument is for the right client', () => {
@@ -128,23 +124,8 @@ describe('Sessions Prose Tests', () => {
      */
     const mongocryptdTestPort = '27022';
     let client: MongoClient;
-    let childProcess: ChildProcess;
-
-    before(() => {
-      const pidFile = path.join(os.tmpdir(), new ObjectId().toHexString());
-      childProcess = spawn(
-        'mongocryptd',
-        ['--port', mongocryptdTestPort, '--ipv6', '--pidfilepath', pidFile],
-        {
-          stdio: 'ignore',
-          detached: true
-        }
-      );
 
-      childProcess.on('error', err => {
-        console.warn('Sessions prose mongocryptd error:', err);
-      });
-    });
+    configureMongocryptdSpawnHooks({ port: mongocryptdTestPort });
 
     beforeEach(async () => {
       client = new MongoClient(`mongodb://localhost:${mongocryptdTestPort}`, {
@@ -160,10 +141,6 @@ describe('Sessions Prose Tests', () => {
       await client?.close();
     });
 
-    after(() => {
-      childProcess.kill();
-    });
-
     it(
       '18. Implicit session is ignored if connection does not support sessions',
       {

test/tools/utils.ts

@@ -1,6 +1,7 @@
 import * as child_process from 'node:child_process';
 import { on, once } from 'node:events';
 import * as fs from 'node:fs/promises';
+import { tmpdir } from 'node:os';
 import * as path from 'node:path';
 
 import { EJSON } from 'bson';
@@ -528,3 +529,33 @@ export const DOMException: {
   ac.abort();
   return ac.signal.reason.constructor;
 })();
+
+export function configureMongocryptdSpawnHooks(
+  options: { port?: string; pidfilepath?: string } = {}
+): { port: string } {
+  const port = options.port ?? '27022';
+  const pidfilepath = options.pidfilepath ?? path.join(tmpdir(), new BSON.ObjectId().toHexString());
+
+  let childProcess: child_process.ChildProcess;
+
+  beforeEach(async function () {
+    childProcess = child_process.spawn(
+      'mongocryptd',
+      ['--port', port, '--ipv6', '--pidfilepath', pidfilepath],
+      {
+        stdio: 'ignore',
+        detached: false
+      }
+    );
+
+    childProcess.on('error', error => console.warn(this.currentTest?.fullTitle(), error));
+  });
+
+  afterEach(function () {
+    childProcess.kill('SIGKILL');
+  });
+
+  return {
+    port
+  };
+}