vitess.io/vitess@v0.16.2/go/vt/schemamanager/local_controller_test.go

/*
Copyright 2019 The Vitess Authors.

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 schemamanager

import (
	"context"
	"fmt"
	"os"
	"path"
	"reflect"
	"strings"
	"testing"

	querypb "vitess.io/vitess/go/vt/proto/query"
)

func TestLocalControllerNoSchemaChanges(t *testing.T) {
	schemaChangeDir := t.TempDir()
	controller := NewLocalController(schemaChangeDir)
	ctx := context.Background()
	if err := controller.Open(ctx); err != nil {
		t.Fatalf("Open should succeed, but got error: %v", err)
	}
	defer controller.Close()
	data, err := controller.Read(ctx)
	if err != nil {
		t.Fatalf("Read should succeed, but got error: %v", err)
	}
	if len(data) != 0 {
		t.Fatalf("there is no schema change, Read should return empty data")
	}
}

func TestLocalControllerOpen(t *testing.T) {
	controller := NewLocalController("")
	ctx := context.Background()

	if err := controller.Open(ctx); err == nil || !strings.Contains(err.Error(), "no such file or directory") {
		t.Fatalf("Open should fail, no such dir, but got: %v", err)
	}

	schemaChangeDir := t.TempDir()

	// create a file under schema change dir
	_, err := os.Create(path.Join(schemaChangeDir, "create_test_table.sql"))
	if err != nil {
		t.Fatalf("failed to create sql file, error: %v", err)
	}

	controller = NewLocalController(schemaChangeDir)
	if err := controller.Open(ctx); err != nil {
		t.Fatalf("Open should succeed")
	}
	data, err := controller.Read(ctx)
	if err != nil {
		t.Fatalf("Read should succeed, but got error: %v", err)
	}
	if len(data) != 0 {
		t.Fatalf("there is no schema change, Read should return empty data")
	}
	controller.Close()

	testKeyspaceDir := path.Join(schemaChangeDir, "test_keyspace")
	if err := os.MkdirAll(testKeyspaceDir, os.ModePerm); err != nil {
		t.Fatalf("failed to create test_keyspace dir, error: %v", err)
	}

	controller = NewLocalController(schemaChangeDir)
	if err := controller.Open(ctx); err != nil {
		t.Fatalf("Open should succeed")
	}
	data, err = controller.Read(ctx)
	if err != nil {
		t.Fatalf("Read should succeed, but got error: %v", err)
	}
	if len(data) != 0 {
		t.Fatalf("there is no schema change, Read should return empty data")
	}
	controller.Close()
}

func TestLocalControllerSchemaChange(t *testing.T) {
	schemaChangeDir := t.TempDir()

	testKeyspaceInputDir := path.Join(schemaChangeDir, "test_keyspace/input")
	if err := os.MkdirAll(testKeyspaceInputDir, os.ModePerm); err != nil {
		t.Fatalf("failed to create test_keyspace dir, error: %v", err)
	}

	file, err := os.Create(path.Join(testKeyspaceInputDir, "create_test_table.sql"))
	if err != nil {
		t.Fatalf("failed to create sql file, error: %v", err)
	}

	sqls := []string{
		"create table test_table_01 (id int)",
		"create table test_table_02 (id string)",
	}

	file.WriteString(strings.Join(sqls, ";"))
	file.Close()

	controller := NewLocalController(schemaChangeDir)
	ctx := context.Background()

	if err := controller.Open(ctx); err != nil {
		t.Fatalf("Open should succeed, but got error: %v", err)
	}

	defer controller.Close()

	data, err := controller.Read(ctx)
	if err != nil {
		t.Fatalf("Read should succeed, but got error: %v", err)
	}

	if !reflect.DeepEqual(sqls, data) {
		t.Fatalf("expect to get sqls: %v, but got: %v", sqls, data)
	}

	if controller.Keyspace() != "test_keyspace" {
		t.Fatalf("expect to get keyspace: 'test_keyspace', but got: '%s'",
			controller.Keyspace())
	}

	// test various callbacks
	if err := controller.OnReadSuccess(ctx); err != nil {
		t.Fatalf("OnReadSuccess should succeed, but got error: %v", err)
	}

	if err := controller.OnReadFail(ctx, fmt.Errorf("read fail")); err != nil {
		t.Fatalf("OnReadFail should succeed, but got error: %v", err)
	}

	errorPath := path.Join(controller.errorDir, controller.sqlFilename)

	if err := controller.OnValidationSuccess(ctx); err != nil {
		t.Fatalf("OnReadSuccess should succeed, but got error: %v", err)
	}

	// move sql file from error dir to input dir for OnValidationFail test
	os.Rename(errorPath, controller.sqlPath)

	if err := controller.OnValidationFail(ctx, fmt.Errorf("validation fail")); err != nil {
		t.Fatalf("OnValidationFail should succeed, but got error: %v", err)
	}

	if _, err := os.Stat(errorPath); os.IsNotExist(err) {
		t.Fatalf("sql file should be moved to error dir, error: %v", err)
	}

	// move sql file from error dir to input dir for OnExecutorComplete test
	os.Rename(errorPath, controller.sqlPath)

	result := &ExecuteResult{
		Sqls: []string{"create table test_table (id int)"},
		SuccessShards: []ShardResult{{
			Shard:  "0",
			Result: &querypb.QueryResult{},
		}},
	}
	logPath := path.Join(controller.logDir, controller.sqlFilename)
	completePath := path.Join(controller.completeDir, controller.sqlFilename)
	if err := controller.OnExecutorComplete(ctx, result); err != nil {
		t.Fatalf("OnExecutorComplete should succeed, but got error: %v", err)
	}
	if _, err := os.Stat(completePath); os.IsNotExist(err) {
		t.Fatalf("sql file should be moved to complete dir, error: %v", err)
	}

	if _, err := os.Stat(logPath); os.IsNotExist(err) {
		t.Fatalf("sql file should be moved to log dir, error: %v", err)
	}

	// move sql file from error dir to input dir for OnExecutorComplete test
	os.Rename(completePath, controller.sqlPath)

	result = &ExecuteResult{
		Sqls: []string{"create table test_table (id int)"},
		FailedShards: []ShardWithError{{
			Shard: "0",
			Err:   "execute error",
		}},
	}

	if err := controller.OnExecutorComplete(ctx, result); err != nil {
		t.Fatalf("OnExecutorComplete should succeed, but got error: %v", err)
	}

	if _, err := os.Stat(errorPath); os.IsNotExist(err) {
		t.Fatalf("sql file should be moved to error dir, error: %v", err)
	}
}