1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/**
* Copyright (C) 2021-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#include "mongo/client/sdam/election_id_set_version_pair.h"
#include "mongo/unittest/unittest.h"
namespace mongo::sdam {
namespace {
class ElectionIdSetVersionPairTest : public unittest::Test {
public:
static inline const OID kOidOne{"000000000000000000000001"};
static inline const OID kOidTwo{"000000000000000000000002"};
static inline const boost::optional<OID> kNullOid;
static inline const boost::optional<int> kNullSet;
enum class Compare {
kEquals,
kLess,
kGreater,
// When any compare operator returns false.
kNotComparable
};
enum class Consistency { kConsistent, kInconsistent };
struct TestCase {
// Curent topology max fields.
const boost::optional<OID> kTerm1;
const boost::optional<int> kSet1;
// Incoming primary fields.
const boost::optional<OID> kTerm2;
const boost::optional<int> kSet2;
const Compare compare;
const Consistency consistent;
};
std::string log(const TestCase& t, int testNum) {
str::stream s;
s << "[" << t.kTerm1 << ", " << t.kSet1 << "][" << t.kTerm2 << ", " << t.kSet2 << "]";
s << ", test=" << testNum;
return s;
}
void test(const TestCase& t, int testNum) {
ElectionIdSetVersionPair p1{t.kTerm1, t.kSet1};
ElectionIdSetVersionPair p2{t.kTerm2, t.kSet2};
switch (t.compare) {
case Compare::kEquals:
ASSERT_TRUE(p1 == p2) << log(t, testNum);
break;
case Compare::kLess:
ASSERT_TRUE(p1 < p2) << log(t, testNum);
break;
case Compare::kGreater:
ASSERT_TRUE(p1 > p2) << log(t, testNum);
break;
case Compare::kNotComparable:
ASSERT_FALSE(p1 > p2) << log(t, testNum);
ASSERT_FALSE(p1 < p2) << log(t, testNum);
ASSERT_FALSE(p1 == p2) << log(t, testNum);
break;
}
const bool isConsistent = isIncomingPrimaryConsistent(p1, p2);
ASSERT_EQ(t.consistent == Consistency::kConsistent, isConsistent) << log(t, testNum);
}
};
TEST_F(ElectionIdSetVersionPairTest, ExpectedOutcome) {
std::vector<TestCase> tests = {
// At startup, both current fields are not set.
{kNullOid, kNullSet, kOidOne, 1, Compare::kNotComparable, Consistency::kConsistent},
{kOidOne, 1, kOidOne, 1, Compare::kEquals, Consistency::kConsistent},
// One field is not set. This should never happen however added for better
// coverage for malformed protocol.
{kNullOid, 1, kOidOne, 1, Compare::kNotComparable, Consistency::kConsistent},
{kOidOne, kNullSet, kOidOne, 1, Compare::kNotComparable, Consistency::kConsistent},
{kOidOne, 1, kNullOid, 1, Compare::kNotComparable, Consistency::kInconsistent},
{kOidOne, 1, kOidOne, kNullSet, Compare::kNotComparable, Consistency::kInconsistent},
// Primary advanced one way or another. "Less" means current < incoming.
{kOidOne, 1, kOidTwo, 1, Compare::kLess, Consistency::kConsistent},
{kOidOne, 1, kOidOne, 2, Compare::kLess, Consistency::kConsistent},
// Primary advanced but current state is incomplete.
{kNullOid, 1, kOidTwo, 1, Compare::kNotComparable, Consistency::kConsistent},
{kNullOid, 1, kOidOne, 2, Compare::kNotComparable, Consistency::kConsistent},
{kOidOne, kNullSet, kOidTwo, 1, Compare::kLess, Consistency::kConsistent},
{kOidOne, kNullSet, kOidOne, 2, Compare::kNotComparable, Consistency::kConsistent},
// Primary went backwards one way or another.
// Inconsistent because Set version went backwards without Term being changed (same
// primary).
{kOidTwo, 2, kOidTwo, 1, Compare::kGreater, Consistency::kInconsistent},
{kOidTwo, 2, kOidOne, 2, Compare::kGreater, Consistency::kConsistent},
// Primary went backwards with current state incomplete.
{kNullOid, 2, kOidTwo, 1, Compare::kNotComparable, Consistency::kConsistent},
{kOidTwo, kNullSet, kOidOne, 1, Compare::kGreater, Consistency::kConsistent},
// Stale primary case when Term went backwards but Set version advanced.
// This case is 'consistent' because it's normal for stale primary. The
// important part is that 'current' > 'incoming', which makes the node 'Unknown'.
{kOidTwo, 1, kOidOne, 2, Compare::kGreater, Consistency::kConsistent},
// Previous primary was unable to replicate the Set version before failover,
// new primary forces it to be rolled back.
{kOidOne, 2, kOidTwo, 1, Compare::kLess, Consistency::kConsistent},
};
int testNum = 0;
for (const auto& t : tests) {
test(t, testNum++);
}
}
} // namespace
} // namespace mongo::sdam
|
