mirror of
https://github.com/etcd-io/etcd.git
synced 2024-09-27 06:25:44 +00:00
313 lines
9.2 KiB
Go
313 lines
9.2 KiB
Go
// Copyright 2021 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 schema
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/coreos/go-semver/semver"
|
|
"github.com/stretchr/testify/assert"
|
|
"go.etcd.io/etcd/raft/v3/raftpb"
|
|
"go.etcd.io/etcd/server/v3/storage/backend"
|
|
betesting "go.etcd.io/etcd/server/v3/storage/backend/testing"
|
|
"go.uber.org/zap"
|
|
)
|
|
|
|
var (
|
|
V3_7 = semver.Version{Major: 3, Minor: 7}
|
|
)
|
|
|
|
func TestValidate(t *testing.T) {
|
|
tcs := []struct {
|
|
name string
|
|
version semver.Version
|
|
// Overrides which keys should be set (default based on version)
|
|
overrideKeys func(tx backend.BatchTx)
|
|
expectError bool
|
|
expectErrorMsg string
|
|
}{
|
|
// As storage version field was added in v3.6, for v3.5 we will not set it.
|
|
// For storage to be considered v3.5 it have both confstate and term key set.
|
|
{
|
|
name: `V3.4 schema is correct`,
|
|
version: V3_4,
|
|
},
|
|
{
|
|
name: `V3.5 schema without confstate and term fields is correct`,
|
|
version: V3_5,
|
|
overrideKeys: func(tx backend.BatchTx) {},
|
|
},
|
|
{
|
|
name: `V3.5 schema without term field is correct`,
|
|
version: V3_5,
|
|
overrideKeys: func(tx backend.BatchTx) {
|
|
MustUnsafeSaveConfStateToBackend(zap.NewNop(), tx, &raftpb.ConfState{})
|
|
},
|
|
},
|
|
{
|
|
name: `V3.5 schema with all fields is correct`,
|
|
version: V3_5,
|
|
overrideKeys: func(tx backend.BatchTx) {
|
|
MustUnsafeSaveConfStateToBackend(zap.NewNop(), tx, &raftpb.ConfState{})
|
|
UnsafeUpdateConsistentIndex(tx, 1, 1, false)
|
|
},
|
|
},
|
|
{
|
|
name: `V3.6 schema is correct`,
|
|
version: V3_6,
|
|
},
|
|
{
|
|
name: `V3.7 schema is unknown and should return error`,
|
|
version: V3_7,
|
|
expectError: true,
|
|
expectErrorMsg: "downgrades are not yet supported",
|
|
},
|
|
}
|
|
for _, tc := range tcs {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
lg := zap.NewNop()
|
|
dataPath := setupBackendData(t, tc.version, tc.overrideKeys)
|
|
|
|
b := backend.NewDefaultBackend(dataPath)
|
|
defer b.Close()
|
|
err := Validate(lg, b.BatchTx())
|
|
if (err != nil) != tc.expectError {
|
|
t.Errorf("Validate(lg, tx) = %+v, expected error: %v", err, tc.expectError)
|
|
}
|
|
if err != nil && err.Error() != tc.expectErrorMsg {
|
|
t.Errorf("Validate(lg, tx) = %q, expected error message: %q", err, tc.expectErrorMsg)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestMigrate(t *testing.T) {
|
|
tcs := []struct {
|
|
name string
|
|
version semver.Version
|
|
// Overrides which keys should be set (default based on version)
|
|
overrideKeys func(tx backend.BatchTx)
|
|
targetVersion semver.Version
|
|
|
|
expectVersion *semver.Version
|
|
expectError bool
|
|
expectErrorMsg string
|
|
}{
|
|
// As storage version field was added in v3.6, for v3.5 we will not set it.
|
|
// For storage to be considered v3.5 it have both confstate and term key set.
|
|
{
|
|
name: `Upgrading v3.5 to v3.6 should be rejected if confstate is not set`,
|
|
version: V3_5,
|
|
overrideKeys: func(tx backend.BatchTx) {},
|
|
targetVersion: V3_6,
|
|
expectVersion: nil,
|
|
expectError: true,
|
|
expectErrorMsg: `cannot detect storage schema version: missing confstate information`,
|
|
},
|
|
{
|
|
name: `Upgrading v3.5 to v3.6 should be rejected if term is not set`,
|
|
version: V3_5,
|
|
overrideKeys: func(tx backend.BatchTx) {
|
|
MustUnsafeSaveConfStateToBackend(zap.NewNop(), tx, &raftpb.ConfState{})
|
|
},
|
|
targetVersion: V3_6,
|
|
expectVersion: nil,
|
|
expectError: true,
|
|
expectErrorMsg: `cannot detect storage schema version: missing term information`,
|
|
},
|
|
{
|
|
name: `Upgrading v3.5 to v3.6 should succeed; all required fields are set`,
|
|
version: V3_5,
|
|
targetVersion: V3_6,
|
|
expectVersion: &V3_6,
|
|
},
|
|
{
|
|
name: `Migrate on same v3.5 version passes and doesn't set storage version'`,
|
|
version: V3_5,
|
|
targetVersion: V3_5,
|
|
expectVersion: nil,
|
|
},
|
|
{
|
|
name: `Migrate on same v3.6 version passes`,
|
|
version: V3_6,
|
|
targetVersion: V3_6,
|
|
expectVersion: &V3_6,
|
|
},
|
|
{
|
|
name: `Migrate on same v3.7 version passes`,
|
|
version: V3_7,
|
|
targetVersion: V3_7,
|
|
expectVersion: &V3_7,
|
|
},
|
|
{
|
|
name: "Upgrading 3.6 to v3.7 is not supported",
|
|
version: V3_6,
|
|
targetVersion: V3_7,
|
|
expectVersion: &V3_6,
|
|
expectError: true,
|
|
expectErrorMsg: `cannot create migration plan: version "3.7.0" is not supported`,
|
|
},
|
|
{
|
|
name: "Downgrading v3.7 to v3.6 is not supported",
|
|
version: V3_7,
|
|
targetVersion: V3_6,
|
|
expectVersion: &V3_7,
|
|
expectError: true,
|
|
expectErrorMsg: `cannot create migration plan: downgrades are not yet supported`,
|
|
},
|
|
{
|
|
name: "Downgrading v3.6 to v3.5 is not supported",
|
|
version: V3_6,
|
|
targetVersion: V3_5,
|
|
expectVersion: &V3_6,
|
|
expectError: true,
|
|
expectErrorMsg: `cannot create migration plan: downgrades are not yet supported`,
|
|
},
|
|
{
|
|
name: "Downgrading v3.5 to v3.4 is not supported",
|
|
version: V3_5,
|
|
targetVersion: V3_4,
|
|
expectVersion: nil,
|
|
expectError: true,
|
|
expectErrorMsg: `cannot create migration plan: downgrades are not yet supported`,
|
|
},
|
|
}
|
|
for _, tc := range tcs {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
lg := zap.NewNop()
|
|
dataPath := setupBackendData(t, tc.version, tc.overrideKeys)
|
|
|
|
b := backend.NewDefaultBackend(dataPath)
|
|
defer b.Close()
|
|
err := Migrate(lg, b.BatchTx(), tc.targetVersion)
|
|
if (err != nil) != tc.expectError {
|
|
t.Errorf("Migrate(lg, tx, %q) = %+v, expected error: %v", tc.targetVersion, err, tc.expectError)
|
|
}
|
|
if err != nil && err.Error() != tc.expectErrorMsg {
|
|
t.Errorf("Migrate(lg, tx, %q) = %q, expected error message: %q", tc.targetVersion, err, tc.expectErrorMsg)
|
|
}
|
|
v := UnsafeReadStorageVersion(b.BatchTx())
|
|
assert.Equal(t, tc.expectVersion, v)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestMigrateIsReversible(t *testing.T) {
|
|
tcs := []struct {
|
|
initialVersion semver.Version
|
|
state map[string]string
|
|
}{
|
|
{
|
|
initialVersion: V3_5,
|
|
state: map[string]string{
|
|
"confState": `{"auto_leave":false}`,
|
|
"consistent_index": "\x00\x00\x00\x00\x00\x00\x00\x01",
|
|
"term": "\x00\x00\x00\x00\x00\x00\x00\x01",
|
|
},
|
|
},
|
|
{
|
|
initialVersion: V3_6,
|
|
state: map[string]string{
|
|
"confState": `{"auto_leave":false}`,
|
|
"consistent_index": "\x00\x00\x00\x00\x00\x00\x00\x01",
|
|
"term": "\x00\x00\x00\x00\x00\x00\x00\x01",
|
|
"storageVersion": "3.6.0",
|
|
},
|
|
},
|
|
}
|
|
for _, tc := range tcs {
|
|
t.Run(tc.initialVersion.String(), func(t *testing.T) {
|
|
lg := zap.NewNop()
|
|
dataPath := setupBackendData(t, tc.initialVersion, nil)
|
|
|
|
be := backend.NewDefaultBackend(dataPath)
|
|
defer be.Close()
|
|
tx := be.BatchTx()
|
|
tx.Lock()
|
|
defer tx.Unlock()
|
|
assertBucketState(t, tx, Meta, tc.state)
|
|
|
|
// Upgrade to current version
|
|
ver := localBinaryVersion()
|
|
err := testUnsafeMigrate(lg, tx, ver)
|
|
if err != nil {
|
|
t.Errorf("Migrate(lg, tx, %q) returned error %+v", ver, err)
|
|
}
|
|
assert.Equal(t, &ver, UnsafeReadStorageVersion(tx))
|
|
|
|
// Downgrade back to initial version
|
|
err = testUnsafeMigrate(lg, tx, tc.initialVersion)
|
|
if err != nil {
|
|
t.Errorf("Migrate(lg, tx, %q) returned error %+v", tc.initialVersion, err)
|
|
}
|
|
|
|
// Assert that all changes were revered
|
|
assertBucketState(t, tx, Meta, tc.state)
|
|
})
|
|
}
|
|
}
|
|
|
|
// Does the same as UnsafeMigrate but skips version checks
|
|
// TODO(serathius): Use UnsafeMigrate when downgrades are implemented
|
|
func testUnsafeMigrate(lg *zap.Logger, tx backend.BatchTx, target semver.Version) error {
|
|
current, err := UnsafeDetectSchemaVersion(lg, tx)
|
|
if err != nil {
|
|
return fmt.Errorf("cannot determine storage version: %w", err)
|
|
}
|
|
plan, err := buildPlan(lg, current, target)
|
|
if err != nil {
|
|
return fmt.Errorf("cannot create migration plan: %w", err)
|
|
}
|
|
return plan.unsafeExecute(lg, tx)
|
|
}
|
|
|
|
func setupBackendData(t *testing.T, version semver.Version, overrideKeys func(tx backend.BatchTx)) string {
|
|
t.Helper()
|
|
be, tmpPath := betesting.NewTmpBackend(t, time.Microsecond, 10)
|
|
tx := be.BatchTx()
|
|
if tx == nil {
|
|
t.Fatal("batch tx is nil")
|
|
}
|
|
tx.Lock()
|
|
UnsafeCreateMetaBucket(tx)
|
|
if overrideKeys != nil {
|
|
overrideKeys(tx)
|
|
} else {
|
|
switch version {
|
|
case V3_4:
|
|
case V3_5:
|
|
MustUnsafeSaveConfStateToBackend(zap.NewNop(), tx, &raftpb.ConfState{})
|
|
UnsafeUpdateConsistentIndex(tx, 1, 1, false)
|
|
case V3_6:
|
|
MustUnsafeSaveConfStateToBackend(zap.NewNop(), tx, &raftpb.ConfState{})
|
|
UnsafeUpdateConsistentIndex(tx, 1, 1, false)
|
|
UnsafeSetStorageVersion(tx, &V3_6)
|
|
case V3_7:
|
|
MustUnsafeSaveConfStateToBackend(zap.NewNop(), tx, &raftpb.ConfState{})
|
|
UnsafeUpdateConsistentIndex(tx, 1, 1, false)
|
|
UnsafeSetStorageVersion(tx, &V3_7)
|
|
tx.UnsafePut(Meta, []byte("future-key"), []byte(""))
|
|
default:
|
|
t.Fatalf("Unsupported storage version")
|
|
}
|
|
}
|
|
tx.Unlock()
|
|
be.ForceCommit()
|
|
be.Close()
|
|
return tmpPath
|
|
}
|