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
|
/*
* 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 "InvokeServer.hpp"
#include "SCPort.hpp"
#include "ecflow/client/ClientEnvironment.hpp"
#include "ecflow/client/ClientInvoker.hpp"
#include "ecflow/core/File.hpp"
#include "ecflow/node/Submittable.hpp"
#include "ecflow/node/Suite.hpp"
#include "ecflow/node/System.hpp" // kill singleton for valgrind
#include "ecflow/test/scaffold/Naming.hpp"
using namespace std;
using namespace ecf;
BOOST_AUTO_TEST_SUITE(S_Client)
BOOST_AUTO_TEST_SUITE(T_ServerAndLifeCycle)
// ************************************************************************************
// Note: If you make edits to node tree, they will have no effect until the server is rebuilt
//
// Note: To test HPUX->Linux, invoke serve on (Linux/HPUX) and the client cmds on other system
// On the client side set ECF_HOST to machine name. To allow further testing if ECF_HOST
// is specified then *don't* shutdown the server
// ************************************************************************************
BOOST_AUTO_TEST_CASE(test_client_lifecyle) {
ECF_NAME_THIS_TEST();
// *******************************************************************************************
// This test will *ONLY* work when testing with new server invocation, since it relies
// on disabling job generation. Hence ignore test if ECF_HOST has been defined
// *******************************************************************************************
std::string host = ClientEnvironment::hostSpecified();
if (!host.empty()) {
// Server allready started, since we cant disable job generation ignore this test
std::cout << "Ignoring test when ECF_HOST specified..." << endl;
return;
}
// This will remove check pt and backup file before server start, to avoid the server from loading previous test
// data
// ** NOTE: We disable job generation in the server **/
InvokeServer invokeServer(
"Client:: ...test_client_lifecycle", SCPort::next(), true /*disable job generation in server*/);
BOOST_REQUIRE_MESSAGE(invokeServer.server_started(),
"Server failed to start on " << invokeServer.host() << ":" << invokeServer.port());
ClientInvoker theClient(invokeServer.host(), invokeServer.port());
BOOST_REQUIRE_MESSAGE(theClient.restartServer() == 0,
CtsApi::restartServer() << " should return 0 server not started, or connection refused\n"
<< theClient.errorMsg());
// load the defs into the server
{
std::string path = File::test_data("libs/client/test/data/lifecycle.txt", "libs/client");
BOOST_REQUIRE_MESSAGE(theClient.delete_all() == 0,
CtsApi::to_string(CtsApi::delete_node()) << " should return 0\n"
<< theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.loadDefs(path) == 0, "Load defs failed \n" << theClient.errorMsg());
}
{
BOOST_REQUIRE_MESSAGE(theClient.getDefs() == 0,
CtsApi::get() << " failed should return 0\n"
<< theClient.errorMsg());
defs_ptr serverDefs = theClient.defs();
BOOST_REQUIRE_MESSAGE(serverDefs.get(), "Server returned a NULL defs");
BOOST_REQUIRE_MESSAGE(serverDefs->suiteVec().size() >= 1, " no suite ?");
}
// Now go through and simulate client request to change Node tree state.
// This is **highly** dependent on lifecycle.txt
// suite suite1
// family family1
// task a
// event 1 myEvent
// meter myMeter 0 100
// task b
// trigger a == complete
// endfamily
// family family2
// task aa
// trigger ../family1/a:myMeter >= 20 and ../family1/a:myEvent
// task bb
// trigger ../family1/a:myMeter >= 50 || ../family1/a:myEvent
// endfamily
// endsuite
string suite1_family1_a = "suite1/family1/a";
string suite1_family1_b = "suite1/family1/b";
string suite1_family2_aa = "suite1/family2/aa";
string suite1_family2_bb = "suite1/family2/bb";
{
// Begin will set all states to queued and then start job submission placing
// any submitted jobs into the active state. Note server setup has disabled job generation
BOOST_REQUIRE_MESSAGE(theClient.begin("suite1") == 0,
CtsApi::begin("suite1") << " failed should return 0\n"
<< theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.getDefs() == 0,
CtsApi::get() << " failed should return 0\n"
<< theClient.errorMsg());
defs_ptr serverDefs = theClient.defs();
node_ptr node = serverDefs->findAbsNode(suite1_family1_a);
// Occasionally we get a random failure here. I suspect this is because the job generation caused by the
// BeginCmd, is such that the
// time_now >= next_poll_time_ //* next_poll_time_ should always be at the minute interval
// When this happens, we defer job generation for a second: See
// NodeTreeTraverser::traverse_node_tree_and_job_generate: line 343 Added time to confirm. If this the case, run
// test when not at/near minute interval
BOOST_REQUIRE_MESSAGE(node->state() == NState::ACTIVE,
"Node expected NState::ACTIVE, but found to be "
<< NState::toString(node->state()) << " time now:" << Calendar::second_clock_time());
}
//**********************************************************************
// Create a request to set the event on Node suite1/family1/a
// This should place suite1_family2_bb immediately into submitted state
// Since we at least one node in submitted, suite should be in SUBMITTED state
{
theClient.taskPath(suite1_family1_a);
theClient.set_jobs_password(Submittable::DUMMY_JOBS_PASSWORD());
BOOST_REQUIRE_MESSAGE(theClient.eventTask("myEvent") == 0, " failed should return 0\n" << theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.forceDependencyEval() == 0,
CtsApi::forceDependencyEval() << " failed should return 0\n"
<< theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.getDefs() == 0,
CtsApi::get() << " failed should return 0\n"
<< theClient.errorMsg());
defs_ptr serverDefs = theClient.defs();
// PrintStyle style(PrintStyle::STATE);
// cerr << *serverDefs.get() << "\n";
BOOST_REQUIRE_MESSAGE(serverDefs.get(), "get command failed to get node tree from server");
node_ptr node = serverDefs->findAbsNode(suite1_family1_a);
BOOST_REQUIRE_MESSAGE(node->state() == NState::ACTIVE,
"Node expected NState::ACTIVE, but found to be " << NState::toString(node->state()));
node_ptr nodeb = serverDefs->findAbsNode(suite1_family2_bb);
BOOST_REQUIRE_MESSAGE(nodeb->state() == NState::ACTIVE,
"Node expected NState::ACTIVE, but found to be " << NState::toString(nodeb->state()));
}
//**********************************************************************
// Create a request to set the Meter on Node suite1/family1/a
// This should force suite1_family2_aa immediately into submitted state
// This should force suite1_family2_bb immediately into submitted state
{
theClient.taskPath(suite1_family1_a);
{
char* argv[] = {
const_cast<char*>("ClientInvoker"), const_cast<char*>("--meter=myMeter"), const_cast<char*>("100")};
BOOST_REQUIRE_MESSAGE(theClient.invoke(3, argv) == 0, " should return 0\n" << theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.forceDependencyEval() == 0,
CtsApi::forceDependencyEval() << " failed should return 0\n"
<< theClient.errorMsg());
}
BOOST_REQUIRE_MESSAGE(theClient.getDefs() == 0,
CtsApi::get() << " failed should return 0\n"
<< theClient.errorMsg());
defs_ptr serverDefs = theClient.defs();
BOOST_REQUIRE_MESSAGE(serverDefs.get(), "get command failed to get node tree from server");
node_ptr nodeaa = serverDefs->findAbsNode(suite1_family2_aa);
BOOST_REQUIRE_MESSAGE(nodeaa->state() == NState::ACTIVE,
"Node expected NState::ACTIVE, but found to be " << NState::toString(nodeaa->state()));
node_ptr nodebb = serverDefs->findAbsNode(suite1_family2_bb);
BOOST_REQUIRE_MESSAGE(nodebb->state() == NState::ACTIVE,
"Node expected NState::ACTIVE, but found to be " << NState::toString(nodebb->state()));
}
//**********************************************************************
// Create a request to complete task suite1/family1/a
// This should force suite1_family1_b to complete
{
theClient.taskPath(suite1_family1_a);
BOOST_REQUIRE_MESSAGE(theClient.completeTask() == 0,
TaskApi::complete() << " failed should return 0\n"
<< theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.forceDependencyEval() == 0,
CtsApi::forceDependencyEval() << " failed should return 0\n"
<< theClient.errorMsg());
// Resolve dependencies
// We could either wait 60 second or
// added a custom command that will force dependency evaluation
BOOST_REQUIRE_MESSAGE(theClient.forceDependencyEval() == 0,
"--force-dep-eval failed should return 0\n"
<< theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.getDefs() == 0,
CtsApi::get() << " failed should return 0\n"
<< theClient.errorMsg());
defs_ptr serverDefs = theClient.defs();
BOOST_REQUIRE_MESSAGE(serverDefs.get(), "get command failed to get node tree from server");
node_ptr node = serverDefs->findAbsNode(suite1_family1_b);
BOOST_REQUIRE_MESSAGE(node->state() == NState::ACTIVE,
"Expected NState::ACTIVE, but found " << NState::toString(node->state()));
}
//********************************************************************************
// Complete the remaining tasks. Should really call init first, but what the eck.
{
theClient.taskPath(suite1_family1_b);
BOOST_REQUIRE_MESSAGE(theClient.completeTask() == 0,
TaskApi::complete() << " failed should return 0\n"
<< theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.forceDependencyEval() == 0,
CtsApi::forceDependencyEval() << " failed should return 0\n"
<< theClient.errorMsg());
theClient.taskPath(suite1_family2_aa);
BOOST_REQUIRE_MESSAGE(theClient.completeTask() == 0,
TaskApi::complete() << " failed should return 0\n"
<< theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.forceDependencyEval() == 0,
CtsApi::forceDependencyEval() << " failed should return 0\n"
<< theClient.errorMsg());
theClient.taskPath(suite1_family2_bb);
BOOST_REQUIRE_MESSAGE(theClient.completeTask() == 0,
TaskApi::complete() << " failed should return 0\n"
<< theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.forceDependencyEval() == 0,
CtsApi::forceDependencyEval() << " failed should return 0\n"
<< theClient.errorMsg());
}
{
// Get the node tree back from the server, and check its node state
// All node state should be complete. + check meter/event value was set properly
BOOST_REQUIRE_MESSAGE(theClient.getDefs() == 0,
CtsApi::get() << " failed should return 0\n"
<< theClient.errorMsg());
defs_ptr serverDefs = theClient.defs();
BOOST_REQUIRE_MESSAGE(serverDefs.get(), "get command failed to get node tree from server");
std::string metername = "myMeter";
int meterValue = 100;
node_ptr node = serverDefs->findAbsNode(suite1_family1_a);
const Meter& theMeter = node->findMeter(metername);
BOOST_REQUIRE_MESSAGE(!theMeter.empty(), "Could not find the meter");
BOOST_REQUIRE_MESSAGE(theMeter.value() == meterValue,
"Expected meter value " << meterValue << " but found " << theMeter.value());
{
std::string errorMsg;
BOOST_REQUIRE_MESSAGE(serverDefs->checkInvariants(errorMsg), errorMsg);
}
std::string eventname = "myEvent";
const Event& theEvent = node->findEventByNameOrNumber(eventname);
BOOST_REQUIRE_MESSAGE(!theEvent.empty(), "Could not find the event myEvent");
BOOST_REQUIRE_MESSAGE(theEvent.value(), "The event was not set");
const std::vector<suite_ptr>& suiteVec = serverDefs->suiteVec();
suite_ptr suite = suiteVec.back();
BOOST_REQUIRE_MESSAGE(suite->state() == NState::COMPLETE,
"Suite expected NState::COMPLETE, but found to be " << NState::toString(suite->state()));
}
{
// Check that a log file was created, by asking the server for it.
BOOST_REQUIRE_MESSAGE(theClient.getLog() == 0, "get log failed should return 0\n" << theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(!theClient.get_string().empty(), "The log file returned from the server is empty!!");
// Clear the log
BOOST_REQUIRE_MESSAGE(theClient.flushLog() == 0,
CtsApi::flushLog() << " failed should return 0\n"
<< theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.clearLog() == 0,
CtsApi::clearLog() << " failed should return 0\n"
<< theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.delete_all() == 0,
CtsApi::to_string(CtsApi::delete_node()) << " should return 0\n"
<< theClient.errorMsg());
}
/// Destroy singleton's to avoid valgrind from complaining
System::destroy();
}
BOOST_AUTO_TEST_SUITE_END()
BOOST_AUTO_TEST_SUITE_END()
|
