2016-12-28 20:03:40 -05:00
|
|
|
// Copyright 2016 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 models
|
|
|
|
|
|
|
|
import (
|
2017-11-30 10:52:15 -05:00
|
|
|
"fmt"
|
2018-02-21 02:38:52 -05:00
|
|
|
"io/ioutil"
|
2018-08-06 07:52:53 -04:00
|
|
|
"math"
|
2018-02-21 02:38:52 -05:00
|
|
|
"net/url"
|
2017-09-21 03:43:26 -04:00
|
|
|
"os"
|
2017-11-30 10:52:15 -05:00
|
|
|
"path/filepath"
|
2016-12-28 20:03:40 -05:00
|
|
|
"testing"
|
|
|
|
|
2019-04-17 12:06:35 -04:00
|
|
|
"code.gitea.io/gitea/modules/base"
|
2017-09-21 03:43:26 -04:00
|
|
|
"code.gitea.io/gitea/modules/setting"
|
2020-08-18 00:23:45 -04:00
|
|
|
"code.gitea.io/gitea/modules/storage"
|
2020-08-11 16:05:34 -04:00
|
|
|
"code.gitea.io/gitea/modules/util"
|
2017-09-21 03:43:26 -04:00
|
|
|
|
2017-01-07 22:10:53 -05:00
|
|
|
"github.com/stretchr/testify/assert"
|
2019-08-23 12:40:30 -04:00
|
|
|
"github.com/unknwon/com"
|
2019-10-17 05:26:49 -04:00
|
|
|
"xorm.io/xorm"
|
2020-03-22 11:12:55 -04:00
|
|
|
"xorm.io/xorm/names"
|
2016-12-28 20:03:40 -05:00
|
|
|
)
|
|
|
|
|
2017-05-20 04:48:22 -04:00
|
|
|
// NonexistentID an ID that will never exist
|
2018-08-06 07:52:53 -04:00
|
|
|
const NonexistentID = int64(math.MaxInt64)
|
2017-01-25 05:37:35 -05:00
|
|
|
|
2017-11-30 10:52:15 -05:00
|
|
|
// giteaRoot a path to the gitea root
|
2020-02-15 03:59:43 -05:00
|
|
|
var (
|
|
|
|
giteaRoot string
|
|
|
|
fixturesDir string
|
|
|
|
)
|
2017-11-30 10:52:15 -05:00
|
|
|
|
2018-02-21 02:38:52 -05:00
|
|
|
func fatalTestError(fmtStr string, args ...interface{}) {
|
|
|
|
fmt.Fprintf(os.Stderr, fmtStr, args...)
|
|
|
|
os.Exit(1)
|
|
|
|
}
|
|
|
|
|
2017-11-30 10:52:15 -05:00
|
|
|
// MainTest a reusable TestMain(..) function for unit tests that need to use a
|
|
|
|
// test database. Creates the test database, and sets necessary settings.
|
|
|
|
func MainTest(m *testing.M, pathToGiteaRoot string) {
|
2017-12-15 16:11:02 -05:00
|
|
|
var err error
|
2017-11-30 10:52:15 -05:00
|
|
|
giteaRoot = pathToGiteaRoot
|
2020-02-15 03:59:43 -05:00
|
|
|
fixturesDir = filepath.Join(pathToGiteaRoot, "models", "fixtures")
|
|
|
|
if err = CreateTestEngine(fixturesDir); err != nil {
|
2018-02-21 02:38:52 -05:00
|
|
|
fatalTestError("Error creating test engine: %v\n", err)
|
2017-11-30 10:52:15 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
setting.AppURL = "https://try.gitea.io/"
|
|
|
|
setting.RunUser = "runuser"
|
|
|
|
setting.SSH.Port = 3000
|
|
|
|
setting.SSH.Domain = "try.gitea.io"
|
2019-08-24 05:24:45 -04:00
|
|
|
setting.Database.UseSQLite3 = true
|
2018-02-21 02:38:52 -05:00
|
|
|
setting.RepoRootPath, err = ioutil.TempDir(os.TempDir(), "repos")
|
|
|
|
if err != nil {
|
|
|
|
fatalTestError("TempDir: %v\n", err)
|
|
|
|
}
|
|
|
|
setting.AppDataPath, err = ioutil.TempDir(os.TempDir(), "appdata")
|
|
|
|
if err != nil {
|
|
|
|
fatalTestError("TempDir: %v\n", err)
|
|
|
|
}
|
2017-12-15 16:11:02 -05:00
|
|
|
setting.AppWorkPath = pathToGiteaRoot
|
|
|
|
setting.StaticRootPath = pathToGiteaRoot
|
|
|
|
setting.GravatarSourceURL, err = url.Parse("https://secure.gravatar.com/avatar/")
|
|
|
|
if err != nil {
|
2018-02-21 02:38:52 -05:00
|
|
|
fatalTestError("url.Parse: %v\n", err)
|
2017-12-15 16:11:02 -05:00
|
|
|
}
|
2020-09-29 05:05:13 -04:00
|
|
|
setting.Attachment.Storage.Path = filepath.Join(setting.AppDataPath, "attachments")
|
2017-11-30 10:52:15 -05:00
|
|
|
|
2020-09-29 05:05:13 -04:00
|
|
|
setting.LFS.Storage.Path = filepath.Join(setting.AppDataPath, "lfs")
|
2020-08-18 00:23:45 -04:00
|
|
|
if err = storage.Init(); err != nil {
|
|
|
|
fatalTestError("storage.Init: %v\n", err)
|
|
|
|
}
|
|
|
|
|
2020-08-11 16:05:34 -04:00
|
|
|
if err = util.RemoveAll(setting.RepoRootPath); err != nil {
|
|
|
|
fatalTestError("util.RemoveAll: %v\n", err)
|
2019-07-29 21:59:10 -04:00
|
|
|
}
|
|
|
|
if err = com.CopyDir(filepath.Join(pathToGiteaRoot, "integrations", "gitea-repositories-meta"), setting.RepoRootPath); err != nil {
|
|
|
|
fatalTestError("com.CopyDir: %v\n", err)
|
|
|
|
}
|
|
|
|
|
2018-02-21 02:38:52 -05:00
|
|
|
exitStatus := m.Run()
|
2020-08-11 16:05:34 -04:00
|
|
|
if err = util.RemoveAll(setting.RepoRootPath); err != nil {
|
|
|
|
fatalTestError("util.RemoveAll: %v\n", err)
|
2018-02-21 02:38:52 -05:00
|
|
|
}
|
2020-08-11 16:05:34 -04:00
|
|
|
if err = util.RemoveAll(setting.AppDataPath); err != nil {
|
|
|
|
fatalTestError("util.RemoveAll: %v\n", err)
|
2018-02-21 02:38:52 -05:00
|
|
|
}
|
|
|
|
os.Exit(exitStatus)
|
2017-11-30 10:52:15 -05:00
|
|
|
}
|
|
|
|
|
2020-02-15 03:59:43 -05:00
|
|
|
// CreateTestEngine creates a memory database and loads the fixture data from fixturesDir
|
|
|
|
func CreateTestEngine(fixturesDir string) error {
|
2017-08-03 01:09:16 -04:00
|
|
|
var err error
|
2020-02-26 18:51:37 -05:00
|
|
|
x, err = xorm.NewEngine("sqlite3", "file::memory:?cache=shared&_txlock=immediate")
|
2017-08-03 01:09:16 -04:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2020-03-22 11:12:55 -04:00
|
|
|
x.SetMapper(names.GonicMapper{})
|
2017-08-03 01:09:16 -04:00
|
|
|
if err = x.StoreEngine("InnoDB").Sync2(tables...); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2017-11-27 05:29:48 -05:00
|
|
|
switch os.Getenv("GITEA_UNIT_TESTS_VERBOSE") {
|
|
|
|
case "true", "1":
|
|
|
|
x.ShowSQL(true)
|
|
|
|
}
|
2017-08-03 01:09:16 -04:00
|
|
|
|
2020-06-17 15:07:58 -04:00
|
|
|
return InitFixtures(fixturesDir)
|
2017-08-03 01:09:16 -04:00
|
|
|
}
|
|
|
|
|
2016-12-28 20:03:40 -05:00
|
|
|
// PrepareTestDatabase load test fixtures into test database
|
|
|
|
func PrepareTestDatabase() error {
|
2017-04-25 03:24:51 -04:00
|
|
|
return LoadFixtures()
|
2016-12-28 20:03:40 -05:00
|
|
|
}
|
2017-01-07 22:10:53 -05:00
|
|
|
|
2017-11-30 10:52:15 -05:00
|
|
|
// PrepareTestEnv prepares the environment for unit tests. Can only be called
|
|
|
|
// by tests that use the above MainTest(..) function.
|
|
|
|
func PrepareTestEnv(t testing.TB) {
|
2017-09-21 03:43:26 -04:00
|
|
|
assert.NoError(t, PrepareTestDatabase())
|
2020-08-11 16:05:34 -04:00
|
|
|
assert.NoError(t, util.RemoveAll(setting.RepoRootPath))
|
2017-11-30 10:52:15 -05:00
|
|
|
metaPath := filepath.Join(giteaRoot, "integrations", "gitea-repositories-meta")
|
|
|
|
assert.NoError(t, com.CopyDir(metaPath, setting.RepoRootPath))
|
2019-04-17 12:06:35 -04:00
|
|
|
base.SetupGiteaRoot() // Makes sure GITEA_ROOT is set
|
2017-09-21 03:43:26 -04:00
|
|
|
}
|
|
|
|
|
2017-06-14 23:09:03 -04:00
|
|
|
type testCond struct {
|
|
|
|
query interface{}
|
|
|
|
args []interface{}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Cond create a condition with arguments for a test
|
|
|
|
func Cond(query interface{}, args ...interface{}) interface{} {
|
|
|
|
return &testCond{query: query, args: args}
|
|
|
|
}
|
|
|
|
|
|
|
|
func whereConditions(sess *xorm.Session, conditions []interface{}) {
|
|
|
|
for _, condition := range conditions {
|
|
|
|
switch cond := condition.(type) {
|
|
|
|
case *testCond:
|
|
|
|
sess.Where(cond.query, cond.args...)
|
|
|
|
default:
|
|
|
|
sess.Where(cond)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-01-08 22:08:36 -05:00
|
|
|
func loadBeanIfExists(bean interface{}, conditions ...interface{}) (bool, error) {
|
2017-01-07 22:10:53 -05:00
|
|
|
sess := x.NewSession()
|
|
|
|
defer sess.Close()
|
2017-06-14 23:09:03 -04:00
|
|
|
whereConditions(sess, conditions)
|
2017-01-08 22:08:36 -05:00
|
|
|
return sess.Get(bean)
|
|
|
|
}
|
|
|
|
|
2017-01-24 11:16:36 -05:00
|
|
|
// BeanExists for testing, check if a bean exists
|
2017-12-23 19:33:34 -05:00
|
|
|
func BeanExists(t testing.TB, bean interface{}, conditions ...interface{}) bool {
|
2017-01-24 11:16:36 -05:00
|
|
|
exists, err := loadBeanIfExists(bean, conditions...)
|
|
|
|
assert.NoError(t, err)
|
|
|
|
return exists
|
|
|
|
}
|
|
|
|
|
2017-01-08 22:08:36 -05:00
|
|
|
// AssertExistsAndLoadBean assert that a bean exists and load it from the test
|
|
|
|
// database
|
2017-12-23 19:33:34 -05:00
|
|
|
func AssertExistsAndLoadBean(t testing.TB, bean interface{}, conditions ...interface{}) interface{} {
|
2017-01-08 22:08:36 -05:00
|
|
|
exists, err := loadBeanIfExists(bean, conditions...)
|
|
|
|
assert.NoError(t, err)
|
2017-02-04 07:37:26 -05:00
|
|
|
assert.True(t, exists,
|
2017-02-07 06:47:55 -05:00
|
|
|
"Expected to find %+v (of type %T, with conditions %+v), but did not",
|
|
|
|
bean, bean, conditions)
|
2017-01-24 21:49:51 -05:00
|
|
|
return bean
|
2017-01-08 22:08:36 -05:00
|
|
|
}
|
|
|
|
|
2017-06-14 23:09:03 -04:00
|
|
|
// GetCount get the count of a bean
|
2017-12-23 19:33:34 -05:00
|
|
|
func GetCount(t testing.TB, bean interface{}, conditions ...interface{}) int {
|
2017-06-14 23:09:03 -04:00
|
|
|
sess := x.NewSession()
|
|
|
|
defer sess.Close()
|
|
|
|
whereConditions(sess, conditions)
|
|
|
|
count, err := sess.Count(bean)
|
|
|
|
assert.NoError(t, err)
|
|
|
|
return int(count)
|
|
|
|
}
|
|
|
|
|
2017-01-08 22:08:36 -05:00
|
|
|
// AssertNotExistsBean assert that a bean does not exist in the test database
|
2017-12-23 19:33:34 -05:00
|
|
|
func AssertNotExistsBean(t testing.TB, bean interface{}, conditions ...interface{}) {
|
2017-01-08 22:08:36 -05:00
|
|
|
exists, err := loadBeanIfExists(bean, conditions...)
|
2017-01-07 22:10:53 -05:00
|
|
|
assert.NoError(t, err)
|
2017-01-08 22:08:36 -05:00
|
|
|
assert.False(t, exists)
|
2017-01-07 22:10:53 -05:00
|
|
|
}
|
2017-02-04 07:37:26 -05:00
|
|
|
|
2017-12-15 16:11:02 -05:00
|
|
|
// AssertExistsIf asserts that a bean exists or does not exist, depending on
|
|
|
|
// what is expected.
|
|
|
|
func AssertExistsIf(t *testing.T, expected bool, bean interface{}, conditions ...interface{}) {
|
|
|
|
exists, err := loadBeanIfExists(bean, conditions...)
|
|
|
|
assert.NoError(t, err)
|
|
|
|
assert.Equal(t, expected, exists)
|
|
|
|
}
|
|
|
|
|
2017-02-04 07:37:26 -05:00
|
|
|
// AssertSuccessfulInsert assert that beans is successfully inserted
|
2017-12-23 19:33:34 -05:00
|
|
|
func AssertSuccessfulInsert(t testing.TB, beans ...interface{}) {
|
2017-02-04 07:37:26 -05:00
|
|
|
_, err := x.Insert(beans...)
|
|
|
|
assert.NoError(t, err)
|
|
|
|
}
|
|
|
|
|
2017-02-27 20:35:55 -05:00
|
|
|
// AssertCount assert the count of a bean
|
2017-12-23 19:33:34 -05:00
|
|
|
func AssertCount(t testing.TB, bean interface{}, expected interface{}) {
|
2017-06-14 23:09:03 -04:00
|
|
|
assert.EqualValues(t, expected, GetCount(t, bean))
|
2017-02-04 07:37:26 -05:00
|
|
|
}
|
2017-07-26 21:20:38 -04:00
|
|
|
|
|
|
|
// AssertInt64InRange assert value is in range [low, high]
|
2017-12-23 19:33:34 -05:00
|
|
|
func AssertInt64InRange(t testing.TB, low, high, value int64) {
|
2017-07-26 21:20:38 -04:00
|
|
|
assert.True(t, value >= low && value <= high,
|
|
|
|
"Expected value in range [%d, %d], found %d", low, high, value)
|
|
|
|
}
|