Documentation
¶
Index ¶
- Constants
- func AssertCount(t TestingT, bean, expected any) bool
- func AssertCountByCond(t TestingT, tableName string, cond builder.Cond, expected int) bool
- func AssertExistsAndLoadBean[T any](t TestingT, bean T, conditions ...any) T
- func AssertExistsAndLoadMap(t TestingT, table string, conditions ...any) map[string]string
- func AssertInt64InRange(t assert.TestingT, low, high, value int64)
- func AssertNotExistsBean(t TestingT, bean any, conditions ...any)
- func CheckConsistencyFor(t TestingT, beansToCheck ...any)
- func Cond(query any, args ...any) any
- func CreateTestEngine(testSQLiteFile string, opts FixturesOptions) error
- func DumpQueryResult(t require.TestingT, sqlOrBean any, sqlArgs ...any)
- func FixturesFileFullPaths(dir string, files []string) (map[string]*FixtureItem, error)
- func GetBean[T any](t TestingT, bean T, conditions ...any) (ret T)
- func GetCount(t TestingT, bean any, conditions ...any) int
- func GetCountByCond(t TestingT, tableName string, cond builder.Cond) int64
- func GetXORMEngine() (x *xorm.Engine)
- func InitFixtures(opts FixturesOptions) (err error)
- func LoadFixtures() error
- func MainTest(m *testing.M, testOptsArg ...*TestOptions)
- func NewMockWebServer(t *testing.T, liveServerBaseURL, testDataDir string, liveMode bool, ...) *httptest.Server
- func OrderBy(orderBy string) any
- func PrepareTestDatabase() error
- func PrepareTestEnv(t testing.TB)
- func ResetTestDatabase() (cleanup func(), err error)
- func SyncDirs(srcPath, destPath string) error
- func SyncFile(srcPath, destPath string) error
- type FixtureItem
- type FixturesLoader
- type FixturesOptions
- type MockServerOptions
- type TestOptions
- type TestingT
Constants ¶
const NonexistentID = int64(math.MaxInt64)
NonexistentID an ID that will never exist
Variables ¶
This section is empty.
Functions ¶
func AssertCount ¶
AssertCount assert the count of a bean
func AssertCountByCond ¶
AssertCountByCond test the count of database entries matching bean
func AssertExistsAndLoadBean ¶
AssertExistsAndLoadBean assert that a bean exists and load it from the test database
func AssertExistsAndLoadMap ¶
AssertExistsAndLoadMap assert that a row exists and load it from the test database
func AssertInt64InRange ¶
AssertInt64InRange assert value is in range [low, high]
func AssertNotExistsBean ¶
AssertNotExistsBean assert that a bean does not exist in the test database
func CheckConsistencyFor ¶
CheckConsistencyFor test that all matching database entries are consistent
func CreateTestEngine ¶
func CreateTestEngine(testSQLiteFile string, opts FixturesOptions) error
CreateTestEngine creates a test database and loads the fixture data from fixturesDir
func DumpQueryResult ¶
DumpQueryResult dumps the result of a query for debugging purpose
func FixturesFileFullPaths ¶
func FixturesFileFullPaths(dir string, files []string) (map[string]*FixtureItem, error)
func GetCountByCond ¶
GetCountByCond get the count of database entries matching bean
func InitFixtures ¶
func InitFixtures(opts FixturesOptions) (err error)
InitFixtures initialize test fixtures for a test database
func MainTest ¶
func MainTest(m *testing.M, testOptsArg ...*TestOptions)
MainTest a reusable TestMain(..) function for unit tests that need to use a test database. Creates the test database, and sets necessary settings.
func NewMockWebServer ¶
func NewMockWebServer(t *testing.T, liveServerBaseURL, testDataDir string, liveMode bool, opts ...MockServerOptions) *httptest.Server
NewMockWebServer returns a test HTTP server that records upstream responses on demand and replays them from disk on subsequent runs.
- liveMode=true: requests are forwarded to liveServerBaseURL and responses written as fixture files under testDataDir.
- liveMode=false: responses come from existing fixture files.
Fixture format: header lines ("Name: value"), a blank line, then the body. Before replay, occurrences of liveServerBaseURL in the body are swapped for the mock URL.
The typical switch is an env var holding an API token; fixtures ship committed so the default run (no token) works offline.
token := os.Getenv("GITEA_TOKEN")
mock := NewMockWebServer(t, "https://gitea.com", fixtureDir, token != "")
func PrepareTestDatabase ¶
func PrepareTestDatabase() error
PrepareTestDatabase load test fixtures into test database
func PrepareTestEnv ¶
PrepareTestEnv prepares the environment for unit tests. Can only be called by tests that use the above MainTest(..) function.
func ResetTestDatabase ¶
func ResetTestDatabase() (cleanup func(), err error)
Types ¶
type FixtureItem ¶
type FixtureItem struct {
// contains filtered or unexported fields
}
type FixturesLoader ¶
func NewFixturesLoader ¶
func NewFixturesLoader(x *xorm.Engine, opts FixturesOptions) (FixturesLoader, error)
type FixturesOptions ¶
FixturesOptions fixtures needs to be loaded options
type MockServerOptions ¶
type MockServerOptions struct {
// Routes installs extra handlers on the mux before the fixture fallback;
// more specific patterns win.
Routes func(mux *http.ServeMux)
// StripPrefix is trimmed from the request path before forwarding upstream,
// useful when the client prepends a prefix the real upstream does not use
// (e.g. go-github prepends "/api/v3").
StripPrefix string
}
MockServerOptions tweaks NewMockWebServer behavior.
type TestOptions ¶
type TestOptions struct {
FixtureFiles []string
SetUp func() error // SetUp will be executed before all tests in this package
TearDown func() error // TearDown will be executed after all tests in this package
}
TestOptions represents test options
Source Files