aboutsummaryrefslogtreecommitdiffstats
path: root/searchlib/src/tests/grouping/grouping_serialization_test.cpp
blob: 5525e663db305334d3d65fb3ba630c660c532c24 (plain) (blame)
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
// Unit tests for grouping_serialization.

#include <vespa/searchlib/aggregation/aggregation.h>
#include <vespa/searchlib/aggregation/expressioncountaggregationresult.h>
#include <vespa/searchlib/aggregation/perdocexpression.h>
#include <vespa/searchlib/expression/getdocidnamespacespecificfunctionnode.h>
#include <vespa/searchlib/expression/getymumchecksumfunctionnode.h>
#include <vespa/searchlib/expression/documentfieldnode.h>
#include <vespa/document/base/documentid.h>
#include <vespa/vespalib/testkit/test_kit.h>
#include <fstream>
#include <vespa/log/log.h>
LOG_SETUP("grouping_serialization_test");

using search::HitRank;
using vespalib::Identifiable;
using vespalib::NBOSerializer;
using vespalib::make_string;
using vespalib::nbostream;
using namespace search::aggregation;
using namespace search::expression;

namespace {

document::GlobalId getGlobalId(uint32_t docId) {
    return document::DocumentId(vespalib::make_string("id:test:type::%u", docId))
        .getGlobalId();
}

#define MU std::make_unique

struct Fixture {
    // Set WRITE_FILES to true to generate new expected serialization files.
    const bool WRITE_FILES = false;
    const std::string file_path = TEST_PATH("../../test/files/");
    std::string file_name;
    std::ifstream file_stream;

    Fixture(const std::string &file_name_in)
        : file_name(file_path + file_name_in),
          file_stream(file_name.c_str(),
                      std::ifstream::in | std::ifstream::binary) {
        if (WRITE_FILES) {
            std::ofstream out(file_name.c_str(),
                              std::ofstream::out | std::ofstream::trunc |
                              std::ofstream::binary);
        }
    }

    void checkObject(const Identifiable &obj) {
        if (WRITE_FILES) {
            nbostream stream;
            NBOSerializer serializer(stream);
            serializer << obj;
            std::ofstream out(file_name.c_str(),
                              std::ofstream::out | std::ofstream::app |
                              std::ofstream::binary);
            uint32_t size = stream.size();
            out.write(reinterpret_cast<const char *>(&size), sizeof(size));
            out.write(stream.peek(), stream.size());
        }

        uint32_t size = 0;
        file_stream.read(reinterpret_cast<char *>(&size), sizeof(size));
        nbostream stream;
        for (size_t i = 0; i < size; ++i) {
            char c;
            file_stream.read(&c, sizeof(c));
            stream << c;
        }
        Identifiable::UP newObj = Identifiable::create(stream);

        if (!EXPECT_TRUE(newObj.get() != 0)) {
            LOG(error, "object of class '%s' resulted in empty echo", obj.getClass().name());
            return;
        }
        if (EXPECT_EQUAL(obj.asString(), newObj->asString())
            && EXPECT_TRUE(newObj->cmp(obj) == 0)
            && EXPECT_TRUE(obj.cmp(*newObj) == 0))
        {
            LOG(debug, "object of class '%s' passed echo test : %s", obj.getClass().name(), newObj->asString().c_str());
        } else {
            LOG(error, "object of class '%s' FAILED echo test", obj.getClass().name());
        }
    }
};

//-----------------------------------------------------------------------------

ExpressionNode::UP
createDummyExpression() {
    std::unique_ptr<AddFunctionNode> f = MU<AddFunctionNode>();
    f->addArg(MU<ConstantNode>(MU<Int64ResultNode>(2))).addArg(MU<ConstantNode>(MU<Int64ResultNode>(2)));
    return f;
}

//-----------------------------------------------------------------------------

TEST_F("testResultTypes", Fixture("testResultTypes")) {
    f.checkObject(Int64ResultNode(7));
    f.checkObject(FloatResultNode(7.3));
    f.checkObject(StringResultNode("7.3"));
    {
        char tmp[7] = { (char)0xe5, (char)0xa6, (char)0x82, (char)0xe6,
                        (char)0x9e, (char)0x9c,0 };
        f.checkObject(StringResultNode(tmp));
    }
    {
        char tmp[] = { '7', '.', '4' };
        f.checkObject(RawResultNode(tmp, 3));
    }
    f.checkObject(IntegerBucketResultNode());
    f.checkObject(FloatBucketResultNode());
    f.checkObject(IntegerBucketResultNode(10, 20));
    f.checkObject(FloatBucketResultNode(10.0, 20.0));
    f.checkObject(StringBucketResultNode("10.0", "20.0"));
    char tmp[] = { 1, 0, 0};
    char tmp2[] = { 1, 1, 0};
    f.checkObject(
            RawBucketResultNode(ResultNode::UP(new RawResultNode(tmp, 3)),
                                ResultNode::UP(new RawResultNode(tmp2, 3))));

    IntegerBucketResultNodeVector iv;
    iv.getVector().push_back(IntegerBucketResultNode(878, 3246823));
    f.checkObject(iv);

    FloatBucketResultNodeVector fv;
    fv.getVector().push_back(FloatBucketResultNode(878, 3246823));
    f.checkObject(fv);

    StringBucketResultNodeVector sv;
    sv.getVector().push_back(StringBucketResultNode("878", "3246823"));
    f.checkObject(sv);

    RawBucketResultNodeVector rv;
    rv.getVector().push_back(
            RawBucketResultNode(ResultNode::UP(new RawResultNode(tmp, 3)),
                                ResultNode::UP(new RawResultNode(tmp2, 3))));
    f.checkObject(rv);
}

TEST_F("testSpecialNodes", Fixture("testSpecialNodes")) {
    f.checkObject(AttributeNode("testattribute"));
    f.checkObject(DocumentFieldNode("testdocumentfield"));
    {
        f.checkObject(GetDocIdNamespaceSpecificFunctionNode(
                        ResultNode::UP(new Int64ResultNode(7))));
    }
}

TEST_F("testFunctionNodes", Fixture("testFunctionNodes")) {
    f.checkObject(AddFunctionNode()
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(7)))
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(8)))
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(9))));
    f.checkObject(XorFunctionNode()
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(7)))
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(8)))
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(9))));
    f.checkObject(MultiplyFunctionNode()
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(7)))
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(8)))
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(9))));
    f.checkObject(DivideFunctionNode()
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(7)))
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(8)))
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(9))));
    f.checkObject(ModuloFunctionNode()
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(7)))
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(8)))
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(9))));
    f.checkObject(MinFunctionNode()
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(7)))
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(8)))
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(9))));
    f.checkObject(MaxFunctionNode()
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(7)))
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(8)))
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(9))));
    f.checkObject(TimeStampFunctionNode(MU<ConstantNode>(MU<Int64ResultNode>(7)),
                                      TimeStampFunctionNode::Hour, true));
    f.checkObject(ZCurveFunctionNode(MU<ConstantNode>(MU<Int64ResultNode>(7)),
                                   ZCurveFunctionNode::X));
    f.checkObject(ZCurveFunctionNode(MU<ConstantNode>(MU<Int64ResultNode>(7)),
                                   ZCurveFunctionNode::Y));
    f.checkObject(NegateFunctionNode(MU<ConstantNode>(MU<Int64ResultNode>(7))));
    f.checkObject(SortFunctionNode(MU<ConstantNode>(MU<Int64ResultNode>(7))));
    f.checkObject(NormalizeSubjectFunctionNode(MU<ConstantNode>(MU<StringResultNode>("foo"))));
    f.checkObject(ReverseFunctionNode(MU<ConstantNode>(MU<Int64ResultNode>(7))));
    f.checkObject(MD5BitFunctionNode(MU<ConstantNode>(MU<Int64ResultNode>(7)), 64));
    f.checkObject(XorBitFunctionNode(MU<ConstantNode>(MU<Int64ResultNode>(7)), 64));
    f.checkObject(CatFunctionNode()
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(7)))
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(8)))
                .addArg(MU<ConstantNode>(MU<Int64ResultNode>(9))));
    f.checkObject(FixedWidthBucketFunctionNode());
    f.checkObject(FixedWidthBucketFunctionNode(MU<AttributeNode>("foo")));
    f.checkObject(FixedWidthBucketFunctionNode(MU<AttributeNode>("foo"))
                .setWidth(Int64ResultNode(10)));
    f.checkObject(FixedWidthBucketFunctionNode(MU<AttributeNode>("foo"))
                .setWidth(FloatResultNode(10.0)));
    f.checkObject(RangeBucketPreDefFunctionNode());
    f.checkObject(RangeBucketPreDefFunctionNode(MU<AttributeNode>("foo")));
    f.checkObject(DebugWaitFunctionNode(MU<ConstantNode>(MU<Int64ResultNode>(5)),
                                      3.3, false));
}

TEST_F("testAggregatorResults", Fixture("testAggregatorResults")) {
    f.checkObject(SumAggregationResult()
                .setExpression(MU<AttributeNode>("attributeA"))
                .setResult(Int64ResultNode(7)));
    f.checkObject(XorAggregationResult()
                .setXor(Int64ResultNode(7))
                .setExpression(MU<AttributeNode>("attributeA")));
    f.checkObject(CountAggregationResult()
                .setCount(7)
                .setExpression(MU<AttributeNode>("attributeA")));
    f.checkObject(MinAggregationResult()
                .setExpression(MU<AttributeNode>("attributeA"))
                .setResult(Int64ResultNode(7)));
    f.checkObject(MaxAggregationResult()
                .setExpression(MU<AttributeNode>("attributeA"))
                .setResult(Int64ResultNode(7)));
    f.checkObject(AverageAggregationResult()
                .setExpression(MU<AttributeNode>("attributeA"))
                .setResult(Int64ResultNode(7)));
    ExpressionCountAggregationResult expression_count;
    expression_count.setExpression(MU<ConstantNode>(MU<Int64ResultNode>(67)))
        .aggregate(DocId(42), HitRank(21));
    f.checkObject(expression_count);
    StandardDeviationAggregationResult stddev;
    stddev.setExpression(MU<ConstantNode>(MU<Int64ResultNode>(67)))
            .aggregate(DocId(42), HitRank(21));
    f.checkObject(stddev);
}

TEST_F("testHitCollection", Fixture("testHitCollection")) {
    f.checkObject(FS4Hit());
    f.checkObject(FS4Hit(0, 50.0).setGlobalId(getGlobalId(100)));
    f.checkObject(VdsHit());
    f.checkObject(VdsHit("100", 50.0));
    f.checkObject(VdsHit("100", 50.0).setSummary("rawsummary", 10));
    f.checkObject(HitsAggregationResult());
    f.checkObject(HitsAggregationResult()
                .setMaxHits(5)
                .addHit(FS4Hit(0, 1.0).setGlobalId(getGlobalId(10)))
                .addHit(FS4Hit(0, 2.0).setGlobalId(getGlobalId(20)))
                .addHit(FS4Hit(0, 3.0).setGlobalId(getGlobalId(30)))
                .addHit(FS4Hit(0, 4.0).setGlobalId(getGlobalId(40)))
                .addHit(FS4Hit(0, 5.0).setGlobalId(getGlobalId(50)))
                .setExpression(MU<ConstantNode>(MU<Int64ResultNode>(5))));
    f.checkObject(HitsAggregationResult()
                .setMaxHits(3)
                .addHit(FS4Hit(0, 1.0).setGlobalId(getGlobalId(10))
                        .setDistributionKey(100))
                .addHit(FS4Hit(0, 2.0).setGlobalId(getGlobalId(20))
                        .setDistributionKey(200))
                .addHit(FS4Hit(0, 3.0).setGlobalId(getGlobalId(30))
                        .setDistributionKey(300))
                .setExpression(MU<ConstantNode>(MU<Int64ResultNode>(5))));
    f.checkObject(HitsAggregationResult()
                .setMaxHits(3)
                .addHit(VdsHit("10", 1.0).setSummary("100", 3))
                .addHit(VdsHit("20", 2.0).setSummary("200", 3))
                .addHit(VdsHit("30", 3.0).setSummary("300", 3))
                .setExpression(MU<ConstantNode>(MU<Int64ResultNode>(5))));
}

template<typename T>
ExpressionNode::UP
createAggr(ExpressionNode::UP e) {
    std::unique_ptr<T> aggr = MU<T>();
    aggr->setExpression(std::move(e));
    return aggr;
}

TEST_F("testGroupingLevel", Fixture("testGroupingLevel")) {
    f.checkObject(GroupingLevel()
                .setMaxGroups(100)
                .setExpression(createDummyExpression())
                .addAggregationResult(createAggr<SumAggregationResult>(createDummyExpression())));
}

TEST_F("testGroup", Fixture("testGroup")) {
    f.checkObject(Group());
    f.checkObject(Group().setId(Int64ResultNode(50))
                .setRank(RawRank(10)));
    f.checkObject(Group().setId(Int64ResultNode(100))
                .addChild(Group().setId(Int64ResultNode(110)))
                .addChild(Group().setId(Int64ResultNode(120))
                          .setRank(20.5)
                          .addAggregationResult(createAggr<SumAggregationResult>(createDummyExpression()))
                          .addAggregationResult(createAggr<SumAggregationResult>(createDummyExpression())))
                .addChild(Group().setId(Int64ResultNode(130))
                          .addChild(Group().setId(Int64ResultNode(131)))));
}

GroupingLevel
createDummyLevel(size_t maxGroups, size_t numAggr) {
    GroupingLevel l;
    l.setMaxGroups(maxGroups);
    l.setExpression(createDummyExpression());
    for (size_t i(0); i < numAggr; i++) {
        l.addAggregationResult(createAggr<SumAggregationResult>(createDummyExpression()));
    }
    return l;
}

GroupingLevel
createLargeLevel() {
    GroupingLevel l;
    l.setExpression(MU<AttributeNode>("folder"));
    l.addAggregationResult(createAggr<XorAggregationResult>(MU<MD5BitFunctionNode>(MU<AttributeNode>("docid"), 64)));
    l.addAggregationResult(createAggr<SumAggregationResult>(
            ExpressionNode::UP(MinFunctionNode()
                                       .addArg(MU<AttributeNode>("attribute1"))
                                       .addArg(MU<AttributeNode>("attribute2")).clone())));
    l.addAggregationResult(createAggr<XorAggregationResult>(
            ExpressionNode::UP(XorBitFunctionNode(
                    ExpressionNode::UP(CatFunctionNode()
                                               .addArg(MU<GetDocIdNamespaceSpecificFunctionNode>())
                                               .addArg(MU<DocumentFieldNode>("folder"))
                                               .addArg(MU<DocumentFieldNode>("flags")).clone())
                    , 64).clone())));
    return l;
}
TEST_F("testGrouping", Fixture("testGrouping")) {

    f.checkObject(Grouping());
    f.checkObject(Grouping().addLevel(createDummyLevel(100, 1))
                            .addLevel(createDummyLevel(10, 2)));
    f.checkObject(Grouping().addLevel(createLargeLevel()));
}

}  // namespace

TEST_MAIN() { TEST_RUN_ALL(); }