aboutsummaryrefslogtreecommitdiffstats
path: root/vsm/src/tests/docsum/docsum.cpp
blob: 4409c5f62151a5fe6bb032a4fd65465bb64f58b7 (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
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#include <vespa/vespalib/testkit/testapp.h>
#include <vespa/document/fieldvalue/fieldvalues.h>
#include <vespa/document/datatype/structdatatype.h>
#include <vespa/document/datatype/weightedsetdatatype.h>
#include <vespa/document/datatype/mapdatatype.h>
#include <vespa/vsm/common/docsum.h>
#include <vespa/vsm/vsm/flattendocsumwriter.h>
#include <vespa/vsm/vsm/slimefieldwriter.h>

using namespace document;

namespace vsm {

template <typename T>
class Vector : public std::vector<T>
{
public:
    Vector<T> & add(T v) { this->push_back(v); return *this; }
};

typedef Vector<std::string>  StringList;
typedef Vector<std::pair<std::string, int32_t> > WeightedStringList;


class TestDocument : public vsm::Document
{
private:
    std::vector<FieldValueContainer> _fields;

public:
    TestDocument(const search::DocumentIdT & docId, size_t numFields) : vsm::Document(docId, numFields), _fields(numFields) {}
    virtual bool setField(FieldIdT fId, document::FieldValue::UP fv) override {
        if (fId < _fields.size()) {
            _fields[fId].reset(fv.release());
            return true;
        }
        return false;
    }
    virtual const document::FieldValue * getField(FieldIdT fId) const override {
        if (fId < _fields.size()) {
            return _fields[fId].get();
        }
        return NULL;
    }
};


class DocsumTest : public vespalib::TestApp
{
private:
    ArrayFieldValue createFieldValue(const StringList & fv);
    WeightedSetFieldValue createFieldValue(const WeightedStringList & fv);

    void assertFlattenDocsumWriter(const FieldValue & fv, const std::string & exp) {
        FlattenDocsumWriter fdw;
        assertFlattenDocsumWriter(fdw, fv, exp);
    }
    void assertFlattenDocsumWriter(FlattenDocsumWriter & fdw, const FieldValue & fv, const std::string & exp);
    void assertSlimeFieldWriter(const FieldValue & fv, const std::string & exp) {
        SlimeFieldWriter sfw;
        TEST_DO(assertSlimeFieldWriter(sfw, fv, exp));
    }
    void assertSlimeFieldWriter(SlimeFieldWriter & sfw, const FieldValue & fv, const std::string & exp);

    void testFlattenDocsumWriter();
    void testSlimeFieldWriter();
    void requireThatSlimeFieldWriterHandlesMap();
    void testDocSumCache();

public:
    int Main() override;
};

ArrayFieldValue
DocsumTest::createFieldValue(const StringList & fv)
{

    static ArrayDataType type(*DataType::STRING);
    ArrayFieldValue afv(type);
    for (size_t i = 0; i < fv.size(); ++i) {
        afv.add(StringFieldValue(fv[i]));
    }
    return afv;
}

WeightedSetFieldValue
DocsumTest::createFieldValue(const WeightedStringList & fv)
{
    static WeightedSetDataType type(*DataType::STRING, false, false);
    WeightedSetFieldValue wsfv(type);
    for (size_t i = 0; i < fv.size(); ++i) {
        wsfv.add(StringFieldValue(fv[i].first), fv[i].second);
    }
    return wsfv;
}

void
DocsumTest::assertFlattenDocsumWriter(FlattenDocsumWriter & fdw, const FieldValue & fv, const std::string & exp)
{
    FieldPath empty;
    fv.iterateNested(empty.getFullRange(), fdw);
    std::string actual(fdw.getResult().getBuffer(), fdw.getResult().getPos());
    EXPECT_EQUAL(actual, exp);
}

void
DocsumTest::assertSlimeFieldWriter(SlimeFieldWriter & sfw, const FieldValue & fv, const std::string & exp)
{
    sfw.convert(fv);

    vespalib::Slime gotSlime;
    vespalib::Memory serialized(sfw.out());
    size_t decodeRes = vespalib::slime::BinaryFormat::decode(serialized, gotSlime);
    ASSERT_EQUAL(decodeRes, serialized.size);

    vespalib::Slime expSlime;
    size_t used = vespalib::slime::JsonFormat::decode(exp, expSlime);
    EXPECT_TRUE(used > 0);
    EXPECT_EQUAL(expSlime, gotSlime);
}

void
DocsumTest::testFlattenDocsumWriter()
{
    { // basic tests
        TEST_DO(assertFlattenDocsumWriter(StringFieldValue("foo bar"), "foo bar"));
        TEST_DO(assertFlattenDocsumWriter(RawFieldValue("foo bar"), "foo bar"));
        TEST_DO(assertFlattenDocsumWriter(LongFieldValue(123456789), "123456789"));
        TEST_DO(assertFlattenDocsumWriter(createFieldValue(StringList().add("foo bar").add("baz").add(" qux ")),
                                  "foo bar baz  qux "));
    }
    { // test mulitple invokations
        FlattenDocsumWriter fdw("#");
        TEST_DO(assertFlattenDocsumWriter(fdw, StringFieldValue("foo"), "foo"));
        TEST_DO(assertFlattenDocsumWriter(fdw, StringFieldValue("bar"), "foo#bar"));
        fdw.clear();
        TEST_DO(assertFlattenDocsumWriter(fdw, StringFieldValue("baz"), "baz"));
        TEST_DO(assertFlattenDocsumWriter(fdw, StringFieldValue("qux"), "baz qux"));
    }
    { // test resizing
        FlattenDocsumWriter fdw("#");
        EXPECT_EQUAL(fdw.getResult().getPos(), 0u);
        EXPECT_EQUAL(fdw.getResult().getLength(), 32u);
        TEST_DO(assertFlattenDocsumWriter(fdw, StringFieldValue("aaaabbbbccccddddeeeeffffgggghhhh"),
                                          "aaaabbbbccccddddeeeeffffgggghhhh"));
        EXPECT_EQUAL(fdw.getResult().getPos(), 32u);
        EXPECT_EQUAL(fdw.getResult().getLength(), 32u);
        TEST_DO(assertFlattenDocsumWriter(fdw, StringFieldValue("aaaa"), "aaaabbbbccccddddeeeeffffgggghhhh#aaaa"));
        EXPECT_EQUAL(fdw.getResult().getPos(), 37u);
        EXPECT_TRUE(fdw.getResult().getLength() >= 37u);
        fdw.clear();
        EXPECT_EQUAL(fdw.getResult().getPos(), 0u);
        EXPECT_TRUE(fdw.getResult().getLength() >= 37u);
    }
}

void
DocsumTest::testSlimeFieldWriter()
{
    { // basic types
        assertSlimeFieldWriter(LongFieldValue(123456789), "123456789");
        assertSlimeFieldWriter(DoubleFieldValue(12.34), "12.34");
        assertSlimeFieldWriter(StringFieldValue("foo bar"), "\"foo bar\"");
    }
    { // collection field values
        assertSlimeFieldWriter(createFieldValue(StringList().add("foo").add("bar").add("baz")),
                               "[\"foo\",\"bar\",\"baz\"]");
        assertSlimeFieldWriter(createFieldValue(WeightedStringList().add(std::make_pair("bar", 20)).
                                                                     add(std::make_pair("baz", 30)).
                                                                     add(std::make_pair("foo", 10))),
                               "[{item:\"bar\",weight:20},{item:\"baz\",weight:30},{item:\"foo\",weight:10}]");
    }
    { // struct field value
        StructDataType subType("substruct");
        Field fd("d", 0, *DataType::STRING, true);
        Field fe("e", 1, *DataType::STRING, true);
        subType.addField(fd);
        subType.addField(fe);
        StructFieldValue subValue(subType);
        subValue.setValue(fd, StringFieldValue("baz"));
        subValue.setValue(fe, StringFieldValue("qux"));

        StructDataType type("struct");
        Field fa("a", 0, *DataType::STRING, true);
        Field fb("b", 1, *DataType::STRING, true);
        Field fc("c", 2, subType, true);
        type.addField(fa);
        type.addField(fb);
        type.addField(fc);
        StructFieldValue value(type);
        value.setValue(fa, StringFieldValue("foo"));
        value.setValue(fb, StringFieldValue("bar"));
        value.setValue(fc, subValue);


        { // select a subset and then all
            SlimeFieldWriter sfw;
            DocsumFieldSpec::FieldIdentifierVector fields;
            {
                FieldPath path;
                type.buildFieldPath(path, "a");
                fields.push_back(DocsumFieldSpec::FieldIdentifier(0, path));
            }
            {
                FieldPath path;
                type.buildFieldPath(path, "c.e");
                fields.push_back(DocsumFieldSpec::FieldIdentifier(0, path));
            }
            sfw.setInputFields(fields);
            TEST_DO(assertSlimeFieldWriter(sfw, value, "{\"a\":\"foo\",\"c\":{\"e\":\"qux\"}}"));
            sfw.clear();
            TEST_DO(assertSlimeFieldWriter(sfw, value, "{\"a\":\"foo\",\"b\":\"bar\",\"c\":{\"d\":\"baz\",\"e\":\"qux\"}}"));
        }

    { // multiple invocations
        SlimeFieldWriter sfw;
        TEST_DO(assertSlimeFieldWriter(sfw, StringFieldValue("foo"), "\"foo\""));
        sfw.clear();
        TEST_DO(assertSlimeFieldWriter(sfw, StringFieldValue("bar"), "\"bar\""));
        sfw.clear();
        TEST_DO(assertSlimeFieldWriter(sfw, StringFieldValue("baz"), "\"baz\""));
    }

    }
}

void
DocsumTest::requireThatSlimeFieldWriterHandlesMap()
{
    { // map<string, string>
        MapDataType mapType(*DataType::STRING, *DataType::STRING);
        MapFieldValue mapfv(mapType);
        EXPECT_TRUE(mapfv.put(StringFieldValue("k1"), StringFieldValue("v1")));
        EXPECT_TRUE(mapfv.put(StringFieldValue("k2"), StringFieldValue("v2")));
        assertSlimeFieldWriter(mapfv, "[{\"key\":\"k1\",\"value\":\"v1\"},{\"key\":\"k2\",\"value\":\"v2\"}]");
    }
    { // map<string, struct>
        StructDataType structType("struct");
        Field fa("a", 0, *DataType::STRING, true);
        Field fb("b", 1, *DataType::STRING, true);
        structType.addField(fa);
        structType.addField(fb);
        StructFieldValue structValue(structType);
        structValue.setValue(fa, StringFieldValue("foo"));
        structValue.setValue(fb, StringFieldValue("bar"));
        MapDataType mapType(*DataType::STRING, structType);
        MapFieldValue mapfv(mapType);
        EXPECT_TRUE(mapfv.put(StringFieldValue("k1"), structValue));
        { // select a subset and then all
            SlimeFieldWriter sfw;
            DocsumFieldSpec::FieldIdentifierVector fields;
            {
                FieldPath path;
                mapType.buildFieldPath(path, "value.b");
                fields.push_back(DocsumFieldSpec::FieldIdentifier(0, path));
            }
            sfw.setInputFields(fields);
            TEST_DO(assertSlimeFieldWriter(sfw, mapfv, "[{\"key\":\"k1\",\"value\":{\"b\":\"bar\"}}]"));
            {
                FieldPath path;
                mapType.buildFieldPath(path, "{k1}.a");
                fields[0] = DocsumFieldSpec::FieldIdentifier(0, path);
            }
            sfw.clear();
            sfw.setInputFields(fields);
            TEST_DO(assertSlimeFieldWriter(sfw, mapfv, "[{\"key\":\"k1\",\"value\":{\"a\":\"foo\"}}]"));
            sfw.clear(); // all fields implicit
            TEST_DO(assertSlimeFieldWriter(sfw, mapfv, "[{\"key\":\"k1\",\"value\":{\"a\":\"foo\",\"b\":\"bar\"}}]"));
        }
    }
}

int
DocsumTest::Main()
{
    TEST_INIT("docsum_test");

    TEST_DO(testFlattenDocsumWriter());
    TEST_DO(testSlimeFieldWriter());
    TEST_DO(requireThatSlimeFieldWriterHandlesMap());

    TEST_DONE();
}

}

TEST_APPHOOK(vsm::DocsumTest);