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
|
/**
* 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 <boost/filesystem.hpp>
#include <boost/filesystem/path.hpp>
#include <map>
#include <set>
#include <string>
#include "mongo/base/string_data.h"
#include "mongo/bson/bsonelement.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/client/connection_string.h"
#include "mongo/client/mongo_uri.h"
#include "mongo/db/jsobj.h"
#include "mongo/platform/mutex.h"
#include "mongo/util/concurrency/mutex.h"
namespace mongo {
class Scope;
class DBClientBase;
namespace shell_utils {
bool isBalanced(const std::string& code);
extern std::string dbConnect;
using EnterpriseShellCallback = void(Scope&);
void RecordMyLocation(const char* _argv0);
void installShellUtils(Scope& scope);
void initScope(Scope& scope);
void onConnect(DBClientBase& c, StringData uri);
boost::filesystem::path getHistoryFilePath();
void setEnterpriseShellCallback(EnterpriseShellCallback* callback);
BSONElement singleArg(const BSONObj& args);
extern const BSONObj undefinedReturn;
/** Prompt for confirmation from cin. */
class Prompter {
public:
Prompter(const std::string& prompt);
/** @return prompted confirmation or cached confirmation. */
bool confirm();
private:
const std::string _prompt;
bool _confirmed;
};
/** Registry of server connections. */
class ConnectionRegistry {
public:
ConnectionRegistry();
void registerConnection(DBClientBase& client, StringData uri);
void killOperationsOnAllConnections(bool withPrompt) const;
private:
std::map<std::string, std::set<std::string>> _connectionUris;
mutable Mutex _mutex = MONGO_MAKE_LATCH("ConnectionRegistry::_mutex");
};
extern ConnectionRegistry connectionRegistry;
// Helper to tell if a file exists cross platform
// TODO: Remove this when we have a cross platform file utility library
bool fileExists(const std::string& file);
// If the test began a GoldenTestContext, end it and compare actual/expected results.
void closeGoldenTestContext();
/**
* Thrown when a GoldenTestContextShell test fails.
*/
struct GoldenTestContextShellFailure {
std::string message;
std::string actualOutputFile;
std::string expectedOutputFile;
std::string toString() const;
void diff() const;
};
enum class NormalizationOpts : uint32_t {
kResults = 0,
// Set this bit to sort an array of results. Used in QueryTester.
kSortResults = 1 << 0,
// Set this bit to sort fields in the BSONObj.
kSortBSON = 1 << 1,
// Set this bit to sort arrays in the BSONObj.
kSortArrays = 1 << 2,
// Set this bit to normalize numerics.
kNormalizeNumerics = 1 << 3,
// Set this bit to treat null and missing as the same value.
kConflateNullAndMissing = 1 << 4,
};
using NormalizationOptsSet = NormalizationOpts;
inline NormalizationOpts operator&(NormalizationOpts lhs, NormalizationOpts rhs) {
return static_cast<NormalizationOpts>(static_cast<uint32_t>(lhs) & static_cast<uint32_t>(rhs));
}
inline NormalizationOpts operator|(NormalizationOpts lhs, NormalizationOpts rhs) {
return static_cast<NormalizationOpts>(static_cast<uint32_t>(lhs) | static_cast<uint32_t>(rhs));
}
inline bool isSet(NormalizationOpts opts, NormalizationOpts flag) {
return (opts & flag) != NormalizationOpts::kResults;
}
// Sorts a vector of BSON objects by their fields as they appear in the BSON.
void sortQueryResults(std::vector<BSONObj>& input);
/**
* Normalizes a BSONObj for more flexible results comparison. By default, this will return the
* BSONObj with no changes.
*
* If the kSortBSON bit, this method will return a new BSON with the same field/value
* pairings, but recursively sorted by the fields. If the kSortArrays bit is set, this method will
* also recursively sort the BSONObj's arrays. If the kNormalizeNumerics bit is set, this method
* will normalize numerics by casting them to the widest type, Decimal128, and normalizing them to
* the maximum precision. If the kConflateNullAndMissing bit is set, this method will treat null,
* undefined, and missing fields as the same by removing null and undefined values.
*/
BSONObj normalizeBSONObj(const BSONObj& input,
NormalizationOptsSet opts = NormalizationOpts::kResults);
} // namespace shell_utils
} // namespace mongo
|
