feat(container): add build.timeout option

garden-io · Aug 20, 2019 · fd58037 · fd58037
1 parent 78de820
commit fd58037
Show file tree

Hide file tree

Showing 11 changed files with 87 additions and 20 deletions.
diff --git a/docs/reference/module-types/container.md b/docs/reference/module-types/container.md
@@ -214,6 +214,16 @@ For multi-stage Dockerfiles, specify which image to build (see https://docs.dock
 | -------- | -------- |
 | `string` | No       |
 
+### `build.timeout`
+
+[build](#build) > timeout
+
+Maximum time in seconds to wait for build to finish.
+
+| Type     | Required | Default |
+| -------- | -------- | ------- |
+| `number` | No       | `1200`  |
+
 ### `buildArgs`
 
 Specify build arguments to use when building the container image.
@@ -969,6 +979,7 @@ build:
         - source:
           target: <same as source path>
   targetImage:
+  timeout: 1200
 buildArgs: {}
 extraFlags:
 image:

diff --git a/docs/reference/module-types/maven-container.md b/docs/reference/module-types/maven-container.md
@@ -219,6 +219,16 @@ For multi-stage Dockerfiles, specify which image to build (see https://docs.dock
 | -------- | -------- |
 | `string` | No       |
 
+### `build.timeout`
+
+[build](#build) > timeout
+
+Maximum time in seconds to wait for build to finish.
+
+| Type     | Required | Default |
+| -------- | -------- | ------- |
+| `number` | No       | `1200`  |
+
 ### `buildArgs`
 
 Specify build arguments to use when building the container image.
@@ -1004,6 +1014,7 @@ build:
         - source:
           target: <same as source path>
   targetImage:
+  timeout: 1200
 buildArgs: {}
 extraFlags:
 image:

diff --git a/garden-service/src/plugins/container/build.ts b/garden-service/src/plugins/container/build.ts
@@ -63,7 +63,8 @@ export async function buildContainerModule({ module, log }: BuildModuleParams<Co
 
   // TODO: log error if it occurs
   // TODO: stream output to log if at debug log level
-  const buildLog = await containerHelpers.dockerCli(module, [...cmdOpts, buildPath])
+  const timeout = module.spec.build.timeout
+  const buildLog = await containerHelpers.dockerCli(module, [...cmdOpts, buildPath], { timeout })
 
   return { fresh: true, buildLog, details: { identifier } }
 }

diff --git a/garden-service/src/plugins/container/config.ts b/garden-service/src/plugins/container/config.ts
@@ -387,6 +387,7 @@ export const containerTaskSchema = baseTaskSpecSchema
 
 export interface ContainerBuildSpec extends BaseBuildSpec {
   targetImage?: string
+  timeout: number
 }
 
 export interface ContainerModuleSpec extends ModuleSpec {
@@ -416,6 +417,10 @@ export const containerModuleSpecSchema = joi.object()
             https://docs.docker.com/engine/reference/commandline/build/#specifying-target-build-stage---target for
             details).
           `),
+        timeout: joi.number()
+          .integer()
+          .default(1200)
+          .description("Maximum time in seconds to wait for build to finish."),
       }),
     buildArgs: joi.object()
       .pattern(/.+/, joiPrimitive())

diff --git a/garden-service/src/plugins/container/container.ts b/garden-service/src/plugins/container/container.ts
@@ -143,7 +143,6 @@ export async function configureContainerModule({ ctx, moduleConfig }: ConfigureM
   return moduleConfig
 }
 
-// TODO: rename this plugin to docker
 export const gardenPlugin = (): GardenPlugin => ({
   moduleActions: {
     container: {

diff --git a/garden-service/src/plugins/container/helpers.ts b/garden-service/src/plugins/container/helpers.ts
@@ -13,6 +13,7 @@ import { splitFirst, spawn, splitLast } from "../../util/util"
 import { ModuleConfig } from "../../config/module"
 import { ContainerModule, ContainerRegistryConfig, defaultTag, defaultNamespace, ContainerModuleConfig } from "./config"
 
+export const DEFAULT_BUILD_TIMEOUT = 600
 export const minDockerVersion = "17.07.0"
 
 interface ParsedImageId {
@@ -248,13 +249,16 @@ const helpers = {
     helpers.dockerVersionChecked = true
   },
 
-  async dockerCli(module: ContainerModule, args: string[]) {
+  async dockerCli(
+    module: ContainerModule, args: string[],
+    { timeout = DEFAULT_BUILD_TIMEOUT }: { timeout?: number } = {},
+  ) {
     await helpers.checkDockerVersion()
 
     const cwd = module.buildPath
 
     try {
-      const res = await spawn("docker", args, { cwd })
+      const res = await spawn("docker", args, { cwd, timeout })
       return res.output || ""
     } catch (err) {
       throw new RuntimeError(

diff --git a/garden-service/src/plugins/kubernetes/container/build.ts b/garden-service/src/plugins/kubernetes/container/build.ts
@@ -30,8 +30,6 @@ import { getPortForward } from "../port-forward"
 
 const dockerDaemonDeploymentName = "garden-docker-daemon"
 const dockerDaemonContainerName = "docker-daemon"
-// TODO: make build timeout configurable
-const buildTimeout = 600
 // Note: v0.9.0 appears to be completely broken: https://github.com/GoogleContainerTools/kaniko/issues/268
 const kanikoImage = "gcr.io/kaniko-project/executor:v0.8.0"
 const registryPort = 5000
@@ -176,6 +174,7 @@ const remoteBuild: BuildHandler = async (params) => {
 
     // Execute the build
     const podName = await getBuilderPodName(provider, log)
+    const buildTimeout = module.spec.build.timeout
     const buildRes = await execInBuilder({ provider, log, args, timeout: buildTimeout, podName })
     buildLog = buildRes.stdout + buildRes.stderr
 
@@ -325,6 +324,6 @@ async function runKaniko(provider: KubernetesProvider, log: LogEntry, module: Co
       }],
     },
     podName,
-    timeout: buildTimeout,
+    timeout: module.spec.build.timeout,
   })
 }
diff --git a/garden-service/src/plugins/local/local-google-cloud-functions.ts b/garden-service/src/plugins/local/local-google-cloud-functions.ts
@@ -15,6 +15,7 @@ import { ContainerModuleConfig } from "../container/config"
 import { ContainerServiceSpec, ServicePortProtocol } from "../container/config"
 import { ConfigureProviderParams } from "../../types/plugin/provider/configureProvider"
 import { ConfigureModuleParams } from "../../types/plugin/module/configure"
+import { DEFAULT_BUILD_TIMEOUT } from "../container/helpers"
 
 const pluginName = "local-google-cloud-functions"
 const emulatorModuleName = "local-gcf-container"
@@ -39,6 +40,7 @@ export const gardenPlugin = (): GardenPlugin => ({
         spec: {
           build: {
             dependencies: [],
+            timeout: DEFAULT_BUILD_TIMEOUT,
           },
           buildArgs: {},
           extraFlags: [],

diff --git a/garden-service/src/plugins/openfaas/config.ts b/garden-service/src/plugins/openfaas/config.ts
@@ -24,6 +24,7 @@ import { ConfigureModuleParams, ConfigureModuleResult } from "../../types/plugin
 import { getNamespace } from "../kubernetes/namespace"
 import { LogEntry } from "../../logger/log-entry"
 import { baseBuildSpecSchema } from "../../config/module"
+import { DEFAULT_BUILD_TIMEOUT } from "../container/helpers"
 
 export interface OpenFaasModuleSpec extends ExecModuleSpec {
   handler: string
@@ -115,6 +116,10 @@ export function getContainerModule(module: OpenFaasModule): ContainerModule {
     ...module,
     spec: {
       ...module.spec,
+      build: {
+        ...module.spec.build,
+        timeout: DEFAULT_BUILD_TIMEOUT,
+      },
       buildArgs: {},
       dockerfile: "Dockerfile",
       extraFlags: [],

diff --git a/garden-service/test/unit/src/plugins/container/container.ts b/garden-service/test/unit/src/plugins/container/container.ts
@@ -19,7 +19,11 @@ import {
   ContainerModuleConfig,
   defaultContainerLimits,
 } from "../../../../../src/plugins/container/config"
-import { containerHelpers as helpers, minDockerVersion } from "../../../../../src/plugins/container/helpers"
+import {
+  containerHelpers as helpers,
+  minDockerVersion,
+  DEFAULT_BUILD_TIMEOUT,
+} from "../../../../../src/plugins/container/helpers"
 
 describe("plugins.container", () => {
   const projectRoot = resolve(dataDir, "test-project-container")
@@ -44,7 +48,10 @@ describe("plugins.container", () => {
     type: "container",
 
     spec: {
-      build: { dependencies: [] },
+      build: {
+        dependencies: [],
+        timeout: DEFAULT_BUILD_TIMEOUT,
+      },
       buildArgs: {},
       extraFlags: [],
       services: [],
@@ -96,7 +103,10 @@ describe("plugins.container", () => {
         type: "container",
 
         spec: {
-          build: { dependencies: [] },
+          build: {
+            dependencies: [],
+            timeout: DEFAULT_BUILD_TIMEOUT,
+          },
           buildArgs: {},
           extraFlags: [],
           services: [{
@@ -174,7 +184,10 @@ describe("plugins.container", () => {
         type: "container",
         spec:
         {
-          build: { dependencies: [] },
+          build: {
+            dependencies: [],
+            timeout: DEFAULT_BUILD_TIMEOUT,
+          },
           buildArgs: {},
           extraFlags: [],
           services:
@@ -304,7 +317,10 @@ describe("plugins.container", () => {
         type: "test",
 
         spec: {
-          build: { dependencies: [] },
+          build: {
+            dependencies: [],
+            timeout: DEFAULT_BUILD_TIMEOUT,
+          },
           buildArgs: {},
           extraFlags: [],
           services: [{
@@ -366,7 +382,10 @@ describe("plugins.container", () => {
         type: "test",
 
         spec: {
-          build: { dependencies: [] },
+          build: {
+            dependencies: [],
+            timeout: DEFAULT_BUILD_TIMEOUT,
+          },
           buildArgs: {},
           extraFlags: [],
           services: [{
@@ -422,7 +441,10 @@ describe("plugins.container", () => {
         type: "test",
 
         spec: {
-          build: { dependencies: [] },
+          build: {
+            dependencies: [],
+            timeout: DEFAULT_BUILD_TIMEOUT,
+          },
           buildArgs: {},
           extraFlags: [],
           services: [{
@@ -517,7 +539,8 @@ describe("plugins.container", () => {
         details: { identifier: "some/image" },
       })
 
-      td.verify(dockerCli(module, ["build", "-t", "some/image", module.buildPath]))
+      const cmdArgs = ["build", "-t", "some/image", module.buildPath]
+      td.verify(dockerCli(module, cmdArgs, { timeout: DEFAULT_BUILD_TIMEOUT }))
     })
 
     it("should set build target image parameter if configured", async () => {
@@ -540,7 +563,8 @@ describe("plugins.container", () => {
         details: { identifier: "some/image" },
       })
 
-      td.verify(dockerCli(module, ["build", "-t", "some/image", "--target", "foo", module.buildPath]))
+      const cmdArgs = ["build", "-t", "some/image", "--target", "foo", module.buildPath]
+      td.verify(dockerCli(module, cmdArgs, { timeout: DEFAULT_BUILD_TIMEOUT }))
     })
 
     it("should build image using the user specified Dockerfile path", async () => {
@@ -572,7 +596,7 @@ describe("plugins.container", () => {
         join(module.buildPath, relDockerfilePath),
         module.buildPath,
       ]
-      td.verify(dockerCli(module, cmdArgs))
+      td.verify(dockerCli(module, cmdArgs, { timeout: DEFAULT_BUILD_TIMEOUT }))
     })
   })
 

diff --git a/garden-service/test/unit/src/plugins/container/helpers.ts b/garden-service/test/unit/src/plugins/container/helpers.ts
@@ -18,7 +18,7 @@ import {
   ContainerModuleSpec,
   ContainerModuleConfig,
 } from "../../../../../src/plugins/container/config"
-import { containerHelpers as helpers } from "../../../../../src/plugins/container/helpers"
+import { containerHelpers as helpers, DEFAULT_BUILD_TIMEOUT } from "../../../../../src/plugins/container/helpers"
 
 describe("containerHelpers", () => {
   const projectRoot = resolve(dataDir, "test-project-container")
@@ -40,7 +40,10 @@ describe("containerHelpers", () => {
     type: "container",
 
     spec: {
-      build: { dependencies: [] },
+      build: {
+        dependencies: [],
+        timeout: DEFAULT_BUILD_TIMEOUT,
+      },
       buildArgs: {},
       extraFlags: [],
       services: [],
@@ -233,7 +236,10 @@ describe("containerHelpers", () => {
         type: "container",
 
         spec: {
-          build: { dependencies: [] },
+          build: {
+            dependencies: [],
+            timeout: DEFAULT_BUILD_TIMEOUT,
+          },
           buildArgs: {},
           extraFlags: [],
           image: "some/image",