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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
|
/*
* Copyright 2009- ECMWF.
*
* This software is licensed under the terms of the Apache Licence version 2.0
* which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
* In applying this licence, ECMWF does not waive the privileges and immunities
* granted to it by virtue of its status as an intergovernmental organisation
* nor does it submit to any jurisdiction.
*/
#include <boost/test/unit_test.hpp>
#include "TestHelper.hpp"
#include "ecflow/base/cts/user/ClientHandleCmd.hpp"
#include "ecflow/base/cts/user/OrderNodeCmd.hpp"
#include "ecflow/core/Converter.hpp"
#include "ecflow/node/Suite.hpp"
#include "ecflow/test/scaffold/Naming.hpp"
using namespace ecf;
// The client handle commands do not change state & modify change number, hence need to bypass these checks
static bool bypass_state_modify_change_check = false;
BOOST_AUTO_TEST_SUITE(U_Base)
BOOST_AUTO_TEST_SUITE(T_ClientHandleCmd)
BOOST_AUTO_TEST_CASE(test_add_log3) {
// create once for all test below, then remove at the end
Log::create("test_add_log3.log");
BOOST_CHECK_MESSAGE(true, "stop boost test form complaining");
}
BOOST_AUTO_TEST_CASE(test_client_handle_cmd_empty_server) {
ECF_NAME_THIS_TEST();
std::vector<std::string> suite_names;
suite_names.reserve(5);
for (int i = 0; i < 5; i++) {
suite_names.push_back("s" + ecf::convert_to<std::string>(i));
}
defs_ptr new_defs = Defs::create();
// Register new handle on an EMPTY server. register the suite
for (const auto& suite_name : suite_names) {
std::vector<std::string> names;
names.push_back(suite_name);
TestHelper::invokeRequest(
new_defs.get(), Cmd_ptr(new ClientHandleCmd(0, names, false)), bypass_state_modify_change_check);
}
// We should have 5 handle, 1,2,3,4,5
// std::cout << " expect failure when dropping(DROP_USER) on handle that does not exist, handle 6" << endl;
TestHelper::invokeFailureRequest(new_defs.get(), Cmd_ptr(new ClientHandleCmd(6)));
// std::cout << " expect failure for auto add,on handle that does not exist, handle 6" << endl;
TestHelper::invokeFailureRequest(new_defs.get(), Cmd_ptr(new ClientHandleCmd(6, true /* auto add */)));
// std::cout << " expect failure for ADD,on handle that does not exist, handle 6" << endl;
TestHelper::invokeFailureRequest(new_defs.get(),
Cmd_ptr(new ClientHandleCmd(6, suite_names, ClientHandleCmd::ADD)));
// std::cout << " expect failure for REMOVE, on handle that does not exist, handle 6" << endl;
TestHelper::invokeFailureRequest(new_defs.get(),
Cmd_ptr(new ClientHandleCmd(6, suite_names, ClientHandleCmd::REMOVE)));
for (int handle = 1; handle < 6; handle++) {
// std::cout << " expect success for dropping handle " << handle << endl;
TestHelper::invokeRequest(
new_defs.get(), Cmd_ptr(new ClientHandleCmd(handle)), bypass_state_modify_change_check);
// std::cout << " expect failure for auto add,on handle that does not exist, handle " << handle << endl;
TestHelper::invokeFailureRequest(new_defs.get(), Cmd_ptr(new ClientHandleCmd(6, true /* auto add */)));
// std::cout << " expect failure for ADD,on handle that does not exist, handle " << handle <<endl;
TestHelper::invokeFailureRequest(new_defs.get(),
Cmd_ptr(new ClientHandleCmd(6, suite_names, ClientHandleCmd::ADD)));
// std::cout << " expect failure for REMOVE, on handle that does not exist, handle " << handle << "\n" <<
// endl;
TestHelper::invokeFailureRequest(new_defs.get(),
Cmd_ptr(new ClientHandleCmd(6, suite_names, ClientHandleCmd::REMOVE)));
}
}
BOOST_AUTO_TEST_CASE(test_client_handle_cmd_register_and_drop) {
ECF_NAME_THIS_TEST();
std::vector<std::string> suite_names;
suite_names.reserve(6);
for (int i = 0; i < 5; i++) {
suite_names.push_back("s" + ecf::convert_to<std::string>(i));
}
Defs defs;
for (const auto& suite_name : suite_names) {
defs.addSuite(Suite::create(suite_name));
}
// Register new handle
for (size_t j = 0; j < suite_names.size(); j++) {
std::vector<std::string> names;
names.push_back(suite_names[j]);
TestHelper::invokeRequest(
&defs, Cmd_ptr(new ClientHandleCmd(0, names, false)), bypass_state_modify_change_check);
BOOST_CHECK_MESSAGE(defs.client_suite_mgr().clientSuites().size() == j + 1,
"Expected " << j + 1 << " Client suites but found "
<< defs.client_suite_mgr().clientSuites().size());
}
// Drop the handles. take a copy, since we about to delete clientSuites
std::vector<ecf::ClientSuites> clientSuites = defs.client_suite_mgr().clientSuites();
for (auto& clientSuite : clientSuites) {
TestHelper::invokeRequest(
&defs, Cmd_ptr(new ClientHandleCmd(clientSuite.handle())), bypass_state_modify_change_check);
}
BOOST_CHECK_MESSAGE(defs.client_suite_mgr().clientSuites().empty(),
"Expected no client handles, but found " << defs.client_suite_mgr().clientSuites().size());
}
BOOST_AUTO_TEST_CASE(test_client_handle_cmd_register__with_drop) {
ECF_NAME_THIS_TEST();
std::vector<std::string> suite_names;
suite_names.reserve(6);
for (int i = 0; i < 5; i++) {
suite_names.push_back("s" + ecf::convert_to<std::string>(i));
}
Defs defs;
for (const auto& suite_name : suite_names) {
defs.addSuite(Suite::create(suite_name));
}
// Register new handle
for (size_t j = 0; j < suite_names.size(); j++) {
std::vector<std::string> names;
names.push_back(suite_names[j]);
TestHelper::invokeRequest(
&defs, Cmd_ptr(new ClientHandleCmd(0, names, false)), bypass_state_modify_change_check);
BOOST_CHECK_MESSAGE(defs.client_suite_mgr().clientSuites().size() == j + 1,
"Expected " << j + 1 << " Client suites but found "
<< defs.client_suite_mgr().clientSuites().size());
}
// Register new handle and drop existing handle at the same time. The number of registered should stay the same
for (size_t j = 0; j < suite_names.size(); j++) {
std::vector<std::string> names;
names.push_back(suite_names[j]);
TestHelper::invokeRequest(
&defs, Cmd_ptr(new ClientHandleCmd(j + 1, names, false)), bypass_state_modify_change_check);
BOOST_CHECK_MESSAGE(defs.client_suite_mgr().clientSuites().size() == suite_names.size(),
"Expected " << suite_names.size() << " Client suites but found "
<< defs.client_suite_mgr().clientSuites().size());
}
// Drop the handles. take a copy, since we about to delete clientSuites
std::vector<ecf::ClientSuites> clientSuites = defs.client_suite_mgr().clientSuites();
for (auto& clientSuite : clientSuites) {
TestHelper::invokeRequest(
&defs, Cmd_ptr(new ClientHandleCmd(clientSuite.handle())), bypass_state_modify_change_check);
}
BOOST_CHECK_MESSAGE(defs.client_suite_mgr().clientSuites().empty(),
"Expected no client handles, but found " << defs.client_suite_mgr().clientSuites().size());
}
BOOST_AUTO_TEST_CASE(test_client_handle_cmd_auto_add) {
ECF_NAME_THIS_TEST();
std::vector<std::string> suite_names;
suite_names.reserve(6);
for (int i = 0; i < 5; i++) {
suite_names.push_back("s" + std::to_string(i));
}
Defs defs;
for (const auto& suite_name : suite_names) {
defs.addSuite(Suite::create(suite_name));
}
// Register new handle, with no suites, but with auto add new suites
std::vector<std::string> names;
TestHelper::invokeRequest(
&defs, Cmd_ptr(new ClientHandleCmd(0, names, false /* auto_add */)), bypass_state_modify_change_check);
BOOST_CHECK_MESSAGE(defs.client_suite_mgr().clientSuites().size() == 1,
"Expected 1 Client suites but found " << defs.client_suite_mgr().clientSuites().size());
BOOST_CHECK_MESSAGE(defs.client_suite_mgr().clientSuites().front().auto_add_new_suites() == false,
"Expected auto add to be disabled");
// Now enable auto add
TestHelper::invokeRequest(
&defs,
Cmd_ptr(new ClientHandleCmd(defs.client_suite_mgr().clientSuites().front().handle(), true /* auto add */)),
bypass_state_modify_change_check);
BOOST_CHECK_MESSAGE(defs.client_suite_mgr().clientSuites().front().auto_add_new_suites(),
"Expected auto add to be enabled");
// now add new suite, they should get added to the new client handles
names.clear();
for (int i = 5; i < 10; i++) {
names.push_back("s" + std::to_string(i));
}
for (const auto& name : names) {
defs.addSuite(Suite::create(name));
}
std::vector<ecf::ClientSuites> clientSuites = defs.client_suite_mgr().clientSuites();
std::vector<std::string> handle_suites;
clientSuites[0].suites(handle_suites);
BOOST_CHECK_MESSAGE(handle_suites == names, "Expected suites to be automatically added to our handle");
// Delete the suite s5,s6,s7,s8,s9
for (int i = 5; i < 10; i++) {
suite_ptr suite = defs.findSuite("s" + std::to_string(i));
BOOST_CHECK_MESSAGE(suite.get(), "Failed to find suite s" << i);
suite->remove();
}
{ // Even when suites have been removed, we still keep registered suite
// These have to be explicitly deleted by the user
std::vector<ecf::ClientSuites> clientSuites = defs.client_suite_mgr().clientSuites();
std::vector<std::string> handle_suites;
clientSuites[0].suites(handle_suites);
BOOST_CHECK_MESSAGE(handle_suites.size() == 5,
"Expected handle to have 5 suites but found" << handle_suites.size());
}
}
BOOST_AUTO_TEST_CASE(test_client_handle_cmd_add_remove) {
ECF_NAME_THIS_TEST();
std::vector<std::string> suite_names;
suite_names.reserve(6);
for (int i = 0; i < 5; i++) {
suite_names.push_back("s" + std::to_string(i));
}
defs_ptr defs = Defs::create();
for (const auto& suite_name : suite_names) {
defs->addSuite(Suite::create(suite_name));
}
std::vector<std::string> empty_vec;
// Register new handle, with no suites,
{
TestHelper::invokeRequest(
defs.get(), Cmd_ptr(new ClientHandleCmd(0, empty_vec, false)), bypass_state_modify_change_check);
BOOST_CHECK_MESSAGE(defs->client_suite_mgr().clientSuites().size() == 1,
"Expected 1 Client suites but found " << defs->client_suite_mgr().clientSuites().size());
BOOST_CHECK_MESSAGE(!defs->client_suite_mgr().handle_changed(1),
"Expected No handle change, when no real suites added");
defs_ptr created_defs = defs->client_suite_mgr().create_defs(1, defs); // clear the handle change
BOOST_CHECK_MESSAGE(created_defs, "Expected defs to be created");
BOOST_CHECK_MESSAGE(created_defs->suiteVec().empty(), "Expected no suites");
BOOST_CHECK_MESSAGE(!defs->client_suite_mgr().handle_changed(1),
"Expected handle changed to be cleared after create_defs()");
}
// Now add suites to the existing handle, then check they match.
std::vector<std::string> handle_suites;
{
TestHelper::invokeRequest(defs.get(),
Cmd_ptr(new ClientHandleCmd(defs->client_suite_mgr().clientSuites().front().handle(),
suite_names,
ClientHandleCmd::ADD)),
bypass_state_modify_change_check);
defs->client_suite_mgr().clientSuites().front().suites(handle_suites);
BOOST_CHECK_MESSAGE(handle_suites == suite_names, "Expected suites to be added to our handle");
BOOST_CHECK_MESSAGE(defs->client_suite_mgr().handle_changed(1),
"Expected handle changed when adding new suites to our handle");
defs_ptr created_defs = defs->client_suite_mgr().create_defs(1, defs); // clear the handle change
BOOST_CHECK_MESSAGE(created_defs, "Expected defs to be created");
BOOST_CHECK_MESSAGE(created_defs.get() == defs.get(),
"When *ALL* suites registered, the returned defs should be the same");
BOOST_CHECK_MESSAGE(created_defs->suiteVec().size() == suite_names.size(), "Not all suites created");
}
// Now remove the suites from the handle
{
TestHelper::invokeRequest(defs.get(),
Cmd_ptr(new ClientHandleCmd(defs->client_suite_mgr().clientSuites().front().handle(),
suite_names,
ClientHandleCmd::REMOVE)),
bypass_state_modify_change_check);
handle_suites.clear();
defs->client_suite_mgr().clientSuites().front().suites(handle_suites);
BOOST_CHECK_MESSAGE(handle_suites == empty_vec,
"Expected no suites in our handle but found " << handle_suites.size());
BOOST_CHECK_MESSAGE(defs->client_suite_mgr().handle_changed(1),
"Expected handle changed when adding new removing suites");
defs_ptr created_defs = defs->client_suite_mgr().create_defs(1, defs); // clear the handle change
BOOST_CHECK_MESSAGE(created_defs, "Expected defs to be created");
BOOST_CHECK_MESSAGE(created_defs->suiteVec().empty(), "Expected no suites");
BOOST_CHECK_MESSAGE(!defs->client_suite_mgr().handle_changed(1),
"Expected handle changed to be cleared after create_defs()");
}
}
static bool check_ordering(Defs& defs) {
// make sure order of suites in handles is the same as server order
const std::vector<suite_ptr>& suite_vec = defs.suiteVec();
std::vector<std::string> suite_names;
for (const auto& i : suite_vec) {
suite_names.push_back(i->name());
}
// Drop the handles. take a copy, since we about to delete clientSuites
std::vector<ecf::ClientSuites> clientSuites = defs.client_suite_mgr().clientSuites();
for (auto& clientSuite : clientSuites) {
std::vector<std::string> names;
names.reserve(6);
clientSuite.suites(names);
if (names != suite_names) {
return false;
}
}
return true;
}
BOOST_AUTO_TEST_CASE(test_client_handle_suite_ordering) {
ECF_NAME_THIS_TEST();
// ensure order of suites in a handle is the same as server suites
std::vector<std::string> suite_names;
suite_names.reserve(6);
for (int i = 0; i < 5; i++) {
suite_names.push_back("s" + ecf::convert_to<std::string>(i));
}
Defs defs;
for (const auto& suite_name : suite_names) {
defs.addSuite(Suite::create(suite_name));
}
// Register 3 new handle
TestHelper::invokeRequest(
&defs, Cmd_ptr(new ClientHandleCmd(0, suite_names, true)), bypass_state_modify_change_check);
TestHelper::invokeRequest(
&defs, Cmd_ptr(new ClientHandleCmd(0, suite_names, true)), bypass_state_modify_change_check);
TestHelper::invokeRequest(
&defs, Cmd_ptr(new ClientHandleCmd(0, suite_names, true)), bypass_state_modify_change_check);
BOOST_CHECK_MESSAGE(defs.client_suite_mgr().clientSuites().size() == 3,
"Expected 3 Client suites but found " << defs.client_suite_mgr().clientSuites().size());
// After registration make sure ordering is the same
BOOST_CHECK_MESSAGE(check_ordering(defs), "Ordering not preserved after registration of handles");
// Check ordering after OrderNodeCmd
TestHelper::invokeRequest(&defs, Cmd_ptr(new OrderNodeCmd("/s0", NOrder::DOWN)));
BOOST_CHECK_MESSAGE(check_ordering(defs), "Ordering not preserved after NOrder::DOWN");
TestHelper::invokeRequest(&defs, Cmd_ptr(new OrderNodeCmd("/s0", NOrder::UP)));
BOOST_CHECK_MESSAGE(check_ordering(defs), "Ordering not preserved after NOrder::UP");
TestHelper::invokeRequest(&defs, Cmd_ptr(new OrderNodeCmd("/s0", NOrder::BOTTOM)));
BOOST_CHECK_MESSAGE(check_ordering(defs), "Ordering not preserved after NOrder::BOTTOM");
TestHelper::invokeRequest(&defs, Cmd_ptr(new OrderNodeCmd("/s0", NOrder::TOP)));
BOOST_CHECK_MESSAGE(check_ordering(defs), "Ordering not preserved after NOrder::TOP");
TestHelper::invokeRequest(&defs, Cmd_ptr(new OrderNodeCmd("/s0", NOrder::ALPHA)));
BOOST_CHECK_MESSAGE(check_ordering(defs), "Ordering not preserved after NOrder::ALPHA");
// check ordering after adding new suites, notice we auto add new suites to all our handles
defs.add_suite("sxx");
BOOST_CHECK_MESSAGE(check_ordering(defs), "Ordering not preserved after adding a new suite");
}
BOOST_AUTO_TEST_CASE(test_destroy_log3) {
Log::destroy();
fs::remove("test_add_log3.log");
BOOST_CHECK_MESSAGE(true, "stop boost test form complaining");
}
BOOST_AUTO_TEST_SUITE_END()
BOOST_AUTO_TEST_SUITE_END()
|
