feat: add with-dependants deploy command flag

garden-io · Jul 11, 2023 · c34851e · c34851e
1 parent 06d967d
commit c34851e
Show file tree

Hide file tree

Showing 3 changed files with 91 additions and 2 deletions.
diff --git a/core/src/commands/deploy.ts b/core/src/commands/deploy.ts
@@ -36,6 +36,7 @@ import { LogMonitor } from "../monitors/logs"
 import { LoggerType, parseLogLevel } from "../logger/logger"
 import { serveOpts } from "./serve"
 import { gardenEnv } from "../constants"
+import { DeployAction } from "../actions/deploy"
 
 export const deployArgs = {
   names: new StringsParameter({
@@ -92,6 +93,12 @@ export const deployOpts = {
     `,
     aliases: ["nodeps"],
   }),
+  "with-dependants": new BooleanParameter({
+    help: deline`
+    Additionally deploy all deploy actions that are downstream dependants of the action(s) being deployed.
+    This can be useful when you know you need to redeploy dependants.
+    `,
+  }),
   "disable-port-forwards": new BooleanParameter({
     help: "Disable automatic port forwarding when running persistently. Note that you can also set GARDEN_DISABLE_PORT_FORWARDS=true in your environment.",
   }),
@@ -208,6 +215,18 @@ export class DeployCommand extends Command<Args, Opts> {
       log.info(chalk.gray(msg))
     }
 
+    const skipRuntimeDependencies = opts["skip-dependencies"]
+    const withDependants = opts["with-dependants"]
+    if (withDependants && args.names && args.names.length > 0) {
+      const result = graph.getDependantsForMany({
+        kind: "Deploy",
+        names: deployActions.map((a) => a.name),
+        recursive: true,
+        filter: (a) => a.kind === "Deploy",
+      }) as DeployAction[]
+      deployActions.push(...result)
+    }
+
     const skipped = opts.skip || []
 
     deployActions = deployActions.filter((s) => !s.isDisabled() && !skipped.includes(s.name))
@@ -217,8 +236,6 @@ export class DeployCommand extends Command<Args, Opts> {
       return { result: { aborted: true, success: true, ...emptyActionResults } }
     }
 
-    const skipRuntimeDependencies = opts["skip-dependencies"]
-
     const force = opts.force
     const startSync = !!opts.sync
 

diff --git a/core/test/unit/src/commands/deploy.ts b/core/test/unit/src/commands/deploy.ts
@@ -122,6 +122,7 @@ export const defaultDeployOpts = withDefaultGlobalOpts({
   "port": defaultServerPort,
   "cmd": undefined,
   "disable-port-forwards": false,
+  "with-dependants": false,
 })
 
 describe("DeployCommand", () => {
@@ -258,6 +259,76 @@ describe("DeployCommand", () => {
     })
   })
 
+  context("when --with-dependants is passed", () => {
+    it("should deploy dependant deploys", async () => {
+      const garden = await makeTestGarden(projectRootA, { plugins: [testProvider()] })
+      const log = garden.log
+
+      const { result, errors } = await command.action({
+        garden,
+        log,
+        args: {
+          names: ["service-a"],
+        },
+        opts: {
+          ...defaultDeployOpts,
+          "with-dependants": true,
+        },
+      })
+
+      if (errors) {
+        throw errors[0]
+      }
+
+      const keys = getAllProcessedTaskNames(result!.graphResults)
+
+      // c has nothing to do with service-a
+      expect(keys).to.not.include("deploy.service-c")
+      // b is a dependant
+      expect(keys).to.include("deploy.service-b")
+    })
+
+    it("should have no effect if no names are passed", async () => {
+      const garden = await makeTestGarden(projectRootA, { plugins: [testProvider()] })
+      const log = garden.log
+
+      const { result: resultWith, errors: errors1 } = await command.action({
+        garden,
+        log,
+        args: {
+          names: [],
+        },
+        opts: {
+          ...defaultDeployOpts,
+          "with-dependants": true,
+        },
+      })
+      if (errors1) {
+        throw errors1[0]
+      }
+
+      const { result: resultWithout, errors: errors2 } = await command.action({
+        garden,
+        log,
+        args: {
+          names: [],
+        },
+        opts: {
+          ...defaultDeployOpts,
+          "with-dependants": true,
+        },
+      })
+      if (errors2) {
+        throw errors2[0]
+      }
+
+      const keysWith = getAllProcessedTaskNames(resultWith!.graphResults)
+      const keysWithout = getAllProcessedTaskNames(resultWithout!.graphResults)
+
+      expect(keysWith).to.eql(keysWithout)
+    })
+  })
+
   it("should be protected", async () => {
     expect(command.protected).to.be.true
   })

diff --git a/docs/reference/commands.md b/docs/reference/commands.md
@@ -995,6 +995,7 @@ the command stays running until explicitly aborted.
 This always takes the precedence over sync mode if there are any conflicts, i.e. if the same Deploys are matched with both &#x60;--sync&#x60; and &#x60;--local&#x60; options.
   | `--skip` |  | array:string | The name(s) of Deploys you&#x27;d like to skip.
   | `--skip-dependencies` |  | boolean | Skip deploy, test and run dependencies. Build dependencies and runtime output reference dependencies are not skipped. This can be useful e.g. when your stack has already been deployed, and you want to run specific Deploys in sync mode without deploying or running dependencies that may have changed since you last deployed.
+  | `--with-dependants` |  | boolean | Additionally deploy all deploy actions that are downstream dependants of the action(s) being deployed. This can be useful when you know you need to redeploy dependants.
   | `--disable-port-forwards` |  | boolean | Disable automatic port forwarding when running persistently. Note that you can also set GARDEN_DISABLE_PORT_FORWARDS&#x3D;true in your environment.
   | `--forward` |  | boolean | Create port forwards and leave process running after deploying. This is implied if any of --sync / --local or --logs are set.
   | `--logs` |  | boolean | Stream logs from the requested Deploy(s) (or services if using modules) during deployment, and leave the log streaming process running after deploying. Note: This option implies the --forward option.