1 /*
2 * Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23
24 #include "precompiled.hpp"
25 #include "logTestFixture.hpp"
26 #include "logTestUtils.inline.hpp"
27 #include "logging/log.hpp"
28 #include "logging/logMessage.hpp"
29 #include "prims/jvm.h"
30 #include "unittest.hpp"
31 #include "utilities/globalDefinitions.hpp"
32
33 class LogMessageTest : public LogTestFixture {
34 protected:
35 static Log(logging) _log;
36 static const char* _level_filename[];
37 LogMessageTest();
38 ~LogMessageTest();
39 };
40
41 const char* LogMessageTest::_level_filename[] = {
42 NULL, // LogLevel::Off
43 #define LOG_LEVEL(name, printname) "multiline-" #printname ".log",
44 LOG_LEVEL_LIST
45 #undef LOG_LEVEL
46 };
47
48 LogMessageTest::LogMessageTest() {
49 for (int i = 0; i < LogLevel::Count; i++) {
50 char buf[32];
51 // Attempt to remove possibly pre-existing log files
52 remove(_level_filename[i]);
53
54 jio_snprintf(buf, sizeof(buf), "logging=%s", LogLevel::name(static_cast<LogLevelType>(i)));
55 set_log_config(_level_filename[i], buf);
56 }
57 }
58
59 LogMessageTest::~LogMessageTest() {
60 // Stop logging to the files and remove them.
61 for (int i = 0; i < LogLevel::Count; i++) {
62 set_log_config(_level_filename[i], "all=off");
63 remove(_level_filename[i]);
64 }
65 }
66
67 // Verify that messages with multiple levels are written
68 // to outputs configured for all the corresponding levels
69 TEST_VM_F(LogMessageTest, level_inclusion) {
70 const size_t message_count = 10;
71 LogMessageBuffer msg[message_count];
72
73 struct {
74 int message_number;
75 LogLevelType level;
76 } lines[] = {
77 { 0, LogLevel::Error },
78 { 1, LogLevel::Info },
79 { 2, LogLevel::Info }, { 2, LogLevel::Debug },
80 { 3, LogLevel::Info }, { 3, LogLevel::Warning },
81 { 4, LogLevel::Debug }, { 4, LogLevel::Warning },
82 { 5, LogLevel::Trace }, { 5, LogLevel::Debug },
83 { 6, LogLevel::Warning }, { 6, LogLevel::Error },
84 { 7, LogLevel::Trace }, { 7, LogLevel::Info }, { 7, LogLevel::Debug },
85 { 8, LogLevel::Trace }, { 8, LogLevel::Debug }, { 8, LogLevel::Info },
86 { 8, LogLevel::Warning }, { 8, LogLevel::Error},
87 { 9, LogLevel::Trace }
88 };
89
90 // Fill in messages with the above lines
91 for (size_t i = 0; i < ARRAY_SIZE(lines); i++) {
92 switch (lines[i].level) {
93 #define LOG_LEVEL(name, printname) \
94 case LogLevel::name: \
95 msg[lines[i].message_number].printname("msg[%d]: " #printname, lines[i].message_number); \
96 break;
97 LOG_LEVEL_LIST
98 #undef LOG_LEVEL
99 }
100 }
101
102 for (size_t i = 0; i < message_count; i++) {
103 _log.write(msg[i]);
104 }
105
106 // Verify that lines are written to the expected log files
107 for (size_t i = 0; i < ARRAY_SIZE(lines); i++) {
108 char expected[256];
109 jio_snprintf(expected, sizeof(expected), "msg[%d]: %s",
110 lines[i].message_number, LogLevel::name(lines[i].level));
111 for (int level = lines[i].level; level > 0; level--) {
112 EXPECT_TRUE(file_contains_substring(_level_filename[level], expected))
113 << "line #" << i << " missing from log file " << _level_filename[level];
114 }
115 for (int level = lines[i].level + 1; level < LogLevel::Count; level++) {
116 EXPECT_FALSE(file_contains_substring(_level_filename[level], expected))
117 << "line #" << i << " erroneously included in log file " << _level_filename[level];
118 }
119 }
120 }
121
122 // Verify that messages are logged in the order they are added to the log message
123 TEST_VM_F(LogMessageTest, line_order) {
124 LogMessageBuffer msg;
125 msg.info("info line").error("error line").trace("trace line")
126 .error("another error").warning("warning line").debug("debug line");
127 _log.write(msg);
128
129 const char* expected[] = { "info line", "error line", "trace line",
130 "another error", "warning line", "debug line", NULL };
131 EXPECT_TRUE(file_contains_substrings_in_order(_level_filename[LogLevel::Trace], expected))
132 << "output missing or in incorrect order";
133 }
134
135 TEST_VM_F(LogMessageTest, long_message) {
136 // Write 10K bytes worth of log data
137 LogMessageBuffer msg;
138 const size_t size = 10 * K;
139 const char* start_marker = "#start#";
140 const char* end_marker = "#the end#";
141 char* data = NEW_C_HEAP_ARRAY(char, size, mtLogging);
142
143 // fill buffer with start_marker...some data...end_marker
144 sprintf(data, "%s", start_marker);
145 for (size_t i = strlen(start_marker); i < size; i++) {
146 data[i] = '0' + (i % 10);
147 }
148 sprintf(data + size - strlen(end_marker) - 1, "%s", end_marker);
149
150 msg.trace("%s", data); // Adds a newline, making the message exactly 10K in length.
151 _log.write(msg);
152
153 const char* expected[] = { start_marker, "0123456789", end_marker, NULL };
154 EXPECT_TRUE(file_contains_substrings_in_order(_level_filename[LogLevel::Trace], expected))
155 << "unable to print long line";
156 FREE_C_HEAP_ARRAY(char, data);
157 }
158
159 TEST_VM_F(LogMessageTest, message_with_many_lines) {
160 const size_t lines = 100;
161 const size_t line_length = 16;
162
163 LogMessageBuffer msg;
164 for (size_t i = 0; i < lines; i++) {
165 msg.info("Line #" SIZE_FORMAT, i);
166 }
167 _log.write(msg);
168
169 char expected_lines_data[lines][line_length];
170 const char* expected_lines[lines + 1];
171 for (size_t i = 0; i < lines; i++) {
172 jio_snprintf(&expected_lines_data[i][0], line_length, "Line #" SIZE_FORMAT, i);
173 expected_lines[i] = expected_lines_data[i];
174 }
175 expected_lines[lines] = NULL;
176
177 EXPECT_TRUE(file_contains_substrings_in_order(_level_filename[LogLevel::Trace], expected_lines))
178 << "couldn't find all lines in multiline message";
179 }
180
181 static size_t dummy_prefixer(char* buf, size_t len) {
182 static int i = 0;
183 const char* prefix = "some prefix: ";
184 const size_t prefix_len = strlen(prefix);
185 if (len < prefix_len) {
186 return prefix_len;
187 }
188 jio_snprintf(buf, len, "%s", prefix);
189 return prefix_len;
190 }
191
192 TEST_VM_F(LogMessageTest, prefixing) {
193 LogMessageBuffer msg;
194 msg.set_prefix(dummy_prefixer);
195 for (int i = 0; i < 3; i++) {
196 msg.info("test %d", i);
197 }
198 msg.set_prefix(NULL);
199 msg.info("test 3");
200 _log.write(msg);
201
202 const char* expected[] = {
203 "] some prefix: test 0",
204 "] some prefix: test 1",
205 "] some prefix: test 2",
206 "] test 3",
207 NULL
208 };
209 EXPECT_TRUE(file_contains_substrings_in_order(_level_filename[LogLevel::Trace], expected))
210 << "error in prefixed output";
211 }
212
213 TEST_VM_F(LogMessageTest, scoped_messages) {
214 {
215 LogMessage(logging) msg;
216 msg.info("scoped info");
217 msg.warning("scoped warn");
218 EXPECT_FALSE(file_contains_substring(_level_filename[LogLevel::Info], "scoped info"))
219 << "scoped log message written prematurely";
220 }
221 EXPECT_TRUE(file_contains_substring(_level_filename[LogLevel::Info], "scoped info"))
222 << "missing output from scoped log message";
223 EXPECT_TRUE(file_contains_substring(_level_filename[LogLevel::Warning], "scoped warn"))
224 << "missing output from scoped log message";
225 }
226
227 TEST_VM_F(LogMessageTest, scoped_flushing) {
228 {
229 LogMessage(logging) msg;
230 msg.info("manual flush info");
231 msg.flush();
232 EXPECT_TRUE(file_contains_substring(_level_filename[LogLevel::Info], "manual flush info"))
233 << "missing output from manually flushed scoped log message";
234 }
235 const char* tmp[] = {"manual flush info", "manual flush info", NULL};
236 EXPECT_FALSE(file_contains_substrings_in_order(_level_filename[LogLevel::Info], tmp))
237 << "log file contains duplicate lines from single scoped log message";
238 }
239
240 TEST_VM_F(LogMessageTest, scoped_reset) {
241 {
242 LogMessage(logging) msg, partial;
243 msg.info("%s", "info reset msg");
244 msg.reset();
245 partial.info("%s", "info reset msg");
246 partial.reset();
247 partial.trace("%s", "trace reset msg");
248 }
249 EXPECT_FALSE(file_contains_substring(_level_filename[LogLevel::Info], "info reset msg"))
250 << "reset message written anyway";
251 EXPECT_TRUE(file_contains_substring(_level_filename[LogLevel::Trace], "trace reset msg"))
252 << "missing message from partially reset scoped log message";
253 }