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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
/**
* 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/util/future.h"
#include "mongo/stdx/thread.h"
#include "mongo/unittest/death_test.h"
#include "mongo/unittest/unittest.h"
#include "mongo/util/executor_test_util.h"
#if !defined(__has_feature)
#define __has_feature(x) 0
#endif
/** Workaround for bug in MSVC 2022's lambda processor. See SERVER-62480. */
#ifdef _MSC_VER
#define FTU_LAMBDA_R(...) ->__VA_ARGS__
#else
#define FTU_LAMBDA_R(...)
#endif
namespace mongo {
enum DoExecutorFuture : bool {
// Force exemptions to say *why* they shouldn't test ExecutorFuture to ensure that if the
// reason stops applying (eg, if we implement ExecutorFuture::tap()) we can delete the enum
// value and recover the test coverage.
kNoExecutorFuture_needsTap = false,
kNoExecutorFuture_needsPromiseSetFrom = false,
kDoExecutorFuture = true,
};
class DummyInterruptible final : public Interruptible {
StatusWith<stdx::cv_status> waitForConditionOrInterruptNoAssertUntil(
stdx::condition_variable& cv, BasicLockableAdapter m, Date_t deadline) noexcept override {
return Status(ErrorCodes::Interrupted, "");
}
Date_t getDeadline() const override {
MONGO_UNREACHABLE;
}
Status checkForInterruptNoAssert() noexcept override {
// Must be implemented because it's called by Interruptible::waitForConditionOrInterrupt.
return Status::OK();
}
DeadlineState pushArtificialDeadline(Date_t deadline, ErrorCodes::Error error) override {
MONGO_UNREACHABLE;
}
void popArtificialDeadline(DeadlineState) override {
MONGO_UNREACHABLE;
}
Date_t getExpirationDateForWaitForValue(Milliseconds waitFor) override {
return Date_t::now() + waitFor;
}
};
template <typename T, typename Func>
void completePromise(Promise<T>* promise, Func&& func) {
promise->emplaceValue(func());
}
template <typename Func>
void completePromise(Promise<void>* promise, Func&& func) {
func();
promise->emplaceValue();
}
inline void sleepIfShould() {
#if !__has_feature(thread_sanitizer)
// TSAN and rr work better without this sleep, but it is useful for testing correctness.
static const bool runningUnderRR = getenv("RUNNING_UNDER_RR") != nullptr;
if (!runningUnderRR)
sleepmillis(100); // Try to wait until after the Future has been handled.
#endif
}
template <typename Func, typename Result = std::invoke_result_t<Func&&>>
Future<Result> async(Func&& func) {
auto pf = makePromiseFuture<Result>();
stdx::thread([promise = std::move(pf.promise), func = std::forward<Func>(func)]() mutable {
sleepIfShould();
try {
completePromise(&promise, func);
} catch (const DBException& ex) {
promise.setError(ex.toStatus());
}
}).detach();
return std::move(pf.future);
}
inline Status failStatus() {
return Status(ErrorCodes::Error(50728), "expected failure");
}
#define ASSERT_THROWS_failStatus(expr) \
[&] { \
ASSERT_THROWS_WITH_CHECK(expr, DBException, [](const DBException& ex) { \
ASSERT_EQ(ex.toStatus(), failStatus()); \
}); \
}()
// Tests a Future completed by completionExpr using testFunc. The Future will be completed in
// various ways to maximize test coverage.
template <DoExecutorFuture doExecutorFuture = kDoExecutorFuture,
typename CompletionFunc,
typename TestFunc,
typename = std::enable_if_t<!std::is_void<std::invoke_result_t<CompletionFunc>>::value>>
void FUTURE_SUCCESS_TEST(const CompletionFunc& completion, const TestFunc& test) {
using CompletionType = decltype(completion());
{ // immediate future
test(Future<CompletionType>::makeReady(completion()));
}
{ // ready future from promise
auto pf = makePromiseFuture<CompletionType>();
pf.promise.emplaceValue(completion());
test(std::move(pf.future));
}
{ // async future
test(async([&] { return completion(); }));
}
if constexpr (doExecutorFuture) { // immediate executor future
auto exec = InlineQueuedCountingExecutor::make();
test(Future<CompletionType>::makeReady(completion()).thenRunOn(exec));
}
}
template <DoExecutorFuture doExecutorFuture = kDoExecutorFuture,
typename CompletionFunc,
typename TestFunc,
typename = std::enable_if_t<std::is_void<std::invoke_result_t<CompletionFunc>>::value>,
typename = void>
void FUTURE_SUCCESS_TEST(const CompletionFunc& completion, const TestFunc& test) {
using CompletionType = decltype(completion());
{ // immediate future
completion();
test(Future<CompletionType>::makeReady());
}
{ // ready future from promise
auto pf = makePromiseFuture<CompletionType>();
completion();
pf.promise.emplaceValue();
test(std::move(pf.future));
}
{ // async future
test(async([&] { return completion(); }));
}
if constexpr (doExecutorFuture) { // immediate executor future
completion();
auto exec = InlineQueuedCountingExecutor::make();
test(Future<CompletionType>::makeReady().thenRunOn(exec));
}
}
template <typename CompletionType,
DoExecutorFuture doExecutorFuture = kDoExecutorFuture,
typename TestFunc>
void FUTURE_FAIL_TEST(const TestFunc& test) {
{ // immediate future
test(Future<CompletionType>::makeReady(failStatus()));
}
{ // ready future from promise
auto pf = makePromiseFuture<CompletionType>();
pf.promise.setError(failStatus());
test(std::move(pf.future));
}
{ // async future
test(async([&]() -> CompletionType {
uassertStatusOK(failStatus());
MONGO_UNREACHABLE;
}));
}
if constexpr (doExecutorFuture) { // immediate executor future
auto exec = InlineQueuedCountingExecutor::make();
test(Future<CompletionType>::makeReady(failStatus()).thenRunOn(exec));
}
}
/**
* True if PromiseT::setFrom(ArgT) is valid.
*/
template <typename PromiseT, typename ArgT, typename = void>
inline constexpr bool canSetFrom = false;
template <typename PromiseT>
inline constexpr bool canSetFrom<PromiseT, //
void, //
decltype(std::declval<PromiseT&>().setFrom())> = true;
template <typename PromiseT, typename ArgT>
inline constexpr bool
canSetFrom<PromiseT, //
ArgT, //
decltype(std::declval<PromiseT&>().setFrom(std::declval<ArgT>()))> = true;
} // namespace mongo
|
