minor #116 Adding tests for the logger and cleaning up a bit internally (weaverryan)

This PR was merged into the master branch.

Discussion
----------

Adding tests for the logger and cleaning up a bit internally

... also added the `recommendation` method, which we will use in #101.

Commits
-------

7ecfece Adding tests for the logger and cleaning up a bit internally

Author: weaverryan

lib/logger.js

@@ -10,15 +10,31 @@
 'use strict';
 
 const chalk = require('chalk');
-let isVerbose = false;
-let quiet = false;
-let messages = {
-    debug: [],
-    warning: [],
+
+const messagesKeys = [
+    'debug',
+    'recommendation',
+    'warning',
+];
+const defaultConfig = {
+    isVerbose: false,
+    quiet: false
+};
+
+let messages = {};
+let config = {};
+
+const reset = function() {
+    messages = {};
+    for (let messageKey of messagesKeys) {
+        messages[messageKey] = [];
+    }
+    config = Object.assign({}, defaultConfig);
 };
+reset();
 
 function log(message) {
-    if (quiet) {
+    if (config.quiet) {
         return;
     }
 
@@ -29,31 +45,36 @@ module.exports = {
     debug(message) {
         messages.debug.push(message);
 
-        if (isVerbose) {
-            log(`${chalk.bgBlack.white(' DEBUG ')} ${message}`);
+        if (config.isVerbose) {
+            log(`${chalk.bgBlack.white('   DEBUG   ')} ${message}`);
         }
     },
 
-    warning(message) {
-        messages.warning.push(message);
+    recommendation(message) {
+        messages.recommendation.push(message);
 
-        log(`${chalk.bgYellow.black(' WARNING ')} ${chalk.yellow(message)}`);
+        log(`${chalk.bgBlue.white(' RECOMMEND ')} ${message}`);
     },
 
-    clearMessages() {
-        messages.debug = [];
-        messages.warning = [];
+    warning(message) {
+        messages.warning.push(message);
+
+        log(`${chalk.bgYellow.black('  WARNING  ')} ${chalk.yellow(message)}`);
     },
 
     getMessages() {
         return messages;
     },
 
-    quiet() {
-        quiet = true;
+    quiet(setQuiet = true) {
+        config.quiet = setQuiet;
+    },
+
+    verbose(setVerbose = true) {
+        config.isVerbose = setVerbose;
     },
 
-    verbose() {
-        isVerbose = true;
+    reset() {
+        reset();
     }
 };

test/config/validator.js

@@ -15,8 +15,6 @@ const RuntimeConfig = require('../../lib/config/RuntimeConfig');
 const validator = require('../../lib/config/validator');
 const logger = require('../../lib/logger');
 
-logger.quiet();
-
 function createConfig() {
     const runtimeConfig = new RuntimeConfig();
     runtimeConfig.context = __dirname;
@@ -77,7 +75,8 @@ describe('The validator function', () => {
         config.addEntry('main', './main');
         config.runtimeConfig.useDevServer = true;
 
-        logger.clearMessages();
+        logger.reset();
+        logger.quiet();
         validator(config);
 
         expect(logger.getMessages().warning).to.have.lengthOf(1);

test/logger.js

@@ -0,0 +1,60 @@
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+'use strict';
+
+const expect = require('chai').expect;
+require('../lib/context').runtimeConfig = {};
+const logger = require('../lib/logger');
+
+describe('logger', () => {
+    beforeEach(() => {
+        logger.reset();
+    });
+
+    afterEach(() => {
+        logger.reset();
+    });
+
+    it('Smoke test for log methods', () => {
+
+        const methods = [
+            'debug',
+            'recommendation',
+            'warning',
+        ];
+        const testString = 'TEST MESSAGE';
+        const expectedMessages = {
+            debug: [testString],
+            recommendation: [testString],
+            warning: [testString],
+        };
+
+        logger.quiet();
+        logger.verbose();
+
+        for (let loggerMethod of methods) {
+            logger[loggerMethod](testString);
+        }
+
+        // clone the object so the afterEach doesn't clear out before
+        // a failure message is shown
+        const actualMessages = Object.assign({}, logger.getMessages());
+        expect(actualMessages).to.deep.equal(expectedMessages);
+    });
+
+    it('test reset()', () => {
+        logger.debug('DEBUG!');
+        logger.reset();
+
+        const actualMessages = Object.assign({}, logger.getMessages());
+
+        expect(actualMessages.debug).to.have.lengthOf(0);
+    });
+});