summaryrefslogtreecommitdiffstats
path: root/documentapi/src/tests/replymerger/replymerger_test.cpp
blob: bfcc4612ce10fbb7b176f080ec5d76ef1bb1dacc (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
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include <iostream>
#include <vespa/vespalib/testkit/testapp.h>
#include <vespa/documentapi/messagebus/replymerger.h>
#include <vespa/documentapi/messagebus/documentprotocol.h>
#include <vespa/documentapi/messagebus/messages/removedocumentreply.h>
#include <vespa/documentapi/messagebus/messages/updatedocumentreply.h>
#include <vespa/documentapi/messagebus/messages/getdocumentreply.h>
#include <vespa/messagebus/emptyreply.h>
#include <vespa/messagebus/error.h>

using namespace documentapi;

class Test : public vespalib::TestApp
{
    static void assertReplyErrorsMatch(const mbus::Reply& r,
                                       const std::vector<mbus::Error>& errors);
public:
    int Main() override;

    void mergingGenericRepliesWithNoErrorsPicksFirstReply();
    void mergingSingleReplyWithOneErrorReturnsEmptyReplyWithError();
    void mergingSingleReplyWithMultipleErrorsReturnsEmptyReplyWithAllErrors();
    void mergingMultipleRepliesWithMultipleErrorsReturnsEmptyReplyWithAllErrors();
    void returnIgnoredReplyWhenAllRepliesHaveOnlyIgnoredErrors();
    void successfulReplyTakesPrecedenceOverIgnoredReplyWhenNoErrors();
    void nonIgnoredErrorTakesPrecedence();
    void returnRemoveDocumentReplyWhereDocWasFound();
    void returnFirstRemoveDocumentReplyIfNoDocsWereFound();
    void returnUpdateDocumentReplyWhereDocWasFound();
    void returnGetDocumentReplyWhereDocWasFound();
    void mergingZeroRepliesReturnsDefaultEmptyReply();
};

TEST_APPHOOK(Test);

void
Test::mergingGenericRepliesWithNoErrorsPicksFirstReply()
{
    mbus::EmptyReply r1;
    mbus::EmptyReply r2;
    mbus::EmptyReply r3;
    ReplyMerger merger;
    merger.merge(0, r1);
    merger.merge(1, r2);
    merger.merge(2, r3);
    ReplyMerger::Result ret(merger.mergedReply());
    ASSERT_TRUE(ret.isSuccessful());
    ASSERT_FALSE(ret.hasGeneratedReply());
    EXPECT_EQUAL(0u, ret.getSuccessfulReplyIndex());
}

void
Test::mergingSingleReplyWithOneErrorReturnsEmptyReplyWithError()
{
    mbus::EmptyReply r1;
    std::vector<mbus::Error> errors = { mbus::Error(1234, "oh no!") };
    r1.addError(errors[0]);
    ReplyMerger merger;
    merger.merge(0, r1);
    ReplyMerger::Result ret(merger.mergedReply());
    ASSERT_FALSE(ret.isSuccessful());
    ASSERT_TRUE(ret.hasGeneratedReply());
    std::unique_ptr<mbus::Reply> gen(ret.releaseGeneratedReply());
    assertReplyErrorsMatch(*gen, errors);
}

void
Test::mergingSingleReplyWithMultipleErrorsReturnsEmptyReplyWithAllErrors()
{
    mbus::EmptyReply r1;
    std::vector<mbus::Error> errors = {
        mbus::Error(1234, "oh no!"),
        mbus::Error(4567, "oh dear!")
    };
    r1.addError(errors[0]);
    r1.addError(errors[1]);
    ReplyMerger merger;
    merger.merge(0, r1);
    ReplyMerger::Result ret(merger.mergedReply());
    ASSERT_FALSE(ret.isSuccessful());
    ASSERT_TRUE(ret.hasGeneratedReply());
    std::unique_ptr<mbus::Reply> gen(ret.releaseGeneratedReply());
    assertReplyErrorsMatch(*gen, errors);
}

void
Test::mergingMultipleRepliesWithMultipleErrorsReturnsEmptyReplyWithAllErrors()
{
    mbus::EmptyReply r1;
    mbus::EmptyReply r2;
    std::vector<mbus::Error> errors = {
        mbus::Error(1234, "oh no!"),
        mbus::Error(4567, "oh dear!"),
        mbus::Error(678, "omg!")
    };
    r1.addError(errors[0]);
    r1.addError(errors[1]);
    r2.addError(errors[2]);
    ReplyMerger merger;
    merger.merge(0, r1);
    merger.merge(1, r2);
    ReplyMerger::Result ret(merger.mergedReply());
    ASSERT_FALSE(ret.isSuccessful());
    ASSERT_TRUE(ret.hasGeneratedReply());
    std::unique_ptr<mbus::Reply> gen(ret.releaseGeneratedReply());
    assertReplyErrorsMatch(*gen, errors);
}

void
Test::returnIgnoredReplyWhenAllRepliesHaveOnlyIgnoredErrors()
{
    mbus::EmptyReply r1;
    mbus::EmptyReply r2;
    std::vector<mbus::Error> errors = {
        mbus::Error(DocumentProtocol::ERROR_MESSAGE_IGNORED, "oh no!"),
        mbus::Error(DocumentProtocol::ERROR_MESSAGE_IGNORED, "oh dear!"),
        mbus::Error(DocumentProtocol::ERROR_MESSAGE_IGNORED, "omg!")
    };
    r1.addError(errors[0]);
    r1.addError(errors[1]);
    r2.addError(errors[2]);
    ReplyMerger merger;
    merger.merge(0, r1);
    merger.merge(1, r2);
    ReplyMerger::Result ret(merger.mergedReply());
    ASSERT_FALSE(ret.isSuccessful());
    ASSERT_TRUE(ret.hasGeneratedReply());
    std::unique_ptr<mbus::Reply> gen(ret.releaseGeneratedReply());
    // Only first ignore error from each reply.
    assertReplyErrorsMatch(*gen, { errors[0], errors[2] });
}

void
Test::successfulReplyTakesPrecedenceOverIgnoredReplyWhenNoErrors()
{
    mbus::EmptyReply r1;
    mbus::EmptyReply r2;
    std::vector<mbus::Error> errors = {
        mbus::Error(DocumentProtocol::ERROR_MESSAGE_IGNORED, "oh no!"),
    };
    r1.addError(errors[0]);
    ReplyMerger merger;
    merger.merge(0, r1);
    merger.merge(1, r2);
    ReplyMerger::Result ret(merger.mergedReply());
    ASSERT_TRUE(ret.isSuccessful());
    ASSERT_FALSE(ret.hasGeneratedReply());
    EXPECT_EQUAL(1u, ret.getSuccessfulReplyIndex());
}

void
Test::nonIgnoredErrorTakesPrecedence()
{
    mbus::EmptyReply r1;
    mbus::EmptyReply r2;
    std::vector<mbus::Error> errors = {
        mbus::Error(DocumentProtocol::ERROR_MESSAGE_IGNORED, "oh no!"),
        mbus::Error(DocumentProtocol::ERROR_ABORTED, "kablammo!"),
        mbus::Error(DocumentProtocol::ERROR_MESSAGE_IGNORED, "omg!")
    };
    r1.addError(errors[0]);
    r1.addError(errors[1]);
    r2.addError(errors[2]);
    ReplyMerger merger;
    merger.merge(0, r1);
    merger.merge(1, r2);
    ReplyMerger::Result ret(merger.mergedReply());
    ASSERT_FALSE(ret.isSuccessful());
    ASSERT_TRUE(ret.hasGeneratedReply());
    std::unique_ptr<mbus::Reply> gen(ret.releaseGeneratedReply());
    // All errors from replies with errors are included, not those that
    // are fully ignored.
    assertReplyErrorsMatch(*gen, { errors[0], errors[1] });
}

void
Test::returnRemoveDocumentReplyWhereDocWasFound()
{
    RemoveDocumentReply r1;
    RemoveDocumentReply r2;
    RemoveDocumentReply r3;
    r1.setWasFound(false);
    r2.setWasFound(true);
    r3.setWasFound(false);

    ReplyMerger merger;
    merger.merge(0, r1);
    merger.merge(1, r2);
    merger.merge(2, r3);
    ReplyMerger::Result ret(merger.mergedReply());
    ASSERT_TRUE(ret.isSuccessful());
    ASSERT_FALSE(ret.hasGeneratedReply());
    ASSERT_EQUAL(1u, ret.getSuccessfulReplyIndex());
}

void
Test::returnFirstRemoveDocumentReplyIfNoDocsWereFound()
{
    RemoveDocumentReply r1;
    RemoveDocumentReply r2;
    r1.setWasFound(false);
    r2.setWasFound(false);

    ReplyMerger merger;
    merger.merge(0, r1);
    merger.merge(1, r2);
    ReplyMerger::Result ret(merger.mergedReply());
    ASSERT_TRUE(ret.isSuccessful());
    ASSERT_FALSE(ret.hasGeneratedReply());
    ASSERT_EQUAL(0u, ret.getSuccessfulReplyIndex());
}

void
Test::returnUpdateDocumentReplyWhereDocWasFound()
{
    UpdateDocumentReply r1;
    UpdateDocumentReply r2;
    UpdateDocumentReply r3;
    r1.setWasFound(false);
    r2.setWasFound(true); // return first reply
    r3.setWasFound(true);

    ReplyMerger merger;
    merger.merge(0, r1);
    merger.merge(1, r2);
    merger.merge(2, r3);
    ReplyMerger::Result ret(merger.mergedReply());
    ASSERT_TRUE(ret.isSuccessful());
    ASSERT_FALSE(ret.hasGeneratedReply());
    ASSERT_EQUAL(1u, ret.getSuccessfulReplyIndex());
}

void
Test::returnGetDocumentReplyWhereDocWasFound()
{
    GetDocumentReply r1;
    GetDocumentReply r2;
    GetDocumentReply r3;
    r2.setLastModified(12345ULL);

    ReplyMerger merger;
    merger.merge(0, r1);
    merger.merge(1, r2);
    merger.merge(2, r3);
    ReplyMerger::Result ret(merger.mergedReply());
    ASSERT_TRUE(ret.isSuccessful());
    ASSERT_FALSE(ret.hasGeneratedReply());
    ASSERT_EQUAL(1u, ret.getSuccessfulReplyIndex());
}

void
Test::assertReplyErrorsMatch(const mbus::Reply& r,
                             const std::vector<mbus::Error>& errors)
{
    ASSERT_EQUAL(r.getNumErrors(), errors.size());
    for (size_t i = 0; i < errors.size(); ++i) {
        ASSERT_EQUAL(errors[i].getCode(), r.getError(i).getCode());
        ASSERT_EQUAL(errors[i].getMessage(), r.getError(i).getMessage());
    }
}

void
Test::mergingZeroRepliesReturnsDefaultEmptyReply()
{
    ReplyMerger merger;
    ReplyMerger::Result ret(merger.mergedReply());
    ASSERT_FALSE(ret.isSuccessful());
    ASSERT_TRUE(ret.hasGeneratedReply());
    std::unique_ptr<mbus::Reply> gen(ret.releaseGeneratedReply());
    ASSERT_TRUE(dynamic_cast<mbus::EmptyReply*>(gen.get()) != 0);
    assertReplyErrorsMatch(*gen, {});
}

#ifdef RUN_TEST
#  error Someone defined RUN_TEST already! Oh no!
#endif
#define RUN_TEST(f) \
  std::cerr << "running test case '" #f "'\n"; \
  f(); TEST_FLUSH();

int
Test::Main()
{
    TEST_INIT("replymerger_test");

    RUN_TEST(mergingGenericRepliesWithNoErrorsPicksFirstReply);
    RUN_TEST(mergingSingleReplyWithOneErrorReturnsEmptyReplyWithError);
    RUN_TEST(mergingSingleReplyWithMultipleErrorsReturnsEmptyReplyWithAllErrors);
    RUN_TEST(mergingMultipleRepliesWithMultipleErrorsReturnsEmptyReplyWithAllErrors);
    RUN_TEST(returnIgnoredReplyWhenAllRepliesHaveOnlyIgnoredErrors);
    RUN_TEST(successfulReplyTakesPrecedenceOverIgnoredReplyWhenNoErrors);
    RUN_TEST(nonIgnoredErrorTakesPrecedence);
    RUN_TEST(returnRemoveDocumentReplyWhereDocWasFound);
    RUN_TEST(returnFirstRemoveDocumentReplyIfNoDocsWereFound);
    RUN_TEST(returnUpdateDocumentReplyWhereDocWasFound);
    RUN_TEST(returnGetDocumentReplyWhereDocWasFound);
    RUN_TEST(mergingZeroRepliesReturnsDefaultEmptyReply);

    TEST_DONE();
}