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
|
/**
* Copyright (C) 2023-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.
*/
#include "mongo/db/exec/document_value/document.h"
#include "mongo/db/exec/document_value/document_value_test_util.h"
#include "mongo/db/exec/document_value/value.h"
#include "mongo/db/pipeline/expression_context_for_test.h"
#include "mongo/db/query/sort_pattern.h"
#include "mongo/unittest/assert.h"
#include "mongo/unittest/unittest.h"
#include "serialization_options.h"
namespace mongo {
namespace {
std::string applyHmacForTest(StringData s) {
return str::stream() << "HASH<" << s << ">";
}
auto getExpCtx() {
auto nss = NamespaceString::createNamespaceString_forTest("db", "coll");
return boost::intrusive_ptr<ExpressionContextForTest>{new ExpressionContextForTest(nss)};
}
TEST(SerializeSortPatternTest, SerializeAndRedactFieldName) {
auto expCtx = getExpCtx();
auto sortPattern = SortPattern(fromjson("{val: 1}"), expCtx);
SerializationOptions opts = {};
opts.applyHmacToIdentifiers = true;
opts.identifierHmacPolicy = applyHmacForTest;
// Most basic sort pattern, confirm that field name gets redacted.
ASSERT_DOCUMENT_EQ_AUTO( // NOLINT
R"({"HASH<val>":1})",
sortPattern.serialize(SortPattern::SortKeySerialization::kForPipelineSerialization, opts));
// Confirm that multiple sort fields get redacted.
sortPattern = SortPattern(fromjson("{val: 1, test: -1, third: -1}"), expCtx);
ASSERT_DOCUMENT_EQ_AUTO( // NOLINT
R"({"HASH<val>":1,"HASH<test>":-1,"HASH<third>":-1})",
sortPattern.serialize(SortPattern::SortKeySerialization::kForPipelineSerialization, opts));
// Test sort pattern that contains an expression.
sortPattern = SortPattern(fromjson("{val: 1, test: {$meta: \"randVal\"}}"), expCtx);
ASSERT_DOCUMENT_EQ_AUTO( // NOLINT
R"({"HASH<val>":1,"$computed1":{"$meta":"randVal"}})",
sortPattern.serialize(SortPattern::SortKeySerialization::kForPipelineSerialization, opts));
// Sorting by only an expression results in a made up field name in serialization and therefore
// doesn't get redacted.
sortPattern = SortPattern(fromjson("{val: {$meta: \"textScore\"}}"), expCtx);
ASSERT_DOCUMENT_EQ_AUTO( // NOLINT
R"({"$computed0":{"$meta":"textScore"}})",
sortPattern.serialize(SortPattern::SortKeySerialization::kForPipelineSerialization, opts));
sortPattern = SortPattern(fromjson("{'a.b.c': 1}"), expCtx);
ASSERT_DOCUMENT_EQ_AUTO( // NOLINT
R"({"HASH<a>.HASH<b>.HASH<c>":1})",
sortPattern.serialize(SortPattern::SortKeySerialization::kForPipelineSerialization, opts));
}
TEST(SerializeSortPatternTest, SerializeNoRedaction) {
auto expCtx = getExpCtx();
auto sortPattern = SortPattern(fromjson("{val: 1}"), expCtx);
SerializationOptions opts = {};
opts.applyHmacToIdentifiers = false;
ASSERT_DOCUMENT_EQ_AUTO( // NOLINT
R"({"val":1})",
sortPattern.serialize(SortPattern::SortKeySerialization::kForPipelineSerialization, opts));
// Call serialize() with no options.
ASSERT_DOCUMENT_EQ_AUTO( // NOLINT
R"({"val":1})",
sortPattern.serialize(SortPattern::SortKeySerialization::kForPipelineSerialization));
}
// Throw assertion in the case we have double defined sort order for a field.
TEST(SortStageDefaultTest, WrongSortKeyDefinition) {
auto expCtx = getExpCtx();
ASSERT_THROWS_CODE(SortPattern(fromjson("{b: 1, b: 1}"), expCtx), AssertionException, 7472500);
// Test if the sort order is ignored for the duplication detection.
ASSERT_THROWS_CODE(SortPattern(fromjson("{b: 1, b: -1}"), expCtx), AssertionException, 7472500);
// Tests that include subdocuments.
ASSERT_DOES_NOT_THROW(SortPattern(fromjson("{a:1, 'b.a':1}"), expCtx));
ASSERT_THROWS_CODE(
SortPattern(fromjson("{a:1, 'b.a':1, 'b.a':-1}"), expCtx), AssertionException, 7472500);
// Test the other SortPattern constructor.
std::vector<SortPattern::SortPatternPart> sortKeys;
sortKeys.push_back(SortPattern::SortPatternPart{false, FieldPath("a")});
sortKeys.push_back(SortPattern::SortPatternPart{false, FieldPath("b")});
sortKeys.push_back(SortPattern::SortPatternPart{true, FieldPath("a")});
ASSERT_THROWS_CODE(SortPattern(std::move(sortKeys)), AssertionException, 7472501);
}
} // namespace
} // namespace mongo
|