feat(uikits): additional test coverage of the main API

Author: bmuenzenmeyer

packages/core/test/index_tests.js

@@ -3,11 +3,13 @@ const rewire = require('rewire');
 const _ = require('lodash');
 const fs = require('fs-extra');
 const get = require('../src/lib/get');
+const events = require('../src/lib/events');
 
 const util = require('./util/test_utils.js');
 const entry = rewire('../src/index');
 const defaultConfig = require('../patternlab-config.json');
 const testConfig = require('./util/patternlab-config.json');
+const packageInfo = require('./../package');
 
 process.env.PATTERNLAB_ENV = 'CI';
 
@@ -44,23 +46,143 @@ const fsMock = {
   },
 };
 
+const loadUIKitsMock = () => {
+  return Promise.resolve();
+};
+
+const buildPatternsMock = () => {
+  return Promise.resolve();
+};
+
 //set our mocks in place of usual require()
 entry.__set__({
   ui_builder: uiBuilderMock,
   fs: fsMock,
   copier: copierMock,
 });
 
-tap.test('getDefaultConfig - should return the default config object', function(
-  test
-) {
-  const requestedConfig = entry.getDefaultConfig();
-  test.type(requestedConfig, 'object');
-  test.equals(requestedConfig, defaultConfig);
+tap.test('version - should call patternlab.getVersion', test => {
+  //arrange
+  const pl = new entry(testConfig);
+
+  //act
+  //assert
+  test.equals(pl.version(), packageInfo.version);
   test.end();
 });
 
-tap.test('buildPatterns', function() {
+tap.test(
+  'getDefaultConfig - static method should return the default config object',
+  test => {
+    const requestedConfig = entry.getDefaultConfig();
+    test.type(requestedConfig, 'object');
+    test.equals(requestedConfig, defaultConfig);
+    test.end();
+  }
+);
+
+tap.test(
+  'getDefaultConfig - instance method should return the default config object',
+  test => {
+    //arrange
+    const pl = new entry(testConfig);
+
+    //act
+    //assert
+    const requestedConfig = pl.getDefaultConfig();
+    test.type(requestedConfig, 'object');
+    test.equals(requestedConfig, defaultConfig);
+    test.end();
+  }
+);
+
+tap.test(
+  'getSupportedTemplateExtensions - calls patternlab.getSupportedTemplateExtensions and returns default template engine extensions',
+  test => {
+    //arrange
+    const pl = new entry(testConfig);
+
+    //act
+    const expectedExtensions = ['.mustache'];
+
+    //assert
+    test.equals(
+      pl.getSupportedTemplateExtensions().length,
+      expectedExtensions.length
+    );
+    test.same(pl.getSupportedTemplateExtensions(), expectedExtensions);
+    test.end();
+  }
+);
+
+tap.test('patternsonly a promise', test => {
+  //arrange
+  const revert = entry.__set__('loaduikits', loadUIKitsMock);
+  const pl = new entry(testConfig);
+
+  //act
+  test.resolves(pl.patternsonly({})).then(() => {
+    revert();
+    test.end();
+  });
+});
+
+tap.test('patternsonly calls loaduikits', test => {
+  //arrange
+  const revert = entry.__set__('loaduikits', () => {
+    test.ok(1);
+    return Promise.resolve();
+  });
+  const pl = new entry(testConfig);
+
+  //act
+  test.resolves(pl.patternsonly({})).then(() => {
+    revert();
+    test.end();
+  });
+});
+
+tap.test('patternsonly calls buildPatterns', test => {
+  //arrange
+  const revert = entry.__set__(
+    'buildPatterns',
+    (cleanPublic, patternlab, data) => {
+      test.type(cleanPublic, 'boolean');
+      test.ok(cleanPublic);
+      test.type(patternlab, 'object');
+      test.type(data, 'object');
+      test.equals(data.foo, 'bar');
+      return Promise.resolve();
+    }
+  );
+  const pl = new entry(testConfig);
+
+  //act
+  test
+    .resolves(pl.patternsonly({ cleanPublic: true, data: { foo: 'bar' } }))
+    .then(() => {
+      revert();
+      test.end();
+    });
+});
+
+tap.test('serve calls serve', test => {
+  //arrange
+  const revert = entry.__set__('serve', patternlab => {
+    test.ok(1);
+    test.type(patternlab, 'object');
+  });
+
+  const pl = new entry(testConfig);
+
+  //act
+  test.resolves(pl.serve({})).then(() => {
+    revert();
+    test.end();
+  });
+});
+
+tap.test('buildPatterns suite', test => {
   //arrange
 
   const patternExporterMock = {
@@ -132,7 +254,6 @@ tap.test('buildPatterns', function() {
 
       tap.test('uses global listItem property', test => {
         var pattern = get('test-listWithPartial', patternlab);
-        console.log(pattern.patternPartialCode);
         let assertionCount = 0;
         ['dA', 'dB', 'dC'].forEach(d => {
           if (pattern.patternPartialCode.indexOf(d) > -1) {
@@ -224,14 +345,26 @@ tap.test('buildPatterns', function() {
   });
 
   testConfig.patternExportPatternPartials = ['test-paramParent'];
-  var pl = new entry(testConfig);
+  const pl = new entry(testConfig);
+
+  test.equals(pl.events.eventNames().length, 0);
 
   //act
-  return pl.build({
-    cleanPublic: true,
-    data: {
-      foo: 'Bar',
-      description: 'Baz',
-    },
-  });
+  return pl
+    .build({
+      cleanPublic: true,
+      data: {
+        foo: 'Bar',
+        description: 'Baz',
+      },
+    })
+    .then(() => {
+      test.equals(
+        pl.events.eventNames().length,
+        2,
+        'should register two events'
+      );
+      test.equals(pl.events.listenerCount(events.PATTERNLAB_PATTERN_CHANGE), 1);
+      test.equals(pl.events.listenerCount(events.PATTERNLAB_GLOBAL_CHANGE), 1);
+    });
 });