Add setup hook and sanityCheck. cf. #1

Author: mwpastore

README.md

@@ -118,6 +118,7 @@ refer to the [Plugin Documentation][2].
 * `didDeploy`
 * `fetchInitialRevisions`
 * `fetchRevisions`
+* `setup`
 * `upload`
 * `willActivate`
 
@@ -152,7 +153,7 @@ A file matching this pattern will be uploaded to the database table.
 
 The name of the database table in which to store the revision keys and file
 contents. By default this option will use the `project.name()` property from
-the deployment context.
+the deployment context, snake-cased and suffixed with `_bootstrap`.
 
 The table is created in your database automatically on the initial deploy, so
 your database user will need `CREATE TABLE` privileges—at least
@@ -171,7 +172,7 @@ The table looks something like this (e.g. in MySQL):
 | is_active   | tinyint(1)   | NO   |     | 0                 |                |
 | created_at  | timestamp    | NO   |     | CURRENT_TIMESTAMP |                |
 
-*Default:* `${projectNameSnakeCased}_bootstrap`
+*Default:* `${projectName}_bootstrap`
 
 ### allowOverwrite
 

index.js

@@ -99,6 +99,15 @@ const DeployPlugin = DeployPluginBase.extend({
   //
   // Pipeline hooks
   //
+  setup() {
+    const
+      deployClient = this.readConfig('deployClient'),
+      tableName = this.readConfig('tableName');
+
+    return deployClient.sanityCheck({ tableName })
+      .catch(errorMessage.bind(this));
+  },
+
   fetchInitialRevisions() {
     const
       deployClient = this.readConfig('deployClient'),

lib/deploy-client.js

@@ -9,15 +9,6 @@ const
 //
 // Private functions
 //
-function conditionallyCreateTable(tableName) {
-  return this.knex.schema.hasTable(tableName)
-    .then(exists => {
-      if (!exists) {
-        return createTable.call(this, tableName);
-      }
-    });
-}
-
 function createTable(tableName) {
   return this.knex.schema.createTable(tableName, tbl => {
     tbl.increments();
@@ -142,6 +133,18 @@ module.exports = CoreObject.extend({
     this.knex.destroy();
   },
 
+  sanityCheck(args) {
+    // TODO: replace let with destructured args
+    let tableName = args.tableName;
+
+    return this.knex.schema.hasTable(tableName)
+      .then(exists => {
+        if (!exists) {
+          return createTable.call(this, tableName);
+        }
+      });
+  },
+
   upload(args) {
     // TODO: replace lets with destructured args
     let
@@ -151,8 +154,7 @@ module.exports = CoreObject.extend({
 
     revisionKey = revisionKey || 'default';
 
-    return conditionallyCreateTable.call(this, tableName)
-      .then(() => conditionallyCreateRevision.call(this, tableName, revisionKey, value))
+    return conditionallyCreateRevision.call(this, tableName, revisionKey, value)
       .then(() => listRevisions.call(this, tableName))
       .then(trimRevisions.bind(this, tableName))
       .then(() => ({ tableName, revisionKey }));

tests/unit/deploy-client-test.js

@@ -6,59 +6,26 @@ const assert = require('../helpers/assert');
 const rewire = require('rewire');
 const subject = rewire('../../lib/deploy-client');
 
-describe('DeployClient private "constructor" method', function() {
+describe('DeployClient private methods', function() {
+  const rewire = require('rewire');
+  const subject = rewire('../../lib/deploy-client');
+
   const knex = require('knex')({
     client: 'sqlite3',
     connection: { filename: ':memory:' },
     useNullAsDefault: true,
     //debug: true
   });
 
+  beforeEach(subject.__get__('createTable').bind({ knex }, 'test'));
+  afterEach(() => knex.schema.dropTable('test'));
+
   // Tear down the connection pool after all the tests have completed.
   after(() => knex.destroy());
 
-  describe('#conditionallyCreateTable()', function() {
-    const conditionallyCreateTable = subject.__get__('conditionallyCreateTable');
-
-    it('creates a table if none exists', function() {
-      return conditionallyCreateTable.call({ knex }, 'foo')
-        .then(() => knex('foo').columnInfo())
-        .then(info => {
-          assert.isObject(info);
-
-          assert.deepPropertyVal(info, 'id.type', 'integer');
-          assert.deepPropertyVal(info, 'key.type', 'varchar');
-          assert.deepPropertyVal(info, 'value.type', 'text');
-          assert.deepPropertyVal(info, 'is_active.type', 'boolean');
-          assert.deepPropertyVal(info, 'created_at.type', 'datetime');
-        })
-        .finally(() => knex.schema.dropTable('foo'));
-    });
-
-    it('does not create a table if one exists', function() {
-      return knex.schema.createTable('bar', tbl => {
-        tbl.increments();
-        tbl.string('key').notNullable().unique();
-        tbl.timestamps();
-      }).then(() => conditionallyCreateTable.call({ knex }, 'bar'))
-        .then(() => knex('bar').columnInfo())
-        .then(info => {
-          assert.isObject(info);
-
-          assert.deepPropertyVal(info, 'id.type', 'integer');
-          assert.deepPropertyVal(info, 'key.type', 'varchar');
-          assert.deepPropertyVal(info, 'created_at.type', 'datetime');
-          assert.deepPropertyVal(info, 'updated_at.type', 'datetime');
-
-          assert.notProperty(info, 'value');
-          assert.notProperty(info, 'is_active');
-        })
-        .finally(() => knex.schema.dropTable('bar'));
-    });
-
+  describe('#createTable()', function() {
     it('sets appropriate column defaults', function() {
-      return conditionallyCreateTable.call({ knex }, 'test')
-        .then(() => knex('test').insert({ key: 'foo', value: 'bar' }))
+      return knex('test').insert({ key: 'foo', value: 'bar' })
         .then(() => knex('test').first())
         .then(row => {
           assert.isObject(row);
@@ -76,24 +43,6 @@ describe('DeployClient private "constructor" method', function() {
         });
     });
   });
-});
-
-describe('DeployClient private methods', function() {
-  const rewire = require('rewire');
-  const subject = rewire('../../lib/deploy-client');
-
-  const knex = require('knex')({
-    client: 'sqlite3',
-    connection: { filename: ':memory:' },
-    useNullAsDefault: true,
-    //debug: true
-  });
-
-  beforeEach(subject.__get__('createTable').bind({ knex }, 'test'));
-  afterEach(() => knex.schema.dropTable('test'));
-
-  // Tear down the connection pool after all the tests have completed.
-  after(() => knex.destroy());
 
   describe('#conditionallyCreateRevision()', function() {
     const createRevision = subject.__get__('conditionallyCreateRevision');
@@ -384,6 +333,46 @@ describe('DeployClient public API', function() {
     }
   });
 
+  describe('#sanityCheck()', function() {
+    it('creates a table if none exists', function() {
+      deployClient = new subject(baseOptions);
+
+      return deployClient.sanityCheck({ tableName: 'foo' })
+        .then(() => deployClient.knex('foo').columnInfo())
+        .then(info => {
+          assert.isObject(info);
+
+          assert.deepPropertyVal(info, 'id.type', 'integer');
+          assert.deepPropertyVal(info, 'key.type', 'varchar');
+          assert.deepPropertyVal(info, 'value.type', 'text');
+          assert.deepPropertyVal(info, 'is_active.type', 'boolean');
+          assert.deepPropertyVal(info, 'created_at.type', 'datetime');
+        });
+    });
+
+    it('does not create a table if one exists', function() {
+      deployClient = new subject(baseOptions);
+
+      return deployClient.knex.schema.createTable('bar', tbl => {
+        tbl.increments();
+        tbl.string('key').notNullable().unique();
+        tbl.timestamps();
+      }).then(() => deployClient.sanityCheck({ tableName: 'bar' }))
+        .then(() => deployClient.knex('bar').columnInfo())
+        .then(info => {
+          assert.isObject(info);
+
+          assert.deepPropertyVal(info, 'id.type', 'integer');
+          assert.deepPropertyVal(info, 'key.type', 'varchar');
+          assert.deepPropertyVal(info, 'created_at.type', 'datetime');
+          assert.deepPropertyVal(info, 'updated_at.type', 'datetime');
+
+          assert.notProperty(info, 'value');
+          assert.notProperty(info, 'is_active');
+        });
+    });
+  });
+
   describe('#fetchRevisions()', function() {
     it('returns successfully', function() {
       deployClient = new subject(baseOptions);
@@ -456,7 +445,8 @@ describe('DeployClient public API', function() {
     it('uploads a new revision with a payload', function() {
       deployClient = new subject(baseOptions);
 
-      return deployClient.upload({ tableName: 'foo', value: 'bar' })
+      return deployClient.sanityCheck({ tableName: 'foo' })
+        .then(() => deployClient.upload({ tableName: 'foo', value: 'bar' }))
         .then(() => deployClient.knex('foo').select('key', 'value'))
         .then(revisions => {
           assert.isArray(revisions);
@@ -473,7 +463,8 @@ describe('DeployClient public API', function() {
     it('returns the table name and revision key', function() {
       deployClient = new subject(baseOptions);
 
-      return deployClient.upload({ tableName: 'foo', value: 'bar' })
+      return deployClient.sanityCheck({ tableName: 'foo' })
+        .then(() => deployClient.upload({ tableName: 'foo', value: 'bar' }))
         .then(result => {
           assert.propertyVal(result, 'tableName', 'foo');
           assert.propertyVal(result, 'revisionKey', 'default');

tests/unit/deploy-plugin-test.js

@@ -21,6 +21,9 @@ describe('DeployPlugin', function() {
     assert.isDefined(plugin.configure);
     assert.isFunction(plugin.configure);
 
+    assert.isDefined(plugin.setup);
+    assert.isFunction(plugin.setup);
+
     assert.isDefined(plugin.fetchInitialRevisions);
     assert.isFunction(plugin.fetchInitialRevisions);
 

tests/unit/setup-hook-test.js

@@ -0,0 +1,57 @@
+/*global Promise*/
+/*eslint-env node*/
+'use strict';
+
+const subject = require('../../index');
+const assert = require('../helpers/assert');
+
+describe('DeployPlugin | setup hook', function() {
+  const mockUi = {
+    verbose: true,
+    messages: [],
+    write: function() {},
+    writeLine: function(message) {
+      this.messages.push(message);
+    }
+  };
+
+  let sanityCheckCalled;
+
+  const mockClient = () => ({
+    sanityCheck(args) {
+      // TODO: replace let with destructured args
+      let tableName = args.tableName;
+
+      sanityCheckCalled = true;
+
+      return Promise.resolve(tableName);
+    }
+  });
+
+  it('calls sanityCheck', function() {
+    const instance = subject.createDeployPlugin({
+      name: 'sql'
+    });
+
+    const context = {
+      ui: mockUi,
+      distDir: 'tests',
+      config: {
+        sql: {
+          client: 'mock',
+          deployClient: mockClient,
+          tableName: 'foo'
+        }
+      }
+    };
+
+    instance.beforeHook(context);
+    instance.configure(context);
+
+    return instance.setup(context)
+      .then(result => {
+        assert.ok(sanityCheckCalled);
+        assert.equal(result, 'foo');
+      });
+  });
+});