feat(MongoInstance): add new options auth, replSet and args for providing additional mongod args (#79) thanks @jloveridge

* feat(MongoInstance): add new option `instance.args` to allow passing additional args.
feat(MongoInstance): add new option `instance.auth` to allow running with auth enabled.
feat(MongoInstance): add new option `instance.replSet` to specify replica set name.

* docs(readme): Update README with info about new options for instance.

* chore(instanceData): The instance data should have `replSet` details on it.

* chore(type): Augment the types with information about the new options.

Author: jloveridge

README.md

@@ -53,6 +53,9 @@ const mongod = new MongodbMemoryServer({
     dbPath?: string, // by default create in temp directory
     storageEngine?: string, // by default `ephemeralForTest`, available engines: [ 'devnull', 'ephemeralForTest', 'mmapv1', 'wiredTiger' ]
     debug?: boolean, // by default false
+    replSet?: string, // by default no replica set, replica set name
+    auth?: boolean, // by default `mongod` is started with '--noauth', start `mongod` with '--auth'
+    args?: string[], // by default no additional arguments, any additional command line arguments for `mongod` `mongod` (ex. ['--notablescan'])
   },
   binary: {
     version?: string, // by default 'latest'

src/MongoMemoryServer.d.ts

@@ -10,6 +10,9 @@ export interface MongoMemoryServerOptsT {
     dbName?: string;
     storageEngine?: string;
     debug?: boolean | ((...args: any[]) => any);
+    replSet?: string;
+    auth?: boolean;
+    args?: string[];
   };
   binary: {
     version?: string;
@@ -35,6 +38,7 @@ export interface MongoInstanceDataT {
     name: string;
     removeCallback: ((...args: any[]) => any);
   };
+  replSet?: string;
 }
 
 export default class MongoMemoryServer {

src/MongoMemoryServer.js

@@ -17,6 +17,9 @@ export type MongoMemoryServerOptsT = {
     dbName?: string,
     storageEngine?: string,
     debug?: boolean | Function,
+    replSet?: string,
+    args?: string[],
+    auth?: boolean,
   },
   binary: {
     version?: string,
@@ -42,6 +45,7 @@ export type MongoInstanceDataT = {
     name: string,
     removeCallback: Function,
   },
+  replSet?: string,
 };
 
 async function generateDbName(dbName?: string): Promise<string> {
@@ -116,6 +120,7 @@ export default class MongoMemoryServer {
     data.dbName = await generateDbName(instOpts.dbName);
     data.uri = await generateConnectionString(data.port, data.dbName);
     data.storageEngine = instOpts.storageEngine || 'ephemeralForTest';
+    data.replSet = instOpts.replSet;
     if (instOpts.dbPath) {
       data.dbPath = instOpts.dbPath;
     } else {
@@ -133,6 +138,9 @@ export default class MongoMemoryServer {
         storageEngine: data.storageEngine,
         dbPath: data.dbPath,
         debug: this.opts.instance.debug,
+        replSet: data.replSet,
+        args: this.opts.instance.args,
+        auth: this.opts.instance.auth,
       },
       binary: this.opts.binary,
       spawn: this.opts.spawn,

src/util/MongoInstance.d.ts

@@ -10,6 +10,9 @@ export interface MongodOps {
         storageEngine?: string;
         dbPath: string;
         debug?: boolean | ((...args: any[]) => any);
+        replSet?: string;
+        args?: string[];
+        auth?: boolean;
     };
 
     // mongo binary options

src/util/MongoInstance.js

@@ -14,6 +14,9 @@ export type MongodOps = {
     storageEngine?: string,
     dbPath: string,
     debug?: boolean | Function,
+    replSet?: string,
+    args?: string[],
+    auth?: boolean,
   },
 
   // mongo binary options
@@ -75,16 +78,17 @@ export default class MongodbInstance {
   }
 
   prepareCommandArgs(): string[] {
-    const { ip, port, storageEngine, dbPath } = this.opts.instance;
+    const { ip, port, storageEngine, dbPath, replSet, auth, args } = this.opts.instance;
 
     const result = [];
     result.push('--bind_ip', ip || '127.0.0.1');
     if (port) result.push('--port', port.toString());
     if (storageEngine) result.push('--storageEngine', storageEngine);
     if (dbPath) result.push('--dbpath', dbPath);
-    result.push('--noauth');
+    if (!auth) result.push('--noauth');
+    if (replSet) result.push('--replSet', replSet);
 
-    return result;
+    return result.concat(args || []);
   }
 
   async run(): Promise<MongodbInstance> {

src/util/__tests__/MongoInstance-test.js

@@ -37,6 +37,59 @@ describe('MongoInstance', () => {
     ]);
   });
 
+  it('should allow specifying replSet', () => {
+    const inst = new MongoInstance({
+      instance: {
+        port: 27555,
+        dbPath: '/data',
+        replSet: 'testset',
+      },
+    });
+    expect(inst.prepareCommandArgs()).toEqual([
+      '--bind_ip',
+      '127.0.0.1',
+      '--port',
+      '27555',
+      '--dbpath',
+      '/data',
+      '--noauth',
+      '--replSet',
+      'testset',
+    ]);
+  });
+
+  it('should be able to enable auth', () => {
+    const inst = new MongoInstance({
+      instance: {
+        port: 27555,
+        dbPath: '/data',
+        auth: true,
+      },
+    });
+    expect(inst.prepareCommandArgs()).toEqual([
+      '--bind_ip',
+      '127.0.0.1',
+      '--port',
+      '27555',
+      '--dbpath',
+      '/data',
+    ]);
+  });
+
+  it('should be able to pass arbitrary args', () => {
+    const args = ['--notablescan', '--nounixsocket'];
+    const inst = new MongoInstance({
+      instance: {
+        port: 27555,
+        dbPath: '/data',
+        args,
+      },
+    });
+    expect(inst.prepareCommandArgs()).toEqual(
+      ['--bind_ip', '127.0.0.1', '--port', '27555', '--dbpath', '/data', '--noauth'].concat(args)
+    );
+  });
+
   it('should start instance on port 27333', async () => {
     const mongod = await MongoInstance.run({
       instance: { port: 27333, dbPath: tmpDir.name },