github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/client/aggregate_results_accumulator_consistency_test.go

// Copyright (c) 2019 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 client

import (
	"fmt"
	"testing"

	"github.com/m3db/m3/src/cluster/shard"
	"github.com/m3db/m3/src/dbnode/generated/thrift/rpc"
	"github.com/m3db/m3/src/dbnode/topology"
	tu "github.com/m3db/m3/src/dbnode/topology/testutil"
	xtime "github.com/m3db/m3/src/x/time"
)

var (
	testStartTime, testEndTime   xtime.UnixNano
	testAggregateSuccessResponse = rpc.AggregateQueryRawResult_{}
	errTestAggregate             = fmt.Errorf("random error")
)

func TestAggregateResultsAccumulatorAnyResponseShouldTerminateConsistencyLevelOneSimpleTopo(t *testing.T) {
	// rf=3, 30 shards total; three identical hosts
	topoMap := tu.MustNewTopologyMap(3, map[string][]shard.Shard{
		"testhost0": tu.ShardsRange(0, 29, shard.Available),
		"testhost1": tu.ShardsRange(0, 29, shard.Available),
		"testhost2": tu.ShardsRange(0, 29, shard.Available),
	})

	// any response should satisfy consistency lvl one
	for i := 0; i < 3; i++ {
		testFetchStateWorkflow{
			t:       t,
			topoMap: topoMap,
			level:   topology.ReadConsistencyLevelOne,
			steps: []testFetchStateWorklowStep{
				{
					hostname:        fmt.Sprintf("testhost%d", i),
					aggregateResult: &testAggregateSuccessResponse,
					expectedDone:    true,
				},
			},
		}.run()
	}

	// should terminate only after all failures, and say it failed
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelOne,
		steps: []testFetchStateWorklowStep{
			{
				hostname:     "testhost0",
				aggregateErr: errTestAggregate,
			},
			{
				hostname:     "testhost1",
				aggregateErr: errTestAggregate,
			},
			{
				hostname:     "testhost1",
				aggregateErr: errTestAggregate,
				expectedDone: true,
				expectedErr:  true,
			},
		},
	}.run()
}

func TestAggregateResultsAccumulatorShardAvailabilityIsEnforced(t *testing.T) {
	// rf=3, 30 shards total; three identical hosts
	topoMap := tu.MustNewTopologyMap(3, map[string][]shard.Shard{
		"testhost0": tu.ShardsRange(0, 29, shard.Available),
		"testhost1": tu.ShardsRange(0, 29, shard.Initializing),
		"testhost2": tu.ShardsRange(0, 29, shard.Available),
	})

	// responses from testhost1 should not count towards success
	// for consistency level 1
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelOne,
		steps: []testFetchStateWorklowStep{
			{
				hostname:        "testhost1",
				aggregateResult: &testAggregateSuccessResponse,
				expectedDone:    false,
			},
		},
	}.run()

	// for consistency level unstrict majority
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelUnstrictMajority,
		steps: []testFetchStateWorklowStep{
			{
				hostname:        "testhost1",
				aggregateResult: &testAggregateSuccessResponse,
			},
			{
				hostname:     "testhost2",
				aggregateErr: errTestAggregate,
			},
			{
				hostname:     "testhost0",
				aggregateErr: errTestAggregate,
				expectedDone: true,
				expectedErr:  true,
			},
		},
	}.run()

	// for consistency level majority
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelMajority,
		steps: []testFetchStateWorklowStep{
			{
				hostname:        "testhost1",
				aggregateResult: &testAggregateSuccessResponse,
			},
			{
				hostname:        "testhost2",
				aggregateResult: &testAggregateSuccessResponse,
			},
			{
				hostname:     "testhost0",
				aggregateErr: errTestAggregate,
				expectedDone: true,
				expectedErr:  true,
			},
		},
	}.run()

	// for consistency level unstrict all
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelUnstrictAll,
		steps: []testFetchStateWorklowStep{
			{
				hostname:        "testhost1",
				aggregateResult: &testAggregateSuccessResponse,
			},
			{
				hostname:        "testhost2",
				aggregateResult: &testAggregateSuccessResponse,
			},
			{
				hostname:     "testhost0",
				aggregateErr: errTestAggregate,
				expectedDone: true,
				expectedErr:  false,
			},
		},
	}.run()
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelUnstrictAll,
		steps: []testFetchStateWorklowStep{
			{
				hostname:     "testhost1",
				aggregateErr: errTestAggregate,
			},
			{
				hostname:        "testhost2",
				aggregateResult: &testAggregateSuccessResponse,
			},
			{
				hostname:     "testhost0",
				aggregateErr: errTestAggregate,
				expectedDone: true,
				expectedErr:  false,
			},
		},
	}.run()
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelUnstrictAll,
		steps: []testFetchStateWorklowStep{
			{
				hostname:     "testhost1",
				aggregateErr: errTestAggregate,
			},
			{
				hostname:     "testhost2",
				aggregateErr: errTestAggregate,
			},
			{
				hostname:     "testhost0",
				aggregateErr: errTestAggregate,
				expectedDone: true,
				expectedErr:  true,
			},
		},
	}.run()

	// for consistency level all
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelAll,
		steps: []testFetchStateWorklowStep{
			{
				hostname:        "testhost1",
				aggregateResult: &testAggregateSuccessResponse,
			},
			{
				hostname:        "testhost2",
				aggregateResult: &testAggregateSuccessResponse,
			},
			{
				hostname:        "testhost0",
				aggregateResult: &testAggregateSuccessResponse,
				expectedDone:    true,
				expectedErr:     true,
			},
		},
	}.run()
}

func TestAggregateResultsAccumulatorAnyResponseShouldTerminateConsistencyLevelOneComplexTopo(t *testing.T) {
	// rf=3, 30 shards total; 2 identical hosts, one additional host with a subset of all shards
	topoMap := tu.MustNewTopologyMap(3, map[string][]shard.Shard{
		"testhost0": tu.ShardsRange(0, 29, shard.Available),
		"testhost1": tu.ShardsRange(0, 29, shard.Available),
		"testhost2": tu.ShardsRange(10, 20, shard.Available),
	})

	// a single response from a host with partial shards isn't enough
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelOne,
		steps: []testFetchStateWorklowStep{
			{
				hostname:        "testhost2",
				aggregateResult: &testAggregateSuccessResponse,
				expectedDone:    false,
			},
		},
	}.run()
}

func TestAggregateResultsAccumulatorConsistencyUnstrictMajority(t *testing.T) {
	// rf=3, 30 shards total; three identical hosts
	topoMap := tu.MustNewTopologyMap(3, map[string][]shard.Shard{
		"testhost0": tu.ShardsRange(0, 29, shard.Available),
		"testhost1": tu.ShardsRange(0, 29, shard.Available),
		"testhost2": tu.ShardsRange(0, 29, shard.Available),
	})

	// two success responses should succeed immediately
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelUnstrictMajority,
		steps: []testFetchStateWorklowStep{
			{
				hostname:        "testhost0",
				aggregateResult: &testAggregateSuccessResponse,
				expectedDone:    false,
			},
			{
				hostname:        "testhost1",
				aggregateResult: &testAggregateSuccessResponse,
				expectedDone:    true,
			},
		},
	}.run()

	// two failures, and one success response should succeed
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelUnstrictMajority,
		steps: []testFetchStateWorklowStep{
			{
				hostname:     "testhost0",
				aggregateErr: errTestAggregate,
			},
			{
				hostname:     "testhost1",
				aggregateErr: errTestAggregate,
			},
			{
				hostname:        "testhost1",
				aggregateResult: &testAggregateSuccessResponse,
				expectedDone:    true,
			},
		},
	}.run()

	// should terminate only after all failures
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelUnstrictMajority,
		steps: []testFetchStateWorklowStep{
			{
				hostname:     "testhost0",
				aggregateErr: errTestAggregate,
			},
			{
				hostname:     "testhost1",
				aggregateErr: errTestAggregate,
			},
			{
				hostname:     "testhost1",
				aggregateErr: errTestAggregate,
				expectedErr:  true,
				expectedDone: true,
			},
		},
	}.run()
}

func TestAggregateResultsAccumulatorConsistencyUnstrictMajorityComplexTopo(t *testing.T) {
	// rf=3, 30 shards total; three identical hosts
	topoMap := tu.MustNewTopologyMap(3, map[string][]shard.Shard{
		"testhost0": tu.ShardsRange(0, 29, shard.Initializing),
		"testhost1": tu.ShardsRange(0, 29, shard.Available),
		"testhost2": tu.ShardsRange(0, 29, shard.Available),
		"testhost3": tu.ShardsRange(0, 29, shard.Leaving),
	})

	// one success responses should succeed
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelUnstrictMajority,
		steps: []testFetchStateWorklowStep{
			{
				hostname:        "testhost0",
				aggregateResult: &testAggregateSuccessResponse,
			},
			{
				hostname:        "testhost1",
				aggregateResult: &testAggregateSuccessResponse,
			},
			{
				hostname:     "testhost2",
				aggregateErr: errTestAggregate,
			},
			{
				hostname:        "testhost3",
				aggregateResult: &testAggregateSuccessResponse,
				expectedDone:    true,
			},
		},
	}.run()
}

func TestAggregateResultsAccumulatorComplextTopoUnstrictMajorityPartialResponses(t *testing.T) {
	// rf=3, 30 shards total; 2 identical "complete hosts", 2 additional hosts which together comprise a "complete" host.
	topoMap := tu.MustNewTopologyMap(3, map[string][]shard.Shard{
		"testhost0": tu.ShardsRange(0, 29, shard.Available),
		"testhost1": tu.ShardsRange(0, 29, shard.Available),
		"testhost2": tu.ShardsRange(15, 29, shard.Available),
		"testhost3": tu.ShardsRange(0, 14, shard.Available),
	})

	// response from testhost2+testhost3 should be sufficient
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelUnstrictMajority,
		steps: []testFetchStateWorklowStep{
			{
				hostname:        "testhost2",
				aggregateResult: &testAggregateSuccessResponse,
			},
			{
				hostname:        "testhost3",
				aggregateResult: &testAggregateSuccessResponse,
			},
			{
				hostname:     "testhost1",
				aggregateErr: errTestAggregate,
			},
			{
				hostname:     "testhost0",
				aggregateErr: errTestAggregate,
				expectedDone: true,
			},
		},
	}.run()
}

func TestAggregateResultsAccumulatorComplexIncompleteTopoUnstrictMajorityPartialResponses(t *testing.T) {
	// rf=3, 30 shards total; 2 identical "complete hosts", 2 additional hosts which do not comprise a complete host.
	topoMap := tu.MustNewTopologyMap(3, map[string][]shard.Shard{
		"testhost0": tu.ShardsRange(0, 29, shard.Available),
		"testhost1": tu.ShardsRange(0, 29, shard.Available),
		"testhost2": tu.ShardsRange(15, 27, shard.Available),
		"testhost3": tu.ShardsRange(0, 14, shard.Available),
	})

	// response from testhost2+testhost3 should be in-sufficient, as they're not complete together
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelUnstrictMajority,
		steps: []testFetchStateWorklowStep{
			{
				hostname:        "testhost2",
				aggregateResult: &testAggregateSuccessResponse,
			},
			{
				hostname:        "testhost3",
				aggregateResult: &testAggregateSuccessResponse,
			},
			{
				hostname:     "testhost1",
				aggregateErr: errTestAggregate,
			},
			{
				hostname:     "testhost0",
				aggregateErr: errTestAggregate,
				expectedDone: true,
				expectedErr:  true,
			},
		},
	}.run()
}

func TestAggregateResultsAccumulatorReadConsitencyLevelMajority(t *testing.T) {
	// rf=3, 30 shards total; three identical hosts
	topoMap := tu.MustNewTopologyMap(3, map[string][]shard.Shard{
		"testhost0": tu.ShardsRange(0, 29, shard.Available),
		"testhost1": tu.ShardsRange(0, 29, shard.Available),
		"testhost2": tu.ShardsRange(0, 29, shard.Available),
	})

	// any single success response should not satisfy consistency majority
	for i := 0; i < 3; i++ {
		testFetchStateWorkflow{
			t:       t,
			topoMap: topoMap,
			level:   topology.ReadConsistencyLevelMajority,
			steps: []testFetchStateWorklowStep{
				{
					hostname:        fmt.Sprintf("testhost%d", i),
					aggregateResult: &testAggregateSuccessResponse,
					expectedDone:    false,
				},
			},
		}.run()
	}

	// all responses failing should fail consistency lvl majority
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelMajority,
		steps: []testFetchStateWorklowStep{
			{
				hostname:     "testhost0",
				aggregateErr: errTestAggregate,
			},
			{
				hostname:     "testhost1",
				aggregateErr: errTestAggregate,
			},
			{
				hostname:     "testhost2",
				aggregateErr: errTestAggregate,
				expectedDone: true,
				expectedErr:  true,
			},
		},
	}.run()

	// any two responses failing should fail regardless of third response
	testFetchStateWorkflow{
		t:       t,
		topoMap: topoMap,
		level:   topology.ReadConsistencyLevelMajority,
		steps: []testFetchStateWorklowStep{
			{
				hostname:     "testhost0",
				aggregateErr: errTestAggregate,
			},
			{
				hostname:        "testhost1",
				aggregateResult: &testAggregateSuccessResponse,
			},
			{
				hostname:     "testhost2",
				aggregateErr: errTestAggregate,
				expectedDone: true,
				expectedErr:  true,
			},
		},
	}.run()
}