fix(embed): run extension-less scripts of the embedded app with php-cli (#2765)

`php-cli` only resolved scripts ending in `.php` against the embedded
app, so `./my-app php-cli bin/console`, documented in `docs/embed.md`,
fails.

Any relative script missing from the working directory is now resolved
against the embedded app, when it exists there. Scripts in the working
directory still take precedence; flags and absolute paths are left
untouched.

Author: dunglas

caddy/php-cli.go

@@ -32,10 +32,8 @@ func cmdPHPCLI(fs caddycmd.Flags) (int, error) {
 	// php's cli sapi expects the 0th arg to be the program itself, only filter out 'php-cli' arg
 	args := append([]string{os.Args[0]}, os.Args[2:]...)
 
-	if frankenphp.EmbeddedAppPath != "" && len(args) > 1 && !strings.HasPrefix(args[1], "-") && strings.HasSuffix(args[1], ".php") {
-		if _, err := os.Stat(args[1]); err != nil {
-			args[1] = filepath.Join(frankenphp.EmbeddedAppPath, args[1])
-		}
+	if len(args) > 1 {
+		args[1] = resolveEmbeddedScript(args[1])
 	}
 
 	logger := slog.New(zapslog.NewHandler(caddy.Log().Core(), zapslog.WithName("frankenphp")))
@@ -45,3 +43,21 @@ func cmdPHPCLI(fs caddycmd.Flags) (int, error) {
 
 	return status, nil
 }
+
+// resolveEmbeddedScript resolves relative scripts missing from the working directory,
+// including extension-less ones such as bin/console, against the embedded app.
+func resolveEmbeddedScript(script string) string {
+	if frankenphp.EmbeddedAppPath == "" || strings.HasPrefix(script, "-") || !filepath.IsLocal(script) {
+		return script
+	}
+	if _, err := os.Stat(script); err == nil {
+		return script
+	}
+
+	embedded := filepath.Join(frankenphp.EmbeddedAppPath, script)
+	if _, err := os.Stat(embedded); err != nil {
+		return script
+	}
+
+	return embedded
+}

caddy/php-cli_test.go

@@ -0,0 +1,36 @@
+package caddy
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/dunglas/frankenphp"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestResolveEmbeddedScript(t *testing.T) {
+	app := t.TempDir()
+	require.NoError(t, os.MkdirAll(filepath.Join(app, "bin"), 0o755))
+	require.NoError(t, os.WriteFile(filepath.Join(app, "bin", "console"), []byte("#!/usr/bin/env php\n<?php\n"), 0o644))
+	require.NoError(t, os.WriteFile(filepath.Join(app, "index.php"), []byte("<?php\n"), 0o644))
+
+	cwd := t.TempDir()
+	require.NoError(t, os.WriteFile(filepath.Join(cwd, "local.php"), []byte("<?php\n"), 0o644))
+	t.Chdir(cwd)
+
+	orig := frankenphp.EmbeddedAppPath
+	t.Cleanup(func() { frankenphp.EmbeddedAppPath = orig })
+
+	frankenphp.EmbeddedAppPath = ""
+	assert.Equal(t, "bin/console", resolveEmbeddedScript("bin/console"))
+
+	frankenphp.EmbeddedAppPath = app
+	assert.Equal(t, filepath.Join(app, "bin", "console"), resolveEmbeddedScript("bin/console"))
+	assert.Equal(t, filepath.Join(app, "index.php"), resolveEmbeddedScript("index.php"))
+	assert.Equal(t, "local.php", resolveEmbeddedScript("local.php"), "files of the working directory take precedence")
+	assert.Equal(t, "missing.php", resolveEmbeddedScript("missing.php"))
+	assert.Equal(t, "-r", resolveEmbeddedScript("-r"))
+	assert.Equal(t, "/bin/console", resolveEmbeddedScript("/bin/console"))
+}