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
|
/*
* 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 "MockServer.hpp"
#include "TestHelper.hpp"
#include "ecflow/base/cts/user/ClientHandleCmd.hpp"
#include "ecflow/base/cts/user/OrderNodeCmd.hpp"
#include "ecflow/base/stc/SSyncCmd.hpp"
#include "ecflow/core/Ecf.hpp"
#include "ecflow/core/Str.hpp"
#include "ecflow/node/Defs.hpp"
#include "ecflow/node/Family.hpp"
#include "ecflow/node/Suite.hpp"
#include "ecflow/node/System.hpp"
#include "ecflow/node/Task.hpp"
#include "ecflow/node/formatter/DefsWriter.hpp"
#include "ecflow/test/scaffold/Naming.hpp"
using namespace std;
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_SSyncCmdOrder)
/// define a function which returns nothing, and takes a defs_ptr parameter
typedef boost::function<void(defs_ptr)> defs_change_cmd;
static std::vector<std::string> vector_abcd() {
std::vector<std::string> names;
names.reserve(4);
names.emplace_back("a");
names.emplace_back("b");
names.emplace_back("c");
names.emplace_back("d");
return names;
}
static std::vector<std::string> vector_dcba() {
std::vector<std::string> names;
names.reserve(4);
names.emplace_back("d");
names.emplace_back("c");
names.emplace_back("b");
names.emplace_back("a");
return names;
}
static defs_ptr create_defs() {
std::vector<std::string> names = vector_dcba();
defs_ptr defs = Defs::create();
for (size_t j = 0; j < names.size(); j++) {
suite_ptr s = defs->add_suite(names[j]);
if (0 == j) { // only add family to first suite
for (size_t k = 0; k < names.size(); k++) {
family_ptr f = s->add_family(names[k]);
for (const auto& name : names) {
task_ptr t = f->add_task(name);
// t->add_alias_only(); // alias0
// t->add_alias_only(); // alias1
// t->add_alias_only(); // alias2
}
}
}
}
return defs;
}
/// Re-use the same test scaffold to modify and then resync, by passing in a function that will modify the defs
static void test_sync_scaffold(defs_change_cmd the_defs_change_command,
unsigned int test_equality, /*0 means test equality, any other number test size*/
bool full_sync,
unsigned int client_handle) {
defs_ptr server_defs = create_defs();
ServerReply server_reply;
server_reply.set_client_defs(create_defs());
Ecf::set_debug_equality(true); // only has affect in DEBUG build
BOOST_CHECK_MESSAGE(*server_defs == *server_reply.client_defs(),
"Starting point client and server defs should be the same");
Ecf::set_debug_equality(false); // only has affect in DEBUG build
// Get change number before any changes
Ecf::set_state_change_no(0);
Ecf::set_modify_change_no(0);
unsigned int client_state_change_no = Ecf::state_change_no();
unsigned int client_modify_change_no = Ecf::modify_change_no();
// make some change to the server
{
Ecf::set_server(true);
the_defs_change_command(server_defs);
std::string errorMsg;
BOOST_REQUIRE_MESSAGE(server_defs->checkInvariants(errorMsg), "Invariants failed " << errorMsg);
BOOST_REQUIRE_MESSAGE(!(*server_reply.client_defs() == *server_defs),
"Expected client and server defs to differ "
<< ecf::as_string(*server_reply.client_defs(), PrintStyle::DEFS) << "\n"
<< "server defs = " << ecf::as_string(*server_defs, PrintStyle::DEFS));
Ecf::set_server(false);
}
// cout << "test_sync_scaffold AFTER Command before SYNC: Server:\n" << *server_defs << "\n";
// cout << "test_sync_scaffold AFTER Command before SYNC: Client:\n" << *server_reply.client_defs() << "\n";
MockServer mock_server(server_defs);
SSyncCmd cmd(client_handle, client_state_change_no, client_modify_change_no, &mock_server);
string error_msg;
BOOST_REQUIRE_MESSAGE(mock_server.defs()->checkInvariants(error_msg), error_msg);
BOOST_CHECK_MESSAGE(cmd.do_sync(server_reply), "Expected server to change");
BOOST_CHECK_MESSAGE(server_reply.in_sync(), "Expected to be in sync");
BOOST_CHECK_MESSAGE(server_reply.full_sync() == full_sync, "Expected full sync");
DebugEquality debug_equality; // only has affect in DEBUG build
if (0 == test_equality) {
BOOST_CHECK_MESSAGE(*server_defs == *server_reply.client_defs(), "Server and client should be same after sync");
}
else {
BOOST_CHECK_MESSAGE(server_reply.client_defs()->suiteVec().size() == test_equality,
"Expected suite of size " << test_equality << " but found "
<< server_reply.client_defs()->suiteVec().size());
}
}
static void reorder_suites(defs_ptr theDefs) {
TestHelper::invokeRequest(theDefs.get(), Cmd_ptr(new OrderNodeCmd("/a", NOrder::ALPHA)));
BOOST_REQUIRE_MESSAGE(ecf::algorithm::transform_to_name_vector(theDefs->suiteVec()) == vector_abcd(),
"NOrder::ALPHA expected "
<< ecf::algorithm::join(vector_abcd()) << " but found: "
<< ecf::algorithm::join(ecf::algorithm::transform_to_name_vector(theDefs->suiteVec())));
}
static void reorder_family(defs_ptr theDefs) {
// std::cout << "reorder_family\n" << *theDefs << "\n";
TestHelper::invokeRequest(theDefs.get(), Cmd_ptr(new OrderNodeCmd("/d/d", NOrder::ALPHA)));
std::vector<Family*> families;
theDefs->findSuite("d")->getAllFamilies(families);
BOOST_REQUIRE_MESSAGE(ecf::algorithm::transform_to_name_vector(families) == vector_abcd(),
"NOrder::ALPHA expected "
<< ecf::algorithm::join(vector_abcd()) << " but found: "
<< ecf::algorithm::join(ecf::algorithm::transform_to_name_vector(families)));
}
static void reorder_task(defs_ptr theDefs) {
// std::cout << "reorder_task\n" << *theDefs << "\n";
TestHelper::invokeRequest(theDefs.get(), Cmd_ptr(new OrderNodeCmd("/d/d/d", NOrder::ALPHA)));
std::vector<Task*> tasks;
theDefs->findAbsNode("/d/d")->getAllTasks(tasks);
BOOST_REQUIRE_MESSAGE(ecf::algorithm::transform_to_name_vector(tasks) == vector_abcd(),
"NOrder::ALPHA expected "
<< ecf::algorithm::join(vector_abcd()) << " but found: "
<< ecf::algorithm::join(ecf::algorithm::transform_to_name_vector(tasks)));
}
// static void reorder_alias(defs_ptr theDefs) {
// //std::cout << "reorder_task\n" << *theDefs << "\n";
//
// TestHelper::invokeRequest(theDefs.get(),Cmd_ptr( new OrderNodeCmd("/d/d/d/alias0",NOrder::ALPHA)));
//
// std::vector<alias_ptr> aliases;
// theDefs->findAbsNode("/d/d/d")->get_all_aliases(aliases);
// BOOST_REQUIRE_MESSAGE( ecf::algorithm::transform_to_name_vector(aliases) == vector_abcd(),"NOrder::ALPHA expected
// " << ecf::algorithm::join(vector_abcd())<< " but found: " <<
// ecf::algorithm::join(ecf::algorithm::transform_to_name_vector(tasks)));
// }
static void reorder_suites_using_handles(defs_ptr theDefs) {
// *** NOTE ****: Whenever we register a handle, we get a *FULL* sync
// create client handle which references all the suites
// It should be noted that invokeRequest, uses a MockServer, which set/unsets
// Hence after this call Ecf::server_ is false. Hence we need to ensure that following
// commands/ DM function set Ecf::server_ to true.
std::vector<std::string> suite_names = vector_abcd();
TestHelper::invokeRequest(
theDefs.get(), Cmd_ptr(new ClientHandleCmd(0, suite_names, false)), bypass_state_modify_change_check);
BOOST_CHECK_MESSAGE(theDefs->client_suite_mgr().clientSuites().size() == 1,
"Expected 1 Client suites but found " << theDefs->client_suite_mgr().clientSuites().size());
TestHelper::invokeRequest(theDefs.get(), Cmd_ptr(new OrderNodeCmd("/a", NOrder::ALPHA)));
BOOST_REQUIRE_MESSAGE(ecf::algorithm::transform_to_name_vector(theDefs->suiteVec()) == vector_abcd(),
"NOrder::ALPHA expected "
<< ecf::algorithm::join(vector_abcd()) << " but found: "
<< ecf::algorithm::join(ecf::algorithm::transform_to_name_vector(theDefs->suiteVec())));
}
static void reorder_family_using_handles(defs_ptr theDefs) {
// *** NOTE ****: Whenever we register a handle, we get a *FULL* sync
// create client handle which references all the suites
// It should be noted that invokeRequest, uses a MockServer, which set/unsets
// Hence after this call Ecf::server_ is false. Hence we need to ensure that following
// commands/ DM function set Ecf::server_ to true.
std::vector<std::string> suite_names;
suite_names.emplace_back("d"); // clinet handle for suite 'd' ONLY
TestHelper::invokeRequest(
theDefs.get(), Cmd_ptr(new ClientHandleCmd(0, suite_names, false)), bypass_state_modify_change_check);
BOOST_CHECK_MESSAGE(theDefs->client_suite_mgr().clientSuites().size() == 1,
"Expected 1 Client suites but found " << theDefs->client_suite_mgr().clientSuites().size());
/// Don't call, data model function directly, since Ecf::server_ is false. *here*
/// The suite should stay the same, only suite d's family should change
TestHelper::invokeRequest(theDefs.get(), Cmd_ptr(new OrderNodeCmd("/d/d", NOrder::ALPHA)));
BOOST_REQUIRE_MESSAGE(
ecf::algorithm::transform_to_name_vector(theDefs->suiteVec()) == vector_dcba(),
"expected " << ecf::algorithm::join(vector_dcba()) << " but found: "
<< ecf::algorithm::join(ecf::algorithm::transform_to_name_vector(theDefs->suiteVec())));
suite_ptr suite_a = theDefs->findSuite("d");
std::vector<Family*> families;
suite_a->getAllFamilies(families);
BOOST_REQUIRE_MESSAGE(ecf::algorithm::transform_to_name_vector(families) == vector_abcd(),
"NOrder::ALPHA expected "
<< ecf::algorithm::join(vector_abcd()) << " but found: "
<< ecf::algorithm::join(ecf::algorithm::transform_to_name_vector(families)));
}
BOOST_AUTO_TEST_CASE(test_ssync_cmd_test_order) {
ECF_NAME_THIS_TEST();
TestLog test_log(
"test_ssync_cmd_test_order.log"); // will create log file, and destroy log and remove file at end of scope
test_sync_scaffold(reorder_suites, 0 /* test equality */, false /* expect full_sync */, 0);
test_sync_scaffold(reorder_family, 0 /* test equality */, false /* expect full_sync */, 0);
test_sync_scaffold(reorder_task, 0 /* test equality */, false /* expect full_sync */, 0);
// test_sync_scaffold(reorder_alias, 0 /* test equality */, false /* expect full_sync */, 0);
test_sync_scaffold(
reorder_suites_using_handles, 0 /* test equality */, true /* expect full_sync */, 1 /* client handle */);
test_sync_scaffold(
reorder_family_using_handles, 1 /* test size */, true /* expect full_sync */, 1 /* client handle */);
/// Keep valgrind happy
System::destroy();
}
BOOST_AUTO_TEST_SUITE_END()
BOOST_AUTO_TEST_SUITE_END()
|
