Added API To Config Themes

src/docker/container.js

@@ -12,15 +12,28 @@ class Container {
     this.options = options
   }
 
+  /**
+   * @param {string[]} args - docker container arguments
+   * @param {(stdout: string, stderr: string) => any} callback - callback that deterred what to return when the process is successful.
+   * @returns {Promise} return what said to return form the callback
+   */
+  dockerContainer (args, callback) {
+    args = ['container'].concat(args)
+
+    const container = spawn('docker', args)
+
+    return ReturnPromise(container, callback)
+  }
+
   /**
    * Start the container.
    *
    * @returns {Promise<Container>} Return the current container.
    */
   start () {
-    const start = spawn('docker', ['container', 'start', this.options.id])
+    const startArgs = ['start', this.options.id]
 
-    return ReturnPromise(start, () => {
+    return this.dockerContainer(startArgs, () => {
       this.options.status = 'started'
       return this
     })
@@ -34,16 +47,14 @@ class Container {
    * @returns {Promise<Container>} Return the current container.
    */
   rm (force = false, volumes = true) {
-    const rmArgs = ['container', 'rm']
+    const rmArgs = ['rm']
 
     if (force) { rmArgs.push('--force') }
     if (volumes) { rmArgs.push('--volumes') }
 
     rmArgs.push(this.options.id)
 
-    const rm = spawn('docker', rmArgs)
-
-    return ReturnPromise(rm, () => {
+    return this.dockerContainer(rmArgs, () => {
       this.options.status = 'removed'
       return this
     })
@@ -56,15 +67,16 @@ class Container {
    * @returns {Promise<Container>} Return the current container.
    */
   stop (time = 10) {
-    const stopArgs = ['container', 'stop']
+    const stopArgs = ['stop']
 
-    stopArgs.push('--time', time)
+    if (0 > time) {
+      throw new Error('time must be bigger then 0')
+    }
 
+    stopArgs.push('--time', time)
     stopArgs.push(this.options.id)
 
-    const stop = spawn('docker', stopArgs)
-
-    return ReturnPromise(stop, () => {
+    return this.dockerContainer(stopArgs, () => {
       this.options.status = 'stopped'
       return this
     })
@@ -80,38 +92,20 @@ class Container {
    * @returns {Promise<{stdout: string, stderr: string, container: Container}}>} Return Promise for container logs.
    */
   logs (options = {}) {
-    const logsArgs = ['container', 'logs']
-    let stdout = ''
-    let stderr = ''
+    const logsArgs = ['logs']
 
     if (options.since) { logsArgs.push('--since', options.since) }
     if (options.tail) { logsArgs.push('--tail', options.tail) }
     if (options.timeStamps) { logsArgs.push('--timestamps') } // eslint-disable-line spellcheck/spell-checker
 
     logsArgs.push(this.options.id)
 
-    const logs = spawn('docker', logsArgs)
-
-    logs.stdout.on('data', (data) => {
-      stdout += data
-    })
-
-    logs.stderr.on('data', (data) => {
-      stderr += data
-    })
-
-    return new Promise((resolve, reject) => {
-      logs.on('close', (code) => {
-        if (code) {
-          reject(stderr)
-          return
-        }
-        resolve({
-          stdout: stdout,
-          stderr: stderr,
-          container: this,
-        })
-      })
+    return this.dockerContainer(logsArgs, (stdout, stderr) => {
+      return {
+        stdout: stdout,
+        stderr: stderr,
+        container: this,
+      }
     })
   }
 
@@ -122,20 +116,13 @@ class Container {
    * @returns {Promise<string|object>} container info.
    */
   inspect (format) {
-    const inspectArgs = ['container', 'inspect']
-    let stdout = ''
+    const inspectArgs = ['inspect']
 
     if (format) { inspectArgs.push('--format', format) }
 
     inspectArgs.push(this.options.id)
 
-    const inspect = spawn('docker', inspectArgs)
-
-    inspect.stdout.on('data', (data) => {
-      stdout += data
-    })
-
-    return ReturnPromise(inspect, () => {
+    return this.dockerContainer(inspectArgs, (stdout) => {
       return CleanInspect(stdout)
     })
   }
@@ -151,6 +138,42 @@ class Container {
       return status
     })
   }
+
+  /**
+   * Checks if the container is healthy or not.
+   *
+   * @returns {Promise<boolean>} if the continer is healthy or not
+   */
+  isHealthy () {
+    if (!this.options.health) {
+      throw new Error('options.health.command must be defined to use IsHealthy')
+    }
+
+    return this.inspect('{{.State.Health.Status}}')
+      .then(status => 'healthy' === status)
+  }
+
+  /**
+   * Run commands in a running container.
+   *
+   * @param {Array} commands - Commands to run.
+   * @returns {Promise<Container>} Return the current container.
+   */
+  exec (commands) {
+    if (!Array.isArray(commands)) {
+      throw new Error('commands must be an array')
+    }
+
+    const execArgs = ['exec']
+
+    execArgs.push(this.options.id)
+
+    execArgs.push.apply(execArgs, commands)
+
+    return this.dockerContainer(execArgs, () => {
+      return this
+    })
+  }
 }
 
 module.exports = Container

src/docker/docker.js

@@ -15,17 +15,11 @@ class Docker {
    * @returns {Promise<Container>} Return promise for continer object
    */
   CreateContainer (options, run = false, detach = true) {
-    let stdout = ''
-
     const args = processCreateContainerOptions(options, run, detach)
 
     const process = spawn('docker', args)
 
-    process.stdout.on('data', (data) => {
-      stdout += data
-    })
-
-    return ReturnPromise(process, () => {
+    return ReturnPromise(process, (stdout) => {
       options.id = stdout.replace('\n', '')
       options.status = run ? 'started' : 'created'
 
@@ -35,22 +29,40 @@ class Docker {
     })
   }
 
+  /**
+   * Run commands in a docker container return it's output.
+   *
+   * @param {ContainerOptions} options - Docker container options.
+   * @returns {Promise<RunInContainerOutput>} Container outputs.
+   */
+  RunInContainer (options) {
+    if (!options.commands) {
+      throw new TypeError('options.commands must be provided to use RunInContainer.')
+    }
+
+    if (!options.rm) {
+      throw new TypeError('options.rm must be true to use RunInContainer. (we don\'t want to leave garbage aroud)')
+    }
+
+    const args = processCreateContainerOptions(options, true, false)
+
+    const process = spawn('docker', args)
+
+    return ReturnPromise(process, (stdout, stderr) => {
+      return { stdout: stdout, stderr: stderr }
+    })
+  }
+
   /**
    * Create docker volume.
    *
    * @param {string} name - Name of the volume.
    * @returns {Promise<Volume>} return promise for volume object.
    */
   CreateVolume (name) {
-    let stdout = ''
-
     const process = spawn('docker', ['volume', 'create', name])
 
-    process.stdout.on('data', (data) => {
-      stdout += data
-    })
-
-    return ReturnPromise(process, () => {
+    return ReturnPromise(process, (stdout) => {
       const options = {}
       options.name = stdout.replace('\n', '')
       options.status = 'alive'
@@ -66,8 +78,6 @@ class Docker {
    * @returns {Promise<Network>} return promise for network object.
    */
   CreateNetwork (options) {
-    let stdout = ''
-
     if ('string' === typeof options) {
       options = { name: options }
     }
@@ -76,11 +86,7 @@ class Docker {
 
     const process = spawn('docker', args)
 
-    process.stdout.on('data', (data) => {
-      stdout += data
-    })
-
-    return ReturnPromise(process, () => {
+    return ReturnPromise(process, (stdout) => {
       options.id = stdout.replace('\n', '')
       options.status = 'alive'
 
@@ -116,8 +122,32 @@ function processCreateContainerOptions (options, run, detach) {
     args.push('--net', options.network)
   }
 
-  if (options.healthCommand) {
-    args.push('--health-cmd', `${options.healthCommand}`)
+  if (options.health) {
+    if (!options.health.command) {
+      throw new TypeError('options.health.command must not be defined to use options.health')
+    }
+
+    args.push('--health-cmd', options.health.command)
+
+    if (options.health.interval) {
+      args.push('--health-interval', options.health.interval)
+    }
+
+    if (options.health.retries) {
+      if (!Number.isInteger(options.health.retries)) {
+        throw new TypeError('options.health.retries must be an integer.')
+      }
+
+      args.push('--health-retries', options.health.retries)
+    }
+
+    if (options.health.startPeriod) {
+      args.push('--health-start-period', options.health.startPeriod)
+    }
+
+    if (options.health.timeout) {
+      args.push('--health-timeout', options.health.timeout)
+    }
   }
 
   if (options.rm) {

src/docker/network.js

@@ -34,19 +34,13 @@ class Network {
   inspect (format) {
     const inspectArgs = ['network', 'inspect']
 
-    let stdout = ''
-
     if (format) { inspectArgs.push('--format', format) }
 
     inspectArgs.push(this.options.id)
 
     const inspect = spawn('docker', inspectArgs)
 
-    inspect.stdout.on('data', (data) => {
-      stdout += data
-    })
-
-    return ReturnPromise(inspect, () => {
+    return ReturnPromise(inspect, (stdout) => {
       return CleanInspect(stdout)
     })
   }

src/docker/presets/containers.js

@@ -22,7 +22,12 @@ function CreateMysqlContainer (name, port, run = false) {
     environmentVariables: [
       { name: 'MYSQL_ROOT_PASSWORD', value: 'cywp' },
     ],
-    healthCommand: 'mysqladmin ping --silent', // eslint-disable-line spellcheck/spell-checker
+    health: {
+      command: 'mysqladmin ping -u root -p$MYSQL_ROOT_PASSWORD | grep \'mysqld is alive\'', // eslint-disable-line spellcheck/spell-checker
+      startPeriod: '5s',
+      retries: 30,
+      interval: '1s',
+    },
   }, run)
 }
 
@@ -47,6 +52,7 @@ function CreateWordpressContainer (name, port, mysqlContainer, run = false) {
     environmentVariables: [
       { name: 'WORDPRESS_DB_HOST', value: `${mysqlContainer.options.name}:${mysqlContainer.options.exposePorts[0].host}` },
       { name: 'WORDPRESS_DB_PASSWORD', value: 'cywp' },
+      { name: 'WORDPRESS_DB_USER', value: 'root' },
       { name: 'WORDPRESS_DB_NAME', value: `cywp-${name}-db` },
     ],
     volumes: [
@@ -57,6 +63,12 @@ function CreateWordpressContainer (name, port, mysqlContainer, run = false) {
     image: 'wordpress',
     network: 'cywp-network',
     name: `cywp-${name}-wordpress`,
+    health: {
+      command: 'test -r wp-includes/version.php',
+      startPeriod: '1s',
+      interval: '1s',
+      retries: 30,
+    },
   }, run)
 }
 
@@ -65,14 +77,14 @@ function CreateWordpressContainer (name, port, mysqlContainer, run = false) {
  *
  * @param {Container} wordpress - WordPress docker container based from.
  * @param {string[]} commands - commands to pass to the container.
- * @returns {Promise<Container>} retrun promise for WordPress continer object.
+ * @returns {Promise<RunInContainerOutput>} retrun promise for WordPress continer object.
  */
 function CreateWordpressCliContainer (wordpress, commands) {
   if (!Array.isArray(commands)) {
     throw new TypeError('commands must be an array')
   }
 
-  return Docker.prototype.CreateContainer({
+  return Docker.prototype.RunInContainer({
     volumes: wordpress.options.volumes,
     image: 'wordpress:cli',
     network: wordpress.options.network,