refactor: reverse MD5 check logic. Now by default it's disabled.

BREAKING CHANGE: Reverse MD5 check logic. Now by default it's disabled.

`MONGOMS_SKIP_MD5_CHECK` was removed
`MONGOMS_MD5_CHECK` was added. Should be `true` if you want to enable md5 check. But who cares this checks if we just need blazing fast tests?

Related typegoose#131

Author: nodkz

README.md

@@ -62,15 +62,17 @@ const mongod = new MongoMemoryServer({
     platform?: string, // by default os.platform()
     arch?: string, // by default os.arch()
     debug?: boolean, // by default false
-    skipMD5?: boolean, // by default false OR process.env.MONGOMS_SKIP_MD5_CHECK
+    checkMD5?: boolean, // by default false OR process.env.MONGOMS_MD5_CHECK
     systemBinary?: string, // by default undefined or process.env.MONGOMS_SYSTEM_BINARY
   },
   debug?: boolean, // by default false
   autoStart?: boolean, // by default true
 });
 ```
+
 Also you can use the environment variables for configure installation process
-```
+
+```txt
 MONGOMS_DOWNLOAD_DIR=/path/to/mongodb/binaries
 MONGOMS_PLATFORM=linux
 MONGOMS_ARCH=x64
@@ -79,11 +81,12 @@ MONGOMS_DEBUG=1 # also available case-insensitive values: "on" "yes" "true"
 MONGOMS_DOWNLOAD_MIRROR=url # your mirror url to download the mongodb binary
 MONGOMS_DISABLE_POSTINSTALL=1 # if you want to skip download binaries on `npm i` command
 MONGOMS_SYSTEM_BINARY=/usr/local/bin/mongod # if you want to use an existing binary already on your system.
-MONGOMS_SKIP_MD5_CHECK=1 # if you want to skip MD5 check of downloaded binary.
-# Passed constructor parameter `binary.skipMD5` has higher priority.
+MONGOMS_MD5_CHECK=1 # if you want to make MD5 check of downloaded binary.
+# Passed constructor parameter `binary.checkMD5` has higher priority.
 ```
 
 ### Replica Set start:
+
 ```js
 import { MongoMemoryReplSet } from 'mongodb-memory-server';
 

src/util/MongoBinaryDownload.d.ts

@@ -12,6 +12,7 @@ export default class MongoBinaryDownload {
   debug: DebugFn;
   dlProgress: DownloadProgressT;
 
+  checkMD5: boolean;
   downloadDir: string;
   arch: string;
   version: string;
@@ -20,7 +21,7 @@ export default class MongoBinaryDownload {
   constructor(opts: MongoBinaryDownloadOpts);
   getMongodPath(): Promise<string>;
   startDownload(): Promise<string>;
-  checkMd5(mongoDBArchiveMd5: string, mongoDBArchive: string): Promise<void>;
+  makeMd5check(mongoDBArchiveMd5: string, mongoDBArchive: string): Promise<void>;
   download(downloadUrl: string): Promise<string>;
   extract(mongoDBArchive: string): Promise<string>;
   httpDownload(

src/util/MongoBinaryDownload.js

@@ -18,14 +18,14 @@ export type MongoBinaryDownloadOpts = {
   platform: string,
   arch: string,
   debug?: DebugPropT,
-  skipMD5?: boolean,
+  checkMD5?: boolean,
 };
 
 export default class MongoBinaryDownload {
   debug: DebugFn;
   dlProgress: DownloadProgressT;
 
-  skipMD5: boolean;
+  checkMD5: boolean;
   downloadDir: string;
   arch: string;
   version: string;
@@ -36,19 +36,19 @@ export default class MongoBinaryDownload {
     arch,
     downloadDir,
     version,
-    skipMD5,
+    checkMD5,
     debug,
   }: $Shape<MongoBinaryDownloadOpts>) {
     this.platform = platform || os.platform();
     this.arch = arch || os.arch();
     this.version = version || 'latest';
     this.downloadDir = path.resolve(downloadDir || 'mongodb-download');
-    if (skipMD5 === undefined) {
-      this.skipMD5 =
-        typeof process.env.MONGOMS_SKIP_MD5_CHECK === 'string' &&
-        ['1', 'on', 'yes', 'true'].indexOf(process.env.MONGOMS_SKIP_MD5_CHECK.toLowerCase()) !== -1;
+    if (checkMD5 === undefined) {
+      this.checkMD5 =
+        typeof process.env.MONGOMS_MD5_CHECK === 'string' &&
+        ['1', 'on', 'yes', 'true'].indexOf(process.env.MONGOMS_MD5_CHECK.toLowerCase()) !== -1;
     } else {
-      this.skipMD5 = skipMD5;
+      this.checkMD5 = checkMD5;
     }
     this.dlProgress = {
       current: 0,
@@ -100,13 +100,13 @@ export default class MongoBinaryDownload {
     const downloadUrl = await mbdUrl.getDownloadUrl();
     const mongoDBArchive = await this.download(downloadUrl);
 
-    await this.checkMD5(`${downloadUrl}.md5`, mongoDBArchive);
+    await this.makeMD5check(`${downloadUrl}.md5`, mongoDBArchive);
 
     return mongoDBArchive;
   }
 
-  async checkMD5(urlForReferenceMD5: string, mongoDBArchive: string): Promise<?boolean> {
-    if (this.skipMD5) {
+  async makeMD5check(urlForReferenceMD5: string, mongoDBArchive: string): Promise<?boolean> {
+    if (!this.checkMD5) {
       return undefined;
     }
     const mongoDBArchiveMd5 = await this.download(urlForReferenceMD5);

src/util/__tests__/MongoBinaryDownload-test.js

@@ -12,16 +12,16 @@ describe('MongoBinaryDownload', () => {
     delete process.env.MONGOMS_SKIP_MD5_CHECK;
   });
 
-  it('skipMD5 attribute can be set via constructor parameter', () => {
-    expect(new MongoBinaryDownload({ skipMD5: true }).skipMD5).toBe(true);
-    expect(new MongoBinaryDownload({ skipMD5: false }).skipMD5).toBe(false);
+  it('checkMD5 attribute can be set via constructor parameter', () => {
+    expect(new MongoBinaryDownload({ checkMD5: true }).checkMD5).toBe(true);
+    expect(new MongoBinaryDownload({ checkMD5: false }).checkMD5).toBe(false);
   });
 
-  it(`if skipMD5 input parameter is missing, then it checks 
-MONGOMS_SKIP_MD5_CHECK environment variable`, () => {
-    expect(new MongoBinaryDownload({}).skipMD5).toBe(false);
-    process.env.MONGOMS_SKIP_MD5_CHECK = '1';
-    expect(new MongoBinaryDownload({}).skipMD5).toBe(true);
+  it(`if checkMD5 input parameter is missing, then it checks 
+MONGOMS_MD5_CHECK environment variable`, () => {
+    expect(new MongoBinaryDownload({}).checkMD5).toBe(false);
+    process.env.MONGOMS_MD5_CHECK = '1';
+    expect(new MongoBinaryDownload({}).checkMD5).toBe(true);
   });
 
   it('should use direct download', async () => {
@@ -56,7 +56,7 @@ MONGOMS_SKIP_MD5_CHECK environment variable`, () => {
     expect(callArg1.agent.options.href).toBe('http://user:pass@proxy:8080/');
   });
 
-  it(`checkMD5 returns true if md5 of downloaded mongoDBArchive is
+  it(`makeMD5check returns true if md5 of downloaded mongoDBArchive is
 the same as in the reference result`, () => {
     const someMd5 = 'md5';
     fs.readFileSync.mockImplementationOnce(() => `${someMd5} fileName`);
@@ -67,33 +67,35 @@ the same as in the reference result`, () => {
     // $FlowFixMe
     du.download = jest.fn(() => Promise.resolve(fileWithReferenceMd5));
     const urlToMongoDBArchivePath = 'some-url';
-    return du.checkMD5(urlToMongoDBArchivePath, mongoDBArchivePath).then(res => {
+    du.checkMD5 = true;
+    return du.makeMD5check(urlToMongoDBArchivePath, mongoDBArchivePath).then(res => {
       expect(res).toBe(true);
       expect(du.download).toBeCalledWith(urlToMongoDBArchivePath);
       expect(fs.readFileSync).toBeCalledWith(fileWithReferenceMd5);
       expect(md5file.sync).toBeCalledWith(mongoDBArchivePath);
     });
   });
 
-  it(`checkMD5 throws an error if md5 of downloaded mongoDBArchive is NOT
+  it(`makeMD5check throws an error if md5 of downloaded mongoDBArchive is NOT
   the same as in the reference result`, () => {
     fs.readFileSync.mockImplementationOnce(() => 'someMd5 fileName');
     md5file.sync.mockImplementationOnce(() => 'anotherMd5');
     const du = new MongoBinaryDownload({});
+    du.checkMD5 = true;
     // $FlowFixMe
     du.download = jest.fn(() => Promise.resolve(''));
-    expect(du.checkMD5('', '')).rejects.toMatchInlineSnapshot(
+    expect(du.makeMD5check('', '')).rejects.toMatchInlineSnapshot(
       `[Error: MongoBinaryDownload: md5 check is failed]`
     );
   });
 
-  it('true value of skipMD5 attribute disables checkMD5 validation', () => {
+  it('false value of checkMD5 attribute disables makeMD5check validation', () => {
     expect.assertions(1);
     fs.readFileSync.mockImplementationOnce(() => 'someMd5 fileName');
     md5file.sync.mockImplementationOnce(() => 'anotherMd5');
     const du = new MongoBinaryDownload({});
-    du.skipMD5 = true;
-    return du.checkMD5('', '').then(res => {
+    du.checkMD5 = false;
+    return du.makeMD5check('', '').then(res => {
       expect(res).toBe(undefined);
     });
   });