123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860 |
- // In all tests, headers added to requests are copied on the heap using strings.Clone.
- // This was originally a workaround for https://github.com/golang/go/issues/65286#issuecomment-1920087884 (fixed in Go 1.22),
- // but this allows to catch panics occuring in real life but not when the string is in the internal binary memory.
- package frankenphp_test
- import (
- "bytes"
- "context"
- "fmt"
- "io"
- "log"
- "mime/multipart"
- "net/http"
- "net/http/cookiejar"
- "net/http/httptest"
- "net/http/httptrace"
- "net/textproto"
- "net/url"
- "os"
- "os/exec"
- "strconv"
- "strings"
- "sync"
- "testing"
- "github.com/dunglas/frankenphp"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
- "go.uber.org/zap"
- "go.uber.org/zap/zaptest"
- "go.uber.org/zap/zaptest/observer"
- )
- type testOptions struct {
- workerScript string
- nbWorkers int
- env map[string]string
- nbParrallelRequests int
- realServer bool
- logger *zap.Logger
- initOpts []frankenphp.Option
- }
- func runTest(t *testing.T, test func(func(http.ResponseWriter, *http.Request), *httptest.Server, int), opts *testOptions) {
- if opts == nil {
- opts = &testOptions{}
- }
- if opts.nbParrallelRequests == 0 {
- opts.nbParrallelRequests = 100
- }
- cwd, _ := os.Getwd()
- testDataDir := cwd + "/testdata/"
- if opts.logger == nil {
- opts.logger = zaptest.NewLogger(t)
- }
- initOpts := []frankenphp.Option{frankenphp.WithLogger(opts.logger)}
- if opts.workerScript != "" {
- initOpts = append(initOpts, frankenphp.WithWorkers(testDataDir+opts.workerScript, opts.nbWorkers, opts.env))
- }
- initOpts = append(initOpts, opts.initOpts...)
- err := frankenphp.Init(initOpts...)
- require.Nil(t, err)
- defer frankenphp.Shutdown()
- handler := func(w http.ResponseWriter, r *http.Request) {
- req, err := frankenphp.NewRequestWithContext(r, frankenphp.WithRequestDocumentRoot(testDataDir, false))
- assert.NoError(t, err)
- err = frankenphp.ServeHTTP(w, req)
- assert.NoError(t, err)
- }
- var ts *httptest.Server
- if opts.realServer {
- ts = httptest.NewServer(http.HandlerFunc(handler))
- defer ts.Close()
- }
- var wg sync.WaitGroup
- wg.Add(opts.nbParrallelRequests)
- for i := 0; i < opts.nbParrallelRequests; i++ {
- go func(i int) {
- test(handler, ts, i)
- wg.Done()
- }(i)
- }
- wg.Wait()
- }
- func TestHelloWorld_module(t *testing.T) { testHelloWorld(t, nil) }
- func TestHelloWorld_worker(t *testing.T) {
- testHelloWorld(t, &testOptions{workerScript: "index.php"})
- }
- func testHelloWorld(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/index.php?i=%d", i), nil)
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- assert.Equal(t, fmt.Sprintf("I am by birth a Genevese (%d)", i), string(body))
- }, opts)
- }
- func TestFinishRequest_module(t *testing.T) { testFinishRequest(t, nil) }
- func TestFinishRequest_worker(t *testing.T) {
- testFinishRequest(t, &testOptions{workerScript: "finish-request.php"})
- }
- func testFinishRequest(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/finish-request.php?i=%d", i), nil)
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- assert.Equal(t, fmt.Sprintf("This is output %d\n", i), string(body))
- }, opts)
- }
- func TestServerVariable_module(t *testing.T) {
- testServerVariable(t, nil)
- }
- func TestServerVariable_worker(t *testing.T) {
- testServerVariable(t, &testOptions{workerScript: "server-variable.php"})
- }
- func testServerVariable(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest("POST", fmt.Sprintf("http://example.com/server-variable.php/baz/bat?foo=a&bar=b&i=%d#hash", i), strings.NewReader("foo"))
- req.SetBasicAuth(strings.Clone("kevin"), strings.Clone("password"))
- req.Header.Add(strings.Clone("Content-Type"), strings.Clone("text/plain"))
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- strBody := string(body)
- assert.Contains(t, strBody, "[REMOTE_HOST]")
- assert.Contains(t, strBody, "[REMOTE_USER] => kevin")
- assert.Contains(t, strBody, "[PHP_AUTH_USER] => kevin")
- assert.Contains(t, strBody, "[PHP_AUTH_PW] => password")
- assert.Contains(t, strBody, "[HTTP_AUTHORIZATION] => Basic a2V2aW46cGFzc3dvcmQ=")
- assert.Contains(t, strBody, "[DOCUMENT_ROOT]")
- assert.Contains(t, strBody, "[PHP_SELF] => /server-variable.php/baz/bat")
- assert.Contains(t, strBody, "[CONTENT_TYPE] => text/plain")
- assert.Contains(t, strBody, fmt.Sprintf("[QUERY_STRING] => foo=a&bar=b&i=%d#hash", i))
- assert.Contains(t, strBody, fmt.Sprintf("[REQUEST_URI] => /server-variable.php/baz/bat?foo=a&bar=b&i=%d#hash", i))
- assert.Contains(t, strBody, "[CONTENT_LENGTH]")
- assert.Contains(t, strBody, "[REMOTE_ADDR]")
- assert.Contains(t, strBody, "[REMOTE_PORT]")
- assert.Contains(t, strBody, "[REQUEST_SCHEME] => http")
- assert.Contains(t, strBody, "[DOCUMENT_URI]")
- assert.Contains(t, strBody, "[AUTH_TYPE]")
- assert.Contains(t, strBody, "[REMOTE_IDENT]")
- assert.Contains(t, strBody, "[REQUEST_METHOD] => POST")
- assert.Contains(t, strBody, "[SERVER_NAME] => example.com")
- assert.Contains(t, strBody, "[SERVER_PROTOCOL] => HTTP/1.1")
- assert.Contains(t, strBody, "[SCRIPT_FILENAME]")
- assert.Contains(t, strBody, "[SERVER_SOFTWARE] => FrankenPHP")
- assert.Contains(t, strBody, "[REQUEST_TIME_FLOAT]")
- assert.Contains(t, strBody, "[REQUEST_TIME]")
- assert.Contains(t, strBody, "[SERVER_PORT] => 80")
- }, opts)
- }
- func TestPathInfo_module(t *testing.T) { testPathInfo(t, nil) }
- func TestPathInfo_worker(t *testing.T) {
- testPathInfo(t, &testOptions{workerScript: "server-variable.php"})
- }
- func testPathInfo(t *testing.T, opts *testOptions) {
- cwd, _ := os.Getwd()
- testDataDir := cwd + strings.Clone("/testdata/")
- path := strings.Clone("/server-variable.php/pathinfo")
- runTest(t, func(_ func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- handler := func(w http.ResponseWriter, r *http.Request) {
- requestURI := r.URL.RequestURI()
- r.URL.Path = path
- rewriteRequest, err := frankenphp.NewRequestWithContext(r,
- frankenphp.WithRequestDocumentRoot(testDataDir, false),
- frankenphp.WithRequestEnv(map[string]string{"REQUEST_URI": requestURI}),
- )
- assert.NoError(t, err)
- err = frankenphp.ServeHTTP(w, rewriteRequest)
- assert.NoError(t, err)
- }
- req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/pathinfo/%d", i), nil)
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- strBody := string(body)
- assert.Contains(t, strBody, "[PATH_INFO] => /pathinfo")
- assert.Contains(t, strBody, fmt.Sprintf("[REQUEST_URI] => /pathinfo/%d", i))
- assert.Contains(t, strBody, "[PATH_TRANSLATED] =>")
- assert.Contains(t, strBody, "[SCRIPT_NAME] => /server-variable.php")
- }, opts)
- }
- func TestHeaders_module(t *testing.T) { testHeaders(t, nil) }
- func TestHeaders_worker(t *testing.T) { testHeaders(t, &testOptions{workerScript: "headers.php"}) }
- func testHeaders(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/headers.php?i=%d", i), nil)
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- assert.Equal(t, "Hello", string(body))
- assert.Equal(t, 201, resp.StatusCode)
- assert.Equal(t, "bar", resp.Header.Get("Foo"))
- assert.Equal(t, "bar2", resp.Header.Get("Foo2"))
- assert.Empty(t, resp.Header.Get("Invalid"))
- assert.Equal(t, fmt.Sprintf("%d", i), resp.Header.Get("I"))
- }, opts)
- }
- func TestResponseHeaders_module(t *testing.T) { testResponseHeaders(t, nil) }
- func TestResponseHeaders_worker(t *testing.T) {
- testResponseHeaders(t, &testOptions{workerScript: "response-headers.php"})
- }
- func testResponseHeaders(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/response-headers.php?i=%d", i), nil)
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- assert.Contains(t, string(body), "'X-Powered-By' => 'PH")
- assert.Contains(t, string(body), "'Foo' => 'bar',")
- assert.Contains(t, string(body), "'Foo2' => 'bar2',")
- assert.Contains(t, string(body), fmt.Sprintf("'I' => '%d',", i))
- assert.NotContains(t, string(body), "Invalid")
- }, opts)
- }
- func TestInput_module(t *testing.T) { testInput(t, nil) }
- func TestInput_worker(t *testing.T) { testInput(t, &testOptions{workerScript: "input.php"}) }
- func testInput(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest("POST", "http://example.com/input.php", strings.NewReader(fmt.Sprintf("post data %d", i)))
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- assert.Equal(t, fmt.Sprintf("post data %d", i), string(body))
- assert.Equal(t, "bar", resp.Header.Get("Foo"))
- }, opts)
- }
- func TestPostSuperGlobals_module(t *testing.T) { testPostSuperGlobals(t, nil) }
- func TestPostSuperGlobals_worker(t *testing.T) {
- testPostSuperGlobals(t, &testOptions{workerScript: "super-globals.php"})
- }
- func testPostSuperGlobals(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- formData := url.Values{"baz": {"bat"}, "i": {fmt.Sprintf("%d", i)}}
- req := httptest.NewRequest("POST", fmt.Sprintf("http://example.com/super-globals.php?foo=bar&iG=%d", i), strings.NewReader(formData.Encode()))
- req.Header.Set("Content-Type", strings.Clone("application/x-www-form-urlencoded"))
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- assert.Contains(t, string(body), "'foo' => 'bar'")
- assert.Contains(t, string(body), fmt.Sprintf("'i' => '%d'", i))
- assert.Contains(t, string(body), "'baz' => 'bat'")
- assert.Contains(t, string(body), fmt.Sprintf("'iG' => '%d'", i))
- }, opts)
- }
- func TestCookies_module(t *testing.T) { testCookies(t, nil) }
- func TestCookies_worker(t *testing.T) { testCookies(t, &testOptions{workerScript: "cookies.php"}) }
- func testCookies(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest("GET", "http://example.com/cookies.php", nil)
- req.AddCookie(&http.Cookie{Name: "foo", Value: "bar"})
- req.AddCookie(&http.Cookie{Name: "i", Value: fmt.Sprintf("%d", i)})
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- assert.Contains(t, string(body), "'foo' => 'bar'")
- assert.Contains(t, string(body), fmt.Sprintf("'i' => '%d'", i))
- }, opts)
- }
- func TestSession_module(t *testing.T) { testSession(t, nil) }
- func TestSession_worker(t *testing.T) {
- testSession(t, &testOptions{workerScript: "session.php"})
- }
- func testSession(t *testing.T, opts *testOptions) {
- if opts == nil {
- opts = &testOptions{}
- }
- opts.realServer = true
- runTest(t, func(_ func(http.ResponseWriter, *http.Request), ts *httptest.Server, i int) {
- jar, err := cookiejar.New(&cookiejar.Options{})
- assert.NoError(t, err)
- client := &http.Client{Jar: jar}
- resp1, err := client.Get(ts.URL + "/session.php")
- assert.NoError(t, err)
- body1, _ := io.ReadAll(resp1.Body)
- assert.Equal(t, "Count: 0\n", string(body1))
- resp2, err := client.Get(ts.URL + "/session.php")
- assert.NoError(t, err)
- body2, _ := io.ReadAll(resp2.Body)
- assert.Equal(t, "Count: 1\n", string(body2))
- }, opts)
- }
- func TestPhpInfo_module(t *testing.T) { testPhpInfo(t, nil) }
- func TestPhpInfo_worker(t *testing.T) { testPhpInfo(t, &testOptions{workerScript: "phpinfo.php"}) }
- func testPhpInfo(t *testing.T, opts *testOptions) {
- var logOnce sync.Once
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/phpinfo.php?i=%d", i), nil)
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- logOnce.Do(func() {
- t.Log(string(body))
- })
- assert.Contains(t, string(body), "frankenphp")
- assert.Contains(t, string(body), fmt.Sprintf("i=%d", i))
- }, opts)
- }
- func TestPersistentObject_module(t *testing.T) { testPersistentObject(t, nil) }
- func TestPersistentObject_worker(t *testing.T) {
- testPersistentObject(t, &testOptions{workerScript: "persistent-object.php"})
- }
- func testPersistentObject(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/persistent-object.php?i=%d", i), nil)
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- assert.Equal(t, fmt.Sprintf(`request: %d
- class exists: 1
- id: obj1
- object id: 1`, i), string(body))
- }, opts)
- }
- func TestAutoloader_module(t *testing.T) { testAutoloader(t, nil) }
- func TestAutoloader_worker(t *testing.T) {
- testAutoloader(t, &testOptions{workerScript: "autoloader.php"})
- }
- func testAutoloader(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/autoloader.php?i=%d", i), nil)
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- assert.Equal(t, fmt.Sprintf(`request %d
- my_autoloader`, i), string(body))
- }, opts)
- }
- func TestLog_module(t *testing.T) { testLog(t, &testOptions{}) }
- func TestLog_worker(t *testing.T) {
- testLog(t, &testOptions{workerScript: "log.php"})
- }
- func testLog(t *testing.T, opts *testOptions) {
- logger, logs := observer.New(zap.InfoLevel)
- opts.logger = zap.New(logger)
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/log.php?i=%d", i), nil)
- w := httptest.NewRecorder()
- handler(w, req)
- for logs.FilterMessage(fmt.Sprintf("request %d", i)).Len() <= 0 {
- }
- }, opts)
- }
- func TestConnectionAbort_module(t *testing.T) { testConnectionAbort(t, &testOptions{}) }
- func TestConnectionAbort_worker(t *testing.T) {
- testConnectionAbort(t, &testOptions{workerScript: "connectionStatusLog.php"})
- }
- func testConnectionAbort(t *testing.T, opts *testOptions) {
- testFinish := func(finish string) {
- t.Run(fmt.Sprintf("finish=%s", finish), func(t *testing.T) {
- logger, logs := observer.New(zap.InfoLevel)
- opts.logger = zap.New(logger)
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/connectionStatusLog.php?i=%d&finish=%s", i, finish), nil)
- w := httptest.NewRecorder()
- ctx, cancel := context.WithCancel(req.Context())
- req = req.WithContext(ctx)
- cancel()
- handler(w, req)
- for logs.FilterMessage(fmt.Sprintf("request %d: 1", i)).Len() <= 0 {
- }
- }, opts)
- })
- }
- testFinish("0")
- testFinish("1")
- }
- func TestException_module(t *testing.T) { testException(t, &testOptions{}) }
- func TestException_worker(t *testing.T) {
- testException(t, &testOptions{workerScript: "exception.php"})
- }
- func testException(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/exception.php?i=%d", i), nil)
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- assert.Contains(t, string(body), "hello")
- assert.Contains(t, string(body), fmt.Sprintf(`Uncaught Exception: request %d`, i))
- }, opts)
- }
- func TestEarlyHints_module(t *testing.T) { testEarlyHints(t, &testOptions{}) }
- func TestEarlyHints_worker(t *testing.T) {
- testEarlyHints(t, &testOptions{workerScript: "early-hints.php"})
- }
- func testEarlyHints(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- var earlyHintReceived bool
- trace := &httptrace.ClientTrace{
- Got1xxResponse: func(code int, header textproto.MIMEHeader) error {
- switch code {
- case http.StatusEarlyHints:
- assert.Equal(t, "</style.css>; rel=preload; as=style", header.Get("Link"))
- assert.Equal(t, strconv.Itoa(i), header.Get("Request"))
- earlyHintReceived = true
- }
- return nil
- },
- }
- req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/early-hints.php?i=%d", i), nil)
- w := NewRecorder()
- w.ClientTrace = trace
- handler(w, req)
- assert.Equal(t, strconv.Itoa(i), w.Header().Get("Request"))
- assert.Equal(t, "", w.Header().Get("Link"))
- assert.True(t, earlyHintReceived)
- }, opts)
- }
- func TestFiberBasic_module(t *testing.T) { testFiberBasic(t, &testOptions{}) }
- func TestFiberBasic_worker(t *testing.T) {
- testFiberBasic(t, &testOptions{workerScript: "fiber-basic.php"})
- }
- func testFiberBasic(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/fiber-basic.php?i=%d", i), nil)
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- assert.Equal(t, string(body), fmt.Sprintf("Fiber %d", i))
- }, opts)
- }
- type streamResponseRecorder struct {
- *httptest.ResponseRecorder
- writeCallback func(buf []byte)
- }
- func (srr *streamResponseRecorder) Write(buf []byte) (int, error) {
- srr.writeCallback(buf)
- return srr.ResponseRecorder.Write(buf)
- }
- func TestFlush_module(t *testing.T) { testFlush(t, &testOptions{}) }
- func TestFlush_worker(t *testing.T) {
- testFlush(t, &testOptions{workerScript: "flush.php"})
- }
- func testFlush(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- var j int
- req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/flush.php?i=%d", i), nil)
- w := &streamResponseRecorder{httptest.NewRecorder(), func(buf []byte) {
- if j == 0 {
- assert.Equal(t, []byte("He"), buf)
- } else {
- assert.Equal(t, []byte(fmt.Sprintf("llo %d", i)), buf)
- }
- j++
- }}
- handler(w, req)
- assert.Equal(t, 2, j)
- }, opts)
- }
- func TestLargeRequest_module(t *testing.T) {
- testLargeRequest(t, &testOptions{})
- }
- func TestLargeRequest_worker(t *testing.T) {
- testLargeRequest(t, &testOptions{workerScript: "large-request.php"})
- }
- func testLargeRequest(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest(
- "POST",
- fmt.Sprintf("http://example.com/large-request.php?i=%d", i),
- strings.NewReader(strings.Repeat("f", 6_048_576)),
- )
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- assert.Contains(t, string(body), fmt.Sprintf("Request body size: 6048576 (%d)", i))
- }, opts)
- }
- func TestVersion(t *testing.T) {
- v := frankenphp.Version()
- assert.GreaterOrEqual(t, v.MajorVersion, 8)
- assert.GreaterOrEqual(t, v.MinorVersion, 0)
- assert.GreaterOrEqual(t, v.ReleaseVersion, 0)
- assert.GreaterOrEqual(t, v.VersionID, 0)
- assert.NotEmpty(t, v.Version, 0)
- }
- func TestFiberNoCgo_module(t *testing.T) { testFiberNoCgo(t, &testOptions{}) }
- func TestFiberNonCgo_worker(t *testing.T) {
- testFiberNoCgo(t, &testOptions{workerScript: "fiber-no-cgo.php"})
- }
- func testFiberNoCgo(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/fiber-no-cgo.php?i=%d", i), nil)
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- assert.Equal(t, string(body), fmt.Sprintf("Fiber %d", i))
- }, opts)
- }
- func TestRequestHeaders_module(t *testing.T) { testRequestHeaders(t, &testOptions{}) }
- func TestRequestHeaders_worker(t *testing.T) {
- testRequestHeaders(t, &testOptions{workerScript: "request-headers.php"})
- }
- func testRequestHeaders(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- req := httptest.NewRequest("GET", fmt.Sprintf("http://example.com/request-headers.php?i=%d", i), nil)
- req.Header.Add(strings.Clone("Content-Type"), strings.Clone("text/plain"))
- req.Header.Add(strings.Clone("Frankenphp-I"), strings.Clone(strconv.Itoa(i)))
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- assert.Contains(t, string(body), "[Content-Type] => text/plain")
- assert.Contains(t, string(body), fmt.Sprintf("[Frankenphp-I] => %d", i))
- }, opts)
- }
- func TestFileUpload_module(t *testing.T) { testFileUpload(t, &testOptions{}) }
- func TestFileUpload_worker(t *testing.T) {
- testFileUpload(t, &testOptions{workerScript: "file-upload.php"})
- }
- func testFileUpload(t *testing.T, opts *testOptions) {
- runTest(t, func(handler func(http.ResponseWriter, *http.Request), _ *httptest.Server, i int) {
- requestBody := &bytes.Buffer{}
- writer := multipart.NewWriter(requestBody)
- part, _ := writer.CreateFormFile("file", "foo.txt")
- _, err := part.Write([]byte("bar"))
- require.NoError(t, err)
- writer.Close()
- req := httptest.NewRequest("POST", "http://example.com/file-upload.php", requestBody)
- req.Header.Add("Content-Type", writer.FormDataContentType())
- w := httptest.NewRecorder()
- handler(w, req)
- resp := w.Result()
- body, _ := io.ReadAll(resp.Body)
- assert.Contains(t, string(body), "Upload OK")
- }, opts)
- }
- func TestExecuteScriptCLI(t *testing.T) {
- if _, err := os.Stat("internal/testcli/testcli"); err != nil {
- t.Skip("internal/testcli/testcli has not been compiled, run `cd internal/testcli/ && go build`")
- }
- cmd := exec.Command("internal/testcli/testcli", "testdata/command.php", "foo", "bar")
- stdoutStderr, err := cmd.CombinedOutput()
- assert.Error(t, err)
- if exitError, ok := err.(*exec.ExitError); ok {
- assert.Equal(t, 3, exitError.ExitCode())
- }
- stdoutStderrStr := string(stdoutStderr)
- assert.Contains(t, stdoutStderrStr, `"foo"`)
- assert.Contains(t, stdoutStderrStr, `"bar"`)
- assert.Contains(t, stdoutStderrStr, "From the CLI")
- }
- func ExampleServeHTTP() {
- if err := frankenphp.Init(); err != nil {
- panic(err)
- }
- defer frankenphp.Shutdown()
- http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
- req, err := frankenphp.NewRequestWithContext(r, frankenphp.WithRequestDocumentRoot("/path/to/document/root", false))
- if err != nil {
- panic(err)
- }
- if err := frankenphp.ServeHTTP(w, req); err != nil {
- panic(err)
- }
- })
- log.Fatal(http.ListenAndServe(":8080", nil))
- }
- func ExampleExecuteScriptCLI() {
- if len(os.Args) <= 1 {
- log.Println("Usage: my-program script.php")
- os.Exit(1)
- }
- os.Exit(frankenphp.ExecuteScriptCLI(os.Args[1], os.Args))
- }
- func BenchmarkHelloWorld(b *testing.B) {
- if err := frankenphp.Init(frankenphp.WithLogger(zap.NewNop())); err != nil {
- panic(err)
- }
- defer frankenphp.Shutdown()
- cwd, _ := os.Getwd()
- testDataDir := cwd + "/testdata/"
- handler := func(w http.ResponseWriter, r *http.Request) {
- req, err := frankenphp.NewRequestWithContext(r, frankenphp.WithRequestDocumentRoot(testDataDir, false))
- if err != nil {
- panic(err)
- }
- if err := frankenphp.ServeHTTP(w, req); err != nil {
- panic(err)
- }
- }
- req := httptest.NewRequest("GET", "http://example.com/index.php", nil)
- w := httptest.NewRecorder()
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- handler(w, req)
- }
- }
- func BenchmarkEcho(b *testing.B) {
- if err := frankenphp.Init(frankenphp.WithLogger(zap.NewNop())); err != nil {
- panic(err)
- }
- defer frankenphp.Shutdown()
- cwd, _ := os.Getwd()
- testDataDir := cwd + "/testdata/"
- handler := func(w http.ResponseWriter, r *http.Request) {
- req, err := frankenphp.NewRequestWithContext(r, frankenphp.WithRequestDocumentRoot(testDataDir, false))
- if err != nil {
- panic(err)
- }
- if err := frankenphp.ServeHTTP(w, req); err != nil {
- panic(err)
- }
- }
- const body = `{
- "squadName": "Super hero squad",
- "homeTown": "Metro City",
- "formed": 2016,
- "secretBase": "Super tower",
- "active": true,
- "members": [
- {
- "name": "Molecule Man",
- "age": 29,
- "secretIdentity": "Dan Jukes",
- "powers": ["Radiation resistance", "Turning tiny", "Radiation blast"]
- },
- {
- "name": "Madame Uppercut",
- "age": 39,
- "secretIdentity": "Jane Wilson",
- "powers": [
- "Million tonne punch",
- "Damage resistance",
- "Superhuman reflexes"
- ]
- },
- {
- "name": "Eternal Flame",
- "age": 1000000,
- "secretIdentity": "Unknown",
- "powers": [
- "Immortality",
- "Heat Immunity",
- "Inferno",
- "Teleportation",
- "Interdimensional travel"
- ]
- }
- ]
- }`
- r := strings.NewReader(body)
- req := httptest.NewRequest("POST", "http://example.com/echo.php", r)
- w := httptest.NewRecorder()
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- r.Reset(body)
- handler(w, req)
- }
- }
- func BenchmarkServerSuperGlobal(b *testing.B) {
- if err := frankenphp.Init(frankenphp.WithLogger(zap.NewNop())); err != nil {
- panic(err)
- }
- defer frankenphp.Shutdown()
- cwd, _ := os.Getwd()
- testDataDir := cwd + "/testdata/"
- // Mimicks headers of a request sent by Firefox to GitHub
- headers := http.Header{}
- headers.Add(strings.Clone("Accept"), strings.Clone("text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8"))
- headers.Add(strings.Clone("Accept-Encoding"), strings.Clone("gzip, deflate, br"))
- headers.Add(strings.Clone("Accept-Language"), strings.Clone("fr,fr-FR;q=0.8,en-US;q=0.5,en;q=0.3"))
- headers.Add(strings.Clone("Cache-Control"), strings.Clone("no-cache"))
- headers.Add(strings.Clone("Connection"), strings.Clone("keep-alive"))
- headers.Add(strings.Clone("Cookie"), strings.Clone("user_session=myrandomuuid; __Host-user_session_same_site=myotherrandomuuid; dotcom_user=dunglas; logged_in=yes; _foo=barbarbarbarbarbar; _device_id=anotherrandomuuid; color_mode=foobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobarfoobar; preferred_color_mode=light; tz=Europe%2FParis; has_recent_activity=1"))
- headers.Add(strings.Clone("DNT"), strings.Clone("1"))
- headers.Add(strings.Clone("Host"), strings.Clone("example.com"))
- headers.Add(strings.Clone("Pragma"), strings.Clone("no-cache"))
- headers.Add(strings.Clone("Sec-Fetch-Dest"), strings.Clone("document"))
- headers.Add(strings.Clone("Sec-Fetch-Mode"), strings.Clone("navigate"))
- headers.Add(strings.Clone("Sec-Fetch-Site"), strings.Clone("cross-site"))
- headers.Add(strings.Clone("Sec-GPC"), strings.Clone("1"))
- headers.Add(strings.Clone("Upgrade-Insecure-Requests"), strings.Clone("1"))
- headers.Add(strings.Clone("User-Agent"), strings.Clone("Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:122.0) Gecko/20100101 Firefox/122.0"))
- // Env vars available in a typical Docker container
- env := map[string]string{
- "HOSTNAME": "a88e81aa22e4",
- "PHP_INI_DIR": "/usr/local/etc/php",
- "HOME": "/root",
- "GODEBUG": "cgocheck=0",
- "PHP_LDFLAGS": "-Wl,-O1 -pie",
- "PHP_CFLAGS": "-fstack-protector-strong -fpic -fpie -O2 -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64",
- "PHP_VERSION": "8.3.2",
- "GPG_KEYS": "1198C0117593497A5EC5C199286AF1F9897469DC C28D937575603EB4ABB725861C0779DC5C0A9DE4 AFD8691FDAEDF03BDF6E460563F15A9B715376CA",
- "PHP_CPPFLAGS": "-fstack-protector-strong -fpic -fpie -O2 -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64",
- "PHP_ASC_URL": "https://www.php.net/distributions/php-8.3.2.tar.xz.asc",
- "PHP_URL": "https://www.php.net/distributions/php-8.3.2.tar.xz",
- "PATH": "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
- "XDG_CONFIG_HOME": "/config",
- "XDG_DATA_HOME": "/data",
- "PHPIZE_DEPS": "autoconf dpkg-dev file g++ gcc libc-dev make pkg-config re2c",
- "PWD": "/app",
- "PHP_SHA256": "4ffa3e44afc9c590e28dc0d2d31fc61f0139f8b335f11880a121b9f9b9f0634e",
- }
- preparedEnv := frankenphp.PrepareEnv(env)
- handler := func(w http.ResponseWriter, r *http.Request) {
- req, err := frankenphp.NewRequestWithContext(r, frankenphp.WithRequestDocumentRoot(testDataDir, false), frankenphp.WithRequestPreparedEnv(preparedEnv))
- if err != nil {
- panic(err)
- }
- r.Header = headers
- if err := frankenphp.ServeHTTP(w, req); err != nil {
- panic(err)
- }
- }
- req := httptest.NewRequest("GET", "http://example.com/server-variable.php", nil)
- w := httptest.NewRecorder()
- b.ResetTimer()
- for i := 0; i < b.N; i++ {
- handler(w, req)
- }
- }
|