navy 6.0.0 → 7.0.0-alpha.2

package/lib/cli/doctor/__tests__/util.js

@@ -0,0 +1,91 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _chai = require("chai");
+var _sinon = _interopRequireDefault(require("sinon"));
+var _util = require("../util");
+/* eslint-env mocha */
+
+describe('cli/doctor/util', function () {
+  let sandbox;
+  let consoleLogStub;
+  beforeEach(function () {
+    sandbox = _sinon.default.createSandbox();
+    consoleLogStub = sandbox.stub(console, 'log');
+  });
+  afterEach(function () {
+    sandbox.restore();
+  });
+  describe('fix', function () {
+    it('should throw an invariant violation when no callback is provided', async function () {
+      let caught;
+      try {
+        await (0, _util.fix)('a message');
+      } catch (err) {
+        caught = err;
+      }
+      (0, _chai.expect)(caught).to.be.an('error');
+      (0, _chai.expect)(caught.message).to.contain('DOCTOR_FIX_NO_PARAMS');
+    });
+    it('should print the formatted message and call the callback', async function () {
+      const callback = sandbox.stub().resolves();
+      await (0, _util.fix)('Found %s, removing', 'env-1', callback);
+      (0, _chai.expect)(consoleLogStub.calledOnce).to.equal(true);
+      const printed = consoleLogStub.firstCall.args[0];
+      (0, _chai.expect)(printed).to.contain('Found env-1, removing');
+      (0, _chai.expect)(callback.calledOnce).to.equal(true);
+    });
+    it('should await the callback before resolving', async function () {
+      let resolved = false;
+      const callback = sandbox.stub().callsFake(() => new Promise(resolve => {
+        setImmediate(() => {
+          resolved = true;
+          resolve();
+        });
+      }));
+      await (0, _util.fix)('msg', callback);
+      (0, _chai.expect)(resolved).to.equal(true);
+    });
+  });
+  describe('start', function () {
+    it('should log a dimmed message with arrow prefix', function () {
+      (0, _util.start)('Doing thing');
+      (0, _chai.expect)(consoleLogStub.calledOnce).to.equal(true);
+      const printed = consoleLogStub.getCalls().map(c => c.args.join(' ')).join(' ');
+      (0, _chai.expect)(printed).to.contain('----->');
+      (0, _chai.expect)(printed).to.contain('Doing thing');
+    });
+  });
+  describe('catchInvariant', function () {
+    it('should call the catch callback when fn throws an Invariant Violation matching the code', async function () {
+      const catchCallback = sandbox.stub().resolves();
+      const err = new Error('MY_CODE: failure happened');
+      err.name = 'Invariant Violation';
+      await (0, _util.catchInvariant)('MY_CODE', async () => {
+        throw err;
+      }, catchCallback);
+      (0, _chai.expect)(catchCallback.calledOnce).to.equal(true);
+    });
+    it('should not call the catch callback when fn throws a non-invariant error', async function () {
+      const catchCallback = sandbox.stub().resolves();
+      await (0, _util.catchInvariant)('MY_CODE', async () => {
+        throw new Error('some other error');
+      }, catchCallback);
+      (0, _chai.expect)(catchCallback.called).to.equal(false);
+    });
+    it('should not call the catch callback when invariant code does not match', async function () {
+      const catchCallback = sandbox.stub().resolves();
+      const err = new Error('OTHER_CODE: failure');
+      err.name = 'Invariant Violation';
+      await (0, _util.catchInvariant)('MY_CODE', async () => {
+        throw err;
+      }, catchCallback);
+      (0, _chai.expect)(catchCallback.called).to.equal(false);
+    });
+    it('should not call the catch callback when fn resolves without throwing', async function () {
+      const catchCallback = sandbox.stub().resolves();
+      await (0, _util.catchInvariant)('MY_CODE', async () => undefined, catchCallback);
+      (0, _chai.expect)(catchCallback.called).to.equal(false);
+    });
+  });
+});

package/lib/cli/doctor/clean-compose-files.js

@@ -1,33 +1,25 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = _default;
-
-var _bluebird = _interopRequireDefault(require("bluebird"));
-
 var _path = _interopRequireDefault(require("path"));
-
+var _fs = require("fs");
 var _ = require("../../");
-
 var _util = require("./util");
-
 var _state = require("../../navy/state");
-
 var _util2 = require("../../navy/util");
-
 async function _default() {
-  const rimraf = _bluebird.default.promisify(require('rimraf'));
-
   (0, _util.start)('Cleaning temporary Docker Compose files');
   const navyNames = await (0, _.getLaunchedNavyNames)();
   await Promise.all(navyNames.map(async navyName => {
     const navyPath = (0, _state.pathToNavy)((0, _util2.normaliseNavyName)(navyName));
-    await rimraf(_path.default.join(navyPath, 'docker-compose.tmp.yml'));
+    await _fs.promises.rm(_path.default.join(navyPath, 'docker-compose.tmp.yml'), {
+      recursive: true,
+      force: true
+    });
   }));
 }
-
 module.exports = exports.default;

package/lib/cli/doctor/index.js

@@ -1,23 +1,16 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = _default;
-
 var _chalk = _interopRequireDefault(require("chalk"));
-
 var _cleanComposeFiles = _interopRequireDefault(require("./clean-compose-files"));
-
 var _invalidState = _interopRequireDefault(require("./invalid-state"));
-
 var _invalidComposeConfig = _interopRequireDefault(require("./invalid-compose-config"));
-
 async function run(fns) {
   const errors = [];
-
   for (const fn of fns) {
     try {
       await fn();
@@ -25,20 +18,16 @@ async function run(fns) {
       errors.push(ex);
     }
   }
-
   return errors;
 }
-
 async function _default() {
   const errors = await run([_cleanComposeFiles.default, _invalidState.default, _invalidComposeConfig.default]);
-
   if (errors.length > 0) {
     console.log(_chalk.default.yellow('There were some issues'));
     console.log();
     errors.forEach(error => console.log(error.stack));
     return;
   }
-
   console.log();
   console.log(_chalk.default.green(' ✔ Finished tests'));
   console.log();
@@ -46,5 +35,4 @@ async function _default() {
   console.log(' If you still have problems, please open an issue at https://github.com/moneyhub/navy/issues/new');
   console.log();
 }
-
 module.exports = exports.default;

package/lib/cli/doctor/invalid-compose-config.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = _default;
-
 var _ = require("../../");
-
 var _util = require("./util");
-
 async function _default() {
   (0, _util.start)('Checking for Navies with invalid/no compose config');
   const navies = await (0, _.getLaunchedNavies)();
@@ -22,5 +19,4 @@ async function _default() {
     });
   }));
 }
-
 module.exports = exports.default;

package/lib/cli/doctor/invalid-state.js

@@ -4,24 +4,19 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = _default;
-
 var _ = require("../../");
-
 var _util = require("./util");
-
 async function _default() {
   (0, _util.start)('Checking for dangling Navies');
   const navies = await (0, _.getLaunchedNavies)();
   await Promise.all(navies.map(async navy => {
     const configProvider = await navy.getConfigProvider();
-
     if (!configProvider) {
       await (0, _util.fix)('Found Navy without config provider %s, removing', navy.name, async () => {
         await navy.delete();
       });
       return;
     }
-
     if (await configProvider.isDangling()) {
       await (0, _util.fix)('Found dangling Navy %s (invalid config), removing', navy.name, async () => {
         await navy.destroy();
@@ -29,5 +24,4 @@ async function _default() {
     }
   }));
 }
-
 module.exports = exports.default;

package/lib/cli/doctor/util.js

@@ -1,33 +1,24 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.start = exports.fix = exports.catchInvariant = void 0;
-
 var _util = _interopRequireDefault(require("util"));
-
 var _invariant = _interopRequireDefault(require("invariant"));
-
 var _chalk = _interopRequireDefault(require("chalk"));
-
 const fix = async (message, ...params) => {
   (0, _invariant.default)(params.length > 0, "DOCTOR_FIX_NO_PARAMS: Expected params to be passed to doctor fix");
   const fixCallback = params[params.length - 1];
   console.log(_chalk.default.yellow('----->', _util.default.format(message, ...params.slice(0, -1))));
   await fixCallback();
 };
-
 exports.fix = fix;
-
 const start = message => {
   console.log(_chalk.default.dim('----->', message));
 };
-
 exports.start = start;
-
 const catchInvariant = async (code, fn, catchCallback) => {
   try {
     await fn();
@@ -37,5 +28,4 @@ const catchInvariant = async (code, fn, catchCallback) => {
     }
   }
 };
-
 exports.catchInvariant = catchInvariant;

package/lib/cli/external-ip.js

@@ -4,15 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _config = require("../config");
-
 var _externalIp = require("../util/external-ip");
-
 var _default = async () => {
   const config = await (0, _config.getConfig)();
   console.log(await (0, _externalIp.getExternalIP)(config.externalIP));
 };
-
 exports.default = _default;
 module.exports = exports.default;

package/lib/cli/health.js

@@ -1,45 +1,33 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = _default;
-
 var _chalk = _interopRequireDefault(require("chalk"));
-
 var _ = require("../");
-
 var _table = _interopRequireDefault(require("../util/table"));
-
 function getStatus(service, state) {
   const health = service.raw && service.raw.State.Health;
-
   if (!health) {
     return '-';
   }
-
   const statusString = health.Status === 'healthy' ? _chalk.default.green('✔ Healthy') : _chalk.default.red('• Unhealthy');
   return statusString;
 }
-
 function getHistory(service, state) {
   const health = service.raw && service.raw.State.Health;
-
   if (!health) {
     return '-';
   }
-
   const history = health.Log;
   return history.map(record => record.ExitCode === 0 ? _chalk.default.green('█') : _chalk.default.red('x')).join(' ');
 }
-
 async function _default(opts) {
   const navy = (0, _.getNavy)(opts.navy);
   const ps = await navy.ps();
   const state = await navy.getState();
   console.log((0, _table.default)([['NAME', 'STATUS', 'HISTORY'], ...ps.map(service => [service.name, getStatus(service, state), getHistory(service, state)])]));
 }
-
 module.exports = exports.default;

package/lib/cli/https.js

@@ -1,75 +1,60 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = _default;
-
 var _chalk = _interopRequireDefault(require("chalk"));
-
 var _errors = require("../errors");
-
 var _navy = require("../navy");
-
 var _config = require("../config");
-
 var _httpProxy = require("../http-proxy");
-
 var _https = require("../util/https");
-
 var _fs = _interopRequireDefault(require("fs"));
-
 async function _default(services, opts) {
   const tlsRootCaDir = (0, _config.getConfig)().tlsRootCaDir || _config.DEFAULT_TLS_ROOT_CA_DIR;
-
   const configDir = (0, _config.getConfigDir)();
-
   if (opts.disable) {
     await (0, _https.removeCert)(opts);
+
+    // Guard isInitialised so `--disable` still works when the navy has
+    // never been launched (otherwise getNavyFile throws).
+    const navy = await (0, _navy.getNavy)(opts.navy);
+    const navyFile = (await navy.isInitialised()) ? await navy.getNavyFile() : undefined;
     await (0, _httpProxy.reconfigureHTTPProxy)({
-      restart: true
+      restart: true,
+      navyFile
     });
     console.log();
     console.log(_chalk.default.green(`✅ HTTPS for service ${opts.disable} is now disabled`));
     console.log();
     return;
   }
-
   if (!services || services.length === 0) {
     if (!_fs.default.existsSync(`${configDir}/tls-certs`)) return;
-
     const files = _fs.default.readdirSync(`${configDir}/tls-certs`);
-
     const urls = files.filter(file => file.endsWith('.crt')).map(crt => {
       return `https://${crt.replace('.crt', '')}`;
     });
-
     for (const url of urls) {
       console.log(`${url}`);
     }
-
     return;
   }
-
   if (!_fs.default.existsSync(`${tlsRootCaDir}/ca.crt`) || !_fs.default.existsSync(`${tlsRootCaDir}/ca.key`)) {
     await (0, _https.generateRootCa)();
   }
-
   const navy = await (0, _navy.getNavy)(opts.navy);
   await navy.ensurePluginsLoaded();
   const availableServices = await navy.getAvailableServiceNames();
   const httpsReadyServices = [];
-
   for (const service of services) {
     if (!availableServices.includes(service)) {
       console.log(`❌ ${service} not found, skipping`);
       continue;
     }
-
     const serviceUrl = await navy.url(service);
-
     try {
       await (0, _https.createCert)({
         serviceUrl
@@ -80,13 +65,12 @@ async function _default(services, opts) {
       throw new _errors.NavyError(`Could not generate TLS cert for ${service}`);
     }
   }
-
   await (0, _httpProxy.reconfigureHTTPProxy)({
-    restart: true
+    restart: true,
+    navyFile: await navy.getNavyFile()
   });
   console.log();
   console.log(_chalk.default.green(`✅ Service(s) ${httpsReadyServices.join(', ')} now accessible via HTTPS🔒`));
   console.log();
 }
-
 module.exports = exports.default;

package/lib/cli/import.js

@@ -1,38 +1,26 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = _default;
-
 var _path = _interopRequireDefault(require("path"));
-
 var _chalk = _interopRequireDefault(require("chalk"));
-
 var _fs = _interopRequireDefault(require("../util/fs"));
-
 var _ = require("../");
-
 var _configProvider = require("../config-provider");
-
 var _util = require("./util");
-
 async function _default(opts) {
   const navy = (0, _.getNavy)(opts.navy);
-
   const boatAsciiArt = _fs.default.readFileSync(_path.default.join(__dirname, '../../resources/sailing-boat.txt')).toString();
-
   const initialiseOpts = await (0, _configProvider.getImportOptionsForCLI)(opts);
   await (0, _util.importNavy)(navy, initialiseOpts);
   console.log(` You can now use ${_chalk.default.bold('navy')} commands from any directory to control this Navy.`);
   console.log();
-
   if (process.stdout.isTTY) {
     console.log(boatAsciiArt);
     console.log();
   }
 }
-
 module.exports = exports.default;

package/lib/cli/index.js

@@ -1,19 +1,12 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 var _package = _interopRequireDefault(require("../../package.json"));
-
 var _program = _interopRequireDefault(require("./program"));
-
 var _errors = require("../errors");
-
 const debug = require('debug')('navy:cli');
-
 _program.default.version(_package.default.version);
-
 _program.default.command('help').alias('*').action(() => _program.default.help());
-
 try {
   _program.default.parse(process.argv);
 } catch (ex) {
@@ -23,9 +16,7 @@ try {
     throw ex;
   }
 }
-
 debug('Invoked CLI action');
-
 if (_program.default.args.length === 0) {
   _program.default.help();
 }

package/lib/cli/lan-ip.js

@@ -1,23 +1,18 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = _default;
-
 var _chalk = _interopRequireDefault(require("chalk"));
-
 var _getLanIp = require("../util/get-lan-ip");
-
 var _config = require("../config");
-
 var _reconfigure = require("./util/reconfigure");
-
 async function _default(navy) {
   const lanIP = await (0, _getLanIp.getLANIP)();
-  await (0, _config.setConfig)({ ...(0, _config.getConfig)(),
+  await (0, _config.setConfig)({
+    ...(0, _config.getConfig)(),
     externalIP: lanIP
   });
   await (0, _reconfigure.reconfigureAllNavies)();
@@ -25,5 +20,4 @@ async function _default(navy) {
   console.log(_chalk.default.green(` ✔ Now using your LAN IP address (${lanIP})`));
   console.log();
 }
-
 module.exports = exports.default;

package/lib/cli/launch.js

@@ -1,18 +1,13 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = _default;
-
 var _inquirer = _interopRequireDefault(require("inquirer"));
-
 var _util = require("./util");
-
 var _driverLogging = require("../driver-logging");
-
 const SELECTED_WEIGHT = 100; // make sure selected services appear at the top
 
 async function _default(services, opts) {
@@ -22,7 +17,6 @@ async function _default(services, opts) {
   const serviceNames = await navy.getAvailableServiceNames();
   const launchedServiceNames = await navy.getLaunchedServiceNames();
   const selectedServiceNames = launchedServiceNames.length > 0 ? launchedServiceNames : navyFile.launchDefaults || [];
-
   if (!services || services.length === 0) {
     const choices = serviceNames.sort(name => selectedServiceNames.indexOf(name) === -1 ? SELECTED_WEIGHT : -1).map(name => ({
       name,
@@ -38,15 +32,12 @@ async function _default(services, opts) {
     }]);
     services = selectedServices;
   }
-
   if (services.length === 0) {
     return;
   }
-
   await navy.emitAsync('cli.before.launch');
   (0, _driverLogging.startDriverLogging)('Launching services...');
   await navy.launch(services);
   (0, _driverLogging.stopDriverLogging)();
 }
-
 module.exports = exports.default;

package/lib/cli/live.js

@@ -1,46 +1,37 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = _default;
-
 var _chalk = _interopRequireDefault(require("chalk"));
-
 var _ = require("../");
-
 var _errors = require("../errors");
-
 var _navyrc = _interopRequireDefault(require("../util/navyrc"));
-
 async function _default(service, opts) {
   const navy = (0, _.getNavy)(opts.navy);
   const cwd = process.cwd();
   const navyRc = await (0, _navyrc.default)(cwd);
-
   if (navyRc && !navyRc.services) {
     throw new _errors.NavyError(`No valid .navyrc file was found in "${cwd}"`);
   }
-
   if (navyRc && navyRc.services.length > 1 && !service) {
     throw new _errors.NavyError('Multiple service mappings are defined in .navyrc, you need to explicitly specify what service to develop');
   }
-
   if (navyRc && !service) {
     service = navyRc.services[0];
   }
-
   const state = (await navy.getState()) || {};
-
   if (!state || !state.services || !state.services[service] || !state.services[service]._develop) {
     return console.log(_chalk.default.dim(`Nothing to do, ${service} is not in development`));
   }
-
-  await navy.saveState({ ...state,
-    services: { ...state.services,
-      [service]: { ...(state.services || {})[service],
+  await navy.saveState({
+    ...state,
+    services: {
+      ...state.services,
+      [service]: {
+        ...state.services[service],
         _develop: undefined
       }
     }
@@ -51,5 +42,4 @@ async function _default(service, opts) {
   });
   console.log(`${service} is no longer in development`);
 }
-
 module.exports = exports.default;

package/lib/cli/local-ip.js

@@ -1,20 +1,16 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = _default;
-
 var _chalk = _interopRequireDefault(require("chalk"));
-
 var _config = require("../config");
-
 var _reconfigure = require("./util/reconfigure");
-
 async function _default(navy) {
-  await (0, _config.setConfig)({ ...(0, _config.getConfig)(),
+  await (0, _config.setConfig)({
+    ...(0, _config.getConfig)(),
     externalIP: '127.0.0.1'
   });
   await (0, _reconfigure.reconfigureAllNavies)();
@@ -22,5 +18,4 @@ async function _default(navy) {
   console.log(_chalk.default.green(' ✔ Now using your local IP address (127.0.0.1)'));
   console.log();
 }
-
 module.exports = exports.default;

package/lib/cli/logs.js

@@ -4,12 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = _default;
-
 var _ = require("../");
-
 async function _default(services, opts) {
   const env = (0, _.getNavy)(opts.navy);
   await env.spawnLogStream(services);
 }
-
 module.exports = exports.default;