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
|
/*
* 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 <set>
#include <boost/test/unit_test.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/Family.hpp"
#include "ecflow/node/JobsParam.hpp"
#include "ecflow/node/Suite.hpp"
#include "ecflow/node/System.hpp"
#include "ecflow/node/Task.hpp"
#include "ecflow/test/scaffold/Naming.hpp"
using namespace std;
using namespace ecf;
void findVariable(std::string& line, std::set<std::string>& variables) {
// scan for variables
// edit SMSFETCH "/home/ma/map/sms/smsfectch -F %ECF_FILES% -I %ECF_INCLUDE%"
// We can also have
//
// "%<VAR>:<substitute>% i.e if VAR exist use it, else use substitute
//
// i.e VAR is defined as BILL
// %VAR:fred --f% will either be "BILL" or if VAR is not defined "fred --f"
while (true) {
size_t firstPercentPos = line.find(Ecf::MICRO());
if (firstPercentPos == string::npos) {
break;
}
size_t secondPercentPos = line.find(Ecf::MICRO(), firstPercentPos + 1);
if (secondPercentPos == string::npos) {
break;
}
if (secondPercentPos - firstPercentPos <= 1) {
break; // handle %% with no characters in between
}
string percentVar(line.begin() + firstPercentPos + 1, line.begin() + secondPercentPos);
size_t firstColon = percentVar.find(':');
if (firstColon != string::npos) {
string var(percentVar.begin(), percentVar.begin() + firstColon);
percentVar = var;
}
// Ignore auto-generated variables
if (percentVar.find("ECF_") == string::npos && percentVar != "DATE" && percentVar != "DAY" &&
percentVar != "DD" && percentVar != "DOW" && percentVar != "DOY" && percentVar != "MM" &&
percentVar != "MONTH" && percentVar != "YYYY" && percentVar != "TASK" && percentVar != "FAMILY" &&
percentVar != "FAMILY1" && percentVar != "SUITE") {
variables.insert(percentVar);
}
// std::cerr << "line before delete " << line << "\n";
line.erase(firstPercentPos, secondPercentPos - firstPercentPos + 1);
// std::cerr << "line after delete " << line << "\n";
}
}
void autoDiscoverVariables(const std::string& directory, std::set<std::string>& variables) {
auto full_path = fs::absolute(directory);
BOOST_CHECK(fs::exists(full_path));
BOOST_CHECK(fs::is_directory(full_path));
// std::cout << "\nIn directory: " << full_path << "\n\n";
fs::directory_iterator end_iter;
for (fs::directory_iterator dir_itr(full_path); dir_itr != end_iter; ++dir_itr) {
try {
fs::path relPath(directory + "/" + dir_itr->path().filename().string());
// recurse down directories
if (fs::is_directory(dir_itr->status())) {
autoDiscoverVariables(relPath.string(), variables);
continue;
}
// std::cout << "......autoDiscoverVariables for file " << relPath.string() << "\n";
if (relPath.extension() != ".h") {
continue; // Only look at .h files
}
// open the file, and find variables.
std::vector<std::string> lines;
if (File::splitFileIntoLines(relPath.string(), lines)) {
for (auto& line : lines) {
findVariable(line, variables);
}
}
}
catch (const std::exception& ex) {
std::cout << "Exception::" << dir_itr->path().filename() << " " << ex.what() << std::endl;
}
}
}
BOOST_AUTO_TEST_SUITE(U_Node)
BOOST_AUTO_TEST_SUITE(T_PreProcessing)
// *Auto* discover the good/bad sms files
void test_sms_preprocessing(const std::string& directory, bool pass) {
// SET ECF_HOME
std::string ecf_home = directory;
auto full_path = fs::absolute(directory);
BOOST_CHECK(fs::exists(full_path));
BOOST_CHECK(fs::is_directory(full_path));
// Create a defs file, where the task name mirrors the sms files in the given directory
Defs theDefs;
{
suite_ptr suite = theDefs.add_suite("suite");
suite->addVariable(Variable(ecf::environment::ECF_INCLUDE, "$ECF_HOME/includes"));
suite->addVariable(Variable(ecf::environment::ECF_OUT, "$ECF_HOME"));
suite->addVariable(Variable("SLEEPTIME", "10"));
family_ptr fam = suite->add_family("family");
// for operations auto discover the variables used in the header files and give
// them a dummy value. This would allow the test to pass when doing
// variable substitution. hence if variable substitution fails its likely to be
// a bug in autoDiscoverVariables
std::set<std::string> discoveredVariables;
autoDiscoverVariables(ecf_home + "/includes", discoveredVariables);
for (const string& var : discoveredVariables) {
// cerr << "autoDiscoverVariables = " << var << "\n";
suite->addVariable(Variable(var, "gobblygook"));
}
// std::cout << "\nIn directory: " << full_path.directory_string() << "\n\n";
fs::directory_iterator end_iter;
for (fs::directory_iterator dir_itr(full_path); dir_itr != end_iter; ++dir_itr) {
try {
fs::path relPath(directory + "/" + dir_itr->path().filename().string());
// Ignore directories were only interested in .ecf files.
if (fs::is_directory(relPath)) {
continue;
}
if (File::getExt(relPath.filename().string()) != "ecf") {
continue; // ignore other files
}
// std::cout << "......Parsing file " << relPath.string() << "\n";
// std::cout << " adding task name " << relPath.leaf() << "\n";
fam->add_task(relPath.stem().string());
}
catch (const std::exception& ex) {
std::cout << "Exception " << dir_itr->path().filename() << " " << ex.what() << std::endl;
}
}
// cerr << "The defs\n" << theDefs << "\n";
}
// get all the task
std::vector<Task*> theTasks;
theDefs.getAllTasks(theTasks);
// Override ECF_HOME. ECF_HOME is need to locate the ecf files
theDefs.server_state().add_or_update_user_variables(ecf::environment::ECF_HOME, ecf_home);
/// begin , will cause creation of generated variables. The generated variables
/// are used in client scripts(sms) and used to locate the sms files
theDefs.beginAll();
// Test Job creator, this will pre-process and perform variable substitution on ecf files
for (Task* t : theTasks) {
// cout << " task " << t->absNodePath() << "\n";
JobsParam jobsParam; // create jobs = false, spawn_jobs = false
bool ok = t->submitJob(jobsParam);
if (pass) { // Test expected to pass
BOOST_CHECK_MESSAGE(ok, "Failed to create jobs. " << jobsParam.getErrorMsg());
}
else { // test expected to fail
BOOST_CHECK_MESSAGE(!ok, "Expected failure " << jobsParam.getErrorMsg());
BOOST_CHECK_MESSAGE(!ok, "expected no passes but found " << t->absNodePath() << " passes");
// cerr << "\n" << jobsParam.getErrorMsg() << " \n"; // un-comment to ensure correct error message
}
}
}
BOOST_AUTO_TEST_CASE(test_good_sms) {
ECF_NAME_THIS_TEST();
std::string path = File::test_data("libs/node/test/data/SMSHOME2/good", "libs/node");
// All the sms in this directory are expected to pass
test_sms_preprocessing(path, true);
}
BOOST_AUTO_TEST_CASE(test_bad_sms) {
ECF_NAME_THIS_TEST();
std::string path = File::test_data("libs/node/test/data/SMSHOME2/bad", "libs/node");
// All the sms in this directory are expected to fail
test_sms_preprocessing(path, false);
/// Destroy System singleton to avoid valgrind from complaining
System::destroy();
}
BOOST_AUTO_TEST_SUITE_END()
BOOST_AUTO_TEST_SUITE_END()
|
