// Copyright 2017 The Gitea Authors. All rights reserved. // Use of this source code is governed by a MIT-style // license that can be found in the LICENSE file. package integrations import ( "bytes" "database/sql" "encoding/json" "fmt" "io" "log" "net/http" "net/http/cookiejar" "net/http/httptest" "net/url" "os" "path" "path/filepath" "strings" "testing" "code.gitea.io/gitea/models" "code.gitea.io/gitea/modules/base" "code.gitea.io/gitea/modules/setting" "code.gitea.io/gitea/routers" "code.gitea.io/gitea/routers/routes" "github.com/PuerkitoBio/goquery" "github.com/Unknwon/com" "github.com/stretchr/testify/assert" "gopkg.in/macaron.v1" "gopkg.in/testfixtures.v2" ) var mac *macaron.Macaron type NilResponseRecorder struct { httptest.ResponseRecorder Length int } func (n *NilResponseRecorder) Write(b []byte) (int, error) { n.Length = n.Length + len(b) return len(b), nil } // NewRecorder returns an initialized ResponseRecorder. func NewNilResponseRecorder() *NilResponseRecorder { return &NilResponseRecorder{ ResponseRecorder: *httptest.NewRecorder(), } } func TestMain(m *testing.M) { initIntegrationTest() mac = routes.NewMacaron() routes.RegisterRoutes(mac) var helper testfixtures.Helper if setting.UseMySQL { helper = &testfixtures.MySQL{} } else if setting.UsePostgreSQL { helper = &testfixtures.PostgreSQL{} } else if setting.UseSQLite3 { helper = &testfixtures.SQLite{} } else if setting.UseMSSQL { helper = &testfixtures.SQLServer{} } else { fmt.Println("Unsupported RDBMS for integration tests") os.Exit(1) } err := models.InitFixtures( helper, path.Join(filepath.Dir(setting.AppPath), "models/fixtures/"), ) if err != nil { fmt.Printf("Error initializing test database: %v\n", err) os.Exit(1) } exitCode := m.Run() writerCloser.t = nil if err = os.RemoveAll(setting.Indexer.IssuePath); err != nil { fmt.Printf("os.RemoveAll: %v\n", err) os.Exit(1) } if err = os.RemoveAll(setting.Indexer.RepoPath); err != nil { fmt.Printf("Unable to remove repo indexer: %v\n", err) os.Exit(1) } os.Exit(exitCode) } func initIntegrationTest() { giteaRoot := base.SetupGiteaRoot() if giteaRoot == "" { fmt.Println("Environment variable $GITEA_ROOT not set") os.Exit(1) } setting.AppPath = path.Join(giteaRoot, "gitea") if _, err := os.Stat(setting.AppPath); err != nil { fmt.Printf("Could not find gitea binary at %s\n", setting.AppPath) os.Exit(1) } giteaConf := os.Getenv("GITEA_CONF") if giteaConf == "" { fmt.Println("Environment variable $GITEA_CONF not set") os.Exit(1) } else if !path.IsAbs(giteaConf) { setting.CustomConf = path.Join(giteaRoot, giteaConf) } else { setting.CustomConf = giteaConf } setting.SetCustomPathAndConf("", "") setting.NewContext() setting.CheckLFSVersion() models.LoadConfigs() switch { case setting.UseMySQL: db, err := sql.Open("mysql", fmt.Sprintf("%s:%s@tcp(%s)/", models.DbCfg.User, models.DbCfg.Passwd, models.DbCfg.Host)) defer db.Close() if err != nil { log.Fatalf("sql.Open: %v", err) } if _, err = db.Exec("CREATE DATABASE IF NOT EXISTS testgitea"); err != nil { log.Fatalf("db.Exec: %v", err) } case setting.UsePostgreSQL: db, err := sql.Open("postgres", fmt.Sprintf("postgres://%s:%s@%s/?sslmode=%s", models.DbCfg.User, models.DbCfg.Passwd, models.DbCfg.Host, models.DbCfg.SSLMode)) defer db.Close() if err != nil { log.Fatalf("sql.Open: %v", err) } rows, err := db.Query(fmt.Sprintf("SELECT 1 FROM pg_database WHERE datname = '%s'", models.DbCfg.Name)) if err != nil { log.Fatalf("db.Query: %v", err) } defer rows.Close() if rows.Next() { break } if _, err = db.Exec("CREATE DATABASE testgitea"); err != nil { log.Fatalf("db.Exec: %v", err) } case setting.UseMSSQL: host, port := models.ParseMSSQLHostPort(models.DbCfg.Host) db, err := sql.Open("mssql", fmt.Sprintf("server=%s; port=%s; database=%s; user id=%s; password=%s;", host, port, "master", models.DbCfg.User, models.DbCfg.Passwd)) if err != nil { log.Fatalf("sql.Open: %v", err) } if _, err := db.Exec("If(db_id(N'gitea') IS NULL) BEGIN CREATE DATABASE gitea; END;"); err != nil { log.Fatalf("db.Exec: %v", err) } defer db.Close() } routers.GlobalInit() } func prepareTestEnv(t testing.TB, skip ...int) { ourSkip := 2 if len(skip) > 0 { ourSkip += skip[0] } PrintCurrentTest(t, ourSkip) assert.NoError(t, models.LoadFixtures()) assert.NoError(t, os.RemoveAll(setting.RepoRootPath)) assert.NoError(t, os.RemoveAll(models.LocalCopyPath())) assert.NoError(t, com.CopyDir(path.Join(filepath.Dir(setting.AppPath), "integrations/gitea-repositories-meta"), setting.RepoRootPath)) } 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 { 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.HeaderMap["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 { 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.HeaderMap["Set-Cookie"], ";")) cr := http.Request{Header: ch} s.jar.SetCookies(baseURL, cr.Cookies()) return resp } const userPassword = "password" var loginSessionCache = make(map[string]*TestSession, 10) func emptyTestSession(t testing.TB) *TestSession { jar, err := cookiejar.New(nil) assert.NoError(t, err) return &TestSession{jar: jar} } func loginUser(t testing.TB, userName string) *TestSession { if session, ok := loginSessionCache[userName]; ok { return session } session := loginUserWithPassword(t, userName, userPassword) loginSessionCache[userName] = session return session } func loginUserWithPassword(t testing.TB, userName, password string) *TestSession { 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.StatusFound) ch := http.Header{} ch.Add("Cookie", strings.Join(resp.HeaderMap["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 } func getTokenForLoggedInUser(t testing.TB, session *TestSession) string { req := NewRequest(t, "GET", "/user/settings/applications") resp := session.MakeRequest(t, req, http.StatusOK) doc := NewHTMLParser(t, resp.Body) req = NewRequestWithValues(t, "POST", "/user/settings/applications", map[string]string{ "_csrf": doc.GetCSRF(), "name": "api-testing-token", }) resp = session.MakeRequest(t, req, http.StatusFound) 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() return token } func NewRequest(t testing.TB, method, urlStr string) *http.Request { return NewRequestWithBody(t, method, urlStr, nil) } func NewRequestf(t testing.TB, method, urlFormat string, args ...interface{}) *http.Request { return NewRequest(t, method, fmt.Sprintf(urlFormat, args...)) } func NewRequestWithValues(t testing.TB, method, urlStr string, values map[string]string) *http.Request { urlValues := url.Values{} for key, value := range values { urlValues[key] = []string{value} } 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 interface{}) *http.Request { 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 { 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 { recorder := httptest.NewRecorder() mac.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 { recorder := NewNilResponseRecorder() mac.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) { 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 } // 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 interface{}) { decoder := json.NewDecoder(resp.Body) assert.NoError(t, decoder.Decode(v)) } func GetCSRF(t testing.TB, session *TestSession, urlStr string) string { req := NewRequest(t, "GET", urlStr) resp := session.MakeRequest(t, req, http.StatusOK) doc := NewHTMLParser(t, resp.Body) return doc.GetCSRF() }