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
|
/**
* 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.
*/
#include <vector>
#include "mongo/base/init.h"
#include "mongo/db/auth/action_set.h"
#include "mongo/db/auth/action_type.h"
#include "mongo/db/auth/privilege.h"
#include "mongo/db/commands.h"
#include "mongo/db/commands/test_commands_enabled.h"
#include "mongo/s/request_types/wait_for_fail_point_gen.h"
#include "mongo/util/fail_point.h"
namespace mongo {
/**
* Command for modifying installed fail points.
*
* Format
* {
* configureFailPoint: <string>, // name of the fail point.
*
* mode: <string|Object>, // the new mode to set. Can have one of the following format:
*
* - 'off' - disable fail point.
*
* - 'alwaysOn' - fail point is always active.
*
* - { activationProbability: <n> } - double n. [0 <= n <= 1]
* n: the probability that the fail point will fire. 0=never, 1=always.
*
* - { times: <n> } - int32 n. n > 0. n: # of passes the fail point remains active.
*
* - { skip: <n> } - int32 n. n > 0. n: # of passes before the fail point activates
* and remains active.
*
* data: <Object> // optional arbitrary object to inject into the failpoint.
* When activated, the FailPoint can read this data and it can be used to inform
* the specific action taken by the code under test.
* }
*/
class FaultInjectCmd : public BasicCommand {
public:
FaultInjectCmd() : BasicCommand("configureFailPoint") {}
AllowedOnSecondary secondaryAllowed(ServiceContext*) const override {
return AllowedOnSecondary::kAlways;
}
bool supportsWriteConcern(const BSONObj& cmd) const override {
return false;
}
bool adminOnly() const override {
return true;
}
bool requiresAuth() const override {
return false;
}
// No auth needed because it only works when enabled via command line.
Status checkAuthForOperation(OperationContext* opCtx,
const DatabaseName& dbName,
const BSONObj& cmdObj) const override {
return Status::OK();
}
std::string help() const override {
return "modifies the settings of a fail point";
}
bool run(OperationContext* opCtx,
const DatabaseName&,
const BSONObj& cmdObj,
BSONObjBuilder& result) override {
const std::string failPointName(cmdObj.firstElement().str());
const auto timesEntered = setGlobalFailPoint(failPointName, cmdObj);
result.appendNumber("count", timesEntered);
return true;
}
};
/**
* Command for waiting for installed fail points.
*
* For number of additional times entered > 1, this command is only guaranteed to work
* correctly if the code that enters the fail point uses the FailPoint API correctly.
* That is, the code can only use one of shouldFail, pauseWhileSet, scopedIf, scoped,
* executeIf, and execute to enter the fail point (as all of these functions have side
* effects on the counter for times entered).
*/
class WaitForFailPointCommand : public TypedCommand<WaitForFailPointCommand> {
public:
using Request = WaitForFailPoint;
class Invocation final : public InvocationBase {
public:
using InvocationBase::InvocationBase;
void typedRun(OperationContext* opCtx) {
const std::string failPointName = request().getCommandParameter().toString();
FailPoint* failPoint = globalFailPointRegistry().find(failPointName);
if (failPoint == nullptr)
uasserted(ErrorCodes::FailPointSetFailed, failPointName + " not found");
failPoint->waitForTimesEntered(opCtx, request().getTimesEntered());
}
private:
bool supportsWriteConcern() const override {
return false;
}
// The command parameter happens to be string so it's historically been interpreted
// by parseNs as a collection. Continuing to do so here for unexamined compatibility.
NamespaceString ns() const override {
return NamespaceString(request().getDbName(), "");
}
// No auth needed because it only works when enabled via command line.
void doCheckAuthorization(OperationContext* opCtx) const override {}
};
std::string help() const override {
return "wait for a fail point to be entered a certain number of times";
}
AllowedOnSecondary secondaryAllowed(ServiceContext*) const override {
return AllowedOnSecondary::kAlways;
}
bool adminOnly() const override {
return true;
}
bool requiresAuth() const override {
return false;
}
} WaitForFailPointCmd;
MONGO_REGISTER_TEST_COMMAND(FaultInjectCmd);
} // namespace mongo
|
