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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/**
* Copyright 2017 (C) MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* 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 GNU Affero General 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.
*/
#pragma once
#include <initializer_list>
#include <ostream>
#include <string>
#include "mongo/bson/bsonobj.h"
#include "mongo/bson/bsonobj_comparator_interface.h"
#include "mongo/bson/simple_bsonobj_comparator.h"
#include "mongo/bson/timestamp.h"
#include "mongo/db/catalog/collection_options.h"
#include "mongo/db/logical_session_id.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/repl/oplog_entry.h"
#include "mongo/db/repl/optime.h"
#include "mongo/db/repl/sync_tail_test_fixture.h"
#include "mongo/util/duration.h"
#include "mongo/util/uuid.h"
namespace mongo {
class Collection;
namespace repl {
struct CollectionState {
CollectionState() = default;
CollectionState(CollectionOptions collectionOptions_,
BSONObjSet indexSpecs_,
std::string dataHash_);
/**
* Compares BSON objects (BSONObj) in two sets of BSON objects (BSONObjSet) to see if the two
* sets are equivalent.
*
* Two sets are equivalent if and only if their sizes are the same and all of their elements
* that share the same index position are also equivalent in value.
*/
bool cmpIndexSpecs(const BSONObjSet& otherSpecs) const;
/**
* Returns a std::string representation of the CollectionState struct of which this is a member
* function. Returns out its representation in the form:
*
* Collection options: {...}; Index options: [...]; MD5 hash: <md5 digest string>
*/
std::string toString() const;
const CollectionOptions collectionOptions = CollectionOptions();
const BSONObjSet indexSpecs = SimpleBSONObjComparator::kInstance.makeBSONObjSet();
const std::string dataHash = "";
const bool exists = false;
};
bool operator==(const CollectionState& lhs, const CollectionState& rhs);
bool operator!=(const CollectionState& lhs, const CollectionState& rhs);
std::ostream& operator<<(std::ostream& stream, const CollectionState& state);
StringBuilderImpl<SharedBufferAllocator>& operator<<(StringBuilderImpl<SharedBufferAllocator>& sb,
const CollectionState& state);
class IdempotencyTest : public SyncTailTest {
protected:
enum class SequenceType : int { kEntireSequence, kAnyPrefix, kAnySuffix, kAnyPrefixOrSuffix };
OplogEntry createCollection(CollectionUUID uuid = UUID::gen());
OplogEntry dropCollection();
OplogEntry insert(const BSONObj& obj);
template <class IdType>
OplogEntry update(IdType _id, const BSONObj& obj);
OplogEntry buildIndex(const BSONObj& indexSpec, const BSONObj& options, UUID uuid);
OplogEntry dropIndex(const std::string& indexName);
virtual Status resetState();
/**
* This method returns true if running the list of operations a single time is equivalent to
* running them two times. It returns false otherwise.
*/
void testOpsAreIdempotent(std::vector<OplogEntry> ops,
SequenceType sequenceType = SequenceType::kEntireSequence);
/**
* This function exists to work around the issue described in SERVER-30470 by providing a
* mechanism for the RandomizedIdempotencyTest class to avoid triggering failures caused by
* differences in the ordering of fields within a document. By default it returns the document
* unchanged.
*/
virtual BSONObj canonicalizeDocumentForDataHash(const BSONObj& obj) {
return obj;
};
std::string computeDataHash(Collection* collection);
virtual std::string getStateString(const CollectionState& state1,
const CollectionState& state2,
const std::vector<OplogEntry>& ops);
/**
* Validate data and indexes. Return the MD5 hash of the documents ordered by _id.
*/
CollectionState validate();
NamespaceString nss{"test.foo"};
};
OplogEntry makeCreateCollectionOplogEntry(OpTime opTime,
const NamespaceString& nss = NamespaceString("test.t"),
const BSONObj& options = BSONObj());
OplogEntry makeInsertDocumentOplogEntry(OpTime opTime,
const NamespaceString& nss,
const BSONObj& documentToInsert);
OplogEntry makeDeleteDocumentOplogEntry(OpTime opTime,
const NamespaceString& nss,
const BSONObj& documentToDelete);
OplogEntry makeUpdateDocumentOplogEntry(OpTime opTime,
const NamespaceString& nss,
const BSONObj& documentToUpdate,
const BSONObj& updatedDocument);
OplogEntry makeCreateIndexOplogEntry(OpTime opTime,
const NamespaceString& nss,
const std::string& indexName,
const BSONObj& keyPattern,
const UUID& uuid);
OplogEntry makeCommandOplogEntry(OpTime opTime,
const NamespaceString& nss,
const BSONObj& command,
boost::optional<UUID> uuid = boost::none);
OplogEntry makeInsertDocumentOplogEntryWithSessionInfo(OpTime opTime,
const NamespaceString& nss,
const BSONObj& documentToInsert,
OperationSessionInfo info);
OplogEntry makeInsertDocumentOplogEntryWithSessionInfoAndStmtId(OpTime opTime,
const NamespaceString& nss,
const BSONObj& documentToInsert,
LogicalSessionId lsid,
TxnNumber txnNum,
StmtId stmtId);
} // namespace repl
} // namespace mongo
|
