123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470 |
- // Copyright 2017 The Gitea Authors. All rights reserved.
- // SPDX-License-Identifier: MIT
-
- //nolint:forbidigo
- package integration
-
- import (
- "bytes"
- "context"
- "fmt"
- "hash"
- "hash/fnv"
- "io"
- "net/http"
- "net/http/cookiejar"
- "net/http/httptest"
- "net/url"
- "os"
- "path/filepath"
- "strings"
- "sync/atomic"
- "testing"
- "time"
-
- "code.gitea.io/gitea/models/auth"
- "code.gitea.io/gitea/models/unittest"
- gitea_context "code.gitea.io/gitea/modules/context"
- "code.gitea.io/gitea/modules/graceful"
- "code.gitea.io/gitea/modules/json"
- "code.gitea.io/gitea/modules/log"
- "code.gitea.io/gitea/modules/setting"
- "code.gitea.io/gitea/modules/testlogger"
- "code.gitea.io/gitea/modules/util"
- "code.gitea.io/gitea/modules/web"
- "code.gitea.io/gitea/routers"
- "code.gitea.io/gitea/tests"
-
- "github.com/PuerkitoBio/goquery"
- "github.com/stretchr/testify/assert"
- "github.com/xeipuuv/gojsonschema"
- )
-
- var testWebRoutes *web.Route
-
- type NilResponseRecorder struct {
- httptest.ResponseRecorder
- Length int
- }
-
- func (n *NilResponseRecorder) Write(b []byte) (int, error) {
- n.Length += len(b)
- return len(b), nil
- }
-
- // NewRecorder returns an initialized ResponseRecorder.
- func NewNilResponseRecorder() *NilResponseRecorder {
- return &NilResponseRecorder{
- ResponseRecorder: *httptest.NewRecorder(),
- }
- }
-
- type NilResponseHashSumRecorder struct {
- httptest.ResponseRecorder
- Hash hash.Hash
- Length int
- }
-
- func (n *NilResponseHashSumRecorder) Write(b []byte) (int, error) {
- _, _ = n.Hash.Write(b)
- n.Length += len(b)
- return len(b), nil
- }
-
- // NewRecorder returns an initialized ResponseRecorder.
- func NewNilResponseHashSumRecorder() *NilResponseHashSumRecorder {
- return &NilResponseHashSumRecorder{
- Hash: fnv.New32(),
- ResponseRecorder: *httptest.NewRecorder(),
- }
- }
-
- func TestMain(m *testing.M) {
- defer log.GetManager().Close()
-
- managerCtx, cancel := context.WithCancel(context.Background())
- graceful.InitManager(managerCtx)
- defer cancel()
-
- tests.InitTest(true)
- testWebRoutes = routers.NormalRoutes()
-
- // integration test settings...
- if setting.CfgProvider != nil {
- testingCfg := setting.CfgProvider.Section("integration-tests")
- testlogger.SlowTest = testingCfg.Key("SLOW_TEST").MustDuration(testlogger.SlowTest)
- testlogger.SlowFlush = testingCfg.Key("SLOW_FLUSH").MustDuration(testlogger.SlowFlush)
- }
-
- if os.Getenv("GITEA_SLOW_TEST_TIME") != "" {
- duration, err := time.ParseDuration(os.Getenv("GITEA_SLOW_TEST_TIME"))
- if err == nil {
- testlogger.SlowTest = duration
- }
- }
-
- if os.Getenv("GITEA_SLOW_FLUSH_TIME") != "" {
- duration, err := time.ParseDuration(os.Getenv("GITEA_SLOW_FLUSH_TIME"))
- if err == nil {
- testlogger.SlowFlush = duration
- }
- }
-
- os.Unsetenv("GIT_AUTHOR_NAME")
- os.Unsetenv("GIT_AUTHOR_EMAIL")
- os.Unsetenv("GIT_AUTHOR_DATE")
- os.Unsetenv("GIT_COMMITTER_NAME")
- os.Unsetenv("GIT_COMMITTER_EMAIL")
- os.Unsetenv("GIT_COMMITTER_DATE")
-
- err := unittest.InitFixtures(
- unittest.FixturesOptions{
- Dir: filepath.Join(filepath.Dir(setting.AppPath), "models/fixtures/"),
- },
- )
- if err != nil {
- fmt.Printf("Error initializing test database: %v\n", err)
- os.Exit(1)
- }
-
- // FIXME: the console logger is deleted by mistake, so if there is any `log.Fatal`, developers won't see any error message.
- // Instead, "No tests were found", last nonsense log is "According to the configuration, subsequent logs will not be printed to the console"
- exitCode := m.Run()
-
- testlogger.WriterCloser.Reset()
-
- if err = util.RemoveAll(setting.Indexer.IssuePath); err != nil {
- fmt.Printf("util.RemoveAll: %v\n", err)
- os.Exit(1)
- }
- if err = util.RemoveAll(setting.Indexer.RepoPath); err != nil {
- fmt.Printf("Unable to remove repo indexer: %v\n", err)
- os.Exit(1)
- }
-
- os.Exit(exitCode)
- }
-
- type TestSession struct {
- jar http.CookieJar
- }
-
- func (s *TestSession) GetCookie(name string) *http.Cookie {
- baseURL, err := url.Parse(setting.AppURL)
- if err != nil {
- return nil
- }
-
- for _, c := range s.jar.Cookies(baseURL) {
- if c.Name == name {
- return c
- }
- }
- return nil
- }
-
- func (s *TestSession) MakeRequest(t testing.TB, req *http.Request, expectedStatus int) *httptest.ResponseRecorder {
- t.Helper()
- baseURL, err := url.Parse(setting.AppURL)
- assert.NoError(t, err)
- for _, c := range s.jar.Cookies(baseURL) {
- req.AddCookie(c)
- }
- resp := MakeRequest(t, req, expectedStatus)
-
- ch := http.Header{}
- ch.Add("Cookie", strings.Join(resp.Header()["Set-Cookie"], ";"))
- cr := http.Request{Header: ch}
- s.jar.SetCookies(baseURL, cr.Cookies())
-
- return resp
- }
-
- func (s *TestSession) MakeRequestNilResponseRecorder(t testing.TB, req *http.Request, expectedStatus int) *NilResponseRecorder {
- t.Helper()
- baseURL, err := url.Parse(setting.AppURL)
- assert.NoError(t, err)
- for _, c := range s.jar.Cookies(baseURL) {
- req.AddCookie(c)
- }
- resp := MakeRequestNilResponseRecorder(t, req, expectedStatus)
-
- ch := http.Header{}
- ch.Add("Cookie", strings.Join(resp.Header()["Set-Cookie"], ";"))
- cr := http.Request{Header: ch}
- s.jar.SetCookies(baseURL, cr.Cookies())
-
- return resp
- }
-
- func (s *TestSession) MakeRequestNilResponseHashSumRecorder(t testing.TB, req *http.Request, expectedStatus int) *NilResponseHashSumRecorder {
- t.Helper()
- baseURL, err := url.Parse(setting.AppURL)
- assert.NoError(t, err)
- for _, c := range s.jar.Cookies(baseURL) {
- req.AddCookie(c)
- }
- resp := MakeRequestNilResponseHashSumRecorder(t, req, expectedStatus)
-
- ch := http.Header{}
- ch.Add("Cookie", strings.Join(resp.Header()["Set-Cookie"], ";"))
- cr := http.Request{Header: ch}
- s.jar.SetCookies(baseURL, cr.Cookies())
-
- return resp
- }
-
- const userPassword = "password"
-
- func emptyTestSession(t testing.TB) *TestSession {
- t.Helper()
- jar, err := cookiejar.New(nil)
- assert.NoError(t, err)
-
- return &TestSession{jar: jar}
- }
-
- func getUserToken(t testing.TB, userName string, scope ...auth.AccessTokenScope) string {
- return getTokenForLoggedInUser(t, loginUser(t, userName), scope...)
- }
-
- func loginUser(t testing.TB, userName string) *TestSession {
- t.Helper()
-
- return loginUserWithPassword(t, userName, userPassword)
- }
-
- func loginUserWithPassword(t testing.TB, userName, password string) *TestSession {
- t.Helper()
- req := NewRequest(t, "GET", "/user/login")
- resp := MakeRequest(t, req, http.StatusOK)
-
- doc := NewHTMLParser(t, resp.Body)
- req = NewRequestWithValues(t, "POST", "/user/login", map[string]string{
- "_csrf": doc.GetCSRF(),
- "user_name": userName,
- "password": password,
- })
- resp = MakeRequest(t, req, http.StatusSeeOther)
-
- ch := http.Header{}
- ch.Add("Cookie", strings.Join(resp.Header()["Set-Cookie"], ";"))
- cr := http.Request{Header: ch}
-
- session := emptyTestSession(t)
-
- baseURL, err := url.Parse(setting.AppURL)
- assert.NoError(t, err)
- session.jar.SetCookies(baseURL, cr.Cookies())
-
- return session
- }
-
- // token has to be unique this counter take care of
- var tokenCounter int64
-
- // getTokenForLoggedInUser returns a token for a logged in user.
- // The scope is an optional list of snake_case strings like the frontend form fields,
- // but without the "scope_" prefix.
- func getTokenForLoggedInUser(t testing.TB, session *TestSession, scopes ...auth.AccessTokenScope) string {
- t.Helper()
- var token string
- req := NewRequest(t, "GET", "/user/settings/applications")
- resp := session.MakeRequest(t, req, http.StatusOK)
- var csrf string
- for _, cookie := range resp.Result().Cookies() {
- if cookie.Name != "_csrf" {
- continue
- }
- csrf = cookie.Value
- break
- }
- if csrf == "" {
- doc := NewHTMLParser(t, resp.Body)
- csrf = doc.GetCSRF()
- }
- assert.NotEmpty(t, csrf)
- urlValues := url.Values{}
- urlValues.Add("_csrf", csrf)
- urlValues.Add("name", fmt.Sprintf("api-testing-token-%d", atomic.AddInt64(&tokenCounter, 1)))
- for _, scope := range scopes {
- urlValues.Add("scope", string(scope))
- }
- req = NewRequestWithURLValues(t, "POST", "/user/settings/applications", urlValues)
- resp = session.MakeRequest(t, req, http.StatusSeeOther)
-
- // Log the flash values on failure
- if !assert.Equal(t, resp.Result().Header["Location"], []string{"/user/settings/applications"}) {
- for _, cookie := range resp.Result().Cookies() {
- if cookie.Name != gitea_context.CookieNameFlash {
- continue
- }
- flash, _ := url.ParseQuery(cookie.Value)
- for key, value := range flash {
- t.Logf("Flash %q: %q", key, value)
- }
- }
- }
-
- req = NewRequest(t, "GET", "/user/settings/applications")
- resp = session.MakeRequest(t, req, http.StatusOK)
- htmlDoc := NewHTMLParser(t, resp.Body)
- token = htmlDoc.doc.Find(".ui.info p").Text()
- assert.NotEmpty(t, token)
- return token
- }
-
- func NewRequest(t testing.TB, method, urlStr string) *http.Request {
- t.Helper()
- return NewRequestWithBody(t, method, urlStr, nil)
- }
-
- func NewRequestf(t testing.TB, method, urlFormat string, args ...any) *http.Request {
- t.Helper()
- return NewRequest(t, method, fmt.Sprintf(urlFormat, args...))
- }
-
- func NewRequestWithValues(t testing.TB, method, urlStr string, values map[string]string) *http.Request {
- t.Helper()
- urlValues := url.Values{}
- for key, value := range values {
- urlValues[key] = []string{value}
- }
- return NewRequestWithURLValues(t, method, urlStr, urlValues)
- }
-
- func NewRequestWithURLValues(t testing.TB, method, urlStr string, urlValues url.Values) *http.Request {
- t.Helper()
- req := NewRequestWithBody(t, method, urlStr, bytes.NewBufferString(urlValues.Encode()))
- req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
- return req
- }
-
- func NewRequestWithJSON(t testing.TB, method, urlStr string, v any) *http.Request {
- t.Helper()
-
- jsonBytes, err := json.Marshal(v)
- assert.NoError(t, err)
- req := NewRequestWithBody(t, method, urlStr, bytes.NewBuffer(jsonBytes))
- req.Header.Add("Content-Type", "application/json")
- return req
- }
-
- func NewRequestWithBody(t testing.TB, method, urlStr string, body io.Reader) *http.Request {
- t.Helper()
- if !strings.HasPrefix(urlStr, "http") && !strings.HasPrefix(urlStr, "/") {
- urlStr = "/" + urlStr
- }
- request, err := http.NewRequest(method, urlStr, body)
- assert.NoError(t, err)
- request.RequestURI = urlStr
- return request
- }
-
- func AddBasicAuthHeader(request *http.Request, username string) *http.Request {
- request.SetBasicAuth(username, userPassword)
- return request
- }
-
- const NoExpectedStatus = -1
-
- func MakeRequest(t testing.TB, req *http.Request, expectedStatus int) *httptest.ResponseRecorder {
- t.Helper()
- recorder := httptest.NewRecorder()
- if req.RemoteAddr == "" {
- req.RemoteAddr = "test-mock:12345"
- }
- testWebRoutes.ServeHTTP(recorder, req)
- if expectedStatus != NoExpectedStatus {
- if !assert.EqualValues(t, expectedStatus, recorder.Code, "Request: %s %s", req.Method, req.URL.String()) {
- logUnexpectedResponse(t, recorder)
- }
- }
- return recorder
- }
-
- func MakeRequestNilResponseRecorder(t testing.TB, req *http.Request, expectedStatus int) *NilResponseRecorder {
- t.Helper()
- recorder := NewNilResponseRecorder()
- testWebRoutes.ServeHTTP(recorder, req)
- if expectedStatus != NoExpectedStatus {
- if !assert.EqualValues(t, expectedStatus, recorder.Code,
- "Request: %s %s", req.Method, req.URL.String()) {
- logUnexpectedResponse(t, &recorder.ResponseRecorder)
- }
- }
- return recorder
- }
-
- func MakeRequestNilResponseHashSumRecorder(t testing.TB, req *http.Request, expectedStatus int) *NilResponseHashSumRecorder {
- t.Helper()
- recorder := NewNilResponseHashSumRecorder()
- testWebRoutes.ServeHTTP(recorder, req)
- if expectedStatus != NoExpectedStatus {
- if !assert.EqualValues(t, expectedStatus, recorder.Code,
- "Request: %s %s", req.Method, req.URL.String()) {
- logUnexpectedResponse(t, &recorder.ResponseRecorder)
- }
- }
- return recorder
- }
-
- // logUnexpectedResponse logs the contents of an unexpected response.
- func logUnexpectedResponse(t testing.TB, recorder *httptest.ResponseRecorder) {
- t.Helper()
- respBytes := recorder.Body.Bytes()
- if len(respBytes) == 0 {
- return
- } else if len(respBytes) < 500 {
- // if body is short, just log the whole thing
- t.Log("Response: ", string(respBytes))
- return
- } else {
- t.Log("Response length: ", len(respBytes))
- }
-
- // log the "flash" error message, if one exists
- // we must create a new buffer, so that we don't "use up" resp.Body
- htmlDoc, err := goquery.NewDocumentFromReader(bytes.NewBuffer(respBytes))
- if err != nil {
- return // probably a non-HTML response
- }
- errMsg := htmlDoc.Find(".ui.negative.message").Text()
- if len(errMsg) > 0 {
- t.Log("A flash error message was found:", errMsg)
- }
- }
-
- func DecodeJSON(t testing.TB, resp *httptest.ResponseRecorder, v any) {
- t.Helper()
-
- decoder := json.NewDecoder(resp.Body)
- assert.NoError(t, decoder.Decode(v))
- }
-
- func VerifyJSONSchema(t testing.TB, resp *httptest.ResponseRecorder, schemaFile string) {
- t.Helper()
-
- schemaFilePath := filepath.Join(filepath.Dir(setting.AppPath), "tests", "integration", "schemas", schemaFile)
- _, schemaFileErr := os.Stat(schemaFilePath)
- assert.Nil(t, schemaFileErr)
-
- schema, schemaFileReadErr := os.ReadFile(schemaFilePath)
- assert.Nil(t, schemaFileReadErr)
- assert.True(t, len(schema) > 0)
-
- nodeinfoSchema := gojsonschema.NewStringLoader(string(schema))
- nodeinfoString := gojsonschema.NewStringLoader(resp.Body.String())
- result, schemaValidationErr := gojsonschema.Validate(nodeinfoSchema, nodeinfoString)
- assert.Nil(t, schemaValidationErr)
- assert.Empty(t, result.Errors())
- assert.True(t, result.Valid())
- }
-
- func GetCSRF(t testing.TB, session *TestSession, urlStr string) string {
- t.Helper()
- req := NewRequest(t, "GET", urlStr)
- resp := session.MakeRequest(t, req, http.StatusOK)
- doc := NewHTMLParser(t, resp.Body)
- return doc.GetCSRF()
- }
|