plan_replayer_handle_test.go

// 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 domain_test

import (
	"fmt"
	"testing"

	"github.com/pingcap/tidb/testkit"
	"github.com/stretchr/testify/require"
)

func TestPlanReplayerHandleCollectTask(t *testing.T) {
	store, dom := testkit.CreateMockStoreAndDomain(t)
	tk := testkit.NewTestKit(t, store)
	prHandle := dom.GetPlanReplayerHandle()

	// assert 1 task
	tk.MustExec("delete from mysql.plan_replayer_task")
	tk.MustExec("delete from mysql.plan_replayer_status")
	tk.MustExec("insert into mysql.plan_replayer_task (sql_digest, plan_digest) values ('123','123');")
	err := prHandle.CollectPlanReplayerTask()
	require.NoError(t, err)
	require.Len(t, prHandle.GetTasks(), 1)

	// assert no task
	tk.MustExec("delete from mysql.plan_replayer_task")
	tk.MustExec("delete from mysql.plan_replayer_status")
	err = prHandle.CollectPlanReplayerTask()
	require.NoError(t, err)
	require.Len(t, prHandle.GetTasks(), 0)

	// assert 1 unhandled task
	tk.MustExec("delete from mysql.plan_replayer_task")
	tk.MustExec("delete from mysql.plan_replayer_status")
	tk.MustExec("insert into mysql.plan_replayer_task (sql_digest, plan_digest) values ('123','123');")
	tk.MustExec("insert into mysql.plan_replayer_task (sql_digest, plan_digest) values ('345','345');")
	tk.MustExec("insert into mysql.plan_replayer_status(sql_digest, plan_digest, token, instance) values ('123','123','123','123')")
	err = prHandle.CollectPlanReplayerTask()
	require.NoError(t, err)
	require.Len(t, prHandle.GetTasks(), 1)

	// assert 2 unhandled task
	tk.MustExec("delete from mysql.plan_replayer_task")
	tk.MustExec("delete from mysql.plan_replayer_status")
	tk.MustExec("insert into mysql.plan_replayer_task (sql_digest, plan_digest) values ('123','123');")
	tk.MustExec("insert into mysql.plan_replayer_task (sql_digest, plan_digest) values ('345','345');")
	tk.MustExec("insert into mysql.plan_replayer_status(sql_digest, plan_digest, fail_reason, instance) values ('123','123','123','123')")
	err = prHandle.CollectPlanReplayerTask()
	require.NoError(t, err)
	require.Len(t, prHandle.GetTasks(), 2)
}

func TestPlanReplayerHandleDumpTask(t *testing.T) {
	store, dom := testkit.CreateMockStoreAndDomain(t)
	tk := testkit.NewTestKit(t, store)
	prHandle := dom.GetPlanReplayerHandle()
	tk.MustExec("use test")
	tk.MustExec("create table t(a int)")
	tk.MustQuery("select * from t;")
	_, d := tk.Session().GetSessionVars().StmtCtx.SQLDigest()
	_, pd := tk.Session().GetSessionVars().StmtCtx.GetPlanDigest()
	sqlDigest := d.String()
	planDigest := pd.String()

	// register task
	tk.MustExec("delete from mysql.plan_replayer_task")
	tk.MustExec("delete from mysql.plan_replayer_status")
	tk.MustExec(fmt.Sprintf("insert into mysql.plan_replayer_task (sql_digest, plan_digest) values ('%v','%v');", sqlDigest, planDigest))
	err := prHandle.CollectPlanReplayerTask()
	require.NoError(t, err)
	require.Len(t, prHandle.GetTasks(), 1)

	tk.MustExec("SET @@tidb_enable_plan_replayer_capture = ON;")

	// capture task and dump
	tk.MustQuery("select * from t;")
	task := prHandle.DrainTask()
	require.NotNil(t, task)
	worker := prHandle.GetWorker()
	success := worker.HandleTask(task)
	require.True(t, success)
	require.Equal(t, prHandle.GetTaskStatus().GetRunningTaskStatusLen(), 0)
	// assert memory task consumed
	require.Len(t, prHandle.GetTasks(), 0)

	// assert collect task again and no more memory task
	err = prHandle.CollectPlanReplayerTask()
	require.NoError(t, err)
	require.Len(t, prHandle.GetTasks(), 0)

	// clean the task and register task
	prHandle.GetTaskStatus().CleanFinishedTaskStatus()
	tk.MustExec("delete from mysql.plan_replayer_task")
	tk.MustExec("delete from mysql.plan_replayer_status")
	tk.MustExec(fmt.Sprintf("insert into mysql.plan_replayer_task (sql_digest, plan_digest) values ('%v','%v');", sqlDigest, "*"))
	err = prHandle.CollectPlanReplayerTask()
	require.NoError(t, err)
	require.Len(t, prHandle.GetTasks(), 1)
	tk.MustQuery("select * from t;")
	task = prHandle.DrainTask()
	require.NotNil(t, task)
	worker = prHandle.GetWorker()
	success = worker.HandleTask(task)
	require.True(t, success)
	require.Equal(t, prHandle.GetTaskStatus().GetRunningTaskStatusLen(), 0)
	// assert capture * task still remained
	require.Len(t, prHandle.GetTasks(), 1)
}