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
|
/*
* 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 <stdexcept>
#include <boost/test/unit_test.hpp>
#include "MyDefsFixture.hpp"
#include "ecflow/core/Ecf.hpp"
#include "ecflow/core/Environment.hpp"
#include "ecflow/core/File.hpp"
#include "ecflow/core/Str.hpp"
#include "ecflow/node/Defs.hpp"
#include "ecflow/node/EcfFile.hpp"
#include "ecflow/node/Family.hpp"
#include "ecflow/node/JobCreationCtrl.hpp"
#include "ecflow/node/Suite.hpp"
#include "ecflow/node/Task.hpp"
#include "ecflow/test/scaffold/Naming.hpp"
using namespace std;
using namespace ecf;
BOOST_AUTO_TEST_SUITE(U_Node)
BOOST_AUTO_TEST_SUITE(T_TaskScriptGenerator)
BOOST_AUTO_TEST_CASE(test_reset_after_job_generation_checking) {
ECF_NAME_THIS_TEST();
{
Defs defs = Defs();
suite_ptr s = defs.add_suite("s");
task_ptr t = s->add_task("t");
t->addTime(TimeAttr("+00:00 23:00 00:30"));
Defs defs_copy = Defs(defs);
BOOST_REQUIRE_MESSAGE(defs_copy == defs, "Expected defs to be equal");
// After check_job_creation, the defs SHOULD be reset. see ECFLOW-1203
job_creation_ctrl_ptr jobCtrl = std::make_shared<JobCreationCtrl>();
defs.check_job_creation(jobCtrl);
BOOST_REQUIRE_MESSAGE(!jobCtrl->get_error_msg().empty(), jobCtrl->get_error_msg());
DebugEquality debug_equality; // only as affect in DEBUG build
BOOST_REQUIRE_MESSAGE(defs_copy == defs, "reset failed - Expected defs to be equal");
}
{
// test reset with a full definition
MyDefsFixture theDefsFixture;
Defs copy = Defs(theDefsFixture.defsfile_);
BOOST_REQUIRE_MESSAGE(copy == theDefsFixture.defsfile_, "Expected defs to be equal");
// After check_job_creation, the defs SHOULD be reset. see ECFLOW-1203
job_creation_ctrl_ptr jobCtrl = std::make_shared<JobCreationCtrl>();
theDefsFixture.defsfile_.check_job_creation(jobCtrl);
DebugEquality debug_equality; // only as affect in DEBUG build
BOOST_REQUIRE_MESSAGE(copy == theDefsFixture.defsfile_, "reset failed - Expected defs to be equal");
}
}
BOOST_AUTO_TEST_CASE(test_task_script_generator) {
ECF_NAME_THIS_TEST();
// SET ECF_HOME
std::string ecf_home = File::test_data("libs/node/test/data/TaskScriptGenerator", "libs/node");
std::string head = ecf_home + "/head.h";
std::string tail = ecf_home + "/tail.h";
fs::remove_all(ecf_home);
BOOST_REQUIRE_MESSAGE(!fs::exists(head), "Remove of head file failed");
BOOST_REQUIRE_MESSAGE(!fs::exists(tail), "Remove of tail file failed");
// Create a defs file corresponding to:
// suite suite
// edit ECF_INCLUDE $ECF_HOME/includes
// edit SLEEP 10
// task t1
// family f1
// task t1
// task t2
// endfamily
// endsuite
Defs theDefs;
{
suite_ptr suite = theDefs.add_suite("suite");
suite->add_variable(ecf::environment::ECF_INCLUDE, ecf_home);
suite->add_variable(ecf::environment::ECF_HOME, ecf_home);
suite->add_variable("SLEEP", "10");
task_ptr t1 = suite->add_task("t1");
t1->addEvent(Event("event1"));
t1->addEvent(Event("event2"));
t1->addEvent(Event("event4"));
t1->addMeter(Meter("meter1", 1, 100, 90));
t1->addMeter(Meter("meter2", 1, 100, 90));
t1->addLabel(Label("label", "label value"));
family_ptr fam = suite->add_family("f1");
fam->add_task("t1");
fam->add_task("t2");
// cerr << theDefs << "\n";
}
/// generate the scripts and head.h and tail.h
theDefs.generate_scripts();
/// Test the ecf file were created, by doing job creation
/// JobCreationCtrl is used control what node we generate the jobs for:
/// Since we have not set the node on it, we force job generation for all tasks
job_creation_ctrl_ptr jobCtrl = std::make_shared<JobCreationCtrl>();
theDefs.check_job_creation(jobCtrl);
BOOST_REQUIRE_MESSAGE(jobCtrl->get_error_msg().empty(), jobCtrl->get_error_msg());
BOOST_REQUIRE_MESSAGE(jobCtrl->fail_submittables().empty(), "Expected no failing tasks");
/// Additional sanity tests #######################################################
/// test that header and tail file were created
BOOST_REQUIRE_MESSAGE(fs::exists(head), "Head file " << head << " not created");
BOOST_REQUIRE_MESSAGE(fs::exists(tail), "Tail file " << tail << " not created");
// get all the task, assume non hierarchical families
std::vector<Task*> theTasks;
theDefs.getAllTasks(theTasks);
/// begin , will cause creation of generated variables. The generated variables
/// are use in client scripts and used to locate the sms files
theDefs.beginAll();
// Test for ECF_ file location
for (Task* t : theTasks) {
try {
EcfFile ecf_file = t->locatedEcfFile();
BOOST_REQUIRE_MESSAGE(ecf_file.valid(), "Could not locate ecf file for task ");
}
catch (std::exception& e) {
BOOST_REQUIRE_MESSAGE(false, "Could not locate ecf file for task " << e.what());
}
}
// Remove the directories that were generated. This occasionally fails on ecgb and lxg ?
try {
fs::remove_all(ecf_home);
}
catch (const fs::filesystem_error& e) {
cout << "Could not remove directory " << ecf_home << " : " << e.what() << "\n";
}
}
BOOST_AUTO_TEST_CASE(test_task_script_generator_with_dummy_tasks) {
ECF_NAME_THIS_TEST();
// SET ECF_HOME
std::string ecf_home = File::test_data("libs/node/test/data/TaskScriptGenerator", "libs/node");
std::string head = ecf_home + "/head.h";
std::string tail = ecf_home + "/tail.h";
fs::remove_all(ecf_home);
BOOST_REQUIRE_MESSAGE(!fs::exists(head), "Remove of head file failed");
BOOST_REQUIRE_MESSAGE(!fs::exists(tail), "Remove of tail file failed");
// Create a defs file corresponding to:
// suite suite
// edit ECF_INCLUDE $ECF_HOME/includes
// edit ECF_HOME $ECF_HOME/includes
// edit SLEEP 10
// family f1
// task t1
// task t2
// endfamily
// family f2
// edit ECF_DUMMY_TASK ''
// task t1
// task t2
// endfamily
// endsuite
std::vector<task_ptr> tasks_with_scripts, tasks_without_scripts;
Defs theDefs;
{
suite_ptr suite = theDefs.add_suite("suite");
suite->add_variable(ecf::environment::ECF_INCLUDE, ecf_home);
suite->add_variable(ecf::environment::ECF_HOME, ecf_home);
suite->add_variable("SLEEP", "10");
family_ptr f1 = suite->add_family("f1");
tasks_with_scripts.push_back(f1->add_task("t1"));
family_ptr f2 = suite->add_family("f2");
f2->add_variable("ECF_DUMMY_TASK", "");
tasks_without_scripts.push_back(f2->add_task("t1"));
tasks_without_scripts.push_back(f2->add_task("t2"));
// cout << theDefs << "\n";
}
/// generate the scripts and head.h and tail.h
theDefs.generate_scripts();
/// Test the ecf file were created, by doing job creation
/// JobCreationCtrl is used control what node we generate the jobs for:
/// Since we have *NOT* set the node on it, we force job generation for all tasks
job_creation_ctrl_ptr jobCtrl = std::make_shared<JobCreationCtrl>();
theDefs.check_job_creation(jobCtrl);
BOOST_REQUIRE_MESSAGE(jobCtrl->get_error_msg().empty(), jobCtrl->get_error_msg());
BOOST_REQUIRE_MESSAGE(jobCtrl->fail_submittables().empty(), "Expected no failing tasks");
/// Additional sanity tests #######################################################
/// test that header and tail file were created
BOOST_REQUIRE_MESSAGE(fs::exists(head), "Head file " << head << " not created");
BOOST_REQUIRE_MESSAGE(fs::exists(tail), "Tail file " << tail << " not created");
/// begin , will cause creation of generated variables. The generated variables
/// are use in client scripts and used to locate the ecf files
theDefs.beginAll();
// Test for script generation
for (task_ptr t : tasks_with_scripts) {
try {
EcfFile ecf_file = t->locatedEcfFile();
BOOST_REQUIRE_MESSAGE(ecf_file.valid(), "Could not locate ecf file for task ");
}
catch (std::exception& e) {
BOOST_REQUIRE_MESSAGE(false, "Could not locate ecf file for task " << e.what());
}
}
// Test that no scripts are generated when ECF_DUMMY_TASK is used
for (task_ptr t : tasks_without_scripts) {
BOOST_REQUIRE_THROW(t->locatedEcfFile(), std::runtime_error);
}
// Remove the directories that were generated. This occasionally fails on ecgb and lxg ?
try {
fs::remove_all(ecf_home);
}
catch (const fs::filesystem_error& e) {
cout << "Could not remove directory " << ecf_home << " : " << e.what() << "\n";
}
}
BOOST_AUTO_TEST_SUITE_END()
BOOST_AUTO_TEST_SUITE_END()
|
