feat(uikits): additional test coverage

Author: bmuenzenmeyer

packages/core/src/lib/loaduikits.js

@@ -34,31 +34,37 @@ const readModuleFile = (kit, subPath) => {
   );
 };
 
+/**
+ * Loads uikits, connecting configuration and installed modules
+ * [1] Looks in node_modules for uikits.
+ * [2] Only continue if uikit is enabled in patternlab-config.json
+ * [3] Reads files from uikit that apply to every template
+ * @param {object} patternlab
+ */
 module.exports = patternlab => {
   const paths = patternlab.config.paths;
 
-  // load all ui kits mentioned in the config, if they are enabled
-  const uikits = findModules(nodeModulesPath, isUIKitModule);
+  const uikits = findModules(nodeModulesPath, isUIKitModule); // [1]
 
-  // add them to the patternlab object for later iteration
   uikits.forEach(kit => {
-    const configEntry = _.find(patternlab.config.uikits, {
+    const configEntry = _.find(_.filter(patternlab.config.uikits, 'enabled'), {
       name: `uikit-${kit.name}`,
-    });
+    }); // [2]
 
     if (!configEntry) {
-      logger.error(
+      logger.warning(
         `Could not find uikit with name uikit-${
           kit.name
-        } defined within patternlab-config.json`
+        } defined within patternlab-config.json, or it is not enabled.`
       );
+      return;
     }
 
     try {
-      // load up all the necessary files from pattern lab that apply to every template
       patternlab.uikits[`uikit-${kit.name}`] = {
+        name: `uikit-${kit.name}`,
         modulePath: kit.modulePath,
-        enabled: configEntry.enabled,
+        enabled: true,
         outputDir: configEntry.outputDir,
         excludedPatternStates: configEntry.excludedPatternStates,
         excludedTags: configEntry.excludedTags,
@@ -79,11 +85,12 @@ module.exports = patternlab => {
           paths.source.patternlabFiles.patternSectionSubtype
         ),
         viewAll: readModuleFile(kit, paths.source.patternlabFiles.viewall),
-      };
+      }; // [3]
     } catch (ex) {
       logger.error(ex);
       logger.error(
         '\nERROR: missing an essential file from ' +
+          kit.modulePath +
           paths.source.patternlabFiles +
           ". Pattern Lab won't work without this file.\n"
       );

packages/core/test/loaduitkits_tests.js

@@ -3,61 +3,105 @@
 const tap = require('tap');
 const rewire = require('rewire');
 
-const loaduikits = require('../src/lib/loaduikits');
+const loaduikits = rewire('../src/lib/loaduikits');
 
-const findModulesMock = function() {
+const testConfig = require('./util/patternlab-config.json');
+
+const findModulesMock = function () {
   return [
     {
-      name: 'uikit-foo',
+      name: 'foo',
       modulePath: 'node_modules/@pattern-lab/uikit-foo',
     },
     {
-      name: 'uikit-bar',
+      name: 'bar',
       modulePath: 'node_modules/@pattern-lab/uikit-bar',
     },
     {
-      name: 'uikit-baz',
+      name: 'baz',
       modulePath: 'node_modules/@pattern-lab/uikit-baz',
     },
   ];
 };
 
-const fsMock = function() {
-  readFileSync: () => {};
+const fsMock = {
+  readFileSync: function(path, encoding) {
+    return 'file';
+  },
 };
 
-tap.test('loaduikits', function(test) {
+loaduikits.__set__({
+  findModules: findModulesMock,
+  fs: fsMock,
+});
+
+tap.test('loaduikits - maps fields correctly', function (test) {
   //arrange
   const patternlab = {
-    uikits: [
-      {
-        name: 'uikit-foo',
-        enabled: true,
-        outputDir: 'foo',
-        excludedPatternStates: ['legacy'],
-        excludedTags: ['baz'],
-      },
-      {
-        name: 'uikit-bar',
-        enabled: true,
-        outputDir: 'bar',
-        excludedPatternStates: ['development'],
-        excludedTags: ['baz', 'foo'],
-      },
-      {
-        name: 'uikit-baz',
-        enabled: false,
-        outputDir: 'baz',
-        excludedPatternStates: [''],
-        excludedTags: [],
-      },
-    ],
+    config: testConfig,
+    uikits: [],
+  };
+
+  const uikitFoo = {
+    name: 'uikit-foo',
+    enabled: true,
+    outputDir: 'foo',
+    excludedPatternStates: ['legacy'],
+    excludedTags: ['baz'],
   };
 
+  patternlab.config.uikits = [uikitFoo];
+
+  //act
+  loaduikits(patternlab).then(() => {
+    //assert
+    test.equals(patternlab.uikits['uikit-foo'].name, uikitFoo.name);
+    test.equals(patternlab.uikits['uikit-foo'].modulePath, 'node_modules/@pattern-lab/uikit-foo');
+    test.ok(patternlab.uikits['uikit-foo'].enabled);
+    test.equals(patternlab.uikits['uikit-foo'].outputDir, uikitFoo.outputDir);
+    test.equals(patternlab.uikits['uikit-foo'].excludedPatternStates, uikitFoo.excludedPatternStates);
+    test.equals(patternlab.uikits['uikit-foo'].excludedTags, uikitFoo.excludedTags);
+    test.end();
+  });
+});
+
+tap.test('loaduikits - only adds files for enabled uikits', function (test) {
+  //arrange
+  const patternlab = {
+    config: testConfig,
+    uikits: [],
+  };
+
+  patternlab.config.uikits = [
+    {
+      name: 'uikit-foo',
+      enabled: true,
+      outputDir: 'foo',
+      excludedPatternStates: ['legacy'],
+      excludedTags: ['baz'],
+    },
+    {
+      name: 'uikit-bar',
+      enabled: true,
+      outputDir: 'bar',
+      excludedPatternStates: ['development'],
+      excludedTags: ['baz', 'foo'],
+    },
+    {
+      name: 'uikit-baz',
+      enabled: false,
+      outputDir: 'baz',
+      excludedPatternStates: [''],
+      excludedTags: [],
+    },
+  ];
+
   //act
   loaduikits(patternlab).then(() => {
     //assert
-    test.equals(patternlab.uikits);
+    test.ok(patternlab.uikits['uikit-foo']);
+    test.ok(patternlab.uikits['uikit-bar']);
+    test.notOk(patternlab.uikits['uikit-baz']);
     test.end();
   });
 });