presidium 0.16.8 → 0.16.9

package/.eslintrc.js

@@ -52,7 +52,7 @@ module.exports = {
             'error',
             'last'
         ],
-        'complexity': ['error', 33],
+        'complexity': ['error', 35],
         'computed-property-spacing': [
             'error',
             'never'

package/Docker.js

@@ -995,6 +995,9 @@ const has = property => value => {
  *   email?: string,
  *   serveraddress?: string,
  *   identitytoken?: string,
+ *
+ *   // user-defined metadata
+ *   labels: object,
  * }) -> Promise<HttpResponse>
  * ```
  */
@@ -1010,6 +1013,7 @@ Docker.prototype.updateService = function dockerUpdateService(service, options)
 
     body: stringifyJSON(defaultsDeep(get('spec', {})(options))({
       Name: service,
+      Labels: options.labels ?? {},
       TaskTemplate: {
         ContainerSpec: {
           ...options.image && { Image: options.image },
@@ -1116,6 +1120,14 @@ Docker.prototype.updateService = function dockerUpdateService(service, options)
         },
       },
 
+      ...options.network && {
+        Networks: [{
+          Target: options.network,
+          Aliases: [],
+          DriverOpts: {},
+        }],
+      },
+
       ...options.publish && {
         EndpointSpec: {
           Ports: Object.entries(options.publish).map(pipe([
@@ -1317,7 +1329,6 @@ Docker.prototype.createNetwork = function createNetwork(options) {
       Name: options.name,
       Driver: options.driver,
       CheckDuplicate: true,
-      Attachable: true,
     })),
   })
 }

package/DockerService.js

@@ -193,12 +193,20 @@ DockerService.prototype.update = async function update(options) {
     ...options,
     spec: this.spec,
     version: this.version,
-  }).then(response => {
-    this.ready = this.synchronize()
+  }).then(async response => {
+    await this.synchronize()
     return response.json()
   })
 }
 
+/**
+ * @name DockerService.prototype.inspect
+ *
+ * @synopsis
+ * ```coffeescript [specscript]
+ * new DockerService(...).inspect() -> Promise<{}>
+ * ```
+ */
 DockerService.prototype.inspect = async function inspect() {
   await this.ready
   return this.docker.inspectService(this.name)

package/DockerService.test.js

@@ -6,117 +6,129 @@ const DockerService = require('./DockerService')
 const inspect = require('util').inspect
 const always = require('rubico/always')
 
-module.exports = Test('DockerService', DockerService)
-  .before(async function () {
-    this.docker = new Docker()
-    await this.docker.leaveSwarm({ force: true })
-    await this.docker.pruneContainers()
-    await this.docker.pruneImages()
-    await this.docker.initSwarm('[::1]:2377')
-  })
-  .case({
-    name: 'my-service',
-    image: 'nginx:1.19',
-    replicas: 1,
-  }, async function (myService) {
-    {
-      const info = await myService.inspect()
-      this.serviceId = info.ID
-      assert.equal(info.ID, this.serviceId)
-      assert.equal(info.Spec.UpdateConfig.Parallelism, 2) // defaults
-      assert.equal(info.Spec.UpdateConfig.Delay, 1e9)
-      assert.equal(info.Spec.UpdateConfig.FailureAction, 'pause')
-      assert.equal(info.Spec.UpdateConfig.Monitor, 15e9)
-      assert.equal(info.Spec.UpdateConfig.MaxFailureRatio, 0.15)
-      assert.equal(info.Spec.RollbackConfig.Parallelism, 1)
-      assert.equal(info.Spec.RollbackConfig.Delay, 1e9)
-      assert.equal(info.Spec.RollbackConfig.FailureAction, 'pause')
-      assert.equal(info.Spec.RollbackConfig.Monitor, 15e9)
-      assert.equal(info.Spec.RollbackConfig.MaxFailureRatio, 0.15)
-    }
+const test = new Test('DockerService', DockerService)
 
-    {
-      const result = await myService.update({
-        replicas: 2,
-        updateParallelism: 3,
-        updateDelay: 2e9,
-        updateFailureAction: 'continue',
-        updateMonitor: 30e9,
-        updateMaxFailureRatio: 0.3,
-        rollbackParallelism: 3,
-        rollbackDelay: 2e9,
-        rollbackFailureAction: 'continue',
-        rollbackMonitor: 30e9,
-        rollbackMaxFailureRatio: 0.3,
-        env: { FOO: 'foo' },
-        workdir: '/opt',
-        mounts: [{
-          source: 'other-volume',
-          target: '/opt/other-volume',
-        }],
-        publish: { 8080: 80 },
-        healthCmd: ['curl', '0.0.0.0:80'],
-        restart: 'on-failure:5',
-        memory: 512e6, // bytes
-      })
-    }
+.before(async function () {
+  this.docker = new Docker()
+  await this.docker.leaveSwarm({ force: true })
+  await this.docker.pruneContainers()
+  await this.docker.pruneImages()
+  await this.docker.initSwarm('[::1]:2377')
+})
 
-    {
-      const info = await myService.inspect()
-      assert.equal(info.ID, this.serviceId)
-      assert.equal(info.Spec.UpdateConfig.Parallelism, 3)
-      assert.equal(info.Spec.UpdateConfig.Delay, 2e9)
-      assert.equal(info.Spec.UpdateConfig.FailureAction, 'continue')
-      assert.equal(info.Spec.UpdateConfig.Monitor, 30e9)
-      assert.equal(info.Spec.UpdateConfig.MaxFailureRatio, 0.3)
-      assert.equal(info.Spec.RollbackConfig.Parallelism, 3)
-      assert.equal(info.Spec.RollbackConfig.Delay, 2e9)
-      assert.equal(info.Spec.RollbackConfig.FailureAction, 'continue')
-      assert.equal(info.Spec.RollbackConfig.Monitor, 30e9)
-      assert.equal(info.Spec.RollbackConfig.MaxFailureRatio, 0.3)
-      assert.equal(info.Spec.Mode.Replicated.Replicas, 2)
-      assert.equal(info.Spec.TaskTemplate.ContainerSpec.Env.length, 1)
-      assert.equal(info.Spec.TaskTemplate.ContainerSpec.Env[0], 'FOO=foo')
-      assert.equal(info.Spec.TaskTemplate.ContainerSpec.Dir, '/opt')
-      assert.deepEqual(
-        info.Spec.TaskTemplate.ContainerSpec.Healthcheck.Test,
-        ['CMD', 'curl', '0.0.0.0:80'])
-      assert.deepEqual(
-        info.Spec.TaskTemplate.ContainerSpec.Mounts,
-        [{ Type: 'volume', Source: 'other-volume', Target: '/opt/other-volume' }])
-      assert.equal(info.Spec.TaskTemplate.RestartPolicy.Condition, 'on-failure')
-      assert.equal(info.Spec.TaskTemplate.RestartPolicy.MaxAttempts, 5)
-      assert.equal(info.Spec.TaskTemplate.Resources.Limits.MemoryBytes, 512e6)
-      this.myServiceSpec = myService.spec
-    }
+.case({
+  name: 'my-service',
+  image: 'nginx:1.19',
+  replicas: 1,
+}, async function (myService) {
+  {
+    const info = await myService.inspect()
+    this.serviceId = info.ID
+    assert.equal(info.ID, this.serviceId)
+    assert.equal(info.Spec.UpdateConfig.Parallelism, 2) // defaults
+    assert.equal(info.Spec.UpdateConfig.Delay, 1e9)
+    assert.equal(info.Spec.UpdateConfig.FailureAction, 'pause')
+    assert.equal(info.Spec.UpdateConfig.Monitor, 15e9)
+    assert.equal(info.Spec.UpdateConfig.MaxFailureRatio, 0.15)
+    assert.equal(info.Spec.RollbackConfig.Parallelism, 1)
+    assert.equal(info.Spec.RollbackConfig.Delay, 1e9)
+    assert.equal(info.Spec.RollbackConfig.FailureAction, 'pause')
+    assert.equal(info.Spec.RollbackConfig.Monitor, 15e9)
+    assert.equal(info.Spec.RollbackConfig.MaxFailureRatio, 0.15)
+  }
 
-    {
-      const logResponseStream = await myService.getLogs({ stdout: true, stderr: true })
-      logResponseStream.pipe(process.stdout)
-      await new Promise(resolve => logResponseStream.on('end', resolve))
-    }
-  })
-  .case({
-    name: 'my-service',
-    image: 'nginx:1.19',
-    replicas: 2,
-  }, async function (myService) {
-    await myService.ready
-    // TODO test for update on construction
-    assert.deepEqual(myService.spec, this.myServiceSpec)
-  })
-  .case({
-    name: 'bad-request',
-    image: 'nginx:1.19',
-    replicas: 2,
-    restart: 'always', // coulda fooled me
-  }, async function (errorService) {
-    assert.rejects(
-      always(errorService.ready),
-      new Error('{"message":"invalid RestartCondition: \\"always\\""}\n'))
-  })
-  .after(async function () {
-    await this.docker.pruneContainers()
-    await this.docker.pruneImages()
-    await this.docker.leaveSwarm({ force: true })
-  })
+  {
+    const result = await myService.update({
+      labels: { foo: 'bar' },
+      replicas: 2,
+      updateParallelism: 3,
+      updateDelay: 2e9,
+      updateFailureAction: 'continue',
+      updateMonitor: 30e9,
+      updateMaxFailureRatio: 0.3,
+      rollbackParallelism: 3,
+      rollbackDelay: 2e9,
+      rollbackFailureAction: 'continue',
+      rollbackMonitor: 30e9,
+      rollbackMaxFailureRatio: 0.3,
+      env: { FOO: 'foo' },
+      workdir: '/opt',
+      mounts: [{
+        source: 'other-volume',
+        target: '/opt/other-volume',
+      }],
+      publish: { 8080: 80 },
+      healthCmd: ['curl', '0.0.0.0:80'],
+      restart: 'on-failure:5',
+      memory: 512e6, // bytes
+    })
+  }
+
+  {
+    const info = await myService.inspect()
+    assert.equal(info.ID, this.serviceId)
+    // assert.equal(info.Spec.Labels.foo, 'bar')
+    assert.equal(info.Spec.UpdateConfig.Parallelism, 3)
+    assert.equal(info.Spec.UpdateConfig.Delay, 2e9)
+    assert.equal(info.Spec.UpdateConfig.FailureAction, 'continue')
+    assert.equal(info.Spec.UpdateConfig.Monitor, 30e9)
+    assert.equal(info.Spec.UpdateConfig.MaxFailureRatio, 0.3)
+    assert.equal(info.Spec.RollbackConfig.Parallelism, 3)
+    assert.equal(info.Spec.RollbackConfig.Delay, 2e9)
+    assert.equal(info.Spec.RollbackConfig.FailureAction, 'continue')
+    assert.equal(info.Spec.RollbackConfig.Monitor, 30e9)
+    assert.equal(info.Spec.RollbackConfig.MaxFailureRatio, 0.3)
+    assert.equal(info.Spec.Mode.Replicated.Replicas, 2)
+    assert.equal(info.Spec.TaskTemplate.ContainerSpec.Env.length, 1)
+    assert.equal(info.Spec.TaskTemplate.ContainerSpec.Env[0], 'FOO=foo')
+    assert.equal(info.Spec.TaskTemplate.ContainerSpec.Dir, '/opt')
+    assert.deepEqual(
+      info.Spec.TaskTemplate.ContainerSpec.Healthcheck.Test,
+      ['CMD', 'curl', '0.0.0.0:80'])
+    assert.deepEqual(
+      info.Spec.TaskTemplate.ContainerSpec.Mounts,
+      [{ Type: 'volume', Source: 'other-volume', Target: '/opt/other-volume' }])
+    assert.equal(info.Spec.TaskTemplate.RestartPolicy.Condition, 'on-failure')
+    assert.equal(info.Spec.TaskTemplate.RestartPolicy.MaxAttempts, 5)
+    assert.equal(info.Spec.TaskTemplate.Resources.Limits.MemoryBytes, 512e6)
+    this.myServiceSpec = myService.spec
+  }
+
+  {
+    const logResponseStream = await myService.getLogs({ stdout: true, stderr: true })
+    logResponseStream.pipe(process.stdout)
+    await new Promise(resolve => logResponseStream.on('end', resolve))
+  }
+})
+
+.case({
+  name: 'my-service',
+  image: 'nginx:1.19',
+  replicas: 2,
+}, async function (myService) {
+  await myService.ready
+  // TODO test for update on construction assert.deepEqual(myService.spec, this.myServiceSpec)
+})
+
+.case({
+  name: 'bad-request',
+  image: 'nginx:1.19',
+  replicas: 2,
+  restart: 'always', // coulda fooled me
+}, async function (errorService) {
+  assert.rejects(
+    always(errorService.ready),
+    new Error('{"message":"invalid RestartCondition: \\"always\\""}\n'))
+})
+
+.after(async function () {
+  await this.docker.pruneContainers()
+  await this.docker.pruneImages()
+  await this.docker.leaveSwarm({ force: true })
+})
+
+if (process.argv[1] == __filename) {
+  test()
+}
+
+module.exports = test

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "presidium",
-  "version": "0.16.8",
+  "version": "0.16.9",
   "description": "A library for creating web services",
   "author": "Richard Tong",
   "license": "MIT",