Simple test of alexedwards/scs using only public api

php Editor Banana This article will introduce how to use the public API to conduct a simple test on Alex Edwards/SCS. Alex Edwards/SCS is a PHP library for session management that makes it easy to manage user sessions in your application. By testing with the public API, we can verify the functionality and performance of the library and ensure its stability and reliability in real-world applications. In this article, we will guide you step by step on how to conduct a simple test and show the analysis and interpretation of the test results. let's start!

Question content

This question is a follow-up question to this question. I want to do a simple test on https://pkg.go.dev/github.com/alexedwards/scs/[email protected] to verify the functionality I want to use. Basically, I just want to put some data into the session, take it out, and verify that it's the same. Something like this:

func testscs_setgetissame1(t *testing.t) {
    sessionmanager := scs.new()
    req := httptest.newrequest("get", "/", nil)
    key := "boolean"
    expected := false
    sessionmanager.put(req.context(), key, expected)
    actual := sessionmanager.getbool(req.context(), key)
    assert.equal(t, expected, actual)
}

This will generate a panic: scs: No session data in context.

I tried copying the example from httptest package, but httptest.server does not implement http.handler (servehttp method is missing).

func TestScs_SetGetIsSame2(t *testing.T) {
    sessionManager := scs.New()

    ts := httptest.NewServer((http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        fmt.Fprintln(w, "Hello, client")
        expected := true
        sessionManager.Put(r.Context(), "key", expected)
        actual := sessionManager.GetBool(r.Context(), "key")
        assert.Equal(t, expected, actual)
    })))
    defer ts.Close()

    res, err := http.Get(ts.URL)
    if err != nil {
        log.Fatal(err)
    }

    greeting, err := io.ReadAll(res.Body)
    res.Body.Close()
    if err != nil {
        log.Fatal(err)
    }

    fmt.Printf("%s", greeting)

    sessionManager.LoadAndSave(ts)
}

I also looked at the tests in the alexedwards/scs repository, but they use the private function addsessiondatatocontext.

What is the best and easiest way to test a session in go?

Solution

I see

in your code

ts := httptest.newserver(http.handlerfunc(func(w http.responsewriter, r *http.request) {
    // ...
}))

sessionmanager.loadandsave(ts) // this line is incorrect

You are trying to pass a test server (ts) to sessionmanager.loadandsave. This won't work because sessionmanager.loadandsave requires http.handler and ts is of type *httptest.server whereas Not http.handler.

Instead, you should pass the actual handler to the sessionmanager. Load and save before creating the test server.

To do this, you can wrap the actual handler function (which does return http.handler) with sessionmanager.loadandsave before passing it to httptest.newserver .

handler := sessionmanager.loadandsave(http.handlerfunc(func(w http.responsewriter, r *http.request) {
    // ... logic here ...
}))

ts := httptest.newserver(handler)

Create a new handler by wrapping the actual handler function with sessionmanager.loadandsave middleware. This wrapped handler is then passed to httptest.newserver.

If you put them together:

package main

import (
    "fmt"
    "github.com/alexedwards/scs/v2"
    "github.com/stretchr/testify/assert"
    "io"
    "log"
    "net/http"
    "net/http/httptest"
    "testing"
)

func TestScs_SetGetIsSame2(t *testing.T) {
    sessionManager := scs.New()

    // Create a handler and wrap it using sessionManager.LoadAndSave
    handler := sessionManager.LoadAndSave(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        fmt.Fprintln(w, "Hello, client")
        expected := true
        sessionManager.Put(r.Context(), "key", expected)
        actual := sessionManager.GetBool(r.Context(), "key")
        assert.Equal(t, expected, actual)
    }))

    // Create a test server with the handler
    ts := httptest.NewServer(handler)
    defer ts.Close()

    // Make a request to the server
    res, err := http.Get(ts.URL)
    if err != nil {
        log.Fatal(err)
    }

    // Read the response body
    greeting, err := io.ReadAll(res.Body)
    res.Body.Close()
    if err != nil {
        log.Fatal(err)
    }

    // Print the response body
    fmt.Printf("%s", greeting)
}

The above is the detailed content of Simple test of alexedwards/scs using only public api. For more information, please follow other related articles on the PHP Chinese website!