File: MyDefsFixture.hpp

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 (292 lines) | stat: -rw-r--r-- 13,447 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
/*
 * 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.
 */

#ifndef ecflow_node_test_MyDefsFixture_HPP
#define ecflow_node_test_MyDefsFixture_HPP

///
/// \brief The structure ONLY used to test the persistence/migration
/// as each new object is created we add it here, to test Serialisation
/// read/write and migration of previous fixtures.
///

#include <algorithm>

#include "ecflow/attribute/AutoArchiveAttr.hpp"
#include "ecflow/attribute/AutoCancelAttr.hpp"
#include "ecflow/attribute/LateAttr.hpp"
#include "ecflow/core/Converter.hpp"
#include "ecflow/core/Str.hpp"
#include "ecflow/node/Alias.hpp"
#include "ecflow/node/AutoRestoreAttr.hpp"
#include "ecflow/node/Defs.hpp"
#include "ecflow/node/Expression.hpp"
#include "ecflow/node/Family.hpp"
#include "ecflow/node/Limit.hpp"
#include "ecflow/node/MiscAttrs.hpp"
#include "ecflow/node/Suite.hpp"
#include "ecflow/node/Task.hpp"

// =======================================================================
// This struct is used in the node migration tests.
// If we ever add to this , then update TestMigration.cpp
// **Ensure** that we keep old fixture.def file, to test that future ecflow
// versions can migrate old data.
// =======================================================================
struct MyDefsFixture
{

    explicit MyDefsFixture(const std::string& port = ecf::Str::DEFAULT_PORT_NUMBER()) : defsfile_(port) {
        suite_ptr suite = create_suite();

        // Must be done last
        defsfile_.addSuite(suite);
        defsfile_.add_extern("/limits:event");
        defsfile_.add_extern("/a/b/c:meter");
        defsfile_.add_extern("/a/b/c/d");

        // add an empty suite. Needed for CHECK_JOB_GEN_ONLY cmd
        defsfile_.addSuite(Suite::create("EmptySuite"));

        // Check expression parse
        std::string errorMsg, warningMsg;
        bool result = defsfile_.check(errorMsg, warningMsg);
        if (!result || !errorMsg.empty()) {
            std::cout << errorMsg;
            assert(false);
        }
    }
    ~MyDefsFixture() = default;

    const Defs& fixtureDefsFile() const { return defsfile_; }

    defs_ptr create_defs(const std::string& port = ecf::Str::DEFAULT_PORT_NUMBER()) const {

        defs_ptr defs = Defs::create(port);

        defs->addSuite(create_suite());
        defs->add_extern("/limits:event");
        defs->add_extern("/a/b/c:meter");
        defs->add_extern("/a/b/c/d");
        defs->server_state().add_or_update_user_variables("MyDefsFixture_user_variable",
                                                          "This is a user variable added to server");
        defs->server_state().add_or_update_server_variable("MyDefsFixture_server_variable",
                                                           "This is a server variable");

        // add an empty suite. Needed for CHECK_JOB_GEN_ONLY cmd
        defs->addSuite(Suite::create("EmptySuite"));

        // Check expression parse
        std::string errorMsg, warningMsg;
        bool result = defs->check(errorMsg, warningMsg);
        if (!result || !errorMsg.empty()) {
            std::cout << errorMsg;
            assert(false);
        }
        return defs;
    }

    Defs defsfile_;

private:
    suite_ptr create_suite() const {
        std::string sname = "suiteName";
        suite_ptr suite   = Suite::create(sname);

        ClockAttr clockAttr(false);
        clockAttr.date(1, 1, 2009);
        clockAttr.set_gain_in_seconds(3600);
        suite->addClock(clockAttr);

        suite->addAutoCancel(ecf::AutoCancelAttr(2));
        suite->addVariable(Variable("VAR", "value"));
        suite->addVariable(Variable("VAR1", "\"value\""));
        suite->addVariable(Variable("ECF_FETCH", "\"smsfetch -F %ECF_FILES% -I %ECF_INCLUDE%\""));

        std::vector<std::string> queue_items;
        queue_items.emplace_back("000");
        queue_items.emplace_back("001");
        queue_items.emplace_back("002");
        suite->add_queue(QueueAttr("queue", queue_items));
        suite->add_queue(QueueAttr("queue1", queue_items));
        suite->add_generic(GenericAttr("gen1", queue_items));
        suite->add_generic(GenericAttr("gen2", queue_items));
        suite->add_task("t1");
        suite->add_task("t2");
        task_ptr suiteTask = suite->add_task("t3");
        suiteTask->add_part_trigger(PartExpression("t1 == complete"));
        suiteTask->add_part_trigger(PartExpression("t2 == complete", false));
        suiteTask->add_part_complete(PartExpression("t1 == complete"));
        suiteTask->add_part_complete(PartExpression("t2 == complete", true));

        std::vector<ecf::Child::CmdType> child_cmds = ecf::Child::list();
        suiteTask->addZombie(ZombieAttr(ecf::Child::USER, child_cmds, ecf::ZombieCtrlAction::FOB, 10));
        suiteTask->addZombie(ZombieAttr(ecf::Child::PATH, child_cmds, ecf::ZombieCtrlAction::BLOCK, 100));
        suiteTask->addZombie(ZombieAttr(ecf::Child::ECF, child_cmds, ecf::ZombieCtrlAction::FAIL, 100));
        suiteTask->addZombie(ZombieAttr(ecf::Child::ECF_PID, child_cmds, ecf::ZombieCtrlAction::FAIL, 100));
        suiteTask->addZombie(ZombieAttr(ecf::Child::ECF_PASSWD, child_cmds, ecf::ZombieCtrlAction::FAIL, 100));
        suiteTask->addZombie(ZombieAttr(ecf::Child::ECF_PID_PASSWD, child_cmds, ecf::ZombieCtrlAction::FAIL, 100));

        task_ptr suiteTask4 = suite->add_task("t4");
        suiteTask4->addZombie(ZombieAttr(ecf::Child::USER, child_cmds, ecf::ZombieCtrlAction::ADOPT, 10));
        suiteTask4->addZombie(ZombieAttr(ecf::Child::PATH, child_cmds, ecf::ZombieCtrlAction::BLOCK, 100));
        suiteTask4->addZombie(ZombieAttr(ecf::Child::ECF, child_cmds, ecf::ZombieCtrlAction::REMOVE, 100));
        suiteTask4->addZombie(ZombieAttr(ecf::Child::ECF_PID, child_cmds, ecf::ZombieCtrlAction::KILL, 100));
        suiteTask4->addZombie(ZombieAttr(ecf::Child::ECF_PASSWD, child_cmds, ecf::ZombieCtrlAction::FOB, 100));
        suiteTask4->addZombie(ZombieAttr(ecf::Child::ECF_PID_PASSWD, child_cmds, ecf::ZombieCtrlAction::BLOCK, 100));

        ecf::CronAttr cronAttr;
        ecf::TimeSlot start(0, 0);
        ecf::TimeSlot finish(10, 0);
        ecf::TimeSlot incr(0, 5);
        std::vector<int> weekdays;
        for (int i = 0; i < 7; ++i) {
            weekdays.push_back(i);
        }
        std::vector<int> daysOfMonth;
        for (int i = 1; i < 32; ++i) {
            daysOfMonth.push_back(i);
        }
        std::vector<int> months;
        for (int i = 1; i < 13; ++i) {
            months.push_back(i);
        }
        cronAttr.addTimeSeries(start, finish, incr);
        cronAttr.addWeekDays(weekdays);
        cronAttr.addDaysOfMonth(daysOfMonth);
        cronAttr.addMonths(months);
        suite->addCron(cronAttr);

        ecf::LateAttr lateAttr;
        lateAttr.addSubmitted(ecf::TimeSlot(3, 12));
        lateAttr.addActive(ecf::TimeSlot(3, 12));
        lateAttr.addComplete(ecf::TimeSlot(4, 12), true);

        std::string suiteLimit  = "suiteLimit";
        std::string suiteLimit2 = "suiteLimit2";
        std::string suiteLimit3 = "suiteLimit3";
        suite->addLimit(Limit(suiteLimit, 10));
        suite->addLimit(Limit(suiteLimit2, 10));
        suite->addLimit(Limit(suiteLimit3, 10));

        // Add tasks with all the repeat variants
        std::vector<std::string> stringList{"10", "20", "30"};
        task_ptr t5 = suite->add_task("t5");
        t5->addRepeat(RepeatEnumerated("AEnum", stringList));

        task_ptr t6 = suite->add_task("t6");
        t6->addRepeat(RepeatString("aString", stringList));

        task_ptr t7 = suite->add_task("t7");
        t7->addRepeat(RepeatInteger("rep", 0, 100, 1));

        task_ptr t8 = suite->add_task("t8");
        t8->addRepeat(RepeatDate("YMD", 20090916, 20090916, 1));

        task_ptr t9 = suite->add_task("t9");
        t9->addRepeat(RepeatDateList("YMD", {20090916, 20090916}));

        task_ptr t10 = suite->add_task("t10");
        t10->addRepeat(RepeatDay(2));

        suite->add_family("f1")->add_autoarchive(ecf::AutoArchiveAttr(ecf::TimeSlot(1, 0), true));
        suite->add_family("f2")->add_autoarchive(ecf::AutoArchiveAttr(5, 22, true));
        suite->add_family("f3")->add_autoarchive(ecf::AutoArchiveAttr(4));
        suite->add_family("f4")->add_autoarchive(ecf::AutoArchiveAttr(0));
        suite->add_family("f5")->add_autoarchive(ecf::AutoArchiveAttr(ecf::TimeSlot(1, 0), true, true));
        suite->add_family("f6")->add_autoarchive(ecf::AutoArchiveAttr(5, 22, true, true));
        suite->add_family("f7")->add_autoarchive(ecf::AutoArchiveAttr(4, true));
        suite->add_family("f8")->add_autoarchive(ecf::AutoArchiveAttr(0, true));

        for (int i = 0; i < 3; ++i) {
            std::string fname     = "familyName";
            std::string tname     = "taskName";
            std::string eventName = "eventName";
            std::string labelName = "labelName";
            std::string limitName = "limitName";
            if (i != 0) {
                fname += ecf::convert_to<std::string>(i);
                tname += ecf::convert_to<std::string>(i);
                labelName += ecf::convert_to<std::string>(i);
            }

            family_ptr fam = suite->add_family(fname);
            fam->addDate(DateAttr(0, 0, 2009)); // 0 is equivalent to a *
            fam->addRepeat(RepeatEnumerated("AEnum", stringList));
            fam->addAutoCancel(ecf::AutoCancelAttr(ecf::TimeSlot(1, 0), true));
            fam->addVariable(Variable("VAR", "value"));
            fam->addTime(ecf::TimeAttr(ecf::TimeSlot(0, 0), ecf::TimeSlot(10, 1), ecf::TimeSlot(0, 1), true));
            fam->addLimit(Limit(limitName, 20));
            fam->addLate(lateAttr);
            fam->addInLimit(InLimit(suiteLimit2, "/" + sname, 2, true /*limit this node only*/));
            fam->add_queue(QueueAttr("queue1", queue_items));
            fam->add_generic(GenericAttr("gen1", queue_items));

            task_ptr task = fam->add_task(tname);
            task->addDate(DateAttr(1, 2, 2009));
            task->addDay(DayAttr(DayAttr::MONDAY));
            task->addVariable(Variable("VAR1", "\"value\""));
            task->addEvent(Event(i));
            task->addEvent(Event(i + 1, eventName));
            task->addEvent(Event(i + 2, "my_event", true /*init value*/));
            task->addMeter(Meter("myMeter", 0, 100, 100));
            task->addLabel(Label(labelName, "\"labelValue\""));
            task->addTime(ecf::TimeAttr(ecf::TimeSlot(10, 10), true));
            task->addToday(ecf::TodayAttr(ecf::TimeSlot(10, 12)));
            task->addToday(ecf::TodayAttr(ecf::TimeSlot(0, 1), ecf::TimeSlot(0, 3), ecf::TimeSlot(0, 1), true));
            task->addDefStatus(DState::COMPLETE);
            task->addInLimit(InLimit(suiteLimit, "/" + sname));
            task->addInLimit(
                InLimit(suiteLimit3, "/" + sname, 1, false /*limit this node only*/, true /*limit submission*/));
            task->addVerify(VerifyAttr(NState::COMPLETE, 3));
            task->addLate(lateAttr);
            task->add_queue(QueueAttr("queue1", queue_items));
            task->add_generic(GenericAttr("gen1", queue_items));
            task->add_generic(GenericAttr("gen2", std::vector<std::string>()));

            std::vector<std::string> nodes_to_restore;
            nodes_to_restore.emplace_back("/EmptySuite");
            task->add_autorestore(ecf::AutoRestoreAttr(nodes_to_restore));
            if (i == 2) {
                std::string compExpr = "../familyName" + ecf::convert_to<std::string>(i - 1);
                compExpr += "/taskName" + ecf::convert_to<std::string>(i - 1);
                compExpr += ":myMeter ge 10";
                task->add_complete(compExpr);

                std::string expression = "../familyName" + ecf::convert_to<std::string>(i - 1);
                expression += "/taskName" + ecf::convert_to<std::string>(i - 1);
                expression += " == complete";
                task->add_trigger(expression);
            }
            task->add_alias_only(); // add alias without creating dir & .usr file
            task->add_alias_only();

            // Add a hierarchical family to the first family
            if (i == 0) {
                std::string heirFamily = "heir_" + fname;
                family_ptr hierFam     = fam->add_family(heirFamily);
                hierFam->addVariable(Variable("VAR1", "value"));
                hierFam->addRepeat(RepeatString("aString", stringList));
                hierFam->add_autoarchive(ecf::AutoArchiveAttr(ecf::TimeSlot(1, 0), true));

                task_ptr task1 = hierFam->add_task(tname);
                task1->addVariable(Variable("VAR1", "value"));
                task1->addEvent(Event(i));
                task1->addEvent(Event(i + 1, eventName));
                task1->addEvent(Event(i + 2, "my_event", true /*init value*/));
                task1->addMeter(Meter("myMeter", 0, 100, 100));
                task1->addAutoCancel(ecf::AutoCancelAttr(ecf::TimeSlot(0, 1), false));
            }
        }
        return suite;
    }
};

#endif /* ecflow_node_test_MyDefsFixture_HPP */