add docker setup script

docker.setup.js

@@ -0,0 +1,265 @@
+// Copyright IBM Corp. 2017,2019. All Rights Reserved.
+// Node module: loopback-connector-cloudant
+// This file is licensed under the Artistic License 2.0.
+// License text available at https://opensource.org/licenses/Artistic-2.0
+
+// This script is created for running an ibmcom/couchdb3 docker container
+// on CI apps like travis, it only sets up the database, but doesn't run 
+// tests.
+
+// It also creates a .sh file with ENVs to export called `cloudant-config.sh`
+// You can run `source cloudant-config.sh` to expose the Cloudant configs.
+
+// To run this script: `node docker.setup.js`
+
+'use strict';
+
+const _ = require('lodash');
+const async = require('async');
+const docker = new require('dockerode')();
+const http = require('http');
+const ms = require('ms');
+const fs = require('fs-extra');
+
+process.env.CLOUDANT_DATABASE = 'testdb';
+process.env.CLOUDANT_PASSWORD = 'pass';
+process.env.CLOUDANT_USERNAME = 'admin';
+
+// these are placeholders. They get set dynamically based on what IP and port
+// get assigned by docker.
+process.env.CLOUDANT_PORT = 'TBD';
+process.env.CLOUDANT_HOST = 'TBD';
+process.env.CLOUDANT_URL = 'TBD';
+
+const CONNECT_RETRIES = 30;
+const CONNECT_DELAY = ms('5s');
+
+let containerToDelete = null;
+
+async.waterfall([
+  dockerStart('ibmcom/couchdb3:latest'),
+  sleep(ms('2s')),
+  setCloudantEnv,
+  waitFor('/_all_dbs'),
+  createAdmin(),
+  createDB(process.env.CLOUDANT_DATABASE),
+  listUser(),
+  exportENV(),
+], function(testErr) {
+  if (testErr) {
+    console.error('error running tests:', testErr);
+    process.exit(1);
+  }
+});
+
+function sleep(n) {
+  return function delayedPassThrough() {
+    const args = [].slice.call(arguments);
+    // last argument is the callback
+    const next = args.pop();
+    // prepend `null` to indicate no error
+    args.unshift(null);
+    setTimeout(function() {
+      next.apply(null, args);
+    }, n);
+  };
+}
+
+function dockerStart(imgName) {
+  return function pullAndStart(next) {
+    console.log('pulling image: %s', imgName);
+    docker.pull(imgName, function(err, stream) {
+      docker.modem.followProgress(stream, function(err, output) {
+        if (err) {
+          return next(err);
+        }
+        console.log('starting container from image: %s', imgName);
+        docker.createContainer({
+          Image: imgName,
+          HostConfig: {
+            PublishAllPorts: true,
+          },
+        }, function(err, container) {
+          console.log('recording container for later cleanup: ', container.id);
+          containerToDelete = container;
+          if (err) {
+            return next(err);
+          }
+          container.start(function(err, data) {
+            next(err, container);
+          });
+        });
+      });
+    });
+  };
+}
+
+function setCloudantEnv(container, next) {
+  container.inspect(function(err, c) {
+    // if swarm, Node.Ip will be set to actual node's IP
+    // if not swarm, but remote docker, use docker host's IP
+    // if local docker, use localhost
+    const host = _.get(c, 'Node.IP', _.get(docker, 'modem.host', '127.0.0.1'));
+    // couchdb uses TCP/IP port 5984
+    // container's port 5984 is dynamically mapped to an external port
+    const port = _.get(c,
+      ['NetworkSettings', 'Ports', '5984/tcp', '0', 'HostPort']);
+    process.env.CLOUDANT_PORT = port;
+    process.env.CLOUDANT_HOST = host;
+    const usr = process.env.CLOUDANT_USERNAME;
+    const pass = process.env.CLOUDANT_PASSWORD;
+    process.env.CLOUDANT_URL = 'http://' + usr + ':' + pass + '@' +
+      host + ':' + port;
+    console.log('env:', _.pick(process.env, [
+      'CLOUDANT_URL',
+      'CLOUDANT_HOST',
+      'CLOUDANT_PORT',
+      'CLOUDANT_USERNAME',
+      'CLOUDANT_PASSWORD',
+      'CLOUDANT_DATABASE',
+    ]));
+    next(null, container);
+  });
+}
+
+function waitFor(path) {
+  return function waitForPath(container, next) {
+    const opts = {
+      host: process.env.CLOUDANT_HOST,
+      port: process.env.CLOUDANT_PORT,
+      path: path,
+    };
+
+    console.log(`waiting for instance to respond: ${opts}`);
+    return ping(null, CONNECT_RETRIES);
+
+    function ping(err, tries) {
+      console.log('ping (%d/%d)', CONNECT_RETRIES - tries, CONNECT_RETRIES);
+      if (tries < 1) {
+        next(err || new Error('failed to contact Cloudant'));
+      }
+      http.get(opts, function(res) {
+        res.pipe(devNull());
+        res.on('error', tryAgain);
+        res.on('end', function() {
+          if (res.statusCode === 200) {
+            setImmediate(next, null, container);
+          } else {
+            tryAgain();
+          }
+        });
+      }).on('error', tryAgain);
+      function tryAgain(err) {
+        setTimeout(ping, CONNECT_DELAY, err, tries - 1);
+      }
+    }
+  };
+}
+
+function createAdmin() {
+  return function createAdminUser(container, next) {
+    const data = '\"pass\"';
+    const uri = '/_node/[email protected]/_config/admins/' +
+      process.env.CLOUDANT_USERNAME;
+    const opts = {
+      method: 'PUT',
+      path: uri,
+      header: {
+        'Content-Type': 'application/x-www-form-urlencoded',
+      },
+      host: process.env.CLOUDANT_HOST,
+      port: process.env.CLOUDANT_PORT,
+      body: data,
+    };
+
+    const req = http.request(opts, function(res) {
+      res.pipe(devNull());
+      res.on('error', next);
+      res.on('end', function() {
+        setImmediate(next, null, container);
+      });
+    });
+    req.write(data);
+    req.end();
+  };
+}
+
+function createDB(db) {
+  return function create(container, next) {
+    const opts = {
+      method: 'PUT',
+      path: '/' + db,
+      host: process.env.CLOUDANT_HOST,
+      port: process.env.CLOUDANT_PORT,
+      auth: process.env.CLOUDANT_USERNAME + ':' + process.env.CLOUDANT_PASSWORD,
+    };
+    console.log('creating db: %j', db);
+    http.request(opts, function(res) {
+      res.pipe(devNull());
+      res.on('error', next);
+      res.on('end', function() {
+        setImmediate(next, null, container);
+      });
+    })
+      .on('error', next)
+      .end();
+  };
+}
+
+function listUser() {
+  return function printUsers(container, next) {
+    const path = '/_node/[email protected]/_config/admins';
+    const opts = {
+      method: 'GET',
+      path: path,
+      host: process.env.CLOUDANT_HOST,
+      port: process.env.CLOUDANT_PORT,
+      auth: process.env.CLOUDANT_USERNAME + ':' + process.env.CLOUDANT_PASSWORD,
+    };
+    // console.log('creating db: %j', db);
+    http.request(opts, function(res) {
+      res.pipe(devNull());
+      res.on('error', next);
+
+      res.setEncoding('utf8');
+      let rawData = '';
+      res.on('data', (chunk) => { rawData += chunk; });
+
+      res.on('end', function() {
+        try {
+          const parsedData = JSON.parse(rawData);
+          console.log(parsedData);
+        } catch (e) {
+          console.error(e.message);
+        }
+        setImmediate(next, null, container);
+      });
+    })
+      .on('error', next)
+      .end();
+  };
+}
+
+function exportENV() {
+  return function createENVFile(container, next) {
+    const content = "export CLOUDANT_URL='" + process.env.CLOUDANT_URL + "'\n" +
+    "export CLOUDANT_DATABASE='" + process.env.CLOUDANT_DATABASE + "'\n" +
+    "export CLOUDANT_USER='" + process.env.CLOUDANT_USERNAME + "'\n" +
+    "export CLOUDANT_PASSWORD='" + process.env.CLOUDANT_PASSWORD + "'\n" +
+    'export CLOUDANT_PORT=' + process.env.CLOUDANT_PORT + '\n' +
+    "export CLOUDANT_HOST='" + process.env.CLOUDANT_HOST + "'";
+    console.log('current directory: ' + __dirname);
+    fs.writeFileSync('cloudant-config.sh', content, 'utf8');
+    next();
+  };
+}
+
+// A Writable Stream that just consumes a stream. Useful for draining readable
+// streams so that they 'end' properly, like sometimes-empty http responses.
+function devNull() {
+  return new require('stream').Writable({
+    write: function(_chunk, _encoding, cb) {
+      return cb(null);
+    },
+  });
+}

package.json

@@ -26,6 +26,7 @@
     "@cloudant/cloudant": "^4.2.1",
     "async": "^3.1.0",
     "debug": "^4.1.1",
+    "fs-extra": "^8.1.0",
     "lodash": "^4.17.11",
     "loopback-connector": "^4.0.0",
     "loopback-connector-couchdb2": "^1.5.1",