File: TestParser.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 (233 lines) | stat: -rw-r--r-- 9,322 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
/*
 * 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 <string>

#include <boost/test/unit_test.hpp>

#include "PersistHelper.hpp"
#include "ecflow/core/Ecf.hpp"
#include "ecflow/core/File.hpp"
#include "ecflow/node/Defs.hpp"
#include "ecflow/node/Node.hpp"
#include "ecflow/node/parser/DefsStructureParser.hpp"
#include "ecflow/test/scaffold/Naming.hpp"

using namespace std;
using namespace ecf;

std::vector<std::string> defs_with_expected_warnings() {
    return {"limit/limit3.def"};
}

BOOST_AUTO_TEST_SUITE(U_Parser)

BOOST_AUTO_TEST_SUITE(T_Parser)

std::vector<fs::path> list_test_data_files(const std::string& base_directory, const std::string& extn = ".def") {
    auto full_path = fs::absolute(base_directory);
    BOOST_CHECK(fs::exists(full_path));
    BOOST_CHECK(fs::is_directory(full_path));

    std::vector<fs::path> files;
    for (const auto& entry : fs::recursive_directory_iterator(full_path)) {
        if (fs::is_regular_file(entry) && entry.path().extension() == extn) {
            files.push_back(entry.path());
        }
    }
    return files;
}

void test_defs(const std::string& directory, bool pass) {
    auto full_path = fs::absolute(directory);

    BOOST_CHECK(fs::exists(full_path));
    BOOST_CHECK(fs::is_directory(full_path));
    DebugEquality debug_equality; // only has effect in DEBUG build

    // std::cout << "\nIn directory: " << full_path.directory_string() << "\n\n";

    auto def_files = list_test_data_files(full_path.string(), ".def");
    for (const auto& relPath : def_files) {
        // std::cout << "......Parsing file " << relPath.string() << "\n";

        Defs defs;
        DefsStructureParser parser(&defs, relPath.string());

        std::string errorMsg, warningMsg;
        bool parsedOk = parser.doParse(errorMsg, warningMsg);
        if (pass) {
            // Test expected to pass
            BOOST_CHECK_MESSAGE(parsedOk, "Failed to parse file " << relPath << "\n" << errorMsg);

            if (parsedOk) {
                // Check triggers and limits
                std::string err_msg, warn_msg;
                defs.check(err_msg, warn_msg);
                BOOST_CHECK_MESSAGE(err_msg.empty(),
                                    "Expected no errors but found:" << err_msg << "File: " << relPath.string());

                // expect warnings for some file:
                bool ignore = false;
                for (auto path : defs_with_expected_warnings()) {
                    if (relPath.string().find(path) != std::string::npos) {
                        ignore = true;
                        break;
                    }
                }
                if (!ignore) {
                    BOOST_CHECK_MESSAGE(warn_msg.empty(),
                                        "Expected no warnings but found:" << warn_msg << "File: " << relPath.string());
                }

                // Write parsed file to a temporary file on disk, and reload, then compare defs, should be the same
                PersistHelper helper;
                BOOST_CHECK_MESSAGE(helper.test_persist_and_reload(defs, parser.get_file_type()),
                                    relPath.string() << " " << helper.errorMsg());
                BOOST_CHECK_MESSAGE(helper.test_cereal_checkpt_and_reload(defs),
                                    relPath.string() << " " << helper.errorMsg());

                // test copy constructor
                Defs copy_of_defs = Defs(defs);
                BOOST_CHECK_MESSAGE(copy_of_defs == defs, "Error copy constructor failed " << relPath);

                // Test parse by string is same as parsing by file:
                {
                    std::string contents;
                    BOOST_CHECK_MESSAGE(File::open(relPath.string(), contents),
                                        "Error could not open file " << relPath);
                    // cout << "parsing file " << relPath << " by string\n";

                    Defs defs2;
                    std::string errorMsg2, warningMsg2;
                    BOOST_CHECK_MESSAGE(defs2.restore_from_string(contents, errorMsg2, warningMsg2),
                                        "restore from string failed for file " << relPath << "\n"
                                                                               << errorMsg2);
                    BOOST_CHECK_MESSAGE(defs2 == defs, "Parse by string != parse by filename for file:\n" << relPath);
                }

                // Make sure all nodes can be found
                std::vector<Node*> all_nodes;
                defs.getAllNodes(all_nodes);
                for (auto node : all_nodes) {
                    node_ptr found_node = defs.findAbsNode(node->absNodePath());
                    BOOST_CHECK_MESSAGE(found_node.get(), "Could not find node " << node->debugNodePath());
                    BOOST_CHECK_MESSAGE(found_node.get() == node,
                                        " Expected to find " << node->debugNodePath() << " but found "
                                                             << found_node->debugNodePath());
                }
            }
        }
        else {
            // test expected to fail
            if (parsedOk) {
                // Check triggers and limits
                std::string err_msg, warn_msg;
                defs.check(err_msg, warn_msg);
                BOOST_CHECK_MESSAGE(!err_msg.empty() || !warn_msg.empty(),
                                    "Expected problems with trigger/limits but found none for file" << relPath << "\n");
            }
            else {
                BOOST_CHECK_MESSAGE(!parsedOk, "Parse expected to fail for " << relPath << "\n" << errorMsg);
            }
        }
    }
}

BOOST_AUTO_TEST_CASE(test_parsing_for_good_defs) {
    ECF_NAME_THIS_TEST();

    std::string path = File::test_data("libs/node/test/parser/data/good_defs", "parser");

    // All the defs in this directory are expected to pass
    test_defs(path, true);
}

BOOST_AUTO_TEST_CASE(test_parsing_for_bad_defs) {
    ECF_NAME_THIS_TEST();

    std::string path = File::test_data("libs/node/test/parser/data/bad_defs", "parser");

    // All the defs in this directory are expected to fail
    test_defs(path, false);
}

BOOST_AUTO_TEST_CASE(test_parsing_for_good_defs_state) {
    ECF_NAME_THIS_TEST();

    std::string path = File::test_data("libs/node/test/parser/data/good_defs_state", "parser");

    // All the defs in this directory are expected to pass
    test_defs(path, true);
}

void test_node_defs(const std::string& directory, bool pass) {
    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.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());

            // recurse down directories
            if (fs::is_directory(dir_itr->status())) {
                test_node_defs(relPath.string(), pass);
                continue;
            }

            // std::cout << "......Parsing file " << relPath.string() << "\n";
            std::string file_contents;
            if (!ecf::File::open(relPath.string(), file_contents)) {
                std::cout << "......Could not open file" << relPath.string() << "\n";
                continue;
            }

            // Parse string as a standalone node.
            DefsStructureParser parser(file_contents);
            std::string errorMsg, warningMsg;
            bool parsedOk = parser.doParse(errorMsg, warningMsg);
            if (pass) {
                // Test expected to pass
                BOOST_CHECK_MESSAGE(parsedOk, "Failed to parse file " << relPath << "\n" << errorMsg);
                BOOST_CHECK_MESSAGE(parser.the_node_ptr(), "Failed to parse file " << relPath << "\n" << errorMsg);
                // PrintStyle print_style(PrintStyle::MIGRATE);
                // parser.the_node_ptr()->print(cout);
            }
            else {
                // test expected to fail
                // std::cout << errorMsg << "\n";
                BOOST_CHECK_MESSAGE(!parser.the_node_ptr(),
                                    "Parse expected to fail for " << relPath << "\n"
                                                                  << errorMsg);
            }
        }
        catch (const std::exception& ex) {
            std::cout << dir_itr->path().filename() << " " << ex.what() << std::endl;
        }
    }
}

BOOST_AUTO_TEST_CASE(test_parsing_node) {
    ECF_NAME_THIS_TEST();

    std::string path = File::test_data("libs/node/test/parser/data/good_node_defs", "parser");

    // All the defs in this directory are expected to pass
    test_node_defs(path, true);
}

BOOST_AUTO_TEST_SUITE_END()

BOOST_AUTO_TEST_SUITE_END()