Fix Skaffold scripts on Windows (#54023)

### Motivation

The code made assumptions about the arch and shell of the host machine.

### Additional Notes

The final compatibility fix to remove a hardcoded arm64 image is happening separately in #51762

Co-authored-by: ofek.lev <ofek.lev@datadoghq.com>

Author: ofek

skaffold.yaml

@@ -3,7 +3,6 @@ kind: Config
 metadata:
   name: datadog-agent
 build:
-  platforms: [ "linux/arm64" ]
   tagPolicy:
     gitCommit: {
         variant: "AbbrevCommitSha"
@@ -18,8 +17,8 @@ deploy:
         remoteChart: datadog/datadog
         setValueTemplates:
           datadog:
-            apiKey: "{{cmd \"bash\" \"-c\" \"echo $DD_API_KEY\"}}"
-            appKey: "{{cmd \"bash\" \"-c\" \"echo $DD_APP_KEY\"}}"
+            apiKey: "{{.DD_API_KEY}}"
+            appKey: "{{.DD_APP_KEY}}"
             kubelet:
               tlsVerify: false
           agents.image:
@@ -56,9 +55,7 @@ profiles:
       artifacts:
       - image: agent
         custom:
-          buildCommand: "docker exec datadog-agent-devcontainer bash -c \"
-            dda inv agent.hacky-dev-image-build --target-image=$IMAGE\""
+          buildCommand: "dda inv -- skaffold.build --target=agent"
       - image: clusteragent
         custom:
-          buildCommand: "docker exec datadog-agent-devcontainer bash -c \"
-            dda inv cluster-agent.hacky-dev-image-build --target-image=$IMAGE\""
+          buildCommand: "dda inv -- skaffold.build --target=clusteragent"

tasks/skaffold.py

@@ -2,6 +2,8 @@
 Skaffold related tasks
 """
 
+import os
+
 from invoke import UnexpectedExit, task
 from invoke.exceptions import Exit
 
@@ -11,6 +13,12 @@
 
 DATADOG_AGENT_MOUNT = "/home/datadog/go/src/github.com/DataDog/datadog-agent"
 
+# Maps a Skaffold artifact name to the invoke task that builds its development image.
+SKAFFOLD_BUILD_TASKS = {
+    "agent": "agent.hacky-dev-image-build",
+    "clusteragent": "cluster-agent.hacky-dev-image-build",
+}
+
 
 @task
 def minikube_start(ctx, path: str = ".") -> None:
@@ -50,16 +58,23 @@ def is_minikube_running(ctx) -> bool:
     return minikube_status.ok
 
 
-def generate_minikube_env(ctx) -> list:
+def minikube_docker_env(ctx) -> dict:
     """
-    Generate the Minikube environment variables
+    Return env vars pointing the Docker CLI at Minikube's daemon, for `ctx.run(env=...)`.
     """
-    minikube_env = []
-    minikube_env_command = ctx.run("minikube docker-env", hide=True)
-    for line in minikube_env_command.stdout.split("\n"):
-        if line.startswith("export"):
-            minikube_env.append(line.replace("export ", ""))
-    return minikube_env
+    # Shell-agnostic `KEY=value` pairs for easier parsing
+    result = ctx.run("minikube docker-env --shell none", hide=True)
+    env = {}
+    for line in result.stdout.splitlines():
+        line = line.strip()
+        if not line or line.startswith("#"):
+            continue
+        key, sep, value = line.partition("=")
+        value = value.strip().strip('"')
+        # Skip empty assignments (e.g. `SSH_AUTH_SOCK=`) so they don't clobber inherited values.
+        if sep and value:
+            env[key.strip()] = value
+    return env
 
 
 @task
@@ -104,7 +119,7 @@ def devcontainer_start(ctx) -> None:
         "sleep infinity",
     ]
 
-    ctx.run(" ".join(generate_minikube_env(ctx) + docker_command))
+    ctx.run(" ".join(docker_command), env=minikube_docker_env(ctx))
 
 
 def is_devcontainer_running(ctx) -> bool:
@@ -119,21 +134,50 @@ def is_devcontainer_running(ctx) -> bool:
         "--format",
         "{{.Names}}",
     ]
-    devcontainer_status = ctx.run(" ".join(generate_minikube_env(ctx) + command), hide=True)
+    devcontainer_status = ctx.run(" ".join(command), hide=True, env=minikube_docker_env(ctx))
     return devcontainer_status.ok and DEVCONTAINER_NAME in devcontainer_status.stdout
 
 
+def ensure_not_worktree(path: str) -> None:
+    """
+    Exit if `path` is a git worktree.
+    """
+    if os.path.isfile(os.path.join(path, ".git")):
+        print(
+            color_message(
+                f"{os.path.abspath(path)} is a git worktree, which the Skaffold development flow does not "
+                "support: only this directory is mounted into the build container, but a worktree's git "
+                "metadata lives in the main repository outside the mount. Run this from a normal clone instead.",
+                Color.RED,
+            )
+        )
+        raise Exit(code=1)
+
+
 @task
 def create(ctx, path=".") -> None:
     """
     Start the Minikube Cluster and the devcontainer
     """
+    ensure_not_worktree(path)
     if not is_minikube_running(ctx):
         minikube_start(ctx, path)
     if not is_devcontainer_running(ctx):
         devcontainer_start(ctx)
 
 
+@task
+def destroy(ctx) -> None:
+    """
+    Remove the devcontainer and delete the Minikube cluster, including anything deployed to it.
+    """
+    if is_minikube_running(ctx):
+        print(color_message("Removing the devcontainer.", Color.BLUE))
+        ctx.run(f"docker rm -f {DEVCONTAINER_NAME}", warn=True, env=minikube_docker_env(ctx))
+    print(color_message("Deleting the Minikube cluster.", Color.BLUE))
+    ctx.run("minikube delete")
+
+
 @task
 def dev(ctx) -> None:
     """
@@ -158,6 +202,14 @@ def dev(ctx) -> None:
     # Create Minikube Cluster and devcontainer if they are not running.
     create(ctx)
 
+    # The deploy installs the `datadog/datadog` remote chart, so ensure its Helm repo is
+    # registered and its index cache (kept under a temp dir that may not persist) is fresh.
+    if not is_installed("helm"):
+        print(color_message("Helm is not installed. Check https://helm.sh/docs/intro/install.", Color.RED))
+        raise Exit(code=1)
+    ctx.run("helm repo add datadog https://helm.datadoghq.com --force-update", warn=True)
+    ctx.run("helm repo update datadog")
+
     # Create Skaffold Dev command
     skaffold_command = [
         "skaffold",
@@ -170,4 +222,24 @@ def dev(ctx) -> None:
         "--status-check=true",
         "--verbosity warn",
     ]
-    ctx.run(" ".join(generate_minikube_env(ctx) + skaffold_command))
+    ctx.run(" ".join(skaffold_command), env=minikube_docker_env(ctx))
+
+
+@task
+def build(ctx, target="agent") -> None:
+    """
+    Build a development image in the running devcontainer, for Skaffold's custom builder.
+
+    Assumes that Skaffold has already set the `IMAGE` env var to the target tag.
+    """
+    build_task = SKAFFOLD_BUILD_TASKS.get(target)
+    if build_task is None:
+        raise Exit(f"Unknown target '{target}'. Valid targets: {', '.join(SKAFFOLD_BUILD_TASKS)}.", code=1)
+
+    target_image = os.environ.get("IMAGE")
+    if not target_image:
+        raise Exit("The IMAGE environment variable is not set (it is provided by Skaffold).", code=1)
+
+    # Run via a login shell to ensure proper environment setup.
+    inner = f"dda inv -- {build_task} --target-image={target_image}"
+    ctx.run(f'docker exec {DEVCONTAINER_NAME} bash -lc "{inner}"', env=minikube_docker_env(ctx))