github.com/m3db/m3@v1.5.0/src/cluster/placement/storage/storage_test.go

// Copyright (c) 2016 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 storage

import (
	"testing"

	"github.com/m3db/m3/src/cluster/generated/proto/placementpb"
	"github.com/m3db/m3/src/cluster/kv"
	"github.com/m3db/m3/src/cluster/kv/mem"
	"github.com/m3db/m3/src/cluster/placement"

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

func TestStorageWithSinglePlacement(t *testing.T) {
	ps := newTestPlacementStorage(mem.NewStore(), placement.NewOptions())
	err := ps.Delete()
	require.Error(t, err)
	require.Equal(t, kv.ErrNotFound, err)

	p := placement.NewPlacement().
		SetInstances([]placement.Instance{}).
		SetShards([]uint32{}).
		SetReplicaFactor(0)

	pGet, err := ps.SetIfNotExist(p)
	assert.Equal(t, 1, pGet.Version())
	require.NoError(t, err)

	_, err = ps.SetIfNotExist(p)
	require.Error(t, err)
	require.Equal(t, kv.ErrAlreadyExists, err)

	pGet, err = ps.Placement()
	require.NoError(t, err)
	require.Equal(t, p.SetVersion(1), pGet)

	_, err = ps.PlacementForVersion(0)
	require.Error(t, err)

	_, err = ps.PlacementForVersion(2)
	require.Error(t, err)

	h, err := ps.PlacementForVersion(1)
	require.NoError(t, err)
	require.Equal(t, pGet, h)

	pGet, err = ps.CheckAndSet(p, pGet.Version())
	require.NoError(t, err)
	assert.Equal(t, 2, pGet.Version())

	_, err = ps.CheckAndSet(p, pGet.Version()-1)
	require.Error(t, err)
	require.Equal(t, kv.ErrVersionMismatch, err)

	pGet, err = ps.Placement()
	require.NoError(t, err)
	require.Equal(t, 2, pGet.Version())
	require.Equal(t, p.SetVersion(2), pGet)

	err = ps.Delete()
	require.NoError(t, err)

	_, err = ps.Placement()
	require.Error(t, err)
	require.Equal(t, kv.ErrNotFound, err)

	pGet, err = ps.SetIfNotExist(p)
	require.NoError(t, err)
	assert.Equal(t, 1, pGet.Version())

	pGet, err = ps.Placement()
	require.NoError(t, err)
	require.Equal(t, 1, pGet.Version())
	require.Equal(t, p.SetVersion(1), pGet)

	proto, v, err := ps.Proto()
	require.NoError(t, err)
	require.Equal(t, 1, v)

	actualP, err := placement.NewPlacementFromProto(proto.(*placementpb.Placement))
	require.NoError(t, err)
	require.Equal(t, p.SetVersion(0), actualP)
}

func TestStorageWithPlacementSnapshots(t *testing.T) {
	ps := newTestPlacementStorage(mem.NewStore(), placement.NewOptions().SetIsStaged(true))

	p := placement.NewPlacement().
		SetInstances([]placement.Instance{}).
		SetShards([]uint32{}).
		SetReplicaFactor(0).
		SetCutoverNanos(100)

	p1, err := ps.SetIfNotExist(p)
	require.NoError(t, err)
	assert.Equal(t, 1, p1.Version())

	_, err = ps.SetIfNotExist(p)
	require.Error(t, err)

	p1, err = ps.Placement()
	require.NoError(t, err)
	require.Equal(t, 1, p1.Version())
	require.Equal(t, p.SetVersion(1), p1)

	_, err = ps.PlacementForVersion(0)
	require.Error(t, err)

	_, err = ps.PlacementForVersion(2)
	require.Error(t, err)

	h, err := ps.PlacementForVersion(1)
	require.NoError(t, err)
	require.Equal(t, p1, h)

	p2 := p1.Clone().
		SetCutoverNanos(p1.CutoverNanos() + 100).
		SetReplicaFactor(p1.ReplicaFactor() + 2)
	pGet2, err := ps.CheckAndSet(p2, p1.Version())
	require.NoError(t, err)
	require.Equal(t, 2, pGet2.Version())
	require.Equal(t, int64(0), pGet2.CutoverNanos())
	require.Equal(t, p2.SetVersion(2), pGet2)

	newProto, v, err := ps.Proto()
	require.NoError(t, err)
	require.Equal(t, 2, v)

	// Only latest snapshot is retained.
	newPs, err := placement.NewPlacementsFromProto(newProto.(*placementpb.PlacementSnapshots))
	require.NoError(t, err)
	require.Equal(t, pGet2.SetVersion(0), newPs.Latest())

	err = ps.Delete()
	require.NoError(t, err)

	_, err = ps.Placement()
	require.Error(t, err)
	require.Equal(t, kv.ErrNotFound, err)

	pGet2, err = ps.SetIfNotExist(p)
	require.NoError(t, err)
	assert.Equal(t, 1, pGet2.Version())

	pGet3, err := ps.Placement()
	require.NoError(t, err)
	require.Equal(t, 1, pGet3.Version())
	require.Equal(t, p.SetVersion(1), pGet3)
}

func TestStorageCompressesStagedPlacement(t *testing.T) {
	expected := placement.NewPlacement().
		SetInstances([]placement.Instance{
			testInstance("i1"),
			testInstance("i2"),
		}).
		SetShards([]uint32{}).
		SetReplicaFactor(2).
		SetCutoverNanos(100)

	testCases := []struct {
		name          string
		storeActionFn func(s placement.Storage, p placement.Placement) error
	}{
		{
			name: "set_if_not_exiss",
			storeActionFn: func(s placement.Storage, p placement.Placement) error {
				_, err := s.SetIfNotExist(p)
				return err
			},
		},
		{
			name: "check_and_set",
			storeActionFn: func(s placement.Storage, p placement.Placement) error {
				_, err := s.CheckAndSet(p, 0)
				return err
			},
		},
		{
			name: "set",
			storeActionFn: func(s placement.Storage, p placement.Placement) error {
				_, err := s.Set(p)
				return err
			},
		},
	}

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			opts := placement.NewOptions().SetIsStaged(true).SetCompress(true)
			storage := newTestPlacementStorage(mem.NewStore(), opts)

			err := tc.storeActionFn(storage, expected.Clone()) // nolint: scopelint
			require.NoError(t, err)

			m, _, err := storage.Proto()
			require.NoError(t, err)
			proto := m.(*placementpb.PlacementSnapshots)
			require.NotNil(t, proto)
			require.Equal(t, placementpb.CompressMode_ZSTD, proto.CompressMode)
			require.True(t, len(proto.CompressedPlacement) > 0)
			require.Equal(t, 0, len(proto.Snapshots))

			ps, err := placement.NewPlacementsFromProto(proto)
			require.NoError(t, err)
			actual := ps.Latest()
			require.Equal(t, expected.String(), actual.String())
		})
	}
}

func TestCheckAndSetProto(t *testing.T) {
	m := mem.NewStore()
	ps := newTestPlacementStorage(m, placement.NewOptions())

	p := placement.NewPlacement().
		SetInstances([]placement.Instance{}).
		SetShards([]uint32{}).
		SetReplicaFactor(0)

	pGet, err := ps.SetIfNotExist(p)
	require.NoError(t, err)
	assert.Equal(t, 1, pGet.Version())

	newProto, v, err := ps.Proto()
	require.NoError(t, err)
	require.Equal(t, 1, v)

	_, err = ps.CheckAndSetProto(newProto, 2)
	require.Error(t, err)

	version, err := ps.CheckAndSetProto(newProto, 1)
	require.NoError(t, err)
	assert.Equal(t, 2, version)

	require.NoError(t, ps.Delete())

	version, err = ps.CheckAndSetProto(newProto, 0)
	require.NoError(t, err)
	assert.Equal(t, 1, version)
}

func TestDryrun(t *testing.T) {
	m := mem.NewStore()
	dryrunPS := newTestPlacementStorage(m, placement.NewOptions().SetDryrun(true))
	ps := newTestPlacementStorage(m, placement.NewOptions())

	p := placement.NewPlacement().
		SetInstances([]placement.Instance{}).
		SetShards([]uint32{}).
		SetReplicaFactor(0)

	dryPGet, err := dryrunPS.SetIfNotExist(p)
	require.NoError(t, err)
	assert.Equal(t, 0, dryPGet.Version())

	_, err = ps.Placement()
	require.Error(t, err)

	pGet, err := ps.SetIfNotExist(p)
	require.NoError(t, err)
	assert.Equal(t, 1, pGet.Version())

	pGet, err = ps.Placement()
	require.NoError(t, err)
	require.Equal(t, 1, pGet.Version())

	_, err = dryrunPS.CheckAndSet(p, 1)
	require.NoError(t, err)

	pGet, _ = ps.Placement()
	require.Equal(t, 1, pGet.Version())

	err = dryrunPS.Delete()
	require.NoError(t, err)

	pGet, err = ps.Placement()
	require.NoError(t, err)
	require.Equal(t, 1, pGet.Version())

	dryPGet, err = dryrunPS.Placement()
	require.NoError(t, err)
	require.Equal(t, 1, dryPGet.Version())

	err = ps.Delete()
	require.NoError(t, err)

	_, err = dryrunPS.Placement()
	require.Error(t, err)
}

func newTestPlacementStorage(store kv.Store, pOpts placement.Options) placement.Storage {
	return NewPlacementStorage(store, "key", pOpts)
}

func testInstance(id string) placement.Instance {
	return placement.NewInstance().
		SetID(id).
		SetIsolationGroup("rack-" + id).
		SetEndpoint("endpoint-" + id).
		SetMetadata(placement.InstanceMetadata{DebugPort: 80}).
		SetWeight(1)
}