feat(ci): support running e2e tests on windows

Signed-off-by: Swapnanil-Gupta <swpnlg@amazon.com>

Author: Swapnanil-Gupta

.github/workflows/macos-ci.yaml

@@ -16,7 +16,7 @@ on:
       - deps/full-os.conf
       - deps/lima-bundles.conf
       - e2e/**
-      - lima-template/**
+      - lima-template/macos.yaml
       - Makefile
       - Makefile.darwin
   workflow_dispatch:

.github/workflows/windows-ci.yaml

@@ -14,27 +14,31 @@ on:
       - .gitmodules
       - deps/container-runtime-full-archive.conf
       - deps/rootfs.conf
-      - lima-template/**
+      - e2e/**
+      - lima-template/windows.yaml
       - Makefile
       - Makefile.windows
   workflow_dispatch:
 
+permissions:
+  contents: read
+
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
 jobs:
-  install-dependencies:
-    # This is a spot check for make install.dependencies on Windows platform.
-    # Finch-core provides the core dependencies needed to run Finch such as the base OS
-    # image, rootfs, and Lima bundle. Validate the mechanism used to install the core
-    # dependencies works on Windows.
+  e2e-tests:
     strategy:
       fail-fast: false
       matrix:
-        os: [windows-2022]
+        os: [windows-2025]
     runs-on: ${{ matrix.os }}
     steps:
+      - name: Configure git CRLF settings
+        run: |
+          git config --global core.autocrlf false
+          git config --global core.eol lf
       - name: Checkout code
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
@@ -46,7 +50,17 @@ jobs:
         with:
           go-version-file: e2e/go.mod
           cache-dependency-path: e2e/go.sum
+      - name: Enable WSL2
+        uses: Vampire/setup-wsl@v7
+      - name: Configure WSL2 networking
+        shell: pwsh
+        run: |
+          "networkingMode=mirrored`nhostAddressLoopback=true" | Out-File -FilePath "$env:USERPROFILE\.wslconfig" -Encoding ascii
+          wsl --shutdown
       - name: Install platform dependencies
         run: make install.dependencies
+      - name: Run e2e tests
+        run: make test-e2e
       - name: Clean up dependencies
+        if: always()
         run: make clean

Makefile

@@ -57,7 +57,7 @@ $(FINCH_DAEMON_OUTDIR)/finch-daemon: $(OUTPUT_DIRECTORIES)
 install: uninstall
 	mkdir -p $(DEST)
 	(cd _output && tar c * | tar Cvx  $(DEST) )
-	sed -i.bak -e "s|${FINCH_OS_IMAGE_LOCATION}|$(FINCH_IMAGE_LOCATION)|g" $(DEST)/lima-template/fedora.yaml
+	sed -i.bak -e "s|${FINCH_OS_IMAGE_LOCATION}|$(FINCH_IMAGE_LOCATION)|g" $(DEST)/lima-template/macos.yaml
 	rm $(DEST)/lima-template/*.yaml.bak
 
 .PHONY: uninstall
@@ -76,5 +76,8 @@ clean:
 	-@cd src/socket_vmnet && make clean 2>/dev/null || true
 
 .PHONY: test-e2e
-test-e2e: $(LIMA_TEMPLATE_OUTDIR)/fedora.yaml
-	cd e2e && VM_TYPE=$(FINCH_VM_TYPE) go test -timeout 30m -v ./... -ginkgo.v
+test-e2e: $(LIMA_TEMPLATE)
+	cd e2e && VM_TYPE=$(FINCH_VM_TYPE) LIMA_TEMPLATE=$(LIMA_TEMPLATE) \
+	go test -timeout 3h -v ./... \
+	-ginkgo.vv \
+	-ginkgo.flake-attempts=3

Makefile.darwin

@@ -3,6 +3,7 @@
 
 OS_OUTDIR := $(OUTDIR)/os
 LIMA_TEMPLATE_OUTDIR := $(OUTDIR)/lima-template
+LIMA_TEMPLATE := $(LIMA_TEMPLATE_OUTDIR)/macos.yaml
 CRED_HELPERS_OUTDIR := $(OUTDIR)/cred-helpers
 OUTPUT_DIRECTORIES += $(OS_OUTDIR) $(LIMA_TEMPLATE_OUTDIR) $(CRED_HELPERS_OUTDIR)
 SOCKET_VMNET_TEMP_PREFIX ?= $(OUTDIR)/dependencies/lima-socket_vmnet/opt/finch
@@ -61,8 +62,8 @@ install.lima-socket-vmnet:
 	cd src/socket_vmnet && git clean -f -d
 	cd src/socket_vmnet && PREFIX=$(SOCKET_VMNET_TEMP_PREFIX) "$(MAKE)" install.bin
 
-$(LIMA_TEMPLATE_OUTDIR)/fedora.yaml: $(LIMA_TEMPLATE_OUTDIR)
-	cp lima-template/fedora.yaml $@.template
+$(LIMA_TEMPLATE_OUTDIR)/macos.yaml: $(LIMA_TEMPLATE_OUTDIR)
+	cp lima-template/macos.yaml $@.template
 	# using -i.bak is very intentional, it allows the following commands to succeed for both GNU / BSD sed
 	# this sed command uses the alternative separator of "|" because the image location uses "/"
 	sed -i.bak -e "s|<image_location>|$(FINCH_IMAGE_LOCATION)|g" $@.template

Makefile.windows

@@ -3,17 +3,34 @@
 
 # TODO: Use Finch rootfs in Finch on Windows testing
 ROOTFS_OUTPUT_DIR := $(OUTDIR)/os
+LIMA_TEMPLATE_OUTDIR := $(OUTDIR)/lima-template
+LIMA_TEMPLATE := $(LIMA_TEMPLATE_OUTDIR)/windows.yaml
 CRED_HELPERS_OUTDIR := $(OUTDIR)/cred-helpers
-OUTPUT_DIRECTORIES += $(ROOTFS_OUTPUT_DIR) $(CRED_HELPERS_OUTDIR)
+OUTPUT_DIRECTORIES += $(ROOTFS_OUTPUT_DIR) $(LIMA_TEMPLATE_OUTDIR) $(CRED_HELPERS_OUTDIR)
 
 include $(CURDIR)/deps/rootfs.conf
 ifeq ($(ARCH), x86_64)
 FINCH_ROOTFS_BASENAME := $(X86_64_ARTIFACT)
 FINCH_ROOTFS_DIGEST := $(X86_64_512_DIGEST)
+LIMA_ARCH = x86_64
 else
 $(error Finch on Windows ARM not supported)
 endif
 
+# WSL2 imports the locally downloaded rootfs tarball rather than booting a disk image.
+FINCH_IMAGE_LOCATION ?= $(ROOTFS_OUTPUT_DIR)/$(FINCH_ROOTFS_BASENAME)
+FINCH_IMAGE_DIGEST ?= "sha512:$(FINCH_ROOTFS_DIGEST)"
+
+# rootfs.conf sets X86_64_ARTIFACT_PATHING for the rootfs download; clear it so it
+# does not leak into the container-runtime artifact URL below.
+X86_64_ARTIFACT_PATHING :=
+include $(CURDIR)/deps/container-runtime-full-archive.conf
+ifneq ($(X86_64_ARTIFACT_PATHING),)
+	X86_64_ARTIFACT := "$(X86_64_ARTIFACT_PATHING)/$(X86_64_ARTIFACT)"
+endif
+CONTAINER_RUNTIME_ARCHIVE_X86_64_LOCATION ?= "$(ARTIFACT_BASE_URL)/$(X86_64_ARTIFACT)"
+CONTAINER_RUNTIME_ARCHIVE_X86_64_DIGEST ?= "sha256:$(X86_64_256_DIGEST)"
+
 # WSL2 is the only virtual machine type supported for Finch on Windows
 FINCH_VM_TYPE := wsl2
 
@@ -22,14 +39,32 @@ WINGIT_x86_URL := $(or $(WINGIT_x86_URL),https://github.com/git-for-windows/git/
 WINGIT_x86_BASENAME ?= $(notdir $(WINGIT_x86_URL))
 WINGIT_x86_HASH := $(or $(WINGIT_x86_HASH),"sha512:795a2e7e0be5ab78f2d28d0bd971961d121b9c808a95dec795343dc5af943574dcf54f63a8580c5a5102075abdae387d7a67135c165821428afc07f11ef7543d")
 
-install.dependencies: install.rootfs install.lima install.docker-credhelper
+install.dependencies: install.rootfs install.lima install.lima-template install.docker-credhelper
 
 .PHONY: install.rootfs
 install.rootfs: $(ROOTFS_OUTPUT_DIR)/$(FINCH_ROOTFS_BASENAME)
 
 $(ROOTFS_OUTPUT_DIR)/$(FINCH_ROOTFS_BASENAME): $(ROOTFS_OUTPUT_DIR) $(CURDIR)/deps/rootfs.conf
 	bash deps/install.sh --arch $(ARCH) --output $@ $(CURDIR)/deps/rootfs.conf
 
+.PHONY: install.lima-template
+install.lima-template: $(LIMA_TEMPLATE)
+
+$(LIMA_TEMPLATE): $(LIMA_TEMPLATE_OUTDIR)
+	cp lima-template/windows.yaml $@.template
+	# using -i.bak is very intentional, it allows the following commands to succeed for both GNU / BSD sed
+	# this sed command uses the alternative separator of "|" because the image location uses "/"
+	sed -i.bak -e "s|<image_location>|$(FINCH_IMAGE_LOCATION)|g" $@.template
+	sed -i.bak -e "s/<image_arch>/$(LIMA_ARCH)/g" $@.template
+	sed -i.bak -e "s/<image_digest>/$(FINCH_IMAGE_DIGEST)/g" $@.template
+	sed -i.bak -e "s|<container_runtime_archive_x86_64_location>|$(CONTAINER_RUNTIME_ARCHIVE_X86_64_LOCATION)|g" $@.template
+	sed -i.bak -e "s/<container_runtime_archive_x86_64_digest>/$(CONTAINER_RUNTIME_ARCHIVE_X86_64_DIGEST)/g" $@.template
+
+	# Replace was successful, so cleanup .bak files
+	rm $(LIMA_TEMPLATE_OUTDIR)/*.yaml.template.bak
+
+	mv $@.template $@
+
 .PHONY: install.lima
 install.lima: lima-exe install.lima-dependencies-wsl2
 

e2e/e2e_test.go

@@ -6,6 +6,7 @@ package e2e
 import (
 	"os"
 	"path/filepath"
+	"runtime"
 	"testing"
 
 	"github.com/onsi/ginkgo/v2"
@@ -38,19 +39,28 @@ func TestE2e(t *testing.T) {
 		t.Fatalf("failed to get the current working directory: %v", err)
 	}
 
-	vmConfigFile := filepath.Join(wd, "./../_output/lima-template/fedora.yaml")
+	configFileName := "macos.yaml"
+	if runtime.GOOS == "windows" {
+		configFileName = "windows.yaml"
+	}
+	vmConfigFile := filepath.Join(wd, "./../_output/lima-template/", configFileName)
 
 	subject := "limactl"
 	limaOpt, err := option.New([]string{subject})
 	if err != nil {
 		t.Fatalf("failed to initialize a testing option: %v", err)
 	}
 
-	vmName := "fedora"
+	vmName := "finch"
+
+	nerdctlMods := []option.Modifier{option.WithNoEnvironmentVariablePassthrough()}
+	if runtime.GOOS == "windows" {
+		nerdctlMods = append(nerdctlMods, option.WithWindowsHostPathTranslation())
+	}
 
 	nerdctlOpt, err := option.New(
 		[]string{subject, "shell", vmName, "sudo", "-E", "nerdctl"},
-		option.WithNoEnvironmentVariablePassthrough(),
+		nerdctlMods...,
 	)
 	if err != nil {
 		t.Fatalf("failed to initialize a testing option: %v", err)

e2e/go.mod

@@ -22,3 +22,6 @@ require (
 	golang.org/x/text v0.38.0 // indirect
 	golang.org/x/tools v0.45.0 // indirect
 )
+
+// TODO: revert
+replace github.com/runfinch/common-tests => github.com/Swapnanil-Gupta/common-tests v0.0.0-20260702223436-6b3984e1a3e8

e2e/go.sum

@@ -1,5 +1,7 @@
 github.com/Masterminds/semver/v3 v3.4.0 h1:Zog+i5UMtVoCU8oKka5P7i9q9HgrJeGzI9SA1Xbatp0=
 github.com/Masterminds/semver/v3 v3.4.0/go.mod h1:4V+yj/TJE1HU9XfppCwVMZq3I84lprf4nC11bSS5beM=
+github.com/Swapnanil-Gupta/common-tests v0.0.0-20260702223436-6b3984e1a3e8 h1:ulNCk+7/Bf1Yi2OzPlF8qxkn8q6oCeHvJQrvB89cnsg=
+github.com/Swapnanil-Gupta/common-tests v0.0.0-20260702223436-6b3984e1a3e8/go.mod h1:mOOz4glmJ0uVwjgPEXKZPgHG8BzS2KCuE+XWV0Zg4hk=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/gkampitakis/ciinfo v0.3.2 h1:JcuOPk8ZU7nZQjdUhctuhQofk7BGHuIy0c9Ez8BNhXs=
@@ -36,8 +38,6 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/rogpeppe/go-internal v1.13.1 h1:KvO1DLK/DRN07sQ1LQKScxyZJuNnedQ5/wKSR38lUII=
 github.com/rogpeppe/go-internal v1.13.1/go.mod h1:uMEvuHeurkdAXX61udpOXGD/AzZDWNMNyH2VO9fmH0o=
-github.com/runfinch/common-tests v0.10.1 h1:noZ9LbolXMLTZgXllAJtNkyO6JQrrnf1mpvN1zknU40=
-github.com/runfinch/common-tests v0.10.1/go.mod h1:PX9VBgtcOm+2Stjm4F6Y6KpovJ2emdSJ+y1X1URnAIU=
 github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
 github.com/tidwall/gjson v1.18.0 h1:FIDeeyB800efLX89e5a8Y0BNH+LOngJyGrIWxG2FKQY=

lima-template/fedora.yaml lima-template/macos.yamllima-template/fedora.yaml renamed to lima-template/macos.yaml

@@ -0,0 +1,44 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+# This template file is based on macos.yaml but with Windows specific options.
+vmType: wsl2
+mountType: wsl2
+
+images:
+- location: "<image_location>"
+  arch: "<image_arch>"
+  digest: "<image_digest>"
+
+containerd:
+  system: true
+  user: false
+  archives:
+  - location: "<container_runtime_archive_x86_64_location>"
+    arch: "x86_64"
+    digest: "<container_runtime_archive_x86_64_digest>"
+
+provision:
+- mode: boot
+  script: |
+    systemctl stop NetworkManager-wait-online.service
+    systemctl reset-failed NetworkManager-wait-online.service
+    systemctl mask NetworkManager-wait-online.service
+- mode: boot
+  script: |
+    modprobe virtiofs
+- mode: boot
+  script: |
+    modprobe br_netfilter
+    cat <<EOF > /etc/sysctl.d/99-finch.conf
+    net.bridge.bridge-nf-call-iptables = 1
+    net.bridge.bridge-nf-call-ip6tables = 1
+    net.ipv4.ip_forward = 1
+    EOF
+    sysctl --system
+# # `user` is executed without the root privilege
+- mode: user
+  script: |
+    #!/bin/bash
+    sudo systemctl add-requires buildkit.service containerd.service
+    sudo systemctl restart containerd.service