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 | // Copyright (C) 2016-2022 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
/// @file Contains tests that exercise the basic functionality of the
// class RotatingFile. These tests are independent of the hooks framework.
#include <config.h>
#include <exceptions/exceptions.h>
#include <cc/data.h>
#include <testutils/gtest_utils.h>
#include <dhcpsrv/legal_log_mgr_factory.h>
#include <dhcpsrv/legal_log_db_log.h>
#include <legal_log_log.h>
#include <rotating_file.h>
#include <gtest/gtest.h>
#include <boost/date_time/posix_time/posix_time.hpp>
using namespace isc;
using namespace isc::data;
using namespace isc::db;
using namespace isc::dhcp;
using namespace isc::legal_log;
using namespace std;
namespace {
const DbLogger::MessageMap legal_log_db_message_map = {
};
DbLogger legal_log_db_logger(legal_log_logger, legal_log_db_message_map);
/// @brief Test fixture
struct LegalLogMgrTest : ::testing::Test {
/// @brief Destructor.
virtual ~LegalLogMgrTest() = default;
/// @brief Called before each test.
virtual void SetUp() override {
// Clean up from past tests.
LegalLogMgrFactory::delAllBackends();
}
/// @brief Called after each test.
virtual void TearDown() override {
// Clean up from past tests.
LegalLogMgrFactory::delAllBackends();
reset();
}
/// @brief Removes files that may be left over from previous tests
void reset() {
std::ostringstream stream;
stream << "rm " << TEST_DATA_BUILDDIR << "/" << "*-legal"
<< ".*.txt 2>/dev/null";
int result = ::system(stream.str().c_str());
if (result != 0) {
// Ignore the result, because it may well be non-zero value when
// files to be removed don't exist.
;
}
}
/// @brief Initializer.
RotatingFileInit init_;
};
// Verifies output of genDurationString()
TEST_F(LegalLogMgrTest, genDurationString) {
EXPECT_EQ("0 hrs 0 mins 0 secs", LegalLogMgr::genDurationString(0));
EXPECT_EQ("0 hrs 0 mins 1 secs", LegalLogMgr::genDurationString(1));
EXPECT_EQ("0 hrs 1 mins 1 secs", LegalLogMgr::genDurationString(61));
EXPECT_EQ("1 hrs 1 mins 1 secs", LegalLogMgr::genDurationString(3661));
EXPECT_EQ("1 days 0 hrs 0 mins 0 secs",
LegalLogMgr::genDurationString(24*60*60));
EXPECT_EQ("1 days 1 hrs 1 mins 1 secs",
LegalLogMgr::genDurationString(24*60*60 + 3661));
EXPECT_EQ("182 days 17 hrs 21 mins 11 secs",
LegalLogMgr::genDurationString(15783671 + 3600));
EXPECT_EQ("infinite duration",
LegalLogMgr::genDurationString(0xFFFFFFFF));
}
// Verifies the LegalLogDbLogger class works as expected
TEST_F(LegalLogMgrTest, legalLogDbLogger) {
EXPECT_EQ(1, db_logger_stack.size());
// Open a block
{
EXPECT_EQ(1, db_logger_stack.size());
// Push local logger
LegalLogDbLogger pushed(legal_log_db_logger);
// Check now we have a second logger
EXPECT_EQ(2, db_logger_stack.size());
}
// Logger was popped when existing the block
EXPECT_EQ(1, db_logger_stack.size());
// Open a try block to check it works with it
try {
EXPECT_EQ(1, db_logger_stack.size());
LegalLogDbLogger pushed(legal_log_db_logger);
EXPECT_EQ(2, db_logger_stack.size());
} catch (const std::exception&) {
ADD_FAILURE() << "no exception was raised";
}
EXPECT_EQ(1, db_logger_stack.size());
// Another check with an exception now
try {
EXPECT_EQ(1, db_logger_stack.size());
LegalLogDbLogger pushed(legal_log_db_logger);
EXPECT_EQ(2, db_logger_stack.size());
isc_throw(Unexpected, "for testing");
ADD_FAILURE() << "an exception was raised";
} catch (const std::exception&) {
// The handler is outside the block
EXPECT_EQ(1, db_logger_stack.size());
}
ASSERT_EQ(1, db_logger_stack.size());
}
// Verifies that vectorDump handles empty content (for static analyzers)
TEST_F(LegalLogMgrTest, emptyVectorDump) {
std::vector<uint8_t> bytes;
EXPECT_TRUE(LegalLogMgr::vectorDump(bytes).empty());
EXPECT_TRUE(LegalLogMgr::vectorHexDump(bytes).empty());
}
// Verify that parsing extra parameters for rotate file works
TEST_F(LegalLogMgrTest, parseExtraRotatingFileParameters) {
isc::db::DatabaseConnection::ParameterMap map;
EXPECT_NO_THROW(LegalLogMgr::parseConfig(ConstElementPtr(), map));
map["path"] = TEST_DATA_BUILDDIR;
EXPECT_NO_THROW(LegalLogMgrFactory::addBackend(map));
EXPECT_TRUE(LegalLogMgrFactory::instance());
RotatingFile& rotating_file = dynamic_cast<RotatingFile&>(*LegalLogMgrFactory::instance());
ElementPtr params = Element::createMap();
params->set("path", Element::create("path"));
params->set("base-name", Element::create("name"));
params->set("time-unit", Element::create(0));
EXPECT_THROW(LegalLogMgr::parseFile(params, map), TypeError);
params->set("time-unit", Element::create("nothing"));
EXPECT_NO_THROW(LegalLogMgr::parseFile(params, map));
EXPECT_THROW(rotating_file.apply(map), BadValue);
params->set("time-unit", Element::create("second"));
params->set("count", Element::create(""));
EXPECT_THROW(LegalLogMgr::parseFile(params, map), TypeError);
params->set("time-unit", Element::create("day"));
params->set("count", Element::create(-1));
EXPECT_THROW(LegalLogMgr::parseFile(params, map), OutOfRange);
params->set("time-unit", Element::create("month"));
params->set("count", Element::create(static_cast<int64_t>(1) << 32));
EXPECT_THROW(LegalLogMgr::parseFile(params, map), OutOfRange);
params->set("time-unit", Element::create("year"));
params->set("count", Element::create(1));
params->set("prerotate", Element::create(FORENSIC_PREROTATE_TEST_SH));
params->set("postrotate", Element::create(FORENSIC_POSTROTATE_TEST_SH));
EXPECT_NO_THROW(LegalLogMgr::parseFile(params, map));
EXPECT_NO_THROW(rotating_file.apply(map));
}
// Verify that parsing extra parameters works
TEST_F(LegalLogMgrTest, parseExtraParameters) {
db::DatabaseConnection::ParameterMap map;
map["path"] = "path";
map["base-name"] = "name";
ASSERT_NO_THROW(LegalLogMgrFactory::instance().reset(new RotatingFile(map)));
ElementPtr params = Element::createMap();
params->set("request-parser-format", Element::create("'request'"));
params->set("response-parser-format", Element::create("'response'"));
params->set("timestamp-format", Element::create("timestamp"));
map.clear();
map["type"] = "logfile";
map["path"] = TEST_DATA_BUILDDIR;
EXPECT_NO_THROW(LegalLogMgr::parseExtraParameters(params, map));
EXPECT_NO_THROW(LegalLogMgrFactory::addBackend(map));
EXPECT_TRUE(LegalLogMgrFactory::instance());
auto request_format = LegalLogMgrFactory::instance()->getRequestFormatExpression();
EXPECT_TRUE(request_format);
auto response_format = LegalLogMgrFactory::instance()->getResponseFormatExpression();
EXPECT_TRUE(response_format);
EXPECT_NE(request_format, response_format);
auto timestamp_format = LegalLogMgrFactory::instance()->getTimestampFormat();
EXPECT_EQ(timestamp_format, "timestamp");
}
TEST_F(LegalLogMgrTest, fileNoParameters) {
db::DatabaseConnection::ParameterMap map;
EXPECT_NO_THROW(LegalLogMgr::parseFile(ConstElementPtr(), map));
map["path"] = TEST_DATA_BUILDDIR;
ASSERT_NO_THROW(LegalLogMgrFactory::instance().reset(new RotatingFile(map)));
ASSERT_NO_THROW(LegalLogMgrFactory::instance()->open());
RotatingFile& rotating_file = dynamic_cast<RotatingFile&>(*LegalLogMgrFactory::instance());
map.clear();
rotating_file.apply(map);
EXPECT_EQ(rotating_file.getPath(), LEGAL_LOG_DIR);
EXPECT_EQ(rotating_file.getBaseName(), "kea-legal");
}
TEST_F(LegalLogMgrTest, databaseNoParameters) {
db::DatabaseConnection::ParameterMap map;
EXPECT_THROW(LegalLogMgr::parseDatabase(ConstElementPtr(), map), BadValue);
}
TEST_F(LegalLogMgrTest, wrongDatabaseType) {
db::DatabaseConnection::ParameterMap map;
ElementPtr parameters = Element::createMap();
parameters->set("type", Element::create(""));
EXPECT_NO_THROW(LegalLogMgr::parseDatabase(parameters, map));
EXPECT_THROW_MSG(LegalLogMgrFactory::addBackend(map), InvalidType,
"The type of the forensic log backend: '' is not supported");
EXPECT_FALSE(LegalLogMgrFactory::instance());
parameters->set("type", Element::create("awesomesql"));
EXPECT_NO_THROW(LegalLogMgr::parseDatabase(parameters, map));
EXPECT_THROW_MSG(LegalLogMgrFactory::addBackend(map), InvalidType,
"The type of the forensic log backend: 'awesomesql' is not supported");
}
} // end of anonymous namespace
|