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) 2021-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 <algorithm>
#include <fmt/format.h>
#include <memory>
#include <string>
#include <tuple>
#include <typeinfo>
#include <utility>
#include "mongo/base/string_data.h"
#include "mongo/stdx/type_traits.h"
#include "mongo/unittest/assert.h"
#include "mongo/unittest/stringify.h"
#include "mongo/util/optional_util.h"
/**
* This file defines infrastructure used in the ASSERT_THAT system.
* (See `assert_that.h`).
*
* It also contains utilities that can be reused in the implementation of
* matcher types. The basic set of matchers are defined in `matcher.h`.
*/
namespace mongo::unittest::match {
/**
* A result returned by a Matcher's `match` function. The `message` should only
* be given if it contains information than the matcher's description or the
* match's stringified input value.
*/
class MatchResult {
public:
MatchResult() = default;
/* implicit */ MatchResult(bool ok) : _ok{ok} {}
MatchResult(bool ok, std::string msg) : _ok{ok}, _msg{std::move(msg)} {}
explicit operator bool() const {
return _ok;
}
const std::string& message() const {
return _msg;
}
private:
bool _ok = true;
std::string _msg;
};
/**
* Base class that identifies matchers.
* Technically doesn't do anything but indicate intent.
*
* Conceptually, a Matcher `m` must have:
*
* m.describe() -> std::string
*
* Returns a very compact description of the matcher.
*
* And for some value `v`:
*
* m.match(v) -> MatchResult
*
* Returns a true MatchResult if match succeeds.
* Otherwise false and a more detailed message only if necessary.
*
* `match` should be SFINAE-friendly and only participate in overload
* resolution if the type of `v` can be matched.
*
* Matchers must be copyable.
*/
class Matcher {};
namespace detail {
/**
* Describes a tuple of matchers. This is just a comma-separated list of descriptions.
* Used in the `describe()` function of variadic matchers.
*/
template <typename MTuple, size_t I = 0>
std::string describeTupleOfMatchers(const MTuple& ms, stringify::Joiner&& joiner = {}) {
if constexpr (I == std::tuple_size_v<MTuple>) {
return std::string{joiner};
} else {
joiner(std::get<I>(ms).describe());
return describeTupleOfMatchers<MTuple, I + 1>(ms, std::move(joiner));
}
}
/**
* Describe an array of MatchResult that was generated by a tuple of
* matchers. Returns a string describing only the failed match results, each
* preceded by an indication of its array position.
*
* Used in the production of MatchResult strings for variadic matchers.
*/
template <typename MTuple, size_t N, size_t I = 0>
std::string matchTupleMessage(const MTuple& ms,
const std::array<MatchResult, N>& arr,
stringify::Joiner&& joiner = {}) {
if constexpr (I == std::tuple_size_v<MTuple>) {
return format(FMT_STRING("failed: [{}]"), std::string{joiner});
} else {
auto&& ri = arr[I];
if (!ri) {
joiner(format(FMT_STRING("{}:({}{}{})"),
I,
std::get<I>(ms).describe(),
ri.message().empty() ? "" : ":",
ri.message()));
}
return matchTupleMessage<MTuple, N, I + 1>(ms, arr, std::move(joiner));
}
}
template <typename E, typename M>
struct MatchAssertion {
MatchAssertion(const E& e, const M& m, const char* eStr) : mr{m.match(e)} {
if (!mr) {
msg = format(FMT_STRING("value: {}, actual: {}{}, expected: {}"),
eStr,
stringify::stringifyForAssert(e),
mr.message().empty() ? "" : format(FMT_STRING(", {}"), mr.message()),
m.describe());
}
}
explicit operator bool() const {
return !!mr;
}
const std::string& failMsg() const {
return msg;
}
MatchResult mr;
std::string msg;
};
} // namespace detail
} // namespace mongo::unittest::match
|
