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
|
/*
* 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 <stdexcept>
#include <boost/test/unit_test.hpp>
#include "InvokeServer.hpp"
#include "SCPort.hpp"
#include "ecflow/client/ClientEnvironment.hpp"
#include "ecflow/client/ClientInvoker.hpp"
#include "ecflow/core/WhiteListFile.hpp"
#include "ecflow/test/scaffold/Naming.hpp"
using namespace std;
using namespace ecf;
BOOST_AUTO_TEST_SUITE(S_Client)
BOOST_AUTO_TEST_SUITE(T_WhiteListFile)
// ************************************************************************************
// Note: If you make edits to node tree, they will have no effect until the server is rebuilt
//
// Note: To test HPUX->Linux, invoke serve on (Linux/HPUX) and the client cmds on other system
// On the client side set ECF_HOST to machine name. To allow further testing if ECF_HOST
// is specified then *don't* shutdown the server
// ************************************************************************************
BOOST_AUTO_TEST_CASE(test_loading_of_white_list_file) {
ECF_NAME_THIS_TEST();
Host the_host;
std::string port = SCPort::next();
std::string host = ClientEnvironment::hostSpecified();
if (host.empty()) {
// make sure NO whitelist file is present before the server is started.
// This allows any user to send requests to the server
// Only do this locally, as white list file on remote machine may not be accessible
fs::remove(the_host.ecf_lists_file(port));
}
// This will remove check pt and backup file before server start, to avoid the server from loading previous test
// data
InvokeServer invokeServer("Client:: ...test_loading_of_white_list_file", port);
BOOST_REQUIRE_MESSAGE(invokeServer.server_started(),
"Server failed to start on " << invokeServer.host() << ":" << invokeServer.port());
ClientInvoker theClient(invokeServer.host(), invokeServer.port());
BOOST_REQUIRE_MESSAGE(theClient.delete_all() == 0,
CtsApi::to_string(CtsApi::delete_node()) << " should return 0\n"
<< theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.shutdownServer() == 0,
CtsApi::shutdownServer() << " should return 0\n"
<< theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.haltServer() == 0,
CtsApi::haltServer() << " should return 0\n"
<< theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.restartServer() == 0,
CtsApi::restartServer() << " should return 0\n"
<< theClient.errorMsg());
// OK now test white list file functionality, but only if server was invoked locally
if (host.empty()) {
// The white list file should not exist, hence reload white list SHOULD fail.
// i.e because we deleted it earlier
BOOST_REQUIRE_THROW(theClient.reloadwsfile(), std::runtime_error);
// Create a valid white list file; For the FIRST time:
// **** IMPORTANT: if we had reloaded a white list file where the user has read access
// **************: _FIRST_ it will not be possible reload white file with write access, afterwards
// **************: since subsequent RELOAD command itself will require write access
std::string errorMsg;
BOOST_REQUIRE_MESSAGE(WhiteListFile::createWithWriteAccess(the_host.ecf_lists_file(port), errorMsg), errorMsg);
// Reload should pass, as its the _first_ time
BOOST_REQUIRE_MESSAGE(theClient.reloadwsfile() == 0,
CtsApi::reloadwsfile() << " should return 0\n"
<< theClient.errorMsg());
// Invoking a client request that requires write access, should pass
BOOST_CHECK_MESSAGE(theClient.shutdownServer() == 0, "should return 0\n" << theClient.errorMsg());
// Invoking a client request that requires read access, should also pass
BOOST_CHECK_MESSAGE(theClient.getDefs() == 0, "should return 0\n" << theClient.errorMsg());
BOOST_CHECK_MESSAGE(theClient.sync_local() == 0, "should return 0\n" << theClient.errorMsg());
BOOST_CHECK_MESSAGE(theClient.news_local() == 0, "should return 0\n" << theClient.errorMsg());
// Remove the white list file. Comment out for debug
fs::remove(the_host.ecf_lists_file(port));
}
}
BOOST_AUTO_TEST_CASE(test_server_has_write_access_in_non_empty_whitelist) {
ECF_NAME_THIS_TEST();
Host the_host;
std::string host = ClientEnvironment::hostSpecified();
if (host.empty()) {
// OK now test white list file functionality, but only if server was invoked locally
// make sure NO whitelist file is present before the server is started.
// This allows any user to send requests to the server
// Only do this locally, as white list file on remote machine may not be accessible
std::string port = SCPort::next();
fs::remove(the_host.ecf_lists_file(port));
// This will remove check pt and backup file before server start, to avoid the server from loading previous test
// data
InvokeServer invokeServer("Client:: ...test_server_has_write_access_in_non_empty_whitelist", port);
BOOST_REQUIRE_MESSAGE(invokeServer.server_started(),
"Server failed to start on " << invokeServer.host() << ":" << invokeServer.port());
ClientInvoker theClient(invokeServer.host(), invokeServer.port());
BOOST_REQUIRE_MESSAGE(theClient.delete_all() == 0,
CtsApi::to_string(CtsApi::delete_node()) << " should return 0\n"
<< theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.shutdownServer() == 0,
CtsApi::shutdownServer() << " should return 0\n"
<< theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.haltServer() == 0,
CtsApi::haltServer() << " should return 0\n"
<< theClient.errorMsg());
BOOST_REQUIRE_MESSAGE(theClient.restartServer() == 0,
CtsApi::restartServer() << " should return 0\n"
<< theClient.errorMsg());
// The white list file should not exist, hence reload white list SHOULD fail.
// i.e because we deleted it earlier
BOOST_REQUIRE_THROW(theClient.reloadwsfile(), std::runtime_error);
// Create a valid white list file where the server HAS NO write access.
std::string errorMsg;
BOOST_REQUIRE_MESSAGE(WhiteListFile::createWithNoAccess(the_host.ecf_lists_file(port), errorMsg), errorMsg);
// Reload whitelist. The server will adapt white list so the server user always has write access
BOOST_REQUIRE_MESSAGE(theClient.reloadwsfile() == 0,
CtsApi::reloadwsfile() << " should return 0\n"
<< theClient.errorMsg());
// Invoking a client request that requires write access, should still pass
BOOST_CHECK_MESSAGE(theClient.shutdownServer() == 0, "should return 0\n" << theClient.errorMsg());
// Invoking a client request that requires read access, should also pass
BOOST_CHECK_MESSAGE(theClient.getDefs() == 0, "should return 0\n" << theClient.errorMsg());
BOOST_CHECK_MESSAGE(theClient.sync_local() == 0, "should return 0\n" << theClient.errorMsg());
BOOST_CHECK_MESSAGE(theClient.news_local() == 0, "should return 0\n" << theClient.errorMsg());
// ###############################################################################################################
// Remove the white list file. Comment out for debug
fs::remove(the_host.ecf_lists_file(port));
// Reload with empty white list. All users should have read/write access
BOOST_REQUIRE_MESSAGE(WhiteListFile::createEmpty(the_host.ecf_lists_file(port), errorMsg), errorMsg);
BOOST_REQUIRE_MESSAGE(theClient.reloadwsfile() == 0,
CtsApi::reloadwsfile() << " should return 0\n"
<< theClient.errorMsg());
// Invoking a client request that requires write access, should still pass
BOOST_REQUIRE_MESSAGE(theClient.restartServer() == 0,
CtsApi::restartServer() << " should return 0\n"
<< theClient.errorMsg());
// Invoking a client request that requires read access, should also pass
BOOST_CHECK_MESSAGE(theClient.getDefs() == 0, "should return 0\n" << theClient.errorMsg());
BOOST_CHECK_MESSAGE(theClient.sync_local() == 0, "should return 0\n" << theClient.errorMsg());
BOOST_CHECK_MESSAGE(theClient.news_local() == 0, "should return 0\n" << theClient.errorMsg());
// Remove the white list file. Comment out for debug
fs::remove(the_host.ecf_lists_file(port));
}
}
BOOST_AUTO_TEST_SUITE_END()
BOOST_AUTO_TEST_SUITE_END()
|
