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
|
/**
* Copyright (C) 2022-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 <boost/optional.hpp>
#include <fmt/format.h>
#include <memory>
#include <optional>
#include <sstream>
#include <string>
#include <tuple>
#include <typeinfo>
#include <utility>
#include "mongo/base/error_codes.h"
#include "mongo/base/string_data.h"
#include "mongo/stdx/type_traits.h"
#include "mongo/util/optional_util.h"
/**
* Mechanisms and extensibility hooks used by this library to format arbitrary
* user-provided objects.
*/
namespace mongo::unittest::stringify {
std::string formatTypedObj(const std::type_info& ti, StringData obj);
std::string lastResortFormat(const std::type_info& ti, const void* p, size_t sz);
/**
* `stringifyForAssert` can be overloaded to extend stringification
* capabilities of the matchers via ADL.
*
* The overload in this namespace is used for types for
* which the unittest library has built-in support.
*/
template <typename T>
std::string stringifyForAssert(const T& x);
template <typename T>
std::string doFormat(const T& x) {
return format(FMT_STRING("{}"), x);
}
template <typename T>
std::string doOstream(const T& x) {
std::ostringstream os;
os << x;
return os.str();
}
using std::begin;
using std::end;
template <typename T>
using HasToStringOp = decltype(std::declval<T>().toString());
template <typename T>
constexpr bool HasToString = stdx::is_detected_v<HasToStringOp, T>;
template <typename T>
using HasBeginEndOp =
std::tuple<decltype(begin(std::declval<T>())), decltype(end(std::declval<T>()))>;
template <typename T>
constexpr bool IsSequence = stdx::is_detected_v<HasBeginEndOp, T>;
template <typename T>
using IsTupleOp = decltype(std::tuple_size<T>::value);
template <typename T>
constexpr bool IsTuple = stdx::is_detected_v<IsTupleOp, T>;
class Joiner {
public:
template <typename T>
Joiner& operator()(const T& v) {
_out += format(FMT_STRING("{}{}"), _sep, stringifyForAssert(v));
_sep = ", ";
return *this;
}
explicit operator const std::string&() const {
return _out;
}
private:
std::string _out;
const char* _sep = "";
};
template <typename T>
std::string doSequence(const T& seq) {
std::string r;
Joiner joiner;
for (const auto& e : seq)
joiner(e);
return format(FMT_STRING("[{}]"), std::string{joiner});
}
template <typename T, size_t... Is>
std::string doTuple(const T& tup, std::index_sequence<Is...>) {
Joiner joiner;
(joiner(std::get<Is>(tup)), ...);
return format(FMT_STRING("({})"), std::string{joiner});
}
template <typename T>
std::string doTuple(const T& tup) {
return doTuple(tup, std::make_index_sequence<std::tuple_size_v<T>>{});
}
/**
* The default stringifyForAssert implementation.
* Encodes the steps by which we determine how to print an object.
* There's a wildcard branch so everything is printable in some way.
*/
template <typename T>
std::string stringifyForAssert(const T& x) {
if constexpr (optional_io::canStreamWithExtension<T>) {
return doOstream(optional_io::Extension{x});
} else if constexpr (HasToString<T>) {
return x.toString();
} else if constexpr (std::is_convertible_v<T, StringData>) {
return doFormat(StringData(x));
} else if constexpr (std::is_pointer_v<T>) {
return doFormat(static_cast<const void*>(x));
} else if constexpr (IsSequence<T>) {
return doSequence(x);
} else if constexpr (IsTuple<T>) {
return doTuple(x);
} else if constexpr (std::is_enum_v<T>) {
return formatTypedObj(typeid(T), doFormat(static_cast<std::underlying_type_t<T>>(x)));
} else {
return lastResortFormat(typeid(x), &x, sizeof(x));
}
}
/** Portably support stringifying `nullptr`. */
inline std::string stringifyForAssert(std::nullptr_t) {
return "nullptr";
}
/** Built-in support to stringify `ErrorCode::Error`. */
inline std::string stringifyForAssert(ErrorCodes::Error ec) {
return ErrorCodes::errorString(ec);
}
} // namespace mongo::unittest::stringify
|
