Add Windows support to Taskfiles (#1304)

My original motivation for this PR was that I was working on a different PR, wanted to manually test changes on Windows, and found that task build wouldn't even run. Therefore, this PR follows the "80/20 rule" to deliver the most improvement for the most users for a reasonable amount of effort. In other words, this does not fix every Windows issue in the project, but it does make sure the vast majority of tasks defined in the Taskfiles do now run correctly on both Windows and MacOS.

Changes were tested on MacOS and Windows (given that Linux and MacOS have nearly the same command set, and no commands that actually run on MacOS were changed, so any tasks that ran correctly on Linux before should continue to). See details at the end of this description.

This PR replaces Linux/MacOS-specific commands in Taskfile.yml and cmd/thv-operator/Taskfile.yml with cross-platform templating functions built into go-task (where possible) or platform-specific commands for both *nix and Windows where unavoidable.

Note that the scope of these changes is limited to:

ensuring that the task commands run correctly once dependencies are installed - for example, task test-e2e will fail if ginkgo is not installed (the same is true on MacOS)
ensuring that the task commands run correctly on Windows, not that they necessarily run successfully
ensuring that (nearly) all task commands which run correctly on MacOS also run correctly on Windows - some tasks were found to fail with the same errors on MacOS and Windows, and so were left as is
Example 1: Before this change, on Windows, task test exited without running any tests. After this change, on Windows, task test runs unit tests ... but several of them fail. (This is an opportunity for further Windows improvements.)

Example 2: task operator-test exits with "shell": executable file not found in $PATH on Windows. However, it exits with the same error on MacOS, so this was not addressed as it is outside the scope of making the Taskfiles cross-platform.

Specific Notes / Exceptions:
task lint: Fails with 8 lint issues on Windows
task test: Several failing tests on Windows
task test-e2e: 10 failing specs on Windows
task operator-deploy-local: This is the big exception mentioned above. This looked like it would be a lot of effort, due to the lack of a tail equivalent in Windows, and also is a task that would probably only be used by a small number of fairly advanced developers who would know how to get this to work manually. For now, keeping the 80/20 rule in mind, at least this task is restricted to Linux and MacOS platforms, so rather than just exiting with an error, a user running this test on Windows will get a message that it isn't supported on Windows. Hopefully some advanced Windows / Kubernetes developer will fix this if they run into it.
task operator-test: Exits with "shell": executable file not found in $PATH on Windows, but this is also the case on MacOS
task operator-e2e-test: 1 test fails on Windows, but this is also the case on MacOS
task crdref-gen: This task wasn't working on either Windows or MacOS, due to incorrect config file paths. This has now been fixed. looks like this is intended for CI, rather than local development, given that it's now failing there. Reverting.
Closes #1217.

Signed-off-by: Chris Gernon <[email protected]>
Co-authored-by: Don Browne <[email protected]>

Author: while1fork

Taskfile.yml

@@ -34,28 +34,93 @@ tasks:
     cmds:
       - golangci-lint run --fix ./...
 
-  test:
-    desc: Run unit tests (excluding e2e tests)
+  test-unixlike:
+    desc: Run unit tests (excluding e2e tests) on Linux and macOS
+    platforms: [linux, darwin]
+    internal: true
     cmds:
       - go test -v $(go list ./... | grep -v '/test/e2e')
 
-  test-coverage:
-    desc: Run unit tests with coverage analysis (excluding e2e tests)
+  test-windows:
+    desc: Run unit tests (excluding e2e tests) on Windows
+    platforms: [windows]
+    internal: true
+    vars:
+      DIR_LIST:
+        sh: go list ./... | findstr -V "\/test\/e2e"
+    cmds:
+      - go test -v {{.DIR_LIST | catLines}}
+
+  test:
+    desc: Run unit tests (excluding e2e tests)
+    cmds:
+      - task: test-unixlike
+        platforms: [linux, darwin]
+      - task: test-windows
+        platforms: [windows]
+
+  test-coverage-unixlike:
+    desc: Run unit tests with coverage analysis (excluding e2e tests) on Linux and macOS
+    platforms: [linux, darwin]
+    internal: true
     cmds:
-      - mkdir -p coverage
+      - cmd: mkdir -p coverage
+        platforms: [linux, darwin]
       - go test -coverprofile=coverage/coverage.out $(go list ./... | grep -v '/test/e2e')
       - go tool cover -func=coverage/coverage.out
       - echo "Generating HTML coverage report in coverage/coverage.html"
       - go tool cover -html=coverage/coverage.out -o coverage/coverage.html
 
+  test-coverage-windows:
+    desc: Run unit tests with coverage analysis (excluding e2e tests) on Windows
+    platforms: [windows]
+    internal: true
+    vars:
+      DIR_LIST:
+        sh: go list ./... | findstr -V "\/test\/e2e"
+    cmds:
+      - cmd: cmd.exe /c mkdir coverage
+        ignore_error: true   # Windows has no mkdir -p, so just ignore error if it exists
+      - go test -coverprofile=coverage/coverage.out {{.DIR_LIST | catLines}}
+      - go tool cover -func=coverage/coverage.out
+      - echo "Generating HTML coverage report in coverage/coverage.html"
+      - go tool cover -html=coverage/coverage.out -o coverage/coverage.html
+
+  test-coverage:
+    desc: Run unit tests with coverage analysis (excluding e2e tests)
+    cmds:
+      - task: test-coverage-unixlike
+        platforms: [linux, darwin]
+      - task: test-coverage-windows
+        platforms: [windows]
+
+  test-e2e-unixlike:
+    desc: Run end-to-end tests on Linux and macOS
+    platforms: [linux, darwin]
+    internal: true
+    env:
+      THV_BINARY: "{{.PWD}}/bin/thv"
+    cmds:
+      - ./test/e2e/run_tests.sh
+
+  test-e2e-windows:
+    desc: Run end-to-end tests on Windows
+    platforms: [windows]
+    internal: true
+    env:
+      THV_BINARY: "{{.ROOT_DIR}}\\bin\\thv.exe"
+    cmds:
+      - cmd: .\\test\\e2e\\run_tests.bat
+
   test-e2e:
     desc: Run end-to-end tests
     deps: [build]
-    env:
-      THV_BINARY: "{{.PWD}}/bin/thv"
     cmds:
       - go install github.com/onsi/ginkgo/v2/ginkgo
-      - ./test/e2e/run_tests.sh
+      - task: test-e2e-unixlike
+        platforms: [linux, darwin]
+      - task: test-e2e-windows
+        platforms: [windows]
 
   test-all:
     desc: Run all tests (unit and e2e)
@@ -68,12 +133,17 @@ tasks:
         sh: git describe --tags --always --dirty --match "v*" || echo "dev"
       COMMIT:
         sh: git rev-parse --short HEAD || echo "unknown"
-      BUILD_DATE:
-        sh: date -u +"%Y-%m-%dT%H:%M:%SZ"
+      BUILD_DATE: '{{dateInZone "2006-01-02T15:04:05Z" (now) "UTC"}}'
     cmds:
-      - mkdir -p bin
-      - go build -ldflags "-s -w -X github.com/stacklok/toolhive/pkg/versions.Version={{.VERSION}} -X github.com/stacklok/toolhive/pkg/versions.Commit={{.COMMIT}} -X github.com/stacklok/toolhive/pkg/versions.BuildDate={{.BUILD_DATE}}" -o bin/thv ./cmd/thv
-
+      - cmd: mkdir -p bin
+        platforms: [linux, darwin]
+      - cmd: go build -ldflags "-s -w -X github.com/stacklok/toolhive/pkg/versions.Version={{.VERSION}} -X github.com/stacklok/toolhive/pkg/versions.Commit={{.COMMIT}} -X github.com/stacklok/toolhive/pkg/versions.BuildDate={{.BUILD_DATE}}" -o bin/thv ./cmd/thv
+        platforms: [linux, darwin]
+      - cmd: cmd.exe /c mkdir bin
+        platforms: [windows]
+        ignore_error: true   # Windows has no mkdir -p, so just ignore error if it exists
+      - cmd: go build -ldflags "-s -w -X github.com/stacklok/toolhive/pkg/versions.Version={{.VERSION}} -X github.com/stacklok/toolhive/pkg/versions.Commit={{.COMMIT}} -X github.com/stacklok/toolhive/pkg/versions.BuildDate={{.BUILD_DATE}}" -o bin/thv.exe ./cmd/thv
+        platforms: [windows]
 
   install:
     desc: Install the thv binary to GOPATH/bin
@@ -82,8 +152,7 @@ tasks:
         sh: git describe --tags --always --dirty --match "v*" || echo "dev"
       COMMIT:
         sh: git rev-parse --short HEAD || echo "unknown"
-      BUILD_DATE:
-        sh: date -u +"%Y-%m-%dT%H:%M:%SZ"
+      BUILD_DATE: '{{dateInZone "2006-01-02T15:04:05Z" (now) "UTC"}}'
     cmds:
       - go install -ldflags "-s -w -X github.com/stacklok/toolhive/pkg/versions.Version={{.VERSION}} -X github.com/stacklok/toolhive/pkg/versions.Commit={{.COMMIT}} -X github.com/stacklok/toolhive/pkg/versions.BuildDate={{.BUILD_DATE}}" -v ./cmd/thv
 

cmd/thv-operator/Taskfile.yml

@@ -2,6 +2,7 @@ version: '3'
 
 vars:
   CRD_DIR: config/crd/bases
+  # Don't change the following 2 paths - they fail locally, but are needed for CI in Github
   DOCS_OUT: ../../docs/operator/crd-api.md
   CRDREF_CONFIG: ../../docs/operator/crd-ref-config.yaml
   OCP_REGISTRY_ROUTE:
@@ -35,7 +36,10 @@ tasks:
     desc: Destroy a local Kind cluster
     cmds:
       - kind delete cluster --name toolhive
-      - rm kconfig.yaml
+      - cmd: rm kconfig.yaml
+        platforms: [linux, darwin]
+      - cmd: cmd.exe /c "del kconfig.yaml"
+        platforms: [windows]
 
   kind-ingress-setup:
     desc: Setup Nginx Ingress Controller in a local Kind cluster
@@ -74,11 +78,17 @@ tasks:
         sh: git describe --tags --always --dirty || echo "dev"
       COMMIT:
         sh: git rev-parse --short HEAD || echo "unknown"
-      BUILD_DATE:
-        sh: date -u +"%Y-%m-%dT%H:%M:%SZ"
+      BUILD_DATE: '{{dateInZone "2006-01-02T15:04:05Z" (now) "UTC"}}'
     cmds:
-      - mkdir -p bin
-      - go build -ldflags "-s -w -X github.com/stacklok/toolhive/pkg/versions.Version={{.VERSION}} -X github.com/stacklok/toolhive/pkg/versions.Commit={{.COMMIT}} -X github.com/stacklok/toolhive/pkg/versions.BuildDate={{.BUILD_DATE}}" -o bin/thv-operator ./cmd/thv-operator
+      - cmd: mkdir -p bin
+        platforms: [linux, darwin]
+      - cmd: go build -ldflags "-s -w -X github.com/stacklok/toolhive/pkg/versions.Version={{.VERSION}} -X github.com/stacklok/toolhive/pkg/versions.Commit={{.COMMIT}} -X github.com/stacklok/toolhive/pkg/versions.BuildDate={{.BUILD_DATE}}" -o bin/thv-operator ./cmd/thv-operator
+        platforms: [linux, darwin]
+      - cmd: cmd.exe /c mkdir bin
+        platforms: [windows]
+        ignore_error: true   # Windows has no mkdir -p, so just ignore error if it exists
+      - cmd: go build -ldflags "-s -w -X github.com/stacklok/toolhive/pkg/versions.Version={{.VERSION}} -X github.com/stacklok/toolhive/pkg/versions.Commit={{.COMMIT}} -X github.com/stacklok/toolhive/pkg/versions.BuildDate={{.BUILD_DATE}}" -o bin/thv-operator.exe ./cmd/thv-operator
+        platforms: [windows]
 
   install-operator:
     desc: Install the thv-operator binary to GOPATH/bin
@@ -87,8 +97,7 @@ tasks:
         sh: git describe --tags --always --dirty || echo "dev"
       COMMIT:
         sh: git rev-parse --short HEAD || echo "unknown"
-      BUILD_DATE:
-        sh: date -u +"%Y-%m-%dT%H:%M:%SZ"
+      BUILD_DATE: '{{dateInZone "2006-01-02T15:04:05Z" (now) "UTC"}}'
     cmds:
       - go install -ldflags "-s -w -X github.com/stacklok/toolhive/pkg/versions.Version={{.VERSION}} -X github.com/stacklok/toolhive/pkg/versions.Commit={{.COMMIT}} -X github.com/stacklok/toolhive/pkg/versions.BuildDate={{.BUILD_DATE}}" -v ./cmd/thv-operator
 
@@ -114,6 +123,7 @@ tasks:
 
   operator-deploy-local:
     desc: Build the ToolHive runtime and Operator image locally and deploy it to the K8s cluster
+    platforms: [linux, darwin]
     vars:
       OPERATOR_IMAGE:
         sh: KO_DOCKER_REPO=kind.local ko build --local -B ./cmd/thv-operator | tail -n 1
@@ -142,14 +152,22 @@ tasks:
   operator-generate:
     desc: Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations
     cmds:
-      - mkdir -p bin
+      - cmd: mkdir -p bin
+        platforms: [linux, darwin]
+      - cmd: cmd.exe /c mkdir bin
+        platforms: [windows]
+        ignore_error: true   # Windows has no mkdir -p, so just ignore error if it exists
       - go install sigs.k8s.io/controller-tools/cmd/[email protected]
       - $(go env GOPATH)/bin/controller-gen object:headerFile="hack/boilerplate.go.txt" paths="./cmd/thv-operator/..."
 
   operator-manifests:
     desc: Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects
     cmds:
-      - mkdir -p bin
+      - cmd: mkdir -p bin
+        platforms: [linux, darwin]
+      - cmd: cmd.exe /c mkdir bin
+        platforms: [windows]
+        ignore_error: true   # Windows has no mkdir -p, so just ignore error if it exists
       - go install sigs.k8s.io/controller-tools/cmd/[email protected]
       - $(go env GOPATH)/bin/controller-gen crd webhook paths="./cmd/thv-operator/..." output:crd:artifacts:config=deploy/charts/operator-crds/templates
       - $(go env GOPATH)/bin/controller-gen rbac:roleName=toolhive-operator-manager-role paths="./cmd/thv-operator/..." output:rbac:artifacts:config=deploy/charts/operator/templates/clusterrole

test/e2e/run_tests.bat

@@ -0,0 +1,85 @@
+@echo off
+setlocal enabledelayedexpansion
+
+REM E2E Test Runner for ToolHive
+REM This script sets up the environment and runs the e2e tests
+
+REM Set error handling
+set "EXIT_CODE=0"
+
+echo ToolHive E2E Test Runner
+echo ================================
+
+REM Set TOOLHIVE_DEV environment variable to true
+set "TOOLHIVE_DEV=true"
+
+REM Check if thv binary exists
+if "%THV_BINARY%"=="" (
+    set "THV_BINARY=thv.exe"
+    where "%THV_BINARY%" >nul 2>&1
+) else (
+    dir "%THV_BINARY%" >nul 2>&1
+)
+if %errorlevel% neq 0 (
+    echo Error: thv binary not found in PATH
+    echo Please build the binary first with: task build
+    echo Or set THV_BINARY environment variable to the binary path
+    exit /b 1
+)
+
+echo ✓ Found thv binary: %THV_BINARY%
+
+REM Check if container runtime is available
+set "CONTAINER_RUNTIME="
+where docker >nul 2>&1
+if %errorlevel% equ 0 (
+    set "CONTAINER_RUNTIME=docker"
+    echo ✓ Found container runtime: docker
+) else (
+    where podman >nul 2>&1
+    if %errorlevel% equ 0 (
+        set "CONTAINER_RUNTIME=podman"
+        echo ✓ Found container runtime: podman
+    ) else (
+        echo Error: Neither docker nor podman found
+        echo Please install docker or podman to run MCP servers
+        exit /b 1
+    )
+)
+
+REM Set test timeout
+if "%TEST_TIMEOUT%"=="" set "TEST_TIMEOUT=20m"
+echo ✓ Test timeout: %TEST_TIMEOUT%
+
+REM Export environment variables for tests
+set "THV_BINARY=%THV_BINARY%"
+set "TEST_TIMEOUT=%TEST_TIMEOUT%"
+
+echo.
+echo Running E2E Tests...
+echo.
+
+REM Run the tests
+cd /d "%~dp0"
+
+REM Build ginkgo command with conditional GitHub output flag
+set "GINKGO_CMD=ginkgo run --timeout=%TEST_TIMEOUT%"
+if defined GITHUB_ACTIONS (
+    echo ✓ GitHub Actions detected, enabling GitHub output format
+    set "GINKGO_CMD=%GINKGO_CMD% --github-output"
+) else (
+    set "GINKGO_CMD=%GINKGO_CMD% --vv --show-node-events --trace"
+)
+set "GINKGO_CMD=%GINKGO_CMD% ."
+
+REM Execute the ginkgo command
+%GINKGO_CMD%
+if %errorlevel% equ 0 (
+    echo.
+    echo ✓ All E2E tests passed!
+    exit /b 0
+) else (
+    echo.
+    echo ✗ Some E2E tests failed
+    exit /b 1
+)