aboutsummaryrefslogtreecommitdiffstats
path: root/searchcore/src/tests/proton/matchengine/matchengine_test.cpp
blob: 514c9038945fc61843db68e05b86bb79ae7dfae9 (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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#include <vespa/searchcore/proton/matchengine/matchengine.h>
#include <vespa/vespalib/data/slime/slime.h>
#include <vespa/searchlib/engine/docsumreply.h>
#include <vespa/vespalib/testkit/test_kit.h>
#include <mutex>
#include <condition_variable>
#include <chrono>

using namespace proton;
using namespace search::engine;
using namespace vespalib::slime;
using vespalib::Slime;

class MySearchHandler : public ISearchHandler {
    size_t _numHits;
    std::string _name;
    std::string _reply;
public:
    explicit MySearchHandler(size_t numHits = 0) :
        _numHits(numHits), _name("my"), _reply("myreply")
    {}
    DocsumReply::UP getDocsums(const DocsumRequest &) override {
        return std::make_unique<DocsumReply>();
    }

    SearchReply::UP match(const SearchRequest &, vespalib::ThreadBundle &) const override
    {
        auto retval = std::make_unique<SearchReply>();
        for (size_t i = 0; i < _numHits; ++i) {
            retval->hits.emplace_back();
        }
        return retval;
    }
};

class LocalSearchClient : public SearchClient {
private:
    std::mutex              _lock;
    std::condition_variable _cond;
    SearchReply::UP         _reply;

public:
    LocalSearchClient();
    ~LocalSearchClient() override;
    void searchDone(SearchReply::UP reply) override {
        std::lock_guard<std::mutex> guard(_lock);
        _reply = std::move(reply);
        _cond.notify_all();
    }

    SearchReply::UP getReply(uint32_t millis) {
        std::unique_lock<std::mutex> guard(_lock);
        auto deadline = std::chrono::steady_clock::now() + std::chrono::milliseconds(millis);
        while (!_reply) {
            if (_cond.wait_until(guard, deadline) == std::cv_status::timeout) {
                break;
            }
        }
        return std::move(_reply);
    }
};

LocalSearchClient::LocalSearchClient() = default;
LocalSearchClient::~LocalSearchClient() = default;

TEST("requireThatSearchesExecute")
{
    int numMatcherThreads = 16;
    MatchEngine engine(numMatcherThreads, 1, 7);
    engine.setNodeUp(true);

    auto handler = std::make_shared<MySearchHandler>();
    DocTypeName dtnvfoo("foo");
    engine.putSearchHandler(dtnvfoo, handler);

    LocalSearchClient client;
    SearchRequest::Source request(new SearchRequest());
    SearchReply::UP reply = engine.search(std::move(request), client);
    EXPECT_FALSE(reply);

    reply = client.getReply(10000);
    EXPECT_TRUE(reply);
}

bool
assertSearchReply(MatchEngine & engine, const std::string & searchDocType, size_t expHits)
{
    auto *request = new SearchRequest();
    request->propertiesMap.lookupCreate(search::MapNames::MATCH).add("documentdb.searchdoctype", searchDocType);
    LocalSearchClient client;
    engine.search(SearchRequest::Source(request), client);
    SearchReply::UP reply = client.getReply(10000);
    ASSERT_TRUE(reply);
    return EXPECT_EQUAL(expHits, reply->hits.size());
}

TEST("requireThatCorrectHandlerIsUsed")
{
    MatchEngine engine(1, 1, 7);
    engine.setNodeUp(true);
    auto h1 = std::make_shared<MySearchHandler>(2);
    auto h2 = std::make_shared<MySearchHandler>(4);
    auto h3 = std::make_shared<MySearchHandler>(6);
    DocTypeName dtnvfoo("foo");
    DocTypeName dtnvbar("bar");
    DocTypeName dtnvbaz("baz");
    engine.putSearchHandler(dtnvfoo, h1);
    engine.putSearchHandler(dtnvbar, h2);
    engine.putSearchHandler(dtnvbaz, h3);

    EXPECT_TRUE(assertSearchReply(engine, "foo", 2));
    EXPECT_TRUE(assertSearchReply(engine, "bar", 4));
    EXPECT_TRUE(assertSearchReply(engine, "baz", 6));
    EXPECT_TRUE(assertSearchReply(engine, "not", 4)); // uses the first (sorted on name)
}

struct ObserveBundleMatchHandler : MySearchHandler {
    using SP = std::shared_ptr<ObserveBundleMatchHandler>;
    mutable size_t bundleSize;
    ObserveBundleMatchHandler() : bundleSize(0) {}

    search::engine::SearchReply::UP match(
            const search::engine::SearchRequest &,
            vespalib::ThreadBundle &threadBundle) const override
    {
        bundleSize = threadBundle.size();
        return std::make_unique<SearchReply>();
    }
};

TEST("requireThatBundlesAreUsed")
{
    MatchEngine engine(15, 5, 7);
    engine.setNodeUp(true);

    auto handler = std::make_shared<ObserveBundleMatchHandler>();
    DocTypeName dtnvfoo("foo");
    engine.putSearchHandler(dtnvfoo, handler);

    LocalSearchClient client;
    SearchRequest::Source request(new SearchRequest());
    engine.search(std::move(request), client);
    SearchReply::UP reply = client.getReply(10000);
    EXPECT_EQUAL(7u, reply->getDistributionKey());
    EXPECT_EQUAL(5u, handler->bundleSize);
}

TEST("requireThatHandlersCanBeRemoved")
{
    MatchEngine engine(1, 1, 7);
    engine.setNodeUp(true);
    auto h = std::make_shared<MySearchHandler>(1);
    DocTypeName docType("foo");
    engine.putSearchHandler(docType, h);

    ISearchHandler::SP r = engine.getSearchHandler(docType);
    EXPECT_TRUE(r);
    EXPECT_TRUE(h.get() == r.get());

    r = engine.removeSearchHandler(docType);
    EXPECT_TRUE(r);
    EXPECT_TRUE(h.get() == r.get());

    r = engine.getSearchHandler(docType);
    EXPECT_FALSE(r);
}

TEST("requireThatEmptySearchReplyIsReturnedWhenEngineIsClosed")
{
    MatchEngine engine(1, 1, 7);
    engine.setNodeUp(true);
    engine.close();
    LocalSearchClient client;
    SearchRequest::Source request(new SearchRequest());
    SearchReply::UP reply = engine.search(std::move(request), client);
    ASSERT_TRUE(reply);
    EXPECT_EQUAL(0u, reply->hits.size());
    EXPECT_EQUAL(7u, reply->getDistributionKey());
}

namespace {

constexpr const char* search_interface_offline_slime_str() noexcept {
    return "{\n"
           "    \"status\": {\n"
           "        \"state\": \"OFFLINE\",\n"
           "        \"message\": \"Search interface is offline\"\n"
           "    }\n"
           "}\n";
}

}

TEST("requireThatStateIsReported")
{
    MatchEngine engine(1, 1, 7);

    Slime slime;
    SlimeInserter inserter(slime);
    engine.get_state(inserter, false);
    EXPECT_EQUAL(search_interface_offline_slime_str(),
                 slime.toString());
}

TEST("searches are executed when node is in maintenance mode")
{
    MatchEngine engine(1, 1, 7);
    engine.setNodeMaintenance(true);
    engine.putSearchHandler(DocTypeName("foo"), std::make_shared<MySearchHandler>(3));
    EXPECT_TRUE(assertSearchReply(engine, "foo", 3));
}

TEST("setNodeMaintenance(true) implies setNodeUp(false)")
{
    MatchEngine engine(1, 1, 7);
    engine.setNodeUp(true);
    engine.setNodeMaintenance(true);
    EXPECT_FALSE(engine.isOnline());
}

TEST("setNodeMaintenance(false) does not imply setNodeUp(false)")
{
    MatchEngine engine(1, 1, 7);
    engine.setNodeUp(true);
    engine.setNodeMaintenance(false);
    EXPECT_TRUE(engine.isOnline());
}

TEST("search interface is reported as offline when node is in maintenance mode")
{
    MatchEngine engine(1, 1, 7);
    engine.setNodeMaintenance(true);

    Slime slime;
    SlimeInserter inserter(slime);
    engine.get_state(inserter, false);
    EXPECT_EQUAL(search_interface_offline_slime_str(),
                 slime.toString());
}

TEST_MAIN() { TEST_RUN_ALL(); }