mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2025-05-31 20:02:09 +00:00
[v10.0/forgejo] Refactor e2e tests to simplify authentication setup (#6585)
**Backport:** https://codeberg.org/forgejo/forgejo/pulls/6400 Replaced manual login and context loading across tests with Playwright's `test.use` configuration for user authentication. This simplifies test setup, improves readability, and reduces repetition. #6362 first part ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests - I added test coverage for Go changes... - [ ] in their respective `*_test.go` for unit tests. - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [x] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [ ] I did not document these changes and I do not expect someone else to do it. ### Release notes - [x] I do not want this change to show in the release notes. - [ ] I want the title to show in the release notes with a link to this pull request. - [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. Co-authored-by: Julian Schlarb <julian.schlarb@denktmit.de> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/6585 Reviewed-by: Otto <otto@codeberg.org> Co-authored-by: forgejo-backport-action <forgejo-backport-action@noreply.codeberg.org> Co-committed-by: forgejo-backport-action <forgejo-backport-action@noreply.codeberg.org>
This commit is contained in:
forgejo-backport-action
Earl Warren
parent
39843ee2b3
commit
05056b8aa2
19 changed files with 327 additions and 254 deletions
|
|
@ -5,17 +5,27 @@ package e2e
|
|||
|
||||
import (
|
||||
"context"
|
||||
"crypto/rand"
|
||||
"encoding/hex"
|
||||
"fmt"
|
||||
"net"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"code.gitea.io/gitea/models/unittest"
|
||||
user_model "code.gitea.io/gitea/models/user"
|
||||
"code.gitea.io/gitea/modules/json"
|
||||
modules_session "code.gitea.io/gitea/modules/session"
|
||||
"code.gitea.io/gitea/modules/setting"
|
||||
"code.gitea.io/gitea/tests"
|
||||
|
||||
"code.forgejo.org/go-chi/session"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
|
|
@ -25,6 +35,8 @@ func onForgejoRunTB(t testing.TB, callback func(testing.TB, *url.URL), prepare .
|
|||
if len(prepare) == 0 || prepare[0] {
|
||||
defer tests.PrepareTestEnv(t, 1)()
|
||||
}
|
||||
createSessions(t)
|
||||
|
||||
s := http.Server{
|
||||
Handler: testE2eWebRoutes,
|
||||
}
|
||||
|
|
@ -64,3 +76,118 @@ func onForgejoRun(t *testing.T, callback func(*testing.T, *url.URL), prepare ...
|
|||
callback(t.(*testing.T), u)
|
||||
}, prepare...)
|
||||
}
|
||||
|
||||
func createSessions(t testing.TB) {
|
||||
t.Helper()
|
||||
// copied from playwright.config.ts
|
||||
browsers := []string{
|
||||
"chromium",
|
||||
"firefox",
|
||||
"webkit",
|
||||
"Mobile Chrome",
|
||||
"Mobile Safari",
|
||||
}
|
||||
scopes := []string{
|
||||
"shared",
|
||||
}
|
||||
users := []string{
|
||||
"user1",
|
||||
"user2",
|
||||
"user12",
|
||||
"user40",
|
||||
}
|
||||
|
||||
authState := filepath.Join(filepath.Dir(setting.AppPath), "tests", "e2e", ".auth")
|
||||
err := os.RemoveAll(authState)
|
||||
require.NoError(t, err)
|
||||
|
||||
err = os.MkdirAll(authState, os.ModePerm)
|
||||
require.NoError(t, err)
|
||||
|
||||
createSessionCookie := stateHelper(t)
|
||||
|
||||
for _, user := range users {
|
||||
u := unittest.AssertExistsAndLoadBean(t, &user_model.User{LowerName: strings.ToLower(user)})
|
||||
for _, browser := range browsers {
|
||||
for _, scope := range scopes {
|
||||
stateFile := strings.ReplaceAll(strings.ToLower(fmt.Sprintf("state-%s-%s-%s.json", browser, user, scope)), " ", "-")
|
||||
createSessionCookie(filepath.Join(authState, stateFile), u)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func stateHelper(t testing.TB) func(stateFile string, user *user_model.User) {
|
||||
type Cookie struct {
|
||||
Name string `json:"name"`
|
||||
Value string `json:"value"`
|
||||
Domain string `json:"domain"`
|
||||
Path string `json:"path"`
|
||||
Expires int `json:"expires"`
|
||||
HTTPOnly bool `json:"httpOnly"`
|
||||
Secure bool `json:"secure"`
|
||||
SameSite string `json:"sameSite"`
|
||||
}
|
||||
|
||||
type BrowserState struct {
|
||||
Cookies []Cookie `json:"cookies"`
|
||||
Origins []string `json:"origins"`
|
||||
}
|
||||
|
||||
options := session.Options{
|
||||
Provider: setting.SessionConfig.Provider,
|
||||
ProviderConfig: setting.SessionConfig.ProviderConfig,
|
||||
CookieName: setting.SessionConfig.CookieName,
|
||||
CookiePath: setting.SessionConfig.CookiePath,
|
||||
Gclifetime: setting.SessionConfig.Gclifetime,
|
||||
Maxlifetime: setting.SessionConfig.Maxlifetime,
|
||||
Secure: setting.SessionConfig.Secure,
|
||||
SameSite: setting.SessionConfig.SameSite,
|
||||
Domain: setting.SessionConfig.Domain,
|
||||
}
|
||||
|
||||
opt := session.PrepareOptions([]session.Options{options})
|
||||
|
||||
vsp := modules_session.VirtualSessionProvider{}
|
||||
err := vsp.Init(opt.Maxlifetime, opt.ProviderConfig)
|
||||
require.NoError(t, err)
|
||||
|
||||
return func(stateFile string, user *user_model.User) {
|
||||
buf := make([]byte, opt.IDLength/2)
|
||||
_, err = rand.Read(buf)
|
||||
require.NoError(t, err)
|
||||
|
||||
sessionID := hex.EncodeToString(buf)
|
||||
|
||||
s, err := vsp.Read(sessionID)
|
||||
require.NoError(t, err)
|
||||
|
||||
err = s.Set("uid", user.ID)
|
||||
require.NoError(t, err)
|
||||
|
||||
err = s.Release()
|
||||
require.NoError(t, err)
|
||||
|
||||
state := BrowserState{
|
||||
Cookies: []Cookie{
|
||||
{
|
||||
Name: opt.CookieName,
|
||||
Value: sessionID,
|
||||
Domain: setting.Domain,
|
||||
Path: "/",
|
||||
Expires: -1,
|
||||
HTTPOnly: true,
|
||||
Secure: false,
|
||||
SameSite: "Lax",
|
||||
},
|
||||
},
|
||||
Origins: []string{},
|
||||
}
|
||||
|
||||
jsonData, err := json.Marshal(state)
|
||||
require.NoError(t, err)
|
||||
|
||||
err = os.WriteFile(stateFile, jsonData, 0o644)
|
||||
require.NoError(t, err)
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue