Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

*: Add testfork.RunTest to run multiple tests in one function #35746

Merged
merged 8 commits into from
Jun 28, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ddl/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ go_test(
"integration_test.go",
"main_test.go",
"modify_column_test.go",
"multi_schema_change_test.go",
"options_test.go",
"partition_test.go",
"placement_policy_ddl_test.go",
Expand Down
1 change: 1 addition & 0 deletions sessiontxn/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ go_test(
"//sessionctx",
"//sessiontxn/staleread",
"//testkit",
"//testkit/testfork",
"//testkit/testsetup",
"@com_github_pingcap_failpoint//:failpoint",
"@com_github_stretchr_testify//require",
Expand Down
115 changes: 55 additions & 60 deletions sessiontxn/txn_context_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import (
"github.com/pingcap/tidb/sessionctx"
"github.com/pingcap/tidb/sessiontxn"
"github.com/pingcap/tidb/testkit"
"github.com/pingcap/tidb/testkit/testfork"
"github.com/pingcap/tidb/testkit/testsetup"
"github.com/stretchr/testify/require"
"go.uber.org/goleak"
Expand Down Expand Up @@ -725,65 +726,59 @@ func TestStillWriteConflictAfterRetry(t *testing.T) {
"update t1 set v=v+1 where id in (1, 2, 3) and v>0",
}

tk := testkit.NewTestKit(t, store)
tk.MustExec("use test")
for _, isolation := range []string{ast.RepeatableRead, ast.ReadCommitted} {
for _, query := range queries {
for _, autocommit := range []bool{true, false} {
t.Run(fmt.Sprintf("%s,%s,autocommit=%v", isolation, query, autocommit), func(t *testing.T) {
tk.MustExec("truncate table t1")
tk.MustExec("insert into t1 values(1, 10)")
tk2 := testkit.NewSteppedTestKit(t, store)
defer tk2.MustExec("rollback")

tk2.MustExec("use test")
tk2.MustExec("set @@tidb_txn_mode = 'pessimistic'")
tk2.MustExec(fmt.Sprintf("set tx_isolation = '%s'", isolation))
if autocommit {
tk2.MustExec("set autocommit=1")
tk2.MustExec("begin")
} else {
tk2.MustExec("set autocommit=0")
}

tk2.SetBreakPoints(
sessiontxn.BreakPointBeforeExecutorFirstRun,
sessiontxn.BreakPointOnStmtRetryAfterLockError,
)

var isSelect, isUpdate bool
switch {
case strings.HasPrefix(query, "select"):
isSelect = true
tk2.SteppedMustQuery(query)
case strings.HasPrefix(query, "update"):
isUpdate = true
tk2.SteppedMustExec(query)
default:
require.FailNowf(t, "invalid query: ", query)
}

// Pause the session before the executor first run and then update the record in another session
tk2.ExpectStopOnBreakPoint(sessiontxn.BreakPointBeforeExecutorFirstRun)
tk.MustExec("update t1 set v=v+1")

// Session continues, it should get a lock error and retry, we pause the session before the executor's next run
// and then update the record in another session again.
tk2.Continue().ExpectStopOnBreakPoint(sessiontxn.BreakPointOnStmtRetryAfterLockError)
tk.MustExec("update t1 set v=v+1")

// Because the record is updated by another session again, when this session continues, it will get a lock error again.
tk2.Continue().ExpectStopOnBreakPoint(sessiontxn.BreakPointOnStmtRetryAfterLockError)
tk2.Continue().ExpectIdle()
switch {
case isSelect:
tk2.GetQueryResult().Check(testkit.Rows("1 12"))
case isUpdate:
tk2.MustExec("commit")
tk2.MustQuery("select * from t1").Check(testkit.Rows("1 13"))
}
})
}
testfork.RunTest(t, func(t *testfork.T) {
tk := testkit.NewTestKit(t, store)
tk.MustExec("use test")
tk.MustExec("truncate table t1")
tk.MustExec("insert into t1 values(1, 10)")
tk2 := testkit.NewSteppedTestKit(t, store)
defer tk2.MustExec("rollback")

tk2.MustExec("use test")
tk2.MustExec("set @@tidb_txn_mode = 'pessimistic'")
tk2.MustExec(fmt.Sprintf("set tx_isolation = '%s'", testfork.PickEnum(t, ast.RepeatableRead, ast.ReadCommitted)))
autocommit := testfork.PickEnum(t, 0, 1)
tk2.MustExec(fmt.Sprintf("set autocommit=%d", autocommit))
if autocommit == 1 {
tk2.MustExec("begin")
}
}

tk2.SetBreakPoints(
sessiontxn.BreakPointBeforeExecutorFirstRun,
sessiontxn.BreakPointOnStmtRetryAfterLockError,
)

var isSelect, isUpdate bool
query := testfork.Pick(t, queries)
switch {
case strings.HasPrefix(query, "select"):
isSelect = true
tk2.SteppedMustQuery(query)
case strings.HasPrefix(query, "update"):
isUpdate = true
tk2.SteppedMustExec(query)
default:
require.FailNowf(t, "invalid query: ", query)
}

// Pause the session before the executor first run and then update the record in another session
tk2.ExpectStopOnBreakPoint(sessiontxn.BreakPointBeforeExecutorFirstRun)
tk.MustExec("update t1 set v=v+1")

// Session continues, it should get a lock error and retry, we pause the session before the executor's next run
// and then update the record in another session again.
tk2.Continue().ExpectStopOnBreakPoint(sessiontxn.BreakPointOnStmtRetryAfterLockError)
tk.MustExec("update t1 set v=v+1")

// Because the record is updated by another session again, when this session continues, it will get a lock error again.
tk2.Continue().ExpectStopOnBreakPoint(sessiontxn.BreakPointOnStmtRetryAfterLockError)
tk2.Continue().ExpectIdle()
switch {
case isSelect:
tk2.GetQueryResult().Check(testkit.Rows("1 12"))
case isUpdate:
tk2.MustExec("commit")
tk2.MustQuery("select * from t1").Check(testkit.Rows("1 13"))
}
})
}
6 changes: 3 additions & 3 deletions testkit/stepped.go
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ func (ch steppedTestKitMsgChan) recvMsgWithCheck(tp steppedTestkitMsgType) (*ste
}

type steppedTestKitCommandContext struct {
t *testing.T
t testing.TB
tk *TestKit
notifyBreakPointAndWait func(string)
}
Expand All @@ -89,7 +89,7 @@ type steppedTestKitCommand func(ctx *steppedTestKitCommandContext) any

// SteppedTestKit is the testkit that can run stepped command
type SteppedTestKit struct {
t *testing.T
t testing.TB
tk *TestKit

// ch1 is used to send msg from foreground to background
Expand All @@ -105,7 +105,7 @@ type SteppedTestKit struct {
}

// NewSteppedTestKit creates a new SteppedTestKit
func NewSteppedTestKit(t *testing.T, store kv.Storage) *SteppedTestKit {
func NewSteppedTestKit(t testing.TB, store kv.Storage) *SteppedTestKit {
tk := &SteppedTestKit{
t: t,
tk: NewTestKit(t, store),
Expand Down
18 changes: 18 additions & 0 deletions testkit/testfork/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")

go_library(
name = "testfork",
srcs = ["fork.go"],
importpath = "github.com/pingcap/tidb/testkit/testfork",
visibility = ["//visibility:public"],
deps = [
"@com_github_cockroachdb_errors//:errors",
"@com_github_stretchr_testify//require",
],
)

go_test(
name = "testfork_test",
srcs = ["fork_test.go"],
embed = [":testfork"],
)
135 changes: 135 additions & 0 deletions testkit/testfork/fork.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
// Copyright 2022 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 testfork

import (
"fmt"
"os"
"strings"
"testing"

"github.com/cockroachdb/errors"
"github.com/stretchr/testify/require"
)

type pickStack struct {
stack [][]any
pos int
valid bool
}

func newPickStack() *pickStack {
return &pickStack{
valid: true,
}
}

func (s *pickStack) NextStack() {
for len(s.stack) > 0 {
lastIndex := len(s.stack) - 1
s.stack[lastIndex] = s.stack[lastIndex][1:]
if len(s.stack[lastIndex]) > 0 {
break
}
s.stack = s.stack[:lastIndex]
}

s.pos = 0
s.valid = len(s.stack) > 0
}

func (s *pickStack) PickValue(values []any) (any, error) {
if len(values) == 0 {
return nil, errors.New("values should not be empty")
}

stackLen := len(s.stack)
if s.pos > stackLen {
return nil, errors.Newf("illegal state %d > %d", s.pos, stackLen)
}

defer func() {
s.pos++
}()

if s.pos == stackLen {
s.stack = append(s.stack, values)
}
return s.stack[s.pos][0], nil
}

func (s *pickStack) Values() []any {
values := make([]any, 0)
for _, v := range s.stack {
values = append(values, v[0])
}
return values
}

func (s *pickStack) ValuesText() string {
values := s.Values()
strValues := make([]string, len(values))
for i, value := range values {
switch v := value.(type) {
case string:
strValues[i] = fmt.Sprintf(`"%s"`, v)
default:
strValues[i] = fmt.Sprintf("%v", v)
}
}
return "[" + strings.Join(strValues, " ") + "]"
}

func (s *pickStack) Valid() bool {
return s.valid
}

// T is used by for test
type T struct {
*testing.T
stack *pickStack
}

// RunTest runs the test function `f` multiple times util all the values in `Pick` are tested.
func RunTest(t *testing.T, f func(t *T)) {
idx := 0
for stack := newPickStack(); stack.Valid(); stack.NextStack() {
success := t.Run("", func(t *testing.T) {
f(&T{T: t, stack: stack})
})

if !success {
_, err := fmt.Fprintf(os.Stderr, "SubTest #%v failed, failed values: %s\n", idx, stack.ValuesText())
require.NoError(t, err)
}
idx++
}
}

// Pick returns a value from the values list
func Pick[E any](t *T, values []E) E {
slice := make([]any, len(values))
for i, item := range values {
slice[i] = item
}
value, err := t.stack.PickValue(slice)
require.NoError(t, err)
return value.(E)
}

// PickEnum returns a value from the value enums
func PickEnum[E any](t *T, item E, other ...E) E {
return Pick(t, append([]E{item}, other...))
}
50 changes: 50 additions & 0 deletions testkit/testfork/fork_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
// Copyright 2022 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 testfork

import (
"testing"

"github.com/stretchr/testify/require"
)

func TestForkSubTest(t *testing.T) {
var values [][]any
RunTest(t, func(t *T) {
x := Pick(t, []int{1, 2, 3})
y := PickEnum(t, "a", "b")
var z any
if x == 2 {
z = PickEnum(t, 10, 11)
} else {
z = Pick(t, []string{"g", "h"})
}
values = append(values, []any{x, y, z})
})
require.Equal(t, [][]any{
{1, "a", "g"},
{1, "a", "h"},
{1, "b", "g"},
{1, "b", "h"},
{2, "a", 10},
{2, "a", 11},
{2, "b", 10},
{2, "b", 11},
{3, "a", "g"},
{3, "a", "h"},
{3, "b", "g"},
{3, "b", "h"},
}, values)
}
1 change: 1 addition & 0 deletions tests/realtikvtest/sessiontest/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ go_test(
"//kv",
"//meta/autoid",
"//parser",
"//parser/ast",
"//parser/auth",
"//parser/format",
"//parser/model",
Expand Down