tests/common/txn_test.go

// Copyright 2022 The etcd 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 common

import (
	"context"
	"fmt"
	"testing"
	"time"

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

	pb "go.etcd.io/etcd/api/v3/etcdserverpb"
	clientv3 "go.etcd.io/etcd/client/v3"
	"go.etcd.io/etcd/tests/v3/framework/config"
	"go.etcd.io/etcd/tests/v3/framework/testutils"
)

type txnReq struct {
	compare       []string
	ifSuccess     []string
	ifFail        []string
	expectResults []string
	expectError   bool
}

func TestTxnSucc(t *testing.T) {
	testRunner.BeforeTest(t)
	reqs := []txnReq{
		{
			compare:       []string{`value("key1") != "value2"`, `value("key2") != "value1"`},
			ifSuccess:     []string{"get key1", "get key2"},
			expectResults: []string{"SUCCESS", "key1", "value1", "key2", "value2"},
		},
		{
			compare:       []string{`version("key1") = "1"`, `version("key2") = "1"`},
			ifSuccess:     []string{"get key1", "get key2", `put "key \"with\" space" "value \x23"`},
			ifFail:        []string{`put key1 "fail"`, `put key2 "fail"`},
			expectResults: []string{"SUCCESS", "key1", "value1", "key2", "value2", "OK"},
		},
		{
			compare:       []string{`version("key \"with\" space") = "1"`},
			ifSuccess:     []string{`get "key \"with\" space"`},
			expectResults: []string{"SUCCESS", `key "with" space`, "value \x23"},
		},
	}
	for _, cfg := range clusterTestCases() {
		t.Run(cfg.name, func(t *testing.T) {
			ctx, cancel := context.WithTimeout(t.Context(), 10*time.Second)
			defer cancel()
			clus := testRunner.NewCluster(ctx, t, config.WithClusterConfig(cfg.config))
			defer clus.Close()
			cc := testutils.MustClient(clus.Client())
			testutils.ExecuteUntil(ctx, t, func() {
				_, err := cc.Put(ctx, "key1", "value1", config.PutOptions{})
				require.NoErrorf(t, err, "could not create key:%s, value:%s", "key1", "value1")
				_, err = cc.Put(ctx, "key2", "value2", config.PutOptions{})
				require.NoErrorf(t, err, "could not create key:%s, value:%s", "key2", "value2")
				for _, req := range reqs {
					resp, err := cc.Txn(ctx, req.compare, req.ifSuccess, req.ifFail, config.TxnOptions{
						Interactive: true,
					})
					require.NoErrorf(t, err, "Txn returned error: %s", err)
					assert.Equal(t, req.expectResults, getRespValues(resp))
				}
			})
		})
	}
}

func TestTxnFail(t *testing.T) {
	testRunner.BeforeTest(t)
	reqs := []txnReq{
		{
			compare:       []string{`version("key") < "0"`},
			ifSuccess:     []string{`put key "success"`},
			ifFail:        []string{`put key "fail"`},
			expectResults: []string{"FAILURE", "OK"},
		},
		{
			compare:       []string{`value("key1") != "value1"`},
			ifSuccess:     []string{`put key1 "success"`},
			ifFail:        []string{`put key1 "fail"`},
			expectResults: []string{"FAILURE", "OK"},
		},
	}
	for _, cfg := range clusterTestCases() {
		t.Run(cfg.name, func(t *testing.T) {
			ctx, cancel := context.WithTimeout(t.Context(), 10*time.Second)
			defer cancel()
			clus := testRunner.NewCluster(ctx, t, config.WithClusterConfig(cfg.config))
			defer clus.Close()
			cc := testutils.MustClient(clus.Client())
			testutils.ExecuteUntil(ctx, t, func() {
				_, err := cc.Put(ctx, "key1", "value1", config.PutOptions{})
				require.NoErrorf(t, err, "could not create key:%s, value:%s", "key1", "value1")
				for _, req := range reqs {
					resp, err := cc.Txn(ctx, req.compare, req.ifSuccess, req.ifFail, config.TxnOptions{
						Interactive: true,
					})
					require.NoErrorf(t, err, "Txn returned error: %s", err)
					assert.Equal(t, req.expectResults, getRespValues(resp))
				}
			})
		})
	}
}

func getRespValues(r *clientv3.TxnResponse) []string {
	var ss []string
	if r.Succeeded {
		ss = append(ss, "SUCCESS")
	} else {
		ss = append(ss, "FAILURE")
	}
	for _, resp := range r.Responses {
		switch v := resp.Response.(type) {
		case *pb.ResponseOp_ResponseDeleteRange:
			r := v.ResponseDeleteRange
			ss = append(ss, fmt.Sprintf("%d", r.GetDeleted()))
		case *pb.ResponseOp_ResponsePut:
			r := v.ResponsePut
			ss = append(ss, "OK")
			if r.GetPrevKv() != nil {
				ss = append(ss, string(r.PrevKv.Key), string(r.PrevKv.Value))
			}
		case *pb.ResponseOp_ResponseRange:
			r := v.ResponseRange
			for _, kv := range r.GetKvs() {
				ss = append(ss, string(kv.Key), string(kv.Value))
			}
		default:
			ss = append(ss, fmt.Sprintf("\"Unknown\" : %q\n", fmt.Sprintf("%+v", v)))
		}
	}
	return ss
}