fix(core): print warning message if docker server version is unparsab…

…le (#5284) (#5288)
garden-io · Oct 23, 2023 · 5f92abd · 5f92abd
1 parent f7b7a9a
commit 5f92abd
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 14 deletions.
diff --git a/core/src/plugins/container/build.ts b/core/src/plugins/container/build.ts
@@ -35,7 +35,7 @@ export const getContainerBuildStatus: BuildActionHandler<"getStatus", ContainerB
 }
 
 export const buildContainer: BuildActionHandler<"build", ContainerBuildAction> = async ({ ctx, action, log }) => {
-  containerHelpers.checkDockerServerVersion(await containerHelpers.getDockerVersion())
+  containerHelpers.checkDockerServerVersion(await containerHelpers.getDockerVersion(), log)
 
   const buildPath = action.getBuildPath()
   const spec = action.getSpec()

diff --git a/core/src/plugins/container/helpers.ts b/core/src/plugins/container/helpers.ts
@@ -21,7 +21,7 @@ import {
 } from "./moduleConfig"
 import { Writable } from "stream"
 import { flatten, uniq, fromPairs, reduce } from "lodash"
-import { Log } from "../../logger/log-entry"
+import { ActionLog, Log } from "../../logger/log-entry"
 import chalk from "chalk"
 import isUrl from "is-url"
 import titleize from "titleize"
@@ -39,10 +39,10 @@ interface DockerVersion {
   server?: string
 }
 
-export const minDockerVersion: DockerVersion = {
+export const minDockerVersion = {
   client: "19.03.0",
   server: "17.07.0",
-}
+} as const
 
 interface ParsedImageId {
   host?: string
@@ -309,15 +309,26 @@ const helpers = {
   /**
    * Asserts that the specified docker client version meets the minimum requirements.
    */
-  checkDockerServerVersion(version: DockerVersion) {
+  checkDockerServerVersion(version: DockerVersion, log: ActionLog) {
     if (!version.server) {
       throw new RuntimeError({
         message: `Failed to check Docker server version: Docker server is not running or cannot be reached.`,
       })
-    } else if (!checkMinDockerVersion(version.server, minDockerVersion.server!)) {
-      throw new RuntimeError({
-        message: `Docker server needs to be version ${minDockerVersion.server} or newer (got ${version.server})`,
-      })
+    } else {
+      let hasMinVersion = true
+      try {
+        hasMinVersion = checkMinDockerVersion(version.server, minDockerVersion.server)
+      } catch (err) {
+        log.warn(
+          `Failed to parse Docker server version: ${version.server}. Please check your Docker installation. A docker factory reset may be required.`
+        )
+        return
+      }
+      if (!hasMinVersion) {
+        throw new RuntimeError({
+          message: `Docker server needs to be version ${minDockerVersion.server} or newer (got ${version.server})`,
+        })
+      }
     }
   },
 

diff --git a/core/test/integ/src/plugins/container/container.ts b/core/test/integ/src/plugins/container/container.ts
@@ -169,7 +169,7 @@ describe("plugins.container", () => {
 
   describe("checkDockerServerVersion", () => {
     it("should return if server version is equal to the minimum version", async () => {
-      containerHelpers.checkDockerServerVersion(minDockerVersion)
+      containerHelpers.checkDockerServerVersion(minDockerVersion, log)
     })
 
     it("should return if server version is greater than the minimum version", async () => {
@@ -178,7 +178,20 @@ describe("plugins.container", () => {
         server: "99.99",
       }
 
-      containerHelpers.checkDockerServerVersion(version)
+      containerHelpers.checkDockerServerVersion(version, log)
+    })
+
+    // see https://github.com/garden-io/garden/issues/5284
+    it("should print a warning message if server returns an unparsable server version", async () => {
+      const version = {
+        client: "99.99",
+        server: "dev",
+      }
+
+      expect(() => containerHelpers.checkDockerServerVersion(version, log)).to.not.throw()
+      expect(log.entries[0].msg).to.equal(
+        "Failed to parse Docker server version: dev. Please check your Docker installation. A docker factory reset may be required."
+      )
     })
 
     it("should throw if server is not reachable (version is undefined)", async () => {
@@ -188,7 +201,7 @@ describe("plugins.container", () => {
       }
 
       await expectError(
-        () => containerHelpers.checkDockerServerVersion(version),
+        () => containerHelpers.checkDockerServerVersion(version, log),
         (err) => {
           expect(err.message).to.equal(
             "Failed to check Docker server version: Docker server is not running or cannot be reached."
@@ -204,7 +217,7 @@ describe("plugins.container", () => {
       }
 
       await expectError(
-        () => containerHelpers.checkDockerServerVersion(version),
+        () => containerHelpers.checkDockerServerVersion(version, log),
         (err) => {
           expect(err.message).to.equal("Docker server needs to be version 17.07.0 or newer (got 17.06)")
         }

diff --git a/package.json b/package.json
@@ -103,4 +103,4 @@
     "sdk",
     "plugins/*"
   ]
-}
+}