Phase 1 - Configure, initialize, connect and disconnect clients

bin/__tests__/commands/run.test.js

@@ -1,7 +1,84 @@
+const ObjectId = require('bson-objectid');
+
+const WeaverMongoClient = require('../../../src/clients/mongodb');
 const run = require('../../commands/run');
+const {
+  _isValidConfig,
+  _parseClients,
+  _parseQueries,
+  parse,
+} = require('../../commands/run/index');
 
-describe('weaver run command tests', () => {
-  test('Base behavior', () => {
+describe('weaver-cli run command integrity', () => {
+  test('Command has the expected properties', () => {
     expect(run).not.toBe(undefined);
+    expect(run.name).not.toBe(undefined);
+    expect(run.description).not.toBe(undefined);
+    expect(run.setup).toBeInstanceOf(Function);
+    expect(run.parse).toBeInstanceOf(Function);
+  });
+
+  test('Command options parsing', () => {
+    expect(parse).toBeInstanceOf(Function);
+    expect(parse({})).toMatchObject({});
+  });
+});
+
+describe('weaver-cli MongoDB options and client parsing', () => {
+  const validType = 'source';
+  const validDbURL = 'test://';
+  const validDbName = 'test';
+  const validDataClient = {
+    family: 'mongodb',
+    type: validType,
+    db: {
+      url: validDbURL,
+      name: validDbName,
+      options: {},
+    },
+  };
+  const validDataClients = [validDataClient];
+  const validQuery = '507f1f77bcf86cd799439011';
+  const validQueries = [validQuery];
+  const validConfig = {
+    queries: validQueries,
+    dataClients: validDataClients,
+  };
+
+  test('weaver-cli MongoDB client parsing', () => {
+    const parsedClients = _parseClients(validDataClients);
+
+    expect(_parseClients).toBeInstanceOf(Function);
+    expect(parsedClients).toBeInstanceOf(Array);
+
+    parsedClients.forEach((client) => {
+      expect(client).toBeInstanceOf(WeaverMongoClient);
+    });
+  });
+
+  test('weaver-cli MongoDB query parsing', () => {
+    const parsedQueries = _parseQueries(validQueries);
+
+    expect(_parseQueries).toBeInstanceOf(Function);
+    expect(parsedQueries).toBeInstanceOf(Array);
+    parsedQueries.forEach((query) => {
+      expect(query._id).toBeInstanceOf(ObjectId);
+    });
+  });
+
+  test('weaver-cli MongoDB options validation', () => {
+    const invalidConfig1 = { queries: [], dataClients: [] };
+    const invalidConfig2 = { queries: {}, dataClients: {} };
+    const invalidConfig3 = { queries: 'any', dataClients: 'any' };
+    const invalidConfig4 = { other: 'value' };
+    const expectedWhenValid = { validConfig: true, hasQueries: true, hasDataClients: true };
+    const expectedWhenInvalid = { validConfig: false, hasQueries: false, hasDataClients: false };
+
+    expect(_isValidConfig).toBeInstanceOf(Function);
+    expect(_isValidConfig(invalidConfig1)).toMatchObject(expectedWhenInvalid);
+    expect(_isValidConfig(invalidConfig2)).toMatchObject(expectedWhenInvalid);
+    expect(_isValidConfig(invalidConfig3)).toMatchObject(expectedWhenInvalid);
+    expect(_isValidConfig(invalidConfig4)).toMatchObject(expectedWhenInvalid);
+    expect(_isValidConfig(validConfig)).toMatchObject(expectedWhenValid);
   });
 });

bin/commands/run.js

@@ -1,60 +1,8 @@
-const Debug = require('debug');
-const shell = require('shelljs');
-const ObjectId = require('bson-objectid');
-const ldLang = require('lodash');
-
-const {
-  getConfig,
-} = require('../lib/config');
-const Weaver = require('../../src');
-const WeaverMongoClient = require('../../src/clients/mongodb');
-
-const logging = Debug('Weaver:bin:commands:run');
-const clientsByFamily = {
-  mongodb: WeaverMongoClient,
-};
+const { parse } = require('./run/');
 
 module.exports = {
   name: 'run',
   description: 'Runs the app with the loaded configuration',
   setup: (yargs) => yargs,
-  parse: (_argv) => {
-    logging(`getting config from argv ${_argv}`);
-    const config = getConfig(_argv);
-    const configStr = JSON.stringify(config, null, 2);
-    let message = `Running with the current configuration"\n ${configStr}`;
-    const hasQueries = !ldLang.isEmpty(config.queries);
-    const hasDataClients = !ldLang.isEmpty(config.dataClients);
-    const validConfig = hasDataClients && hasQueries;
-
-    if (!hasDataClients) {
-      message = `Error: dataClients not set, try:
-      weaver add [client|query|ignore]
-      `;
-    }
-    if (!hasQueries) {
-      message = `Error: queries not set, try:
-      weaver run --queries <a document id>
-      `;
-    }
-    shell.echo(message);
-    if (!validConfig) return _argv;
-
-    // TODO: need to delegate this conversion to each client
-    // once starting to add new client families
-    config.dataClients = config.dataClients.map((c) => {
-      const ClientConstructor = clientsByFamily[c.family];
-      if (ClientConstructor) { return new ClientConstructor(c); }
-      return c;
-    });
-    config.queries = config.queries.map((q) => ({ _id: ObjectId(q) }));
-
-    const weaver = new Weaver(config);
-    weaver.run((result) => {
-      logging('Result', result);
-      shell.echo('Done');
-      weaver.disconnect(process.exit);
-    });
-    return _argv;
-  },
+  parse,
 };

bin/commands/run/index.js

@@ -0,0 +1,114 @@
+const Debug = require('debug');
+const shell = require('shelljs');
+const ObjectId = require('bson-objectid');
+const ldLang = require('lodash/lang');
+const ldObject = require('lodash/object');
+const ldColl = require('lodash/collection');
+
+const {
+  getConfig,
+} = require('../../lib/config');
+const Weaver = require('../../../src');
+const WeaverMongoClient = require('../../../src/clients/mongodb');
+
+const logging = Debug('Weaver:bin:commands:run');
+const clientsByFamily = {
+  mongodb: WeaverMongoClient,
+};
+
+// TODO: once starting to add new client families,
+// add `family` as required second param, as it will be used to define clients and queries
+const _hasValidQueries = (queries) => {
+  let validQueries = ldLang.isArray(queries);
+  validQueries = validQueries && !ldLang.isEmpty(queries);
+  validQueries = validQueries && !ldLang.isEmpty(queries[0]);
+  validQueries = validQueries && ldColl.every(queries, ObjectId.isValid);
+  return validQueries;
+};
+
+// TODO: once starting to add new client families,
+// add `family` as required second param, as it will be used to define clients and queries
+const _hasValidDataClient = (dataClient) => {
+  let validDataClient = ldLang.isObject(dataClient);
+  validDataClient = validDataClient && ldObject.hasIn(dataClient, 'type');
+  validDataClient = validDataClient && (dataClient.type === 'target' || dataClient.type === 'source');
+  validDataClient = validDataClient && ldObject.hasIn(dataClient, 'db');
+  validDataClient = validDataClient && ldObject.hasIn(dataClient, 'db.url');
+  validDataClient = validDataClient && ldObject.hasIn(dataClient, 'db.name');
+  validDataClient = validDataClient && ldObject.hasIn(dataClient, 'db.options');
+  validDataClient = validDataClient && ldLang.isObject(dataClient.db.options);
+  return validDataClient;
+};
+
+// TODO: once starting to add new client families,
+// add `family` as required second param, as it will be used to define clients and queries
+const _hasValidDataClientss = (dataClients) => {
+  let validDataClients = ldLang.isArray(dataClients);
+  validDataClients = validDataClients && !ldLang.isEmpty(dataClients);
+  validDataClients = validDataClients && ldColl.every(dataClients, _hasValidDataClient);
+  return validDataClients;
+};
+
+// TODO: once starting to add new client families,
+// add `family` as required second param, as it will be used to define clients and queries
+const _parseClients = (dataClients) => dataClients.map((c) => {
+  const ClientConstructor = clientsByFamily[c.family];
+  if (ClientConstructor) { return new ClientConstructor(c); }
+  return c;
+});
+
+// TODO: once starting to add new client families,
+// add `family` as required second param, as it will be used to define clients and queries
+const _parseQueries = (queries) => {
+  const parsedQueries = queries.map((q) => ({ _id: ObjectId(q) }));
+  return parsedQueries;
+};
+
+const _isValidConfig = (config) => {
+  const hasQueries = _hasValidQueries(config.queries);
+  const hasDataClients = _hasValidDataClientss(config.dataClients);
+  const validConfig = hasDataClients && hasQueries;
+  return { hasQueries, hasDataClients, validConfig };
+};
+
+const parse = (_argv) => {
+  logging(`getting config from argv ${_argv}`);
+  const config = getConfig(_argv);
+  const configStr = JSON.stringify(config, null, 2);
+  let message = `Running with the current configuration"\n ${configStr}`;
+  const { validConfig, hasQueries, hasDataClients } = _isValidConfig(config);
+
+  if (!hasDataClients) {
+    message = `Error: dataClients not set, try:
+    weaver add client
+    `;
+  }
+  if (!hasQueries) {
+    message = `Error: queries not set, try:
+    weaver run --queries <a document id>
+    `;
+  }
+  shell.echo(message);
+  if (!validConfig) return _argv;
+
+  config.dataClients = _parseClients(config.dataClients);
+  config.queries = _parseQueries(config.queries);
+
+  const weaver = new Weaver(config);
+  weaver.run((result) => {
+    logging('Result', result);
+    shell.echo('Done');
+    weaver.disconnect(process.exit);
+  });
+  return _argv;
+};
+
+module.exports = {
+  _hasValidQueries,
+  _hasValidDataClient,
+  _hasValidDataClientss,
+  _isValidConfig,
+  _parseClients,
+  _parseQueries,
+  parse,
+};

package.json

@@ -14,9 +14,9 @@
     "dev": "DEBUG=* nodemon --config ./nodemon.json ./src/index.js",
     "debug-install": "MONGOMS_DEBUG=1 npm install --foreground-scripts",
     "test": "jest --runInBand",
-    "test-debug": "jest --clearCache && MONGOMS_DEBUG=1 DEBUG=Weaver* jest --runInBand --detectOpenHandles --debug",
-    "test-dev": "MONGOMS_DEBUG=1 jest --runInBand --detectOpenHandles --onlyChanged",
-    "test-coverage": "jest  --runInBand --detectOpenHandles --coverage --coverageReporters=text-lcov | coveralls"
+    "test-debug": "jest --clearCache && MONGOMS_DEBUG=1 DEBUG=Weaver* jest --runInBand --detectOpenHandles --silent=false --debug",
+    "test-dev": "jest --runInBand --detectOpenHandles --onlyChanged --silent=false",
+    "test-coverage": "jest --runInBand --detectOpenHandles --coverage --coverageReporters=text-lcov | coveralls"
   },
   "bin": {
     "weaver": "dist/bin/cli.js"