fix(cli): return error in garden run task if task fails (#1669)

* fix: return an error if the test fails

* fix: create common helper

Co-authored-by: Mitchell Friedman <[email protected]>
Co-authored-by: Jon Edvald <[email protected]>

garden-service/src/commands/base.ts

@@ -7,19 +7,21 @@
  */
 
 import Joi = require("@hapi/joi")
+import chalk from "chalk"
+import dedent = require("dedent")
+import inquirer = require("inquirer")
 import stripAnsi from "strip-ansi"
-import { GardenError, RuntimeError, InternalError, ParameterError } from "../exceptions"
-import { TaskResults } from "../task-graph"
-import { LoggerType } from "../logger/logger"
-import { ProcessResults } from "../process"
+
+import { GlobalOptions } from "../cli/cli"
+import { joi } from "../config/common"
+import { GardenError, InternalError, ParameterError, RuntimeError } from "../exceptions"
 import { Garden } from "../garden"
 import { LogEntry } from "../logger/log-entry"
+import { LoggerType } from "../logger/logger"
 import { printFooter } from "../logger/util"
-import { GlobalOptions } from "../cli/cli"
-import { joi } from "../config/common"
-import inquirer = require("inquirer")
-import dedent = require("dedent")
-import chalk from "chalk"
+import { ProcessResults } from "../process"
+import { TaskResults } from "../task-graph"
+import { RunResult } from "../types/plugin/base"
 
 export interface ParameterConstructor<T> {
   help: string
@@ -370,6 +372,20 @@ export abstract class Command<T extends Parameters = {}, U extends Parameters =
   }
 }
 
+export async function handleActionResult(action: string, result: RunResult): Promise<CommandResult<RunResult>> {
+  if (!result.success) {
+    return {
+      errors: [
+        new RuntimeError(`${action} failed!`, {
+          result,
+        }),
+      ],
+    }
+  }
+
+  return { result }
+}
+
 export async function handleTaskResults(
   log: LogEntry,
   taskType: string,

garden-service/src/commands/run/module.ts

@@ -7,13 +7,22 @@
  */
 
 import chalk from "chalk"
-import { RunResult } from "../../types/plugin/base"
-import { BooleanParameter, Command, CommandParams, StringParameter, CommandResult, StringsParameter } from "../base"
-import { printRuntimeContext } from "./run"
+
 import { printHeader } from "../../logger/util"
+import { prepareRuntimeContext } from "../../runtime-context"
 import { BuildTask } from "../../tasks/build"
+import { RunResult } from "../../types/plugin/base"
 import { dedent, deline } from "../../util/string"
-import { prepareRuntimeContext } from "../../runtime-context"
+import {
+  BooleanParameter,
+  Command,
+  CommandParams,
+  CommandResult,
+  handleActionResult,
+  StringParameter,
+  StringsParameter,
+} from "../base"
+import { printRuntimeContext } from "./run"
 
 const runArgs = {
   module: new StringParameter({
@@ -118,6 +127,6 @@ export class RunModuleCommand extends Command<Args, Opts> {
       timeout: opts.interactive ? 999999 : undefined,
     })
 
-    return { result }
+    return handleActionResult(`Module ${module.name}`, result)
   }
 }

garden-service/src/commands/run/service.ts

@@ -7,16 +7,17 @@
  */
 
 import chalk from "chalk"
-import { RunResult } from "../../types/plugin/base"
-import { BooleanParameter, Command, CommandParams, CommandResult, StringParameter } from "../base"
-import { printRuntimeContext } from "./run"
 import dedent = require("dedent")
+
+import { CommandError } from "../../exceptions"
 import { printHeader } from "../../logger/util"
-import { DeployTask } from "../../tasks/deploy"
-import { getServiceStatuses, getRunTaskResults } from "../../tasks/base"
 import { prepareRuntimeContext } from "../../runtime-context"
+import { getRunTaskResults, getServiceStatuses } from "../../tasks/base"
+import { DeployTask } from "../../tasks/deploy"
+import { RunResult } from "../../types/plugin/base"
 import { deline } from "../../util/string"
-import { CommandError } from "../../exceptions"
+import { BooleanParameter, Command, CommandParams, CommandResult, handleActionResult, StringParameter } from "../base"
+import { printRuntimeContext } from "./run"
 
 const runArgs = {
   service: new StringParameter({
@@ -110,6 +111,6 @@ export class RunServiceCommand extends Command<Args, Opts> {
       timeout: 999999,
     })
 
-    return { result }
+    return handleActionResult(`Service ${service.name} in module ${module.name}`, result)
   }
 }

garden-service/src/commands/run/test.ts

@@ -7,17 +7,18 @@
  */
 
 import chalk from "chalk"
-import { ParameterError, CommandError } from "../../exceptions"
-import { RunResult } from "../../types/plugin/base"
-import { findByName, getNames } from "../../util/util"
-import { BooleanParameter, Command, CommandParams, CommandResult, StringParameter } from "../base"
-import { printRuntimeContext } from "./run"
-import { prepareRuntimeContext } from "../../runtime-context"
+
+import { CommandError, ParameterError } from "../../exceptions"
 import { printHeader } from "../../logger/util"
-import { TestTask } from "../../tasks/test"
+import { prepareRuntimeContext } from "../../runtime-context"
 import { getRunTaskResults, getServiceStatuses } from "../../tasks/base"
-import { dedent, deline } from "../../util/string"
+import { TestTask } from "../../tasks/test"
+import { RunResult } from "../../types/plugin/base"
 import { testFromConfig } from "../../types/test"
+import { dedent, deline } from "../../util/string"
+import { findByName, getNames } from "../../util/util"
+import { BooleanParameter, Command, CommandParams, CommandResult, handleActionResult, StringParameter } from "../base"
+import { printRuntimeContext } from "./run"
 
 const runArgs = {
   module: new StringParameter({
@@ -137,6 +138,6 @@ export class RunTestCommand extends Command<Args, Opts> {
       testVersion: testTask.version,
     })
 
-    return { result }
+    return handleActionResult(`Test ${test.name} in module ${module.name}`, result)
   }
 }

garden-service/test/data/test-project-fails/garden.yml

@@ -0,0 +1,7 @@
+kind: Project
+name: test-project-failing-test
+environments:
+  - name: local
+providers:
+  - name: test-plugin
+    environments: [local]

garden-service/test/data/test-project-fails/module/garden.yml

@@ -0,0 +1,9 @@
+kind: Module
+name: module
+type: test
+tests:
+  - name: unit
+    command: [exit, "10"]
+tasks:
+  - name: task
+    command: [exit, "10"]

garden-service/test/helpers.ts

@@ -91,6 +91,7 @@ async function runModule(params: RunModuleParams): Promise<RunResult> {
 }
 
 export const projectRootA = getDataDir("test-project-a")
+export const projectTestFailsRoot = getDataDir("test-project-fails")
 
 const testModuleTestSchema = () => containerTestSchema().keys({ command: joi.array().items(joi.string()) })
 
@@ -351,6 +352,10 @@ export const makeTestGardenA = async (extraPlugins: RegisterPluginParam[] = [])
   return makeTestGarden(projectRootA, { plugins: extraPlugins })
 }
 
+export const makeTestGardenTasksFails = async (extraPlugins: RegisterPluginParam[] = []) => {
+  return makeTestGarden(projectTestFailsRoot, { plugins: extraPlugins })
+}
+
 export function stubAction<T extends keyof PluginActionHandlers>(
   garden: Garden,
   pluginName: string,

garden-service/test/unit/src/commands/run/module.ts

@@ -6,12 +6,13 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
+import { expect } from "chai"
+import td from "testdouble"
+
 import { RunModuleCommand } from "../../../../../src/commands/run/module"
+import { Garden } from "../../../../../src/garden"
 import { RunResult } from "../../../../../src/types/plugin/base"
 import { makeTestGardenA, testModuleVersion, testNow, withDefaultGlobalOpts } from "../../../../helpers"
-import { expect } from "chai"
-import { Garden } from "../../../../../src/garden"
-import td from "testdouble"
 
 describe("RunModuleCommand", () => {
   // TODO: test optional flags

garden-service/test/unit/src/commands/run/test.ts

@@ -9,7 +9,7 @@
 import stripAnsi from "strip-ansi"
 import { expect } from "chai"
 import { omit } from "lodash"
-import { makeTestGardenA, withDefaultGlobalOpts, expectError } from "../../../../helpers"
+import { makeTestGardenA, makeTestGardenTasksFails, withDefaultGlobalOpts, expectError } from "../../../../helpers"
 import { RunTestCommand } from "../../../../../src/commands/run/test"
 
 describe("RunTestCommand", () => {
@@ -39,6 +39,22 @@ describe("RunTestCommand", () => {
     expect(omit(result, ["completedAt", "startedAt", "version"])).to.eql(expected)
   })
 
+  it("should return an error if the test fails", async () => {
+    const garden = await makeTestGardenTasksFails()
+    const log = garden.log
+
+    const result = await cmd.action({
+      garden,
+      log,
+      headerLog: log,
+      footerLog: log,
+      args: { test: "unit", module: "module" },
+      opts: withDefaultGlobalOpts({ "force": false, "force-build": false, "interactive": true }),
+    })
+
+    expect(result.errors).to.have.lengthOf(1)
+  })
+
   it("should throw if the test is disabled", async () => {
     const garden = await makeTestGardenA()
     const log = garden.log