Add core options unit tests

Author: javierbrea

jest.config.js

@@ -17,10 +17,10 @@ module.exports = {
   // An object that configures minimum threshold enforcement for coverage results
   coverageThreshold: {
     global: {
-      branches: 70,
-      functions: 75,
-      lines: 75,
-      statements: 75
+      branches: 80,
+      functions: 78,
+      lines: 80,
+      statements: 80
     }
   },
 
@@ -43,9 +43,10 @@ module.exports = {
     "**/test/unit/core/mocks/FilesHandler.spec.js",
     "**/test/unit/core/mocks/Mocks.spec.js",
     "**/test/unit/core/server/Server.spec.js",
-    "**/test/unit/core/settings/CommandLineArguments.spec.js"
+    "**/test/unit/core/settings/CommandLineArguments.spec.js",
+    "**/test/unit/core/settings/Options.spec.js"
   ],
-  //testMatch: ["**/test/unit/core/settings/CommandLineArguments.spec.js"],
+  //testMatch: ["**/test/unit/core/settings/CommandLineArguments.spec.js", "**/test/unit/core/settings/Options.spec.js"],
 
   // The test environment that will be used for testing
   testEnvironment: "node"

lib/core/settings/CommandLineArguments.js

@@ -11,9 +11,10 @@ Unless required by applicable law or agreed to in writing, software distributed
 
 "use strict";
 
-const commander = require("commander");
 const { isUndefined } = require("lodash");
 
+const commander = require("commander");
+
 class CommandLineArguments {
   constructor(defaultOptions) {
     this._options = {};
@@ -33,10 +34,7 @@ class CommandLineArguments {
   }
 
   init() {
-    this._options = this._getDefinedOptions(
-      this._commander.parse(process.argv),
-      this._optionsNames
-    );
+    this._options = this._commander.parse(process.argv);
     return Promise.resolve();
   }
 
@@ -50,15 +48,6 @@ class CommandLineArguments {
     throw new Error("Invalid boolean value");
   }
 
-  _getDefinedOptions(options, keys) {
-    return keys.reduce((cleanObject, currentKey) => {
-      if (!isUndefined(options[currentKey])) {
-        cleanObject[currentKey] = options[currentKey];
-      }
-      return cleanObject;
-    }, {});
-  }
-
   addCustom(optionDetails) {
     const optionPrefix =
       optionDetails.type === "boolean" && optionDetails.default === true ? "--no-" : "--";

lib/core/settings/Options.js

@@ -9,6 +9,8 @@ http://www.apache.org/licenses/LICENSE-2.0
 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 */
 
+const { isUndefined } = require("lodash");
+
 const tracer = require("../tracer");
 
 const CommandLineArguments = require("./CommandLineArguments");
@@ -44,12 +46,14 @@ class Options {
     };
     if (!this._onlyProgrammaticOptions) {
       await this._commandLineArguments.init();
-      this._options = this._removeDeprecatedOptions({
-        ...baseOptions,
-        ...this._commandLineArguments.options
-      });
+      this._options = this._getDefinedOptions(
+        this._removeDeprecatedOptions({
+          ...baseOptions,
+          ...this._commandLineArguments.options
+        })
+      );
     } else {
-      this._options = this._removeDeprecatedOptions(baseOptions);
+      this._options = this._getDefinedOptions(this._removeDeprecatedOptions(baseOptions));
     }
     return Promise.resolve();
   }
@@ -75,44 +79,54 @@ class Options {
       tracer.error(`Option with name ${optionDetails.name} is already registered`);
       return;
     }
-    if (!optionDetails.description) {
-      tracer.error("Please provide option description when adding a new option");
-      return;
-    }
     if (
       !optionDetails.type ||
       !["string", "number", "boolean", "booleanString"].includes(optionDetails.type)
     ) {
       tracer.error("Please provide a valid option type between: string, number, boolean");
       return;
     }
+    if (!optionDetails.description) {
+      tracer.warn("Please provide option description when adding a new option");
+      optionDetails.description = "";
+    }
 
     this._optionsNames.push(optionDetails.name);
     this._customDefaults[optionDetails.name] = optionDetails.default;
     this._commandLineArguments.addCustom(optionDetails);
   }
 
+  _getDefinedOptions(options) {
+    return this._optionsNames.reduce((cleanObject, currentKey) => {
+      if (!isUndefined(options[currentKey])) {
+        cleanObject[currentKey] = options[currentKey];
+      }
+      return cleanObject;
+    }, {});
+  }
+
   // TODO, remove deprecated options
   _removeDeprecatedOptions(options) {
-    if (options.feature) {
+    if (options.feature !== DEFAULT_OPTIONS.feature) {
       tracer.warn(
         "Deprecation warning: --feature option will be deprecated. Use --behavior instead"
       );
       if (!options.behavior) {
         options.behavior = options.feature;
       }
-      delete options.feature;
     }
 
-    if (options.features) {
+    if (options.features !== DEFAULT_OPTIONS.features) {
       tracer.warn(
         "Deprecation warning: --features option will be deprecated. Use --behaviors instead"
       );
       if (!options.behaviors) {
         options.behaviors = options.features;
       }
-      delete options.features;
     }
+
+    delete options.feature;
+    delete options.features;
     return options;
   }
 }

test/unit/core/settings/CommandLineArguments.mocks.js

@@ -0,0 +1,43 @@
+/*
+Copyright 2019 Javier Brea
+Copyright 2019 XbyOrange
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+*/
+
+const sinon = require("sinon");
+
+jest.mock("../../../../lib/core/settings/CommandLineArguments");
+
+const CommandLineArguments = require("../../../../lib/core/settings/CommandLineArguments");
+
+class Mock {
+  constructor() {
+    this._sandbox = sinon.createSandbox();
+
+    this._stubs = {
+      init: this._sandbox.stub(),
+      addCustom: this._sandbox.stub(),
+      options: {}
+    };
+
+    CommandLineArguments.mockImplementation(() => this._stubs);
+  }
+
+  get stubs() {
+    return {
+      Constructor: CommandLineArguments,
+      instance: this._stubs
+    };
+  }
+
+  restore() {
+    this._sandbox.restore();
+  }
+}
+
+module.exports = Mock;

test/unit/core/settings/CommandLineArguments.spec.js

@@ -75,20 +75,6 @@ describe("options", () => {
       await commandLineArguments.init();
     });
 
-    it("should only get values from keys defined in default values", async () => {
-      const options = {
-        behavior: "foo-behavior",
-        behaviors: "foo/behaviors/path"
-      };
-      parseStub.returns({
-        ...options,
-        foo: "foo-2",
-        cli: true
-      });
-      await commandLineArguments.init();
-      expect(commandLineArguments.options).toEqual(options);
-    });
-
     it("should omit undefined values", async () => {
       const options = {
         behavior: "foo-behavior",
@@ -169,29 +155,6 @@ describe("options", () => {
   });
 
   describe("when adding custom option", () => {
-    describe("when initializing", () => {
-      it("should get values from keys defined in new options", async () => {
-        const options = {
-          behavior: "foo-behavior",
-          behaviors: "foo/behaviors/path"
-        };
-        parseStub.returns({
-          ...options,
-          foo: "foo-2",
-          cli: true
-        });
-        commandLineArguments.addCustom({
-          name: "cli",
-          type: "boolean"
-        });
-        await commandLineArguments.init();
-        expect(commandLineArguments.options).toEqual({
-          ...options,
-          cli: true
-        });
-      });
-    });
-
     describe("when it is string type", () => {
       it("should add commander option with mandatory value", async () => {
         expect.assertions(2);