1
=== modified file 'include/unity/scopes/SearchListenerBase.h'
2
--- include/unity/scopes/SearchListenerBase.h	2014-07-28 08:51:57 +0000
3
+++ include/unity/scopes/SearchListenerBase.h	2014-07-30 21:36:19 +0000
4
@@ -19,13 +19,14 @@
5
19
#ifndef UNITY_SCOPES_SEARCHLISTENERBASE_H
19
#ifndef UNITY_SCOPES_SEARCHLISTENERBASE_H
6
20
#define UNITY_SCOPES_SEARCHLISTENERBASE_H
20
#define UNITY_SCOPES_SEARCHLISTENERBASE_H
7
21
21
8
22
#include <unity/scopes/Annotation.h>
9
23
#include <unity/scopes/CategorisedResult.h>
10
24
#include <unity/scopes/Category.h>
11
25
#include <unity/scopes/Department.h>
12
26
#include <unity/scopes/FilterBase.h>
13
22
#include <unity/scopes/ListenerBase.h>
27
#include <unity/scopes/ListenerBase.h>
14
23
#include <unity/util/DefinesPtrs.h>
28
#include <unity/util/DefinesPtrs.h>
15
24
#include <unity/util/NonCopyable.h>
29
#include <unity/util/NonCopyable.h>
16
25
#include <unity/scopes/Category.h>
17
26
#include <unity/scopes/Annotation.h>
18
27
#include <unity/scopes/Department.h>
19
28
#include <unity/scopes/FilterBase.h>
20
29
30
21
30
#include <string>
31
#include <string>
22
31
32
23
@@ -35,9 +36,6 @@
24
35
namespace scopes
36
namespace scopes
25
36
{
37
{
26
37
38
27
38
class CategorisedResult;
28
39
class FilterState;
29
40
30
41
namespace experimental
39
namespace experimental
31
42
{
40
{
32
43
class Annotation;
41
class Annotation;
33
44
42
34
=== modified file 'src/scopes/internal/ReplyObject.cpp'
35
--- src/scopes/internal/ReplyObject.cpp	2014-07-28 09:55:08 +0000
36
+++ src/scopes/internal/ReplyObject.cpp	2014-07-30 21:36:19 +0000
37
@@ -149,7 +149,6 @@
38
149
    // Only one thread can reach this point, any others were thrown out above.
149
    // Only one thread can reach this point, any others were thrown out above.
39
150
150
40
151
    reap_item_->destroy();
151
    reap_item_->destroy();
41
152
    disconnect();               // Disconnect self from middleware, if this hasn't happened yet.
42
153
152
43
154
    // Wait until all currently executing calls to push() have completed.
153
    // Wait until all currently executing calls to push() have completed.
44
155
    unique_lock<mutex> lock(mutex_);
154
    unique_lock<mutex> lock(mutex_);
45
@@ -175,6 +174,12 @@
46
175
        cerr << "ReplyObject::finished(): unknown exception" << endl;
174
        cerr << "ReplyObject::finished(): unknown exception" << endl;
47
176
        // TODO: log error
175
        // TODO: log error
48
177
    }
176
    }
49
177
50
178
    // Disconnect self from middleware, if this hasn't happened yet.
51
179
    // We do this last because disconnect() can trigger
52
180
    // the destructor of this instance (if finished() is called
53
181
    // by the reaper, for example).
54
182
    disconnect();
55
178
}
183
}
56
179
184
57
180
void ReplyObject::info(OperationInfo const& op_info) noexcept
185
void ReplyObject::info(OperationInfo const& op_info) noexcept
58
181
186
59
=== modified file 'test/gtest/scopes/CMakeLists.txt'
60
--- test/gtest/scopes/CMakeLists.txt	2014-07-29 09:33:53 +0000
61
+++ test/gtest/scopes/CMakeLists.txt	2014-07-30 21:36:19 +0000
62
@@ -17,6 +17,7 @@
63
17
add_subdirectory(RadioButtonsFilter)
17
add_subdirectory(RadioButtonsFilter)
64
18
add_subdirectory(RangeInputFilter)
18
add_subdirectory(RangeInputFilter)
65
19
add_subdirectory(RatingFilter)
19
add_subdirectory(RatingFilter)
66
20
add_subdirectory(ReplyReaper)
67
20
add_subdirectory(SwitchFilter)
21
add_subdirectory(SwitchFilter)
68
21
add_subdirectory(ValueSliderFilter)
22
add_subdirectory(ValueSliderFilter)
69
22
add_subdirectory(PreviewWidget)
23
add_subdirectory(PreviewWidget)
70
23
24
71
=== added directory 'test/gtest/scopes/ReplyReaper'
72
=== added file 'test/gtest/scopes/ReplyReaper/CMakeLists.txt'
73
--- test/gtest/scopes/ReplyReaper/CMakeLists.txt	1970-01-01 00:00:00 +0000
74
+++ test/gtest/scopes/ReplyReaper/CMakeLists.txt	2014-07-30 21:36:19 +0000
75
@@ -0,0 +1,10 @@
76
1
configure_file(Registry.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Registry.ini)
77
2
configure_file(Runtime.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Runtime.ini)
78
3
configure_file(Zmq.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Zmq.ini)
79
4
80
5
add_definitions(-DTEST_DIR="${CMAKE_CURRENT_BINARY_DIR}")
81
6
82
7
add_executable(ReplyReaper_test ReplyReaper_test.cpp NoReplyScope.cpp)
83
8
target_link_libraries(ReplyReaper_test ${TESTLIBS})
84
9
85
10
add_test(ReplyReaper ReplyReaper_test)
86
0
11
87
=== added file 'test/gtest/scopes/ReplyReaper/NoReplyScope.cpp'
88
--- test/gtest/scopes/ReplyReaper/NoReplyScope.cpp	1970-01-01 00:00:00 +0000
89
+++ test/gtest/scopes/ReplyReaper/NoReplyScope.cpp	2014-07-30 21:36:19 +0000
90
@@ -0,0 +1,61 @@
91
1
/*
92
2
 * Copyright (C) 2014 Canonical Ltd
93
3
 *
94
4
 * This program is free software: you can redistribute it and/or modify
95
5
 * it under the terms of the GNU Lesser General Public License version 3 as
96
6
 * published by the Free Software Foundation.
97
7
 *
98
8
 * This program is distributed in the hope that it will be useful,
99
9
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
100
10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
101
11
 * GNU Lesser General Public License for more details.
102
12
 *
103
13
 * You should have received a copy of the GNU Lesser General Public License
104
14
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
105
15
 *
106
16
 * Authored by: Michi Henning <michi.henning@canonical.com>
107
17
 */
108
18
109
19
#include "NoReplyScope.h"
110
20
111
21
#include <unity/scopes/ScopeBase.h>
112
22
113
23
#include <thread>
114
24
115
25
#include <gtest/gtest.h>
116
26
117
27
using namespace std;
118
28
using namespace unity::scopes;
119
29
120
30
namespace
121
31
{
122
32
123
33
class Query : public SearchQueryBase
124
34
{
125
35
public:
126
36
    Query(CannedQuery const& query, SearchMetadata const& metadata)
127
37
        : SearchQueryBase(query, metadata)
128
38
    {
129
39
    }
130
40
131
41
    virtual void run(SearchReplyProxy const&) override
132
42
    {
133
43
        this_thread::sleep_for(chrono::seconds(3));
134
44
    }
135
45
136
46
    virtual void cancelled() override
137
47
    {
138
48
    }
139
49
};
140
50
141
51
}  // namespace
142
52
143
53
SearchQueryBase::UPtr NoReplyScope::search(CannedQuery const& query, SearchMetadata const& metadata)
144
54
{
145
55
    return SearchQueryBase::UPtr(new Query(query, metadata));
146
56
}
147
57
148
58
PreviewQueryBase::UPtr NoReplyScope::preview(Result const&, ActionMetadata const&)
149
59
{
150
60
    return nullptr;  // Not called
151
61
}
152
0
62
153
=== added file 'test/gtest/scopes/ReplyReaper/NoReplyScope.h'
154
--- test/gtest/scopes/ReplyReaper/NoReplyScope.h	1970-01-01 00:00:00 +0000
155
+++ test/gtest/scopes/ReplyReaper/NoReplyScope.h	2014-07-30 21:36:19 +0000
156
@@ -0,0 +1,33 @@
157
1
/*
158
2
 * Copyright (C) 2014 Canonical Ltd
159
3
 *
160
4
 * This program is free software: you can redistribute it and/or modify
161
5
 * it under the terms of the GNU Lesser General Public License version 3 as
162
6
 * published by the Free Software Foundation.
163
7
 *
164
8
 * This program is distributed in the hope that it will be useful,
165
9
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
166
10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
167
11
 * GNU Lesser General Public License for more details.
168
12
 *
169
13
 * You should have received a copy of the GNU Lesser General Public License
170
14
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
171
15
 *
172
16
 * Authored by: Michi Henning <michi.henning@canonical.com>
173
17
 */
174
18
175
19
#ifndef TEST_NOREPLYSCOPE_H
176
20
#define TEST_NOREPLYSCOPE_H
177
21
178
22
#include <unity/scopes/ScopeBase.h>
179
23
180
24
class NoReplyScope : public unity::scopes::ScopeBase
181
25
{
182
26
public:
183
27
    virtual unity::scopes::SearchQueryBase::UPtr search(unity::scopes::CannedQuery const&,
184
28
                                                        unity::scopes::SearchMetadata const&) override;
185
29
    virtual unity::scopes::PreviewQueryBase::UPtr preview(unity::scopes::Result const&,
186
30
                                                          unity::scopes::ActionMetadata const&) override;
187
31
};
188
32
189
33
#endif
190
0
34
191
=== added file 'test/gtest/scopes/ReplyReaper/Registry.ini.in'
192
--- test/gtest/scopes/ReplyReaper/Registry.ini.in	1970-01-01 00:00:00 +0000
193
+++ test/gtest/scopes/ReplyReaper/Registry.ini.in	2014-07-30 21:36:19 +0000
194
@@ -0,0 +1,6 @@
195
1
[Registry]
196
2
Middleware = Zmq
197
3
Zmq.ConfigFile = @CMAKE_CURRENT_BINARY_DIR@/Zmq.ini
198
4
Scope.InstallDir = /unused
199
5
Click.InstallDir = /unused
200
6
Scoperunner.Path = /unused
201
0
7
202
=== added file 'test/gtest/scopes/ReplyReaper/ReplyReaper_test.cpp'
203
--- test/gtest/scopes/ReplyReaper/ReplyReaper_test.cpp	1970-01-01 00:00:00 +0000
204
+++ test/gtest/scopes/ReplyReaper/ReplyReaper_test.cpp	2014-07-30 21:36:19 +0000
205
@@ -0,0 +1,107 @@
206
1
/*
207
2
 * Copyright (C) 2014 Canonical Ltd
208
3
 *
209
4
 * This program is free software: you can redistribute it and/or modify
210
5
 * it under the terms of the GNU Lesser General Public License version 3 as
211
6
 * published by the Free Software Foundation.
212
7
 *
213
8
 * This program is distributed in the hope that it will be useful,
214
9
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
215
10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
216
11
 * GNU Lesser General Public License for more details.
217
12
 *
218
13
 * You should have received a copy of the GNU Lesser General Public License
219
14
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
220
15
 *
221
16
 * Authored by: Michi Henning <michi.henning@canonical.com>
222
17
 */
223
18
224
19
#include <unity/scopes/internal/RegistryObject.h>
225
20
#include <unity/scopes/internal/RuntimeImpl.h>
226
21
#include <unity/scopes/internal/ScopeImpl.h>
227
22
228
23
#include <boost/algorithm/string.hpp>
229
24
#include <gtest/gtest.h>
230
25
231
26
#include "NoReplyScope.h"
232
27
233
28
using namespace std;
234
29
using namespace unity::scopes;
235
30
using namespace unity::scopes::internal;
236
31
237
32
class NullReceiver : public SearchListenerBase
238
33
{
239
34
public:
240
35
    NullReceiver()
241
36
        : query_complete_(false)
242
37
    {
243
38
    }
244
39
245
40
    virtual void push(CategorisedResult /* result */) override
246
41
    {
247
42
    }
248
43
249
44
    virtual void finished(CompletionDetails const& details) override
250
45
    {
251
46
        // Check that finished() was called by the reaper.
252
47
        EXPECT_EQ(CompletionDetails::Error, details.status()) << details.message();
253
48
        EXPECT_TRUE(boost::starts_with(details.message(), "No activity on ReplyObject for scope"));
254
49
        lock_guard<mutex> lock(mutex_);
255
50
        query_complete_ = true;
256
51
        cond_.notify_all();
257
52
    }
258
53
259
54
    void wait_until_finished()
260
55
    {
261
56
        unique_lock<mutex> lock(mutex_);
262
57
        cond_.wait(lock, [this] { return this->query_complete_; });
263
58
    }
264
59
265
60
private:
266
61
    bool query_complete_;
267
62
    mutex mutex_;
268
63
    condition_variable cond_;
269
64
};
270
65
271
66
std::shared_ptr<core::posix::SignalTrap>
272
67
    trap(core::posix::trap_signals_for_all_subsequent_threads({core::posix::Signal::sig_chld}));
273
68
std::unique_ptr<core::posix::ChildProcess::DeathObserver>
274
69
    death_observer(core::posix::ChildProcess::DeathObserver::create_once_with_signal_trap(trap));
275
70
276
71
RuntimeImpl::SPtr run_test_registry()
277
72
{
278
73
    RuntimeImpl::SPtr runtime = RuntimeImpl::create("TestRegistry", TEST_DIR "/Runtime.ini");
279
74
    MiddlewareBase::SPtr middleware = runtime->factory()->create("TestRegistry", "Zmq", "Zmq.ini");
280
75
    RegistryObject::SPtr reg_obj(std::make_shared<RegistryObject>(*death_observer, std::make_shared<Executor>(), middleware));
281
76
    middleware->add_registry_object("TestRegistry", reg_obj);
282
77
    return runtime;
283
78
}
284
79
285
80
void scope_thread(Runtime::SPtr const& rt, string const& runtime_ini_file)
286
81
{
287
82
    NoReplyScope scope;
288
83
    rt->run_scope(&scope, runtime_ini_file, "");
289
84
}
290
85
291
86
TEST(ReplyReaper, reap)
292
87
{
293
88
    auto reg_rt = run_test_registry();
294
89
295
90
    Runtime::SPtr no_reply_rt = move(Runtime::create_scope_runtime("NoReplyScope", TEST_DIR "/Runtime.ini"));
296
91
    std::thread scope_t(scope_thread, no_reply_rt, TEST_DIR "/Runtime.ini");
297
92
298
93
    // Run a query in the scope. The query will do nothing for 3 seconds,
299
94
    // but the reaper will reap after at most 2 seconds.
300
95
    auto rt = internal::RuntimeImpl::create("", TEST_DIR "/Runtime.ini");
301
96
    auto mw = rt->factory()->create("NoReplyScope", "Zmq", TEST_DIR "/Zmq.ini");
302
97
    mw->start();
303
98
    auto proxy = mw->create_scope_proxy("NoReplyScope");
304
99
    auto scope = internal::ScopeImpl::create(proxy, rt.get(), "NoReplyScope");
305
100
306
101
    auto receiver = make_shared<NullReceiver>();
307
102
    scope->search("test", SearchMetadata("en", "phone"), receiver);
308
103
    receiver->wait_until_finished();
309
104
310
105
    no_reply_rt->destroy();
311
106
    scope_t.join();
312
107
}
313
0
108
314
=== added file 'test/gtest/scopes/ReplyReaper/Runtime.ini.in'
315
--- test/gtest/scopes/ReplyReaper/Runtime.ini.in	1970-01-01 00:00:00 +0000
316
+++ test/gtest/scopes/ReplyReaper/Runtime.ini.in	2014-07-30 21:36:19 +0000
317
@@ -0,0 +1,7 @@
318
1
[Runtime]
319
2
Registry.Identity = TestRegistry
320
3
Registry.ConfigFile = @CMAKE_CURRENT_BINARY_DIR@/Registry.ini
321
4
Reap.Expiry = 2
322
5
Reap.Interval = 1
323
6
Default.Middleware = Zmq
324
7
Zmq.ConfigFile = @CMAKE_CURRENT_BINARY_DIR@/Zmq.ini
325
0
8
326
=== added file 'test/gtest/scopes/ReplyReaper/Zmq.ini.in'
327
--- test/gtest/scopes/ReplyReaper/Zmq.ini.in	1970-01-01 00:00:00 +0000
328
+++ test/gtest/scopes/ReplyReaper/Zmq.ini.in	2014-07-30 21:36:19 +0000
329
@@ -0,0 +1,2 @@
330
1
[Zmq]
331
2
EndpointDir = /tmp
Reviewer	Review Type	Date Requested	Status
PS Jenkins bot (community)	continuous-integration		Approve on 2014-07-30
Michal Hruby (community)		2014-07-29	Approve on 2014-07-30
Review via email: mp+228600@code.launchpad.net