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
|
/**
* 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 <functional>
#include <memory>
#include <string>
#include "mongo/unittest/framework.h"
/**
* Constructs a single death test named `TEST_NAME` within the test suite `SUITE_NAME`.
*
* The test only succeeds if the process terminates abnormally, e.g. through an fassert
* failure or deadly signal.
*
* Death tests are incompatible with already-running threads. If you need multiple threads
* in your death test, start them in the test body, or use DEATH_TEST_F and start them
* in the setUp() method of the fixture.
*/
#define DEATH_TEST(SUITE_NAME, TEST_NAME, MATCH_EXPR) \
DEATH_TEST_DEFINE_(SUITE_NAME, TEST_NAME, MATCH_EXPR, ::mongo::unittest::Test)
/**
* See DEATH_TEST for details.
* Validates output is a partial match using a PCRE regular expression instead of a string match.
*/
#define DEATH_TEST_REGEX(SUITE_NAME, TEST_NAME, REGEX_EXPR) \
DEATH_TEST_DEFINE_REGEX_(SUITE_NAME, TEST_NAME, REGEX_EXPR, ::mongo::unittest::Test)
/**
* Constructs a single test named TEST_NAME that has access to a common fixture
* named `FIXTURE_NAME`, which will be used as the Suite name.
*
* See description of DEATH_TEST for more details on death tests.
*/
#define DEATH_TEST_F(FIXTURE_NAME, TEST_NAME, MATCH_EXPR) \
DEATH_TEST_DEFINE_(FIXTURE_NAME, TEST_NAME, MATCH_EXPR, FIXTURE_NAME)
#define DEATH_TEST_REGEX_F(FIXTURE_NAME, TEST_NAME, REGEX_EXPR) \
DEATH_TEST_DEFINE_REGEX_(FIXTURE_NAME, TEST_NAME, REGEX_EXPR, FIXTURE_NAME)
#define DEATH_TEST_DEFINE_(SUITE_NAME, TEST_NAME, MATCH_EXPR, TEST_BASE) \
DEATH_TEST_DEFINE_PRIMITIVE_(SUITE_NAME, \
TEST_NAME, \
MATCH_EXPR, \
false, \
UNIT_TEST_DETAIL_TEST_TYPE_NAME(SUITE_NAME, TEST_NAME), \
TEST_BASE)
#define DEATH_TEST_DEFINE_REGEX_(SUITE_NAME, TEST_NAME, REGEX_EXPR, TEST_BASE) \
DEATH_TEST_DEFINE_PRIMITIVE_(SUITE_NAME, \
TEST_NAME, \
REGEX_EXPR, \
true, \
UNIT_TEST_DETAIL_TEST_TYPE_NAME(SUITE_NAME, TEST_NAME), \
TEST_BASE)
#define DEATH_TEST_DEFINE_PRIMITIVE_( \
SUITE_NAME, TEST_NAME, MATCH_EXPR, IS_REGEX, TEST_TYPE, TEST_BASE) \
class TEST_TYPE : public TEST_BASE { \
public: \
static std::string getPattern() { \
return MATCH_EXPR; \
} \
\
static bool isRegex() { \
return IS_REGEX; \
} \
\
static int getLine() { \
return __LINE__; \
} \
\
static std::string getFile() { \
return __FILE__; \
} \
\
private: \
void _doTest() override; \
static inline const ::mongo::unittest::TestInfo _testInfo{ \
#SUITE_NAME, #TEST_NAME, __FILE__, __LINE__}; \
static inline const RegistrationAgent<::mongo::unittest::DeathTest<TEST_TYPE>> _agent{ \
&_testInfo}; \
}; \
void TEST_TYPE::_doTest()
namespace mongo::unittest {
class DeathTestBase : public Test {
public:
/**
* A test can use this to opt-out of exec behavior.
* Would have to be called by the constructor. By the time the test body is
* running, it's too late.
*/
void setExec(bool enable) {
_exec = enable;
}
protected:
DeathTestBase() = default;
private:
struct Subprocess;
// Forks, executes _doMakeTest() in the child process to create a Test, then runs that Test.
void _doTest() final;
// Customization points for derived DeathTest classes.
virtual std::unique_ptr<Test> _doMakeTest() = 0;
virtual std::string _doGetPattern() = 0;
virtual bool _isRegex() = 0;
virtual int _getLine() = 0;
virtual std::string _getFile() = 0;
/**
* All death tests will fork a subprocess.
* Some will be configured to then go ahead and exec.
*/
bool _exec = true;
};
template <typename T>
class DeathTest : public DeathTestBase {
public:
template <typename... Args>
explicit DeathTest(Args&&... args)
: _makeTest([args...] { return std::make_unique<T>(args...); }) {}
private:
std::string _doGetPattern() override {
return T::getPattern();
}
bool _isRegex() override {
return T::isRegex();
}
int _getLine() override {
return T::getLine();
}
std::string _getFile() override {
return T::getFile();
}
std::unique_ptr<Test> _doMakeTest() override {
return _makeTest();
}
std::function<std::unique_ptr<Test>()> _makeTest;
};
} // namespace mongo::unittest
|
