feat(mem-check): add skip flag

Author: vikaspotluri123

lib/commands/doctor/checks/check-memory.js

@@ -16,5 +16,6 @@ function checkMemory() {
 module.exports = {
     title: 'Checking memory availability',
     task: checkMemory,
+    enabled: ctx => ctx.argv['check-mem'] === true,
     category: ['install', 'start', 'update']
 };

lib/commands/doctor/index.js

@@ -56,5 +56,13 @@ DoctorCommand.description = 'Check the system for any potential hiccups when ins
 DoctorCommand.longDescription = '$0 doctor [categories..]\n Run various checks to determine potential problems with your environment.'
 DoctorCommand.params = '[categories..]';
 DoctorCommand.global = true;
+DoctorCommand.options = {
+    'check-mem': {
+        alias: 'mem-check',
+        description: '[--no-check-mem] Enable/Disable memory availability checks',
+        type: 'boolean',
+        default: true
+    }
+}
 
 module.exports = DoctorCommand;

lib/commands/install.js

@@ -3,18 +3,19 @@ const path = require('path');
 const Command = require('../command');
 const symlinkSync = require('symlink-or-copy').sync;
 const SetupCommand = require('./setup');
+const DoctorCommand = require('./doctor');
 
 class InstallCommand extends Command {
     static configureOptions(commandName, yargs, extensions) {
         yargs = super.configureOptions(commandName, yargs, extensions);
+        yargs = DoctorCommand.configureOptions('doctor', yargs, extensions, true);
         return SetupCommand.configureOptions('setup', yargs, extensions, true);
     }
 
     run(argv) {
         const fs = require('fs-extra');
         const every = require('lodash/every');
         const errors = require('../errors');
-        const DoctorCommand = require('./doctor');
         const yarnInstall = require('../tasks/yarn-install');
         const ensureStructure = require('../tasks/ensure-structure');
 

lib/commands/start.js

@@ -1,5 +1,6 @@
 'use strict';
 const Command = require('../command');
+const DoctorCommand = require('./doctor');
 
 class StartCommand extends Command {
     static configureOptions(commandName, yargs, extensions) {
@@ -15,11 +16,11 @@ class StartCommand extends Command {
             Object.assign(this.options, omit(options, Object.keys(this.options)));
         });
 
-        return super.configureOptions(commandName, yargs, extensions);
+        yargs = super.configureOptions(commandName, yargs, extensions);
+        return DoctorCommand.configureOptions('doctor', yargs, extensions, true);
     }
 
     run(argv) {
-        const DoctorCommand = require('./doctor');
         const ProcessManager = require('../process-manager');
 
         const instance = this.system.getInstance();

lib/commands/update.js

@@ -5,13 +5,18 @@ const path = require('path');
 // Utils
 const errors = require('../errors');
 const Command = require('../command');
+const DoctorCommand = require('./doctor');
 
 class UpdateCommand extends Command {
+    static configureOptions(commandName, yargs, extensions) {
+        yargs = super.configureOptions(commandName, yargs, extensions);
+        return DoctorCommand.configureOptions('doctor', yargs, extensions, true);
+    }
+
     run(argv) {
         const chalk = require('chalk');
         const semver = require('semver');
 
-        const DoctorCommand = require('./doctor');
         const MigrateCommand = require('./migrate');
         const migrate = require('../tasks/migrate');
 

test/unit/commands/doctor/checks/check-memory-spec.js

@@ -19,25 +19,43 @@ describe('Unit: Doctor Checks > Memory', function () {
 
         expect(checkMem.title).to.equal('Checking memory availability');
         expect(checkMem.task).to.be.a('function');
+        expect(checkMem.enabled).to.a('function');
         expect(checkMem.category).to.deep.equal(['install', 'start', 'update']);
     });
 
-    it('errors if not enough memory is available', function () {
+    it('enabled is determined by check-mem argument', function () {
+        const memCheck = require(modulePath);
+        const ctx = {
+            argv: {'check-mem': false}
+        };
+
+        expect(memCheck.enabled(ctx)).to.be.false;
+        ctx.argv['check-mem'] = true;
+        expect(memCheck.enabled(ctx)).to.be.true;
+    });
+
+    it('fails if not enough memory is available', function () {
         const osStub = sandbox.stub(os, 'freemem').returns(10);
         const memCheck = require(modulePath);
+        const ctx = {
+            argv: {'check-mem': true}
+        };
 
-        return memCheck.task().catch((error) => {
+        return memCheck.task(ctx).catch((error) => {
             expect(error).to.be.an.instanceof(errors.SystemError);
             expect(error.message).to.match(/MB of memory available for smooth operation/);
             expect(osStub.calledOnce).to.be.true;
         });
     });
 
-    it('works if there is enough memory', function () {
+    it('passes if there is enough memory', function () {
         const osStub = sandbox.stub(os, 'freemem').returns(157286400);
         const memCheck = require(modulePath);
+        const ctx = {
+            argv: {'check-mem': true}
+        };
 
-        return memCheck.task().then(() => {
+        return memCheck.task(ctx).then(() => {
             expect(osStub.calledOnce).to.be.true;
         });
     });

test/unit/commands/install-spec.js

@@ -9,16 +9,18 @@ const modulePath = '../../../lib/commands/install';
 const errors = require('../../../lib/errors');
 
 describe('Unit: Commands > Install', function () {
-    it('configureOptions adds setup options as well', function () {
+    it('configureOptions adds setup & doctor options', function () {
         const superStub = sinon.stub().returnsArg(1);
         const setupStub = sinon.stub().returnsArg(1);
+        const doctorStub = sinon.stub().returnsArg(1);
 
         // Needed for extension
         class Command {}
         Command.configureOptions = superStub;
 
         const InstallCommand = proxyquire(modulePath, {
             './setup': {configureOptions: setupStub},
+            './doctor': {configureOptions: doctorStub},
             '../command': Command
         });
 
@@ -28,6 +30,8 @@ describe('Unit: Commands > Install', function () {
         expect(superStub.calledWithExactly('install', {yargs: true}, [{extensiona: true}])).to.be.true;
         expect(setupStub.calledOnce).to.be.true;
         expect(setupStub.calledWithExactly('setup', {yargs: true}, [{extensiona: true}], true)).to.be.true;
+        expect(doctorStub.calledOnce).to.be.true;
+        expect(doctorStub.calledWithExactly('doctor', {yargs: true}, [{extensiona: true}], true)).to.be.true;
     });
 
     describe('run', function () {

test/unit/commands/start-spec.js

@@ -219,8 +219,11 @@ describe('Unit: Commands > Start', function () {
         });
     });
 
-    // @todo: Add more tests if necessary
     it('configureOptions loops over extensions', function () {
+        const doctorStub = sinon.stub().returnsArg(1);
+        const StartCommand = proxyquire(modulePath, {
+            './doctor': {configureOptions: doctorStub}
+        });
         const extensions = [{
             config: {options: {start: {test: true}}}
         }, {}];
@@ -230,5 +233,6 @@ describe('Unit: Commands > Start', function () {
         StartCommand.configureOptions.call({options: {}}, 'Test', yargs, extensions, true);
         expect(yargs.option.called).to.be.true;
         expect(yargs.option.args[0][0]).to.equal('test');
+        expect(doctorStub.calledOnce).to.be.true;
     });
 });

test/unit/commands/update-spec.js

@@ -13,6 +13,25 @@ const errors = require('../../../lib/errors');
 const Instance = require('../../../lib/instance');
 
 describe('Unit: Commands > Update', function () {
+    it('configureOptions adds setup & doctor options', function () {
+        const superStub = sinon.stub().returnsArg(1);
+        const doctorStub = sinon.stub().returnsArg(1);
+
+        // Needed for extension
+        class Command {}
+        Command.configureOptions = superStub;
+
+        const InstallCommand = proxyquire(modulePath, {
+            './doctor': {configureOptions: doctorStub},
+            '../command': Command
+        });
+
+        const result = InstallCommand.configureOptions('install', {yargs: true}, [{extensiona: true}]);
+        expect(result).to.deep.equal({yargs: true});
+        expect(superStub.calledOnce).to.be.true;
+        expect(superStub.calledWithExactly('install', {yargs: true}, [{extensiona: true}])).to.be.true;
+    });
+
     describe('run', function () {
         it('doesn\'t run tasks if no new versions are available', function () {
             const UpdateCommand = require(modulePath);