tasks/common/persistence/sql/sqlplugin/tests/history_tree.go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package tests

import (
	"math/rand"
	"testing"

	"github.com/stretchr/testify/require"
	"github.com/stretchr/testify/suite"
	"go.temporal.io/server/common/persistence/sql/sqlplugin"
	"go.temporal.io/server/common/primitives"
	"go.temporal.io/server/common/shuffle"
)

type (
	historyTreeSuite struct {
		suite.Suite
		*require.Assertions

		store sqlplugin.HistoryTree
	}
)

const (
	testHistoryTreeEncoding = "random encoding"
)

var (
	testHistoryTreeData = []byte("random history tree data")
)

func NewHistoryTreeSuite(
	t *testing.T,
	store sqlplugin.HistoryTree,
) *historyTreeSuite {
	return &historyTreeSuite{
		Assertions: require.New(t),
		store:      store,
	}
}

func (s *historyTreeSuite) SetupSuite() {

}

func (s *historyTreeSuite) TearDownSuite() {

}

func (s *historyTreeSuite) SetupTest() {
	s.Assertions = require.New(s.T())
}

func (s *historyTreeSuite) TearDownTest() {

}

func (s *historyTreeSuite) TestInsert_Success() {
	shardID := rand.Int31()
	treeID := primitives.NewUUID()
	branchID := primitives.NewUUID()

	node := s.newRandomTreeRow(shardID, treeID, branchID)
	result, err := s.store.InsertIntoHistoryTree(newExecutionContext(), &node)
	s.NoError(err)
	rowsAffected, err := result.RowsAffected()
	s.NoError(err)
	s.Equal(1, int(rowsAffected))
}

func (s *historyTreeSuite) TestInsert_Duplicate_Success() {
	shardID := rand.Int31()
	treeID := primitives.NewUUID()
	branchID := primitives.NewUUID()

	node := s.newRandomTreeRow(shardID, treeID, branchID)
	result, err := s.store.InsertIntoHistoryTree(newExecutionContext(), &node)
	s.NoError(err)
	rowsAffected, err := result.RowsAffected()
	s.NoError(err)
	s.Equal(1, int(rowsAffected))

	node = s.newRandomTreeRow(shardID, treeID, branchID)
	result, err = s.store.InsertIntoHistoryTree(newExecutionContext(), &node)
	s.NoError(err)
	_, err = result.RowsAffected()
	s.NoError(err)
	// TODO cannot assert on the number of rows affect
	//  since MySQL and PostgreSQL have different behavior
}

func (s *historyTreeSuite) TestInsertSelect() {
	shardID := rand.Int31()
	treeID := primitives.NewUUID()
	branchID := primitives.NewUUID()

	tree := s.newRandomTreeRow(shardID, treeID, branchID)
	result, err := s.store.InsertIntoHistoryTree(newExecutionContext(), &tree)
	s.NoError(err)
	rowsAffected, err := result.RowsAffected()
	s.NoError(err)
	s.Equal(1, int(rowsAffected))

	selectFilter := sqlplugin.HistoryTreeSelectFilter{
		ShardID: shardID,
		TreeID:  treeID,
	}
	rows, err := s.store.SelectFromHistoryTree(newExecutionContext(), selectFilter)
	s.NoError(err)
	for index := range rows {
		rows[index].ShardID = shardID
		rows[index].TreeID = treeID
	}
	s.Equal([]sqlplugin.HistoryTreeRow{tree}, rows)
}

func (s *historyTreeSuite) TestDeleteSelect() {
	shardID := rand.Int31()
	treeID := primitives.NewUUID()
	branchID := primitives.NewUUID()

	deleteFilter := sqlplugin.HistoryTreeDeleteFilter{
		ShardID:  shardID,
		TreeID:   treeID,
		BranchID: branchID,
	}
	result, err := s.store.DeleteFromHistoryTree(newExecutionContext(), deleteFilter)
	s.NoError(err)
	rowsAffected, err := result.RowsAffected()
	s.NoError(err)
	s.Equal(0, int(rowsAffected))

	selectFilter := sqlplugin.HistoryTreeSelectFilter{
		ShardID: shardID,
		TreeID:  treeID,
	}
	rows, err := s.store.SelectFromHistoryTree(newExecutionContext(), selectFilter)
	s.NoError(err)
	for index := range rows {
		rows[index].ShardID = shardID
		rows[index].TreeID = treeID
	}
	s.Equal([]sqlplugin.HistoryTreeRow(nil), rows)
}

func (s *historyTreeSuite) TestInsertDeleteSelect() {
	shardID := rand.Int31()
	treeID := primitives.NewUUID()
	branchID := primitives.NewUUID()

	tree := s.newRandomTreeRow(shardID, treeID, branchID)
	result, err := s.store.InsertIntoHistoryTree(newExecutionContext(), &tree)
	s.NoError(err)
	rowsAffected, err := result.RowsAffected()
	s.NoError(err)
	s.Equal(1, int(rowsAffected))

	deleteFilter := sqlplugin.HistoryTreeDeleteFilter{
		ShardID:  shardID,
		TreeID:   treeID,
		BranchID: branchID,
	}
	result, err = s.store.DeleteFromHistoryTree(newExecutionContext(), deleteFilter)
	s.NoError(err)
	rowsAffected, err = result.RowsAffected()
	s.NoError(err)
	s.Equal(1, int(rowsAffected))

	selectFilter := sqlplugin.HistoryTreeSelectFilter{
		ShardID: shardID,
		TreeID:  treeID,
	}
	rows, err := s.store.SelectFromHistoryTree(newExecutionContext(), selectFilter)
	s.NoError(err)
	for index := range rows {
		rows[index].ShardID = shardID
		rows[index].TreeID = treeID
	}
	s.Equal([]sqlplugin.HistoryTreeRow(nil), rows)
}

func (s *historyTreeSuite) newRandomTreeRow(
	shardID int32,
	treeID primitives.UUID,
	branchID primitives.UUID,
) sqlplugin.HistoryTreeRow {
	return sqlplugin.HistoryTreeRow{
		ShardID:      shardID,
		TreeID:       treeID,
		BranchID:     branchID,
		Data:         shuffle.Bytes(testHistoryTreeData),
		DataEncoding: testHistoryTreeEncoding,
	}
}