fix Caddy module tests

Author: dunglas

.github/workflows/windows.yaml

@@ -180,6 +180,6 @@ jobs:
           $env:PHPRC = Get-Location
 
           go test ./...
-          #cd caddy
-          #go test ./...
+          cd caddy
+          go test ./...
         working-directory: ${{ github.workspace }}\frankenphp

caddy/caddy_test.go

@@ -21,6 +21,25 @@ import (
 
 var testPort = "9080"
 
+// skipIfSymlinkNotValid skips the test if the given path is not a valid symlink
+func skipIfSymlinkNotValid(t *testing.T, path string) {
+	t.Helper()
+
+	info, err := os.Lstat(path)
+	if err != nil {
+		t.Skipf("symlink test skipped: cannot stat %s: %v", path, err)
+	}
+
+	if info.Mode()&os.ModeSymlink == 0 {
+		t.Skipf("symlink test skipped: %s is not a symlink (git may not support symlinks on this platform)", path)
+	}
+}
+
+// escapeMetricLabel escapes backslashes in label values for Prometheus text format
+func escapeMetricLabel(s string) string {
+	return strings.ReplaceAll(s, "\\", "\\\\")
+}
+
 func TestPHP(t *testing.T) {
 	var wg sync.WaitGroup
 	tester := caddytest.NewTester(t)
@@ -548,6 +567,7 @@ func TestWorkerMetrics(t *testing.T) {
 	`, "caddyfile")
 
 	workerName, _ := fastabs.FastAbs("../testdata/index.php")
+	workerName = escapeMetricLabel(workerName)
 
 	// Make some requests
 	for i := range 10 {
@@ -731,6 +751,7 @@ func TestAutoWorkerConfig(t *testing.T) {
 	`, "caddyfile")
 
 	workerName, _ := fastabs.FastAbs("../testdata/index.php")
+	workerName = escapeMetricLabel(workerName)
 
 	// Make some requests
 	for i := range 10 {
@@ -804,6 +825,7 @@ func TestAllDefinedServerVars(t *testing.T) {
 	expectedBody = strings.ReplaceAll(expectedBody, "{documentRoot}", documentRoot)
 	expectedBody = strings.ReplaceAll(expectedBody, "\r\n", "\n")
 	expectedBody = strings.ReplaceAll(expectedBody, "{testPort}", testPort)
+	expectedBody = strings.ReplaceAll(expectedBody, documentRoot+"/", documentRoot+string(filepath.Separator))
 	tester := caddytest.NewTester(t)
 	tester.InitServer(`
 		{
@@ -1505,6 +1527,7 @@ func TestLog(t *testing.T) {
 func TestSymlinkWorkerPaths(t *testing.T) {
 	cwd, _ := os.Getwd()
 	publicDir := filepath.Join(cwd, "..", "testdata", "symlinks", "public")
+	skipIfSymlinkNotValid(t, publicDir)
 
 	t.Run("NeighboringWorkerScript", func(t *testing.T) {
 		// Scenario: neighboring worker script
@@ -1640,6 +1663,7 @@ func TestSymlinkResolveRoot(t *testing.T) {
 	cwd, _ := os.Getwd()
 	testDir := filepath.Join(cwd, "..", "testdata", "symlinks", "test")
 	publicDir := filepath.Join(cwd, "..", "testdata", "symlinks", "public")
+	skipIfSymlinkNotValid(t, publicDir)
 
 	t.Run("ResolveRootSymlink", func(t *testing.T) {
 		// Tests that resolve_root_symlink directive works correctly
@@ -1698,6 +1722,7 @@ func TestSymlinkResolveRoot(t *testing.T) {
 func TestSymlinkWorkerBehavior(t *testing.T) {
 	cwd, _ := os.Getwd()
 	publicDir := filepath.Join(cwd, "..", "testdata", "symlinks", "public")
+	skipIfSymlinkNotValid(t, publicDir)
 
 	t.Run("WorkerScriptFailsWithoutWorkerMode", func(t *testing.T) {
 		// Tests that accessing a worker-only script without configuring it as a worker actually results in an error

internal/fastabs/filepath.go

@@ -9,5 +9,6 @@ import (
 // FastAbs can't be optimized on Windows because the
 // syscall.FullPath function takes an input.
 func FastAbs(path string) (string, error) {
-	return filepath.Abs(path)
+	// Normalize forward slashes to backslashes for Windows compatibility
+	return filepath.Abs(filepath.FromSlash(path))
 }

testdata/files/index.php

@@ -0,0 +1,2 @@
+<?php
+http_response_code(404);

testdata/mercure-publish.php

@@ -3,6 +3,6 @@
 require_once __DIR__.'/_executor.php';
 
 return function () {
-	echo "update 1: " . mercure_publish('foo', 'bar', true, 'myid', 'mytype', 10) . PHP_EOL;
-	echo "update 2: " . mercure_publish(['baz', 'bar']) . PHP_EOL;
+	echo "update 1: " . mercure_publish('foo', 'bar', true, 'myid', 'mytype', 10) . "\n";
+	echo "update 2: " . mercure_publish(['baz', 'bar']) . "\n";
 };

worker.go

@@ -114,7 +114,7 @@ func newWorker(o workerOpt) (*worker, error) {
 	// Order is important!
 	// This order ensures that FrankenPHP started from inside a symlinked directory will properly resolve any paths.
 	// If it is started from outside a symlinked directory, it is resolved to the same path that we use in the Caddy module.
-	absFileName, err := filepath.EvalSymlinks(o.fileName)
+	absFileName, err := filepath.EvalSymlinks(filepath.FromSlash(o.fileName))
 	if err != nil {
 		return nil, fmt.Errorf("worker filename is invalid %q: %w", o.fileName, err)
 	}