Add tests for customFormat

Also minor tweaks for the usability (no explicit json call)
davglass · Sep 7, 2015 · 4aa7065 · 4aa7065
1 parent 6fa44ef
commit 4aa7065
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 7 deletions.
diff --git a/bin/license-checker b/bin/license-checker
@@ -18,12 +18,8 @@ if (!args.color && (args.json || args.csv || args.out)) {
     args.color = false;
 }
 
-args.customFormat = checker.parseJson(args.customPath);
-
 checker.init(args, function(json) {
 
-    console.log(args.customFormat);
-
     var formattedOutput = '';
     if (args.json) {
         formattedOutput = JSON.stringify(json, null, 2);

diff --git a/lib/index.js b/lib/index.js
@@ -136,13 +136,17 @@ var flatten = function(options) {
 exports.init = function(options, callback) {
     console.error('scanning' , options.start);
 
+    if (options.customPath) {
+        options.customFormat = parseJson(options.customPath);
+    }
+
     read(options.start, { dev: true }, function(err, json) {
         var data = flatten({
                 deps: json,
                 data: {},
                 color: options.color,
                 unknown: options.unknown,
-                customFormat: options.customFormat
+                customFormat: options.customFormat,
                 filter: options.filter
             }),
             colorize = options.color,
@@ -263,7 +267,7 @@ exports.asMarkDown = function(sorted, customFormat) {
     return text;
 };
 
-exports.parseJson = function(jsonPath) {
+parseJson = function(jsonPath) {
     if (typeof jsonPath !== 'string') {
         return {};
     }

diff --git a/tests/test.js b/tests/test.js
@@ -1,7 +1,9 @@
 var vows = require('vows'),
     assert = require('assert'),
     path = require('path'),
-    checker = require('../lib/index');
+    checker = require('../lib/index'),
+    args = require('../lib/args'),
+    fs = require('fs');
 
 var tests = {
     loading: {
@@ -85,6 +87,64 @@ var tests = {
         'on undefined': function (d) {
             assert.equal(d, 'Undefined');
         }
+    },
+    'should create a custom format using customFormat': {
+        topic: function () {
+            var self = this;
+
+            checker.init({
+                start: path.join(__dirname, '../'),
+                exclude: "MIT, ISC",
+                customFormat: {
+                    'name': '<<Default Name>>',
+                    'description': '<<Default Description>>',
+                    'pewpew': '<<Should Never be set>>'
+                }
+            }, function (filtered) {
+                self.callback(null, filtered);
+            });
+        },
+        'create custom format with name, description and pewpew (customFormat manipulation)': function (d) {
+            Object.keys(d).forEach(function(item) {
+                assert.notEqual(d[item].name, undefined);
+                assert.notEqual(d[item].description, undefined);
+                assert.notEqual(d[item].pewpew, undefined);
+                assert.equal(d[item].pewpew, '<<Should Never be set>>');
+            });
+        }
+    },
+    'should create a custom format using customPath': {
+        topic: function () {
+            var self = this;
+
+            process.argv.push('--customPath');
+            process.argv.push('./customFormatExample.json');
+
+            args = args.parse();
+            args.start = path.join(__dirname, '../');
+
+            process.argv.pop();
+            process.argv.pop();
+
+            checker.init(args, function (filtered) {
+                self.callback(null, filtered);
+            });
+        },
+        'create custom format with contents of customFormatExample': function (d) {
+            var customFormatContent = fs.readFileSync(path.join(__dirname, './../customFormatExample.json'), 'utf8');
+
+            assert.notEqual(customFormatContent, undefined);
+            assert.notEqual(customFormatContent, null);
+
+            var customJson = JSON.parse(customFormatContent);
+
+            //Test dynamically with the file directly
+            Object.keys(d).forEach(function(licenseItem) {
+                Object.keys(customJson).forEach(function(definedItem) {
+                    assert.notEqual(d[licenseItem][definedItem], undefined);
+                });
+            });
+        }
     }
 };