File: TestHandle.cpp

package info (click to toggle)
ecflow 5.15.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 51,868 kB
  • sloc: cpp: 269,341; python: 22,756; sh: 3,609; perl: 770; xml: 333; f90: 204; ansic: 141; makefile: 70
file content (424 lines) | stat: -rw-r--r-- 21,104 bytes parent folder | download
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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
/*
 * 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 <iostream>
#include <limits>

#include <boost/test/unit_test.hpp>

#include "ServerTestHarness.hpp"
#include "TestFixture.hpp"
#include "ecflow/attribute/VerifyAttr.hpp"
#include "ecflow/base/cts/ClientToServerCmd.hpp"
#include "ecflow/core/AssertTimer.hpp"
#include "ecflow/core/Converter.hpp"
#include "ecflow/core/PrintStyle.hpp"
#include "ecflow/core/Timer.hpp"
#include "ecflow/node/Defs.hpp"
#include "ecflow/node/Family.hpp"
#include "ecflow/node/Suite.hpp"
#include "ecflow/node/Task.hpp"
#include "ecflow/node/formatter/DefsWriter.hpp"
#include "ecflow/test/scaffold/Naming.hpp"

using namespace std;
using namespace ecf;

///
/// \note This is used to INVOKE a SINGLE test.
/// Making it easier for Easier for debugging and development
///

BOOST_AUTO_TEST_SUITE(S_Test)

BOOST_AUTO_TEST_SUITE(T_Handle)

BOOST_AUTO_TEST_CASE(test_handle) {
    ECF_NAME_THIS_TEST();

    DurationTimer timer;
    TestClean clean_at_start_and_end;

    Defs theDefs;
    {
        for (int s = 0; s < 7; s++) {
            suite_ptr suite = theDefs.add_suite("s" + ecf::convert_to<std::string>(s));
            suite->addDefStatus(DState::SUSPENDED); // NO NEED to run jobs for this test:
            for (int t = 0; t < 2; t++) {
                suite->add_task("t" + ecf::convert_to<std::string>(t));
            }
        }
    }

    // The test harness will create corresponding directory structure & default ecf file
    ServerTestHarness serverTestHarness;
    serverTestHarness.run(theDefs,
                          ServerTestHarness::testDataDefsLocation("test_handle.def"),
                          1 /*timeout*/,
                          false /* don't wait for test to finish */);

    std::vector<std::string> suites_s0_s1_s2;
    suites_s0_s1_s2.push_back("s0");
    suites_s0_s1_s2.push_back("s1");
    suites_s0_s1_s2.push_back("s2");
    std::vector<std::string> suites_s3_s4;
    suites_s3_s4.push_back("s3");
    suites_s3_s4.push_back("s4");
    std::vector<std::string> suites_s0_s1_s2_s3_s4;
    suites_s0_s1_s2_s3_s4.push_back("s0");
    suites_s0_s1_s2_s3_s4.push_back("s1");
    suites_s0_s1_s2_s3_s4.push_back("s2"), suites_s0_s1_s2_s3_s4.push_back("s3"), suites_s0_s1_s2_s3_s4.push_back("s4");
    ;
    std::vector<std::pair<unsigned int, std::vector<std::string>>> ch_suites;

    {
        // register suites s0,s1,s2
        TestFixture::client().ch_register(false /*add new suites to handle*/, suites_s0_s1_s2);

        // get the handle associated with the registered suites
        unsigned int client_handle = TestFixture::client().server_reply().client_handle();

        // Check the sync_local() does a full sync for our handle
        TestFixture::client().sync_local();
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().in_sync(), "Expected to be in sync after syn_local()");
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().full_sync(),
                            "Expected a full_sync() after registering");

        // Now check the suites were registered, correctly
        TestFixture::client().ch_suites();
        ch_suites = TestFixture::client().server_reply().get_client_handle_suites();
        BOOST_CHECK_MESSAGE(!ch_suites.empty(), "Expected to have registered suites");
        BOOST_CHECK_MESSAGE(ch_suites.size() == 1, "Expected to have registered a single set");
        BOOST_CHECK_MESSAGE(ch_suites[0].first == client_handle,
                            "Expected first client handle to be: " << client_handle << ", but found "
                                                                   << ch_suites[0].first);
        BOOST_CHECK_MESSAGE(ch_suites[0].second == suites_s0_s1_s2, "Expected suites s0,s1,s2");

        // Now drop the handle and Check handle was dropped
        TestFixture::client().ch_drop(client_handle);
        TestFixture::client().ch_suites();
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().get_client_handle_suites().empty(),
                            "Expected to have no registered suites");
    }

    {
        // register suites s0,s1,s2
        TestFixture::client().ch_register(false /*add new suites to handle*/, suites_s0_s1_s2);

        // get the handle associated with the registered suites
        unsigned int client_handle = TestFixture::client().server_reply().client_handle();
        BOOST_CHECK_MESSAGE(client_handle == 1, "Expected to have handle 1");

        // Check the sync_local() does a full sync for our handle. *THIS* should also clear the handle_changed flag
        TestFixture::client().sync_local();
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().in_sync(), "Expected to be in sync after syn_local()");
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().full_sync(),
                            "Expected a full_sync() after registering");

        // add additional suites & check suites were added to our handle. Sync_local should returna full_sync()
        std::vector<std::string> added_suites;
        added_suites.push_back("s3");
        added_suites.push_back("s4");
        TestFixture::client().ch_add(client_handle, added_suites);

        TestFixture::client().ch_suites();
        ch_suites = TestFixture::client().server_reply().get_client_handle_suites();
        BOOST_CHECK_MESSAGE(!ch_suites.empty(), "Expected to have registered suites");
        BOOST_CHECK_MESSAGE(ch_suites.size() == 1, "Expected to have registered a single set");
        BOOST_CHECK_MESSAGE(ch_suites[0].first == client_handle,
                            "Expected first client handle to be: " << client_handle << ", but found "
                                                                   << ch_suites[0].first);
        BOOST_CHECK_MESSAGE(ch_suites[0].second == suites_s0_s1_s2_s3_s4, "Expected suites s0,s1,s2,s3,s4");

        TestFixture::client().sync_local();
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().full_sync(),
                            "Expected a full_sync() after adding suites.");

        // remove the added suites, and check they were removed
        TestFixture::client().ch_remove(client_handle, added_suites);

        TestFixture::client().ch_suites();
        ch_suites = TestFixture::client().server_reply().get_client_handle_suites();
        BOOST_CHECK_MESSAGE(!ch_suites.empty(), "Expected to have registered suites");
        BOOST_CHECK_MESSAGE(ch_suites.size() == 1, "Expected to have registered a single set");
        BOOST_CHECK_MESSAGE(ch_suites[0].first == client_handle,
                            "Expected first client handle to be: " << client_handle << ", but found "
                                                                   << ch_suites[0].first);
        BOOST_CHECK_MESSAGE(ch_suites[0].second == suites_s0_s1_s2, "Expected suites s0,s1,s2");

        TestFixture::client().sync_local();
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().full_sync(),
                            "Expected a full_sync() after removing suites");

        // Now drop the handle and check handle was dropped
        TestFixture::client().ch_drop(client_handle);
        TestFixture::client().ch_suites();
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().get_client_handle_suites().empty(),
                            "Expected to have no registered suites");
    }

    {
        // register suites s0,s1,s2
        TestFixture::client().ch_register(false /*add new suites to handle*/, suites_s0_s1_s2);

        // register suite s3,s4
        TestFixture::client().ch_register(false /*add new suites to handle*/, suites_s3_s4);

        // get all the registered suites
        TestFixture::client().ch_suites();
        ch_suites = TestFixture::client().server_reply().get_client_handle_suites();
        BOOST_CHECK_MESSAGE(!ch_suites.empty(), "Expected to have registered suites");
        BOOST_CHECK_MESSAGE(ch_suites.size() == 2, "Expected to have 2 registered sets");
        BOOST_CHECK_MESSAGE(ch_suites[0].first == 1,
                            "Expected first client handle to be 1, but found " << ch_suites[0].first);
        BOOST_CHECK_MESSAGE(ch_suites[0].second == suites_s0_s1_s2, "Expected suites s0,s1,s2, in first handle");
        BOOST_CHECK_MESSAGE(ch_suites[1].first == 2,
                            "Expected second client handle to be 2, but found " << ch_suites[1].first);
        BOOST_CHECK_MESSAGE(ch_suites[1].second == suites_s3_s4, "Expected suites s3,s4 , in second handle");

        // Drop all handles
        for (size_t i = 0; i < ch_suites.size(); i++) {
            TestFixture::client().ch_drop(ch_suites[i].first);
        }
        TestFixture::client().ch_suites();
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().get_client_handle_suites().empty(),
                            "Expected to have no registered suites");
    }

    cout << timer.duration() << " update-calendar-count(" << serverTestHarness.serverUpdateCalendarCount() << ")\n";
}

BOOST_AUTO_TEST_CASE(test_handle_sync) {
    ECF_NAME_THIS_TEST();

    DurationTimer timer;
    TestClean clean_at_start_and_end;

    Defs theDefs;
    {
        for (int s = 0; s < 7; s++) {
            suite_ptr suite = theDefs.add_suite("s" + ecf::convert_to<std::string>(s));
            suite->addDefStatus(DState::SUSPENDED);
            for (int t = 0; t < 2; t++) {
                suite->add_task("t" + ecf::convert_to<std::string>(t));
            }
        }
    }

    // The test harness will create corresponding directory structure & default ecf file
    ServerTestHarness serverTestHarness;
    serverTestHarness.run(theDefs,
                          ServerTestHarness::testDataDefsLocation("test_handle_sync.def"),
                          1 /*timeout*/,
                          false /* don't wait for test to finish */);

    std::vector<std::string> suites_s0_s1_s2;
    suites_s0_s1_s2.push_back("s0");
    suites_s0_s1_s2.push_back("s1");
    suites_s0_s1_s2.push_back("s2");
    std::vector<std::pair<unsigned int, std::vector<std::string>>> ch_suites;

    {
        // register suites s0,s1,s2
        TestFixture::client().ch_register(false /*add new suites to handle*/, suites_s0_s1_s2);
        unsigned int client_handle = TestFixture::client().server_reply().client_handle();
        TestFixture::client().news_local();
        BOOST_CHECK_MESSAGE(TestFixture::client().get_news(), "Expected news after registering");
        TestFixture::client().sync_local(); // sync for any changes to get full update before test starts
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().full_sync(),
                            "Expected a full_sync() after registering");
        BOOST_CHECK_MESSAGE(TestFixture::client().defs()->suiteVec().size() == 3,
                            "Expected 3 suites back from sync, after registering 3 suites "
                                << ecf::as_string(*TestFixture::client().defs(), PrintStyle::DEFS));

        // make a change to a suite not in our handle, that does not cause state propagation.
        // State propagation changes the defs state. The defs state is sync regardless
        TestFixture::client().suspend("/s3");
        TestFixture::client().news_local();
        BOOST_CHECK_MESSAGE(!TestFixture::client().get_news(),
                            "Expected no change since suite s3 is not in our handle");

        // make a change to a suite *not* in our handle, that *does* cause state propagation.
        TestFixture::client().force("/s3/t0", "aborted");
        TestFixture::client().news_local();
        BOOST_CHECK_MESSAGE(TestFixture::client().get_news(),
                            "Expected change via state propagation to defs, even though s3 not in our handle");

        TestFixture::client().sync_local();
        BOOST_CHECK_MESSAGE(!TestFixture::client().server_reply().full_sync(),
                            "Expected incremental change, not a full update");

        // make a change to a suite in our handle
        TestFixture::client().force("/s0", "complete");
        TestFixture::client().news_local();
        BOOST_CHECK_MESSAGE(TestFixture::client().get_news(), "Expected news since state changed");

        TestFixture::client().sync_local();
        BOOST_CHECK_MESSAGE(!TestFixture::client().server_reply().full_sync(),
                            "Expected incremental change, not a full update");

        TestFixture::client().ch_drop(client_handle);
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().get_client_handle_suites().empty(),
                            "Expected to have no registered suites");
    }

    {
        // register suites s0,s1,s2
        TestFixture::client().ch_register(false /*add new suites to handle*/, suites_s0_s1_s2);
        unsigned int client_handle = TestFixture::client().server_reply().client_handle();
        TestFixture::client().news_local();
        BOOST_CHECK_MESSAGE(TestFixture::client().get_news(), "Expected news after registering");
        TestFixture::client().sync_local(); // sync for any changes to get full update before test starts
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().full_sync(),
                            "Expected a full_sync() after registering");

        // make a small change to a suite *IN* our handle
        TestFixture::client().force("/s1", "complete");
        TestFixture::client().sync_local();
        BOOST_CHECK_MESSAGE(!TestFixture::client().server_reply().full_sync(),
                            "Expected incremental change, not a full update");

        // Change the order
        TestFixture::client().order("/s0", "alpha");
        TestFixture::client().sync_local();
        BOOST_CHECK_MESSAGE(!TestFixture::client().server_reply().full_sync(), "Expected incremental update");

        TestFixture::client().ch_drop(client_handle);
        TestFixture::client().suites();
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().get_client_handle_suites().empty(),
                            "Expected to have no registered suites");
    }

    {
        // register suites s0,s1,s2
        TestFixture::client().ch_register(false /*add new suites to handle*/, suites_s0_s1_s2);
        unsigned int client_handle = TestFixture::client().server_reply().client_handle();
        TestFixture::client().news_local();
        BOOST_CHECK_MESSAGE(TestFixture::client().get_news(), "Expected news after registering");
        TestFixture::client().sync_local(); // sync for any changes to get full update **before** test starts
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().full_sync(),
                            "Expected a full_sync() after registering");

        // make a small change to a suite *IN* our handle
        TestFixture::client().force("/s1", "unknown");
        TestFixture::client().sync_local();
        BOOST_CHECK_MESSAGE(!TestFixture::client().server_reply().full_sync(),
                            "Expected incremental change, not a full update");

        // DELETE suite s2, i.e make a change that should force a *FULL* update
        TestFixture::client().delete_node("/s2", true /*force*/);
        TestFixture::client().news_local();
        BOOST_CHECK_MESSAGE(TestFixture::client().get_news(), "Expected news after deleting node");
        TestFixture::client().sync_local();
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().full_sync(), "Expected full update");

        // Check that suite s2 is STILL in our handle.
        // delete suites STAY registered until they are explicitly deleted
        TestFixture::client().ch_suites();
        ch_suites = TestFixture::client().server_reply().get_client_handle_suites();
        BOOST_CHECK_MESSAGE(ch_suites[0].second == suites_s0_s1_s2, "Expected suites s0,s1,s2, in handle");

        TestFixture::client().ch_drop(client_handle);
        TestFixture::client().ch_suites();
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().get_client_handle_suites().empty(),
                            "Expected to have no registered suites");
    }

    cout << timer.duration() << " update-calendar-count(" << serverTestHarness.serverUpdateCalendarCount() << ")\n";
}

BOOST_AUTO_TEST_CASE(test_handle_add_remove_add) {
    ECF_NAME_THIS_TEST();

    DurationTimer timer;
    TestClean clean_at_start_and_end;

    defs_ptr theDefs = Defs::create();
    {
        for (int s = 0; s < 3; s++) {
            suite_ptr suite = theDefs->add_suite("s" + ecf::convert_to<std::string>(s));
            suite->addDefStatus(DState::SUSPENDED); // NO NEED to run jobs for this test:
            for (int t = 0; t < 2; t++) {
                suite->add_task("t" + ecf::convert_to<std::string>(t));
            }
        }
    }

    // The test harness will create corresponding directory structure & default ecf file
    // ADD
    ServerTestHarness serverTestHarness;
    serverTestHarness.run(*theDefs,
                          ServerTestHarness::testDataDefsLocation("test_handle_sync.def"),
                          1 /*timeout*/,
                          false /* don't wait for test to finish */);

    TestFixture::client().set_throw_on_error(true);
    std::vector<std::string> suites_s0_s1_s2;
    suites_s0_s1_s2.push_back("s0");
    suites_s0_s1_s2.push_back("s1");
    suites_s0_s1_s2.push_back("s2");

    {
        // register suites s0
        TestFixture::client().ch_register(false /*add new suites to handle*/, suites_s0_s1_s2);
        unsigned int client_handle = TestFixture::client().server_reply().client_handle();
        BOOST_CHECK_MESSAGE(client_handle == 1, "Expected handle of value 1 but found " << client_handle);

        // Get the registered suites
        TestFixture::client().ch_suites();
        BOOST_CHECK_MESSAGE(!TestFixture::client().server_reply().get_client_handle_suites().empty(),
                            "Expected to have registered suites");

        // Check the sync_local() does a full sync for our handle
        TestFixture::client().sync_local();
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().in_sync(), "Expected to be in sync after syn_local()");
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().full_sync(),
                            "Expected a full_sync() after registering");
        BOOST_CHECK_MESSAGE(TestFixture::client().defs()->suiteVec().size() == 3,
                            "Expected 3 suites back from sync "
                                << ecf::as_string(*TestFixture::client().defs(), PrintStyle::DEFS));

        // DELETE suites. They should stay *registered*
        TestFixture::client().delete_node("/s0");
        TestFixture::client().delete_node("/s1");
        TestFixture::client().delete_node("/s2");
        TestFixture::client().sync_local();
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().full_sync(),
                            "Expected a full_sync() after deleting suite");
        BOOST_CHECK_MESSAGE(TestFixture::client().defs()->suiteVec().size() == 0,
                            "Expected 0 suites back from sync "
                                << ecf::as_string(*TestFixture::client().defs(), PrintStyle::DEFS));

        // Check suites are still registered. Only explicit drop can remove registered suites
        TestFixture::client().ch_suites();
        BOOST_CHECK_MESSAGE(!TestFixture::client().server_reply().get_client_handle_suites().empty(),
                            "Expected to have registered suites");

        // RELOAD the defs, which includes s0,s1,s2:: THIS SHOULD GET RE_ADDED TO OUR EXISTING HANDLE's
        // The handle references to the suites should get *refreshed*
        TestFixture::client().load(theDefs);
        TestFixture::client().sync_local();
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().full_sync(),
                            "Expected a full_sync() since client handle should be refreshed with new suite_pts");
        BOOST_CHECK_MESSAGE(TestFixture::client().defs()->suiteVec().size() == 3,
                            "Expected 3 suites back from sync "
                                << ecf::as_string(*TestFixture::client().defs(), PrintStyle::DEFS));

        TestFixture::client().ch_drop(client_handle);
        BOOST_CHECK_MESSAGE(TestFixture::client().server_reply().get_client_handle_suites().empty(),
                            "Expected to have no registered suites");
    }

    cout << timer.duration() << " update-calendar-count(" << serverTestHarness.serverUpdateCalendarCount() << ")\n";
}

BOOST_AUTO_TEST_SUITE_END()

BOOST_AUTO_TEST_SUITE_END()