fix(container): don't error on init if docker server can't be reached

garden-io · Feb 24, 2020 · 4bf8aab · 4bf8aab
1 parent 71f41d4
commit 4bf8aab
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 28 deletions.
diff --git a/garden-service/src/plugins/container/helpers.ts b/garden-service/src/plugins/container/helpers.ts
@@ -11,21 +11,22 @@ import { readFile, pathExists, lstat } from "fs-extra"
 import semver from "semver"
 import { parse, CommandEntry } from "docker-file-parser"
 import isGlob from "is-glob"
-import { ConfigurationError, RuntimeError } from "../../exceptions"
-import { splitFirst, spawn, splitLast } from "../../util/util"
+import { ConfigurationError, RuntimeError, InternalError } from "../../exceptions"
+import { splitFirst, spawn, splitLast, SpawnOutput } from "../../util/util"
 import { ModuleConfig } from "../../config/module"
 import { ContainerModule, ContainerRegistryConfig, defaultTag, defaultNamespace, ContainerModuleConfig } from "./config"
 import { Writable } from "stream"
 import Bluebird from "bluebird"
-import { flatten, uniq } from "lodash"
+import { flatten, uniq, fromPairs } from "lodash"
 import { LogEntry } from "../../logger/log-entry"
 import chalk from "chalk"
 import isUrl from "is-url"
 import { BinaryCmd } from "../../util/ext-tools"
+import titleize from "titleize"
 
 interface DockerVersion {
-  client: string
-  server: string
+  client?: string
+  server?: string
 }
 
 export const DEFAULT_BUILD_TIMEOUT = 600
@@ -221,41 +222,40 @@ const helpers = {
    * Retrieves the docker client and server version.
    */
   async getDockerVersion(cliPath = "docker"): Promise<DockerVersion> {
-    let versionRes: any
+    const results = await Bluebird.map(["client", "server"], async (key) => {
+      let res: SpawnOutput
 
-    try {
-      versionRes = await spawn(cliPath, ["version", "-f", "{{ .Client.Version }} {{ .Server.Version }}"])
-    } catch (err) {
-      throw new RuntimeError(`Unable to get docker version: ${err.message}`, {
-        err,
-      })
-    }
+      try {
+        res = await spawn(cliPath, ["version", "-f", `{{ .${titleize(key)}.Version }}`])
+      } catch (err) {
+        return [key, undefined]
+      }
 
-    const output = versionRes.output.trim()
-    const split = output.split(" ")
+      const output = res.output.trim()
 
-    const clientVersion = split[0]
-    const serverVersion = split[1]
+      if (!output) {
+        throw new RuntimeError(`Unexpected docker version output: ${output}`, {
+          output,
+        })
+      }
 
-    if (!clientVersion || !serverVersion) {
-      throw new RuntimeError(`Unexpected docker version output: ${output}`, {
-        output,
-      })
-    }
+      return [key, output]
+    })
 
-    return { client: clientVersion, server: serverVersion }
+    return fromPairs(results)
   },
 
   /**
    * Asserts that the specified docker client version meets the minimum requirements.
    */
   checkDockerClientVersion(version: DockerVersion) {
-    if (!checkMinDockerVersion(version.client, minDockerVersion.client)) {
+    if (!version.client) {
+      // This should not occur in normal usage, so it is classed as an internal error
+      throw new InternalError(`Docker client is not installed.`, version)
+    } else if (!checkMinDockerVersion(version.client, minDockerVersion.client!)) {
       throw new RuntimeError(
         `Docker client needs to be version ${minDockerVersion.client} or newer (got ${version.client})`,
-        {
-          ...version,
-        }
+        version
       )
     }
   },
@@ -264,7 +264,9 @@ const helpers = {
    * Asserts that the specified docker client version meets the minimum requirements.
    */
   checkDockerServerVersion(version: DockerVersion) {
-    if (!checkMinDockerVersion(version.server, minDockerVersion.server)) {
+    if (!version.server) {
+      throw new RuntimeError(`Docker server is not running or cannot be reached.`, version)
+    } else if (!checkMinDockerVersion(version.server, minDockerVersion.server!)) {
       throw new RuntimeError(
         `Docker server needs to be version ${minDockerVersion.server} or newer (got ${version.server})`,
         {

diff --git a/garden-service/test/unit/src/plugins/container/container.ts b/garden-service/test/unit/src/plugins/container/container.ts
@@ -918,6 +918,20 @@ describe("plugins.container", () => {
       helpers.checkDockerClientVersion(version)
     })
 
+    it("should throw if client is not installed (version is undefined)", async () => {
+      const version = {
+        client: undefined,
+        server: minDockerVersion.server,
+      }
+
+      await expectError(
+        () => helpers.checkDockerClientVersion(version),
+        (err) => {
+          expect(err.message).to.equal("Docker client is not installed.")
+        }
+      )
+    })
+
     it("should throw if client version is too old", async () => {
       const version = {
         client: "17.06",
@@ -947,6 +961,20 @@ describe("plugins.container", () => {
       helpers.checkDockerServerVersion(version)
     })
 
+    it("should throw if server is not reachable (version is undefined)", async () => {
+      const version = {
+        client: minDockerVersion.client,
+        server: undefined,
+      }
+
+      await expectError(
+        () => helpers.checkDockerServerVersion(version),
+        (err) => {
+          expect(err.message).to.equal("Docker server is not running or cannot be reached.")
+        }
+      )
+    })
+
     it("should throw if server version is too old", async () => {
       const version = {
         client: minDockerVersion.client,