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
|
/**
* Copyright (C) 2018-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.
*/
#pragma once
#include "mongo/platform/basic.h"
#include "mongo/db/read_write_concern_defaults_cache_lookup_mock.h"
#include "mongo/s/catalog_cache_test_fixture.h"
namespace mongo {
using InspectionCallback = std::function<void(const executor::RemoteCommandRequest& request)>;
class ClusterCommandTestFixture : public CatalogCacheTestFixture {
protected:
const size_t numShards = 2;
const NamespaceString kNss = NamespaceString::createNamespaceString_forTest("test", "coll");
const LogicalTime kInMemoryLogicalTime = LogicalTime(Timestamp(10, 1));
const Timestamp kAfterClusterTime = Timestamp(50, 2);
void setUp() override;
virtual void expectInspectRequest(int shardIndex, InspectionCallback cb) = 0;
virtual void expectReturnsSuccess(int shardIndex) = 0;
void expectReturnsError(ErrorCodes::Error code);
void expectAbortTransaction();
DbResponse runCommand(BSONObj cmd);
DbResponse runCommandSuccessful(BSONObj cmd, bool isTargeted);
void runTxnCommandOneError(BSONObj cmd, ErrorCodes::Error code, bool isTargeted);
void runCommandInspectRequests(BSONObj cmd, InspectionCallback cb, bool isTargeted);
void runTxnCommandMaxErrors(BSONObj cmd, ErrorCodes::Error code, bool isTargeted);
/**
* Verifies that running the given commands through mongos will succeed.
*/
void testNoErrors(BSONObj targetedCmd, BSONObj scatterGatherCmd = BSONObj());
/**
* Verifies that the given commands will retry on a snapshot error.
*/
void testRetryOnSnapshotError(BSONObj targetedCmd, BSONObj scatterGatherCmd = BSONObj());
/**
* Verifies that the given commands will retry up to the max retry attempts on snapshot
* errors then return the final errors they receive.
*/
void testMaxRetriesSnapshotErrors(BSONObj targetedCmd, BSONObj scatterGatherCmd = BSONObj());
/**
* Verifies that atClusterTime is attached to the given commands.
*/
void testAttachesAtClusterTimeForSnapshotReadConcern(BSONObj targetedCmd,
BSONObj scatterGatherCmd = BSONObj());
/**
* Verifies that the chosen atClusterTime is greater than or equal to each command's
* afterClusterTime.
*/
void testSnapshotReadConcernWithAfterClusterTime(BSONObj targetedCmd,
BSONObj scatterGatherCmd = BSONObj());
/**
* Appends the metadata shards return on responses to transaction statements, such as the
* readOnly field.
*/
void appendTxnResponseMetadata(BSONObjBuilder& bob);
private:
/**
* Makes a new command object from the one given by apppending read concern
* snapshot and the appropriate transaction options. If includeAfterClusterTime
* is true, also appends afterClusterTime to the read concern.
*/
BSONObj _makeCmd(BSONObj cmdObj, bool includeAfterClusterTime = false);
// Enables the transaction router to retry within a transaction on stale version and snapshot
// errors for the duration of each test.
// TODO SERVER-39704: Remove this failpoint block.
std::unique_ptr<FailPointEnableBlock> _staleVersionAndSnapshotRetriesBlock;
ReadWriteConcernDefaultsLookupMock _lookupMock;
};
} // namespace mongo
|
