feat(MongoBinary): add ability to disable SYSTEM_BINARY version check

fixes #529

Author: hasezoey

docs/api/config-options.md

@@ -92,6 +92,12 @@ Format:
 - `/path/to/binary/mongod` (POSIX)
 - `C:/path/to/binary/mongod.exe` (DOS)
 
+### SYSTEM_BINARY_VERSION_CHECK
+
+Option `SYSTEM_BINARY_VERSION_CHECK` is used to disable the version conflict check if [`SYSTEM_BINARY`](#system_binary) is set and version returned from `mongod_system_binary --version` does not match [`VERSION`](#version)
+
+Default: `true`
+
 ### MD5_CHECK
 
 Option `MD5_CHECK` is used to enable an md5 check after download

packages/mongodb-memory-server-core/src/util/MongoBinary.ts

@@ -100,16 +100,21 @@ export class MongoBinary {
           !isNullOrUndefined(spawnOutput),
           new Error('Couldnt find an version from system binary output!')
         );
-        const binaryVersion = spawnOutput[1];
-
-        if (semver.neq(options.version, binaryVersion)) {
-          // we will log the version number of the system binary and the version requested so the user can see the difference
-          console.warn(
-            'getPath: MongoMemoryServer: Possible version conflict\n' +
-              `  SystemBinary version: "${binaryVersion}"\n` +
-              `  Requested version:    "${options.version}"\n\n` +
-              '  Using SystemBinary!'
-          );
+
+        // dont warn if the versions dont match if "SYSTEM_BINARY_VERSION_CHECK" is false, but still test the binary if it is available to be executed
+        if (envToBool(resolveConfig(ResolveConfigVariables.SYSTEM_BINARY_VERSION_CHECK))) {
+          log('getPath: Checking & Warning about version conflicts');
+          const binaryVersion = spawnOutput[1];
+
+          if (semver.neq(options.version, binaryVersion)) {
+            // we will log the version number of the system binary and the version requested so the user can see the difference
+            console.warn(
+              'getPath: MongoMemoryServer: Possible version conflict\n' +
+                `  SystemBinary version: "${binaryVersion}"\n` +
+                `  Requested version:    "${options.version}"\n\n` +
+                '  Using SystemBinary!'
+            );
+          }
         }
       } else {
         throw new Error(

packages/mongodb-memory-server-core/src/util/__tests__/MongoBinary.test.ts

@@ -109,6 +109,7 @@ describe('MongoBinary', () => {
       afterEach(() => {
         delete process.env[envName(ResolveConfigVariables.VERSION)];
         delete process.env[envName(ResolveConfigVariables.SYSTEM_BINARY)];
+        delete process.env[envName(ResolveConfigVariables.SYSTEM_BINARY_VERSION_CHECK)];
       });
 
       it('should return and check an SystemBinary', async () => {
@@ -157,6 +158,9 @@ build environment:
         );
         process.env[envName(ResolveConfigVariables.VERSION)] = '4.4.0'; // set it explicitly to that version to test non-matching versions
         process.env[envName(ResolveConfigVariables.SYSTEM_BINARY)] = sysBinaryPath;
+        expect(resolveConfig(ResolveConfigVariables.SYSTEM_BINARY_VERSION_CHECK)).toStrictEqual(
+          'true'
+        );
 
         const output = await MongoBinary.getPath();
         expect(childProcess.spawnSync).toHaveBeenCalledTimes(1);
@@ -165,6 +169,38 @@ build environment:
         expect(console.warn).toHaveBeenCalledTimes(1);
       });
 
+      it('should return and check an SYSTEM_BINARY and dont warn version conflict if SYSTEM_BINARY_VERSION_CHECK is false', async () => {
+        jest.spyOn(console, 'warn');
+        // Output taken from mongodb x64 for "ubuntu" version "4.0.25"
+        // DO NOT INDENT THE TEXT
+        jest.spyOn(childProcess, 'spawnSync').mockReturnValue(
+          // @ts-expect-error Because "Buffer" is missing values from type, but they are not used in code, so its fine
+          {
+            stdout: Buffer.from(`db version v4.0.25
+git version: e2416422da84a0b63cde2397d60b521758b56d1b
+OpenSSL version: OpenSSL 1.1.1f  31 Mar 2020
+allocator: tcmalloc
+modules: none
+build environment:
+    distmod: ubuntu1804
+    distarch: x86_64
+    target_arch: x86_64`),
+          }
+        );
+        process.env[envName(ResolveConfigVariables.VERSION)] = '4.4.0'; // set it explicitly to that version to test non-matching versions
+        process.env[envName(ResolveConfigVariables.SYSTEM_BINARY)] = sysBinaryPath;
+        expect(resolveConfig(ResolveConfigVariables.SYSTEM_BINARY_VERSION_CHECK)).toStrictEqual(
+          'true'
+        );
+        process.env[envName(ResolveConfigVariables.SYSTEM_BINARY_VERSION_CHECK)] = 'false';
+
+        const output = await MongoBinary.getPath();
+        expect(childProcess.spawnSync).toHaveBeenCalledTimes(1);
+        expect(MongoBinary.download).not.toHaveBeenCalled();
+        expect(console.warn).not.toHaveBeenCalled();
+        expect(output).toBe(sysBinaryPath);
+      });
+
       it('should throw an error if SYSTEM_BINARY is set, but no binary can be found', async () => {
         process.env[envName(ResolveConfigVariables.SYSTEM_BINARY)] = sysBinaryPath;
         jest.spyOn(DryMongoBinary, 'locateBinary').mockResolvedValue(undefined);

packages/mongodb-memory-server-core/src/util/resolveConfig.ts

@@ -21,6 +21,7 @@ export enum ResolveConfigVariables {
   ARCHIVE_NAME = 'ARCHIVE_NAME',
   RUNTIME_DOWNLOAD = 'RUNTIME_DOWNLOAD',
   USE_HTTP = 'USE_HTTP',
+  SYSTEM_BINARY_VERSION_CHECK = 'SYSTEM_BINARY_VERSION_CHECK',
 }
 
 export const ENV_CONFIG_PREFIX = 'MONGOMS_';
@@ -30,6 +31,7 @@ export const defaultValues = new Map<ResolveConfigVariables, string>([
   [ResolveConfigVariables.PREFER_GLOBAL_PATH, 'true'],
   [ResolveConfigVariables.RUNTIME_DOWNLOAD, 'true'],
   [ResolveConfigVariables.USE_HTTP, 'false'],
+  [ResolveConfigVariables.SYSTEM_BINARY_VERSION_CHECK, 'true'],
 ]);
 
 /**