fix: handling varfiles in remote actions (#6147)

* fix: handling varfiles with helm sources Signed-off-by: Manuel Ruck <git@manuelruck.de> * refactor: 🧹 reuse basePath Signed-off-by: Manuel Ruck <git@manuelruck.de> * test(e2e): add varfiles to `remote-sources` e2e test * refactor: helpers for effective config file's dir resolution --------- Signed-off-by: Manuel Ruck <git@manuelruck.de> Co-authored-by: Manuel Ruck <git@manuelruck.de> Co-authored-by: Vladimir Vagaytsev <vladimir.vagaitsev@gmail.com>
garden-io · Jun 10, 2024 · 4d9026f · 4d9026f
1 parent d0a99da
commit 4d9026f
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 4 deletions.
diff --git a/core/src/actions/base.ts b/core/src/actions/base.ts
@@ -67,6 +67,7 @@ import { joinWithPosix } from "../util/fs.js"
 import type { LinkedSource } from "../config-store/local.js"
 import type { BaseActionTaskParams, ExecuteTask } from "../tasks/base.js"
 import { styles } from "../logger/styles.js"
+import { dirname } from "node:path"
 
 // TODO: split this file
 
@@ -476,6 +477,11 @@ export abstract class BaseAction<
     return this._config.internal.configFilePath
   }
 
+  effectiveConfigFileLocation() {
+    const configPath = this.configPath()
+    return !!configPath ? dirname(configPath) : this.sourcePath()
+  }
+
   moduleName(): string | null {
     return this._moduleName || null
   }
@@ -675,6 +681,7 @@ export abstract class BaseAction<
   set executeConcurrencyLimit(limit: number | undefined) {
     this._config.internal.executeConcurrencyLimit = limit
   }
+
   get executeConcurrencyLimit(): number | undefined {
     return this._config.internal.executeConcurrencyLimit
   }

diff --git a/core/src/config/base.ts b/core/src/config/base.ts
@@ -27,7 +27,7 @@ import { isNotNull, isTruthy } from "../util/util.js"
 import type { DeepPrimitiveMap, PrimitiveMap } from "./common.js"
 import { createSchema, joi } from "./common.js"
 import { emitNonRepeatableWarning } from "../warnings.js"
-import type { ActionKind } from "../actions/types.js"
+import type { ActionKind, BaseActionConfig } from "../actions/types.js"
 import { actionKinds } from "../actions/types.js"
 import { mayContainTemplateString } from "../template-string/template-string.js"
 import type { Log } from "../logger/log-entry.js"
@@ -56,6 +56,11 @@ export interface YamlDocumentWithSource extends Document {
   source: string
 }
 
+export function getEffectiveConfigFileLocation(actionConfig: BaseActionConfig): string {
+  const internal = actionConfig.internal
+  return !!internal.configFilePath ? dirname(internal.configFilePath) : internal.basePath
+}
+
 export interface GardenResourceInternalFields {
   /**
    * The path/working directory where commands and operations relating to the config should be executed. This is

diff --git a/core/src/graph/actions.ts b/core/src/graph/actions.ts
@@ -34,7 +34,7 @@ import { BuildAction, buildActionConfigSchema, isBuildActionConfig } from "../ac
 import { DeployAction, deployActionConfigSchema, isDeployActionConfig } from "../actions/deploy.js"
 import { RunAction, runActionConfigSchema, isRunActionConfig } from "../actions/run.js"
 import { TestAction, testActionConfigSchema, isTestActionConfig } from "../actions/test.js"
-import { noTemplateFields } from "../config/base.js"
+import { getEffectiveConfigFileLocation, noTemplateFields } from "../config/base.js"
 import type { ActionReference, JoiDescription } from "../config/common.js"
 import { describeSchema, parseActionReference } from "../config/common.js"
 import type { GroupConfig } from "../config/group.js"
@@ -456,8 +456,10 @@ async function processActionConfig({
     config.internal.treeVersion ||
     (await garden.vcs.getTreeVersion({ log, projectName: garden.projectName, config, scanRoot }))
 
+  const effectiveConfigFileLocation = getEffectiveConfigFileLocation(config)
+
   let variables = await mergeVariables({
-    basePath: config.internal.basePath,
+    basePath: effectiveConfigFileLocation,
     variables: config.variables,
     varfiles: config.varfiles,
   })

diff --git a/core/src/tasks/resolve-action.ts b/core/src/tasks/resolve-action.ts
@@ -157,9 +157,11 @@ export class ResolveActionTask<T extends Action> extends BaseActionTask<T, Resol
       })
     }
 
+    const basePath = action.effectiveConfigFileLocation()
+
     const actionVariables = resolveTemplateStrings({
       value: await mergeVariables({
-        basePath: action.sourcePath(),
+        basePath,
         variables: config.variables,
         varfiles: config.varfiles,
       }),

diff --git a/examples/remote-sources/worker/.env b/examples/remote-sources/worker/.env
@@ -0,0 +1 @@
+FOO=bar
diff --git a/examples/remote-sources/worker/garden.yml b/examples/remote-sources/worker/garden.yml
@@ -5,6 +5,10 @@ source:
   repository:
     url: https://github.com/garden-io/garden-example-remote-module-jworker.git#main
 
+# Do not delete, this must be resolved from the current path, not from the cloned sourced path
+varfiles:
+  - ./.env
+
 ---
 kind: Deploy
 description: The worker that collects votes and stores results in a postgres table