Files
tidb/pkg/session/testutil.go
2026-01-07 03:13:23 +00:00

112 lines
3.6 KiB
Go

// Copyright 2023 PingCAP, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package session
import (
"context"
"fmt"
"testing"
"github.com/pingcap/tidb/pkg/config/kerneltype"
"github.com/pingcap/tidb/pkg/domain"
"github.com/pingcap/tidb/pkg/expression"
"github.com/pingcap/tidb/pkg/kv"
"github.com/pingcap/tidb/pkg/session/sessionapi"
"github.com/pingcap/tidb/pkg/store/mockstore"
"github.com/pingcap/tidb/pkg/testkit/testenv"
"github.com/pingcap/tidb/pkg/util/sqlexec"
"github.com/stretchr/testify/require"
atomicutil "go.uber.org/atomic"
)
var (
// GetBootstrapVersion is used in test
GetBootstrapVersion = getBootstrapVersion
// CurrentBootstrapVersion is used in test
CurrentBootstrapVersion = currentBootstrapVersion
// TiDBDDLTableVersionForTest is used in test
TiDBDDLTableVersionForTest = tidbDDLTableVersion
)
// CreateStoreAndBootstrap creates a mock store and bootstrap it.
func CreateStoreAndBootstrap(t *testing.T) (kv.Storage, *domain.Domain) {
testenv.SetGOMAXPROCSForTest()
if kerneltype.IsNextGen() {
testenv.UpdateConfigForNextgen(t)
}
store, err := mockstore.NewMockStore(mockstore.WithStoreType(mockstore.EmbedUnistore))
require.NoError(t, err)
dom, err := BootstrapSession(store)
require.NoError(t, err)
return store, dom
}
var sessionKitIDGenerator atomicutil.Uint64
// CreateSessionAndSetID creates a session and set connection ID.
func CreateSessionAndSetID(t *testing.T, store kv.Storage) sessionapi.Session {
se, err := CreateSession4Test(store)
se.SetConnectionID(sessionKitIDGenerator.Inc())
require.NoError(t, err)
return se
}
// MustExec executes a sql statement and asserts no error occurs.
func MustExec(t *testing.T, se sessionapi.Session, sql string, args ...any) {
rs, err := exec(se, sql, args...)
require.NoError(t, err)
if rs != nil {
require.NoError(t, rs.Close())
}
}
// MustExecToRecodeSet executes a sql statement and asserts no error occurs.
func MustExecToRecodeSet(t *testing.T, se sessionapi.Session, sql string, args ...any) sqlexec.RecordSet {
rs, err := exec(se, sql, args...)
require.NoError(t, err)
return rs
}
func exec(se sessionapi.Session, sql string, args ...any) (sqlexec.RecordSet, error) {
ctx := context.Background()
if len(args) == 0 {
rs, err := se.Execute(ctx, sql)
if err == nil && len(rs) > 0 {
return rs[0], nil
}
return nil, err
}
stmtID, _, _, err := se.PrepareStmt(sql)
if err != nil {
return nil, err
}
params := expression.Args2Expressions4Test(args...)
rs, err := se.ExecutePreparedStmt(ctx, stmtID, params)
if err != nil {
return nil, err
}
return rs, nil
}
// RevertVersionAndVariables reverts the version and variables in mysql.tidb and
// mysql.global_variables for testing upgrade/downgrade.
func RevertVersionAndVariables(t *testing.T, se sessionapi.Session, ver int) {
MustExec(t, se, fmt.Sprintf("update mysql.tidb set variable_value='%d' where variable_name='tidb_server_version'", ver))
if ver <= version195 {
// for version <= version195, tidb_enable_dist_task should be disabled before upgrade
MustExec(t, se, "update mysql.global_variables set variable_value='off' where variable_name='tidb_enable_dist_task'")
}
}