File: logging_chrome_unittest.cc

package info (click to toggle)
chromium 138.0.7204.157-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,864 kB
  • sloc: cpp: 34,936,859; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,967; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (330 lines) | stat: -rw-r--r-- 12,427 bytes parent folder | download | duplicates (3)
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/common/logging_chrome.h"

#include <memory>
#include <optional>

#include "base/command_line.h"
#include "base/environment.h"
#include "base/files/file_enumerator.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "build/build_config.h"
#include "chrome/common/env_vars.h"
#include "content/public/common/content_switches.h"
#include "testing/gmock/include/gmock/gmock-matchers.h"
#include "testing/gtest/include/gtest/gtest.h"

class ChromeLoggingTest : public testing::Test {
 public:
  // Stores the current value of the log file name environment
  // variable and sets the variable to new_value.
  void SaveEnvironmentVariable(const std::string& new_value) {
    std::unique_ptr<base::Environment> env(base::Environment::Create());
    environment_filename_ = env->GetVar(env_vars::kLogFileName).value_or("");

    env->SetVar(env_vars::kLogFileName, new_value);
  }

  // Restores the value of the log file nave environment variable
  // previously saved by SaveEnvironmentVariable().
  void RestoreEnvironmentVariable() {
    std::unique_ptr<base::Environment> env(base::Environment::Create());
    env->SetVar(env_vars::kLogFileName, environment_filename_);
  }

  void SetLogFileFlag(const std::string& value) {
    cmd_line_.AppendSwitchASCII(switches::kLogFile, value);
  }

  const base::CommandLine& cmd_line() { return cmd_line_; }

 private:
  std::string environment_filename_;  // Saves real environment value.
  base::CommandLine cmd_line_ =
      base::CommandLine(base::CommandLine::NO_PROGRAM);
};

// Tests the log file name getter without an environment variable.
TEST_F(ChromeLoggingTest, LogFileName) {
  SaveEnvironmentVariable(std::string());

  base::FilePath filename = logging::GetLogFileName(cmd_line());
  ASSERT_NE(base::FilePath::StringType::npos,
            filename.value().find(FILE_PATH_LITERAL("chrome_debug.log")));
#if BUILDFLAG(IS_WIN)
  ASSERT_TRUE(filename.IsAbsolute());
#endif  // BUILDFLAG(IS_WIN)

  RestoreEnvironmentVariable();
}

// Tests the log file name getter with an environment variable.
#if BUILDFLAG(IS_WIN)
TEST_F(ChromeLoggingTest, EnvironmentLogFileName) {
  SaveEnvironmentVariable("c:\\path\\test env value");
  base::FilePath filename = logging::GetLogFileName(cmd_line());
  ASSERT_NE(base::FilePath::StringType::npos,
            filename.value().find(FILE_PATH_LITERAL("test env value")));
  ASSERT_TRUE(filename.IsAbsolute());
  RestoreEnvironmentVariable();
}
#else
TEST_F(ChromeLoggingTest, EnvironmentLogFileName) {
  SaveEnvironmentVariable("test env value");
  base::FilePath filename = logging::GetLogFileName(cmd_line());
  ASSERT_NE(base::FilePath::StringType::npos,
            filename.value().find(FILE_PATH_LITERAL("test env value")));
  RestoreEnvironmentVariable();
}
#endif  // BUILDFLAG(IS_WIN)

// Tests the log file name getter with a command-line flag.
#if BUILDFLAG(IS_WIN)
TEST_F(ChromeLoggingTest, FlagLogFileName) {
  SetLogFileFlag("c:\\path\\test flag value");
  base::FilePath filename = logging::GetLogFileName(cmd_line());
  ASSERT_NE(base::FilePath::StringType::npos,
            filename.value().find(FILE_PATH_LITERAL("test flag value")));
  ASSERT_TRUE(filename.IsAbsolute());
}
// Non-absolute path falls back to default.
TEST_F(ChromeLoggingTest, FlagLogFileNameNonAbsolute) {
  SetLogFileFlag("test file value");
  base::FilePath filename = logging::GetLogFileName(cmd_line());
  ASSERT_NE(base::FilePath::StringType::npos,
            filename.value().find(FILE_PATH_LITERAL("chrome_debug.log")));
  ASSERT_TRUE(filename.IsAbsolute());
}
#else
TEST_F(ChromeLoggingTest, FlagLogFileName) {
  SetLogFileFlag("test flag value");
  base::FilePath filename = logging::GetLogFileName(cmd_line());
  ASSERT_NE(base::FilePath::StringType::npos,
            filename.value().find(FILE_PATH_LITERAL("test flag value")));
}
#endif  // BUILDFLAG(IS_WIN)

// Tests the log file name getter with with an environment variable and a
// command-line flag. The flag takes precedence.
#if BUILDFLAG(IS_WIN)
TEST_F(ChromeLoggingTest, EnvironmentAndFlagLogFileName) {
  SaveEnvironmentVariable("c:\\path\\test env value");
  SetLogFileFlag("d:\\path\\test flag value");

  base::FilePath filename = logging::GetLogFileName(cmd_line());
  ASSERT_NE(base::FilePath::StringType::npos,
            filename.value().find(FILE_PATH_LITERAL("test flag value")));
  ASSERT_TRUE(filename.IsAbsolute());
  RestoreEnvironmentVariable();
}
#else
TEST_F(ChromeLoggingTest, EnvironmentAndFlagLogFileName) {
  SaveEnvironmentVariable("test env value");
  SetLogFileFlag("test flag value");

  base::FilePath filename = logging::GetLogFileName(cmd_line());
  ASSERT_NE(base::FilePath::StringType::npos,
            filename.value().find(FILE_PATH_LITERAL("test flag value")));
  RestoreEnvironmentVariable();
}
#endif  // BUILDFLAG(IS_WIN)

#if BUILDFLAG(IS_CHROMEOS)
TEST_F(ChromeLoggingTest, TimestampedName) {
  base::FilePath path = base::FilePath(FILE_PATH_LITERAL("xy.zzy"));
  base::FilePath timestamped_path =
      logging::GenerateTimestampedName(path, base::Time::Now());
  EXPECT_THAT(timestamped_path.value(),
              ::testing::MatchesRegex("^xy_\\d+-\\d+\\.zzy$"));
}

TEST_F(ChromeLoggingTest, SetUpSymlink) {
  base::ScopedTempDir temp_dir;
  ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
  const base::FilePath temp_dir_path = temp_dir.GetPath();
  base::FilePath bare_symlink_path =
      temp_dir_path.AppendASCII("chrome-test-log");
  base::FilePath latest_symlink_path =
      temp_dir_path.AppendASCII("chrome-test-log.LATEST");
  base::FilePath previous_symlink_path =
      temp_dir_path.AppendASCII("chrome-test-log.PREVIOUS");

  // Start from a legacy situation, where "chrome-test-log" is a symlink
  // pointing to the latest log, which has a time-stamped name from a while
  // ago.
  base::FilePath old_target_path = logging::GenerateTimestampedName(
      bare_symlink_path, base::Time::UnixEpoch());

  ASSERT_TRUE(base::CreateSymbolicLink(old_target_path, bare_symlink_path));

  // Call the testee with the new symlink path, as if starting a new session.
  logging::SetUpSymlinkIfNeeded(latest_symlink_path,
                                /*start_new_log=*/true);

  // We now expect:
  //
  // chrome-test-log --> chrome-test-log.LATEST
  // chrome-test-log.LATEST --> <new time-stamped path>
  // no chrome-test-log.PREVIOUS on the legacy transition.
  base::FilePath target_path;
  ASSERT_TRUE(base::ReadSymbolicLink(bare_symlink_path, &target_path));
  EXPECT_EQ(target_path.value(), latest_symlink_path.value());

  base::FilePath latest_target_path;
  ASSERT_TRUE(base::ReadSymbolicLink(latest_symlink_path, &latest_target_path));
  EXPECT_NE(latest_target_path.value(), old_target_path.value());
  EXPECT_THAT(latest_target_path.value(),
              ::testing::MatchesRegex("^.*chrome-test-log_\\d+-\\d+$"));

  // Simulate one more session cycle.
  logging::SetUpSymlinkIfNeeded(latest_symlink_path, /*start_new_log=*/true);

  // We now expect:
  //
  // chrome-test-log.PREVIOUS --> <previous target of chrome-test-log.LATEST>
  //
  // We also expect that the .LATEST file is now pointing to a file with a
  // newer time stamp.  Unfortunately it's probably not newer enough to tell
  // the difference since the time stamp granularity is 1 second.
  ASSERT_TRUE(base::ReadSymbolicLink(previous_symlink_path, &target_path));
  EXPECT_EQ(target_path.value(), latest_target_path.value());

  ASSERT_TRUE(base::ReadSymbolicLink(latest_symlink_path, &latest_target_path));
  EXPECT_THAT(latest_target_path.value(),
              ::testing::MatchesRegex("^.*chrome-test-log_\\d+-\\d+$"));
}

// Test the case of the normal rotation.
TEST_F(ChromeLoggingTest, RotateLogFiles) {
  constexpr char kLog1Content[] = "log#1\n";
  base::ScopedTempDir temp_dir;
  ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
  const base::FilePath temp_dir_path = temp_dir.GetPath();
  base::FilePath log_path_latest = temp_dir_path.AppendASCII("chrome-test-log");

  // Prepare the latest log file.
  ASSERT_TRUE(base::WriteFile(log_path_latest, kLog1Content));
  base::File::Info file_info;
  base::File(log_path_latest, base::File::FLAG_OPEN | base::File::FLAG_READ)
      .GetInfo(&file_info);
  base::Time creation_time = file_info.creation_time;

  // Generate the log file path which is rotated to.
  base::FilePath expected_rotated_path =
      logging::GenerateTimestampedName(log_path_latest, creation_time);

  // Check the condition before rotation.
  {
    EXPECT_TRUE(base::PathExists(log_path_latest));
    EXPECT_FALSE(base::PathExists(expected_rotated_path));
  }

  // Simulate the rotation.
  ASSERT_TRUE(logging::RotateLogFile(log_path_latest));

  // Check the conditions after rotation: the log file and the rotated log file.
  {
    EXPECT_FALSE(base::PathExists(log_path_latest));
    EXPECT_TRUE(base::PathExists(expected_rotated_path));

    std::string buffer;
    base::ReadFileToString(expected_rotated_path, &buffer);
    EXPECT_EQ(buffer, kLog1Content);
  }
}

// Test the case that chrome tries the rotation but there is no files.
TEST_F(ChromeLoggingTest, RotateLogFilesNoFile) {
  base::ScopedTempDir temp_dir;
  ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
  const base::FilePath temp_dir_path = temp_dir.GetPath();

  base::FilePath log_path_latest = temp_dir_path.AppendASCII("chrome-test-log");

  // Check the condition before rotation.
  {
    EXPECT_FALSE(base::PathExists(log_path_latest));

    // Ensure no file in the directory.
    base::FileEnumerator enumerator(temp_dir_path, true,
                                    base::FileEnumerator::FILES);
    EXPECT_TRUE(enumerator.Next().empty());
  }

  // Simulate the rotation.
  ASSERT_TRUE(logging::RotateLogFile(log_path_latest));

  // Check the condition after rotation: nothing happens.
  {
    EXPECT_FALSE(base::PathExists(log_path_latest));

    // Ensure still no file in the directory.
    base::FileEnumerator enumerator(temp_dir_path, true,
                                    base::FileEnumerator::FILES);
    EXPECT_TRUE(enumerator.Next().empty());
  }
}

// Test the case that chrome tries the rotation but the target path already
// exists. The logic should use the altanate target path.
TEST_F(ChromeLoggingTest, RotateLogFilesExisting) {
  constexpr char kLatestLogContent[] = "log#1\n";
  constexpr char kOldLogContent[] = "log#2\n";

  base::ScopedTempDir temp_dir;
  ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
  const base::FilePath temp_dir_path = temp_dir.GetPath();
  base::FilePath log_path_latest = temp_dir_path.AppendASCII("chrome-test-log");

  // Prepare the latest log file.
  ASSERT_TRUE(base::WriteFile(log_path_latest, kLatestLogContent));
  base::File::Info file_info;
  {
    base::File(log_path_latest, base::File::FLAG_OPEN | base::File::FLAG_READ)
        .GetInfo(&file_info);
  }
  base::Time creation_time = file_info.creation_time;

  base::FilePath exist_log_path =
      logging::GenerateTimestampedName(log_path_latest, creation_time);
  ASSERT_TRUE(base::WriteFile(exist_log_path, kOldLogContent));

  base::FilePath rotated_log_path = logging::GenerateTimestampedName(
      log_path_latest, creation_time + base::Seconds(1));

  // Check the condition before rotation.
  {
    // The latest log file exists.
    EXPECT_TRUE(base::PathExists(log_path_latest));
    // First candidate does already exist.
    EXPECT_TRUE(base::PathExists(exist_log_path));
    // Second candidate does already exist.
    EXPECT_FALSE(base::PathExists(rotated_log_path));
  }

  // Simulate one more session cycle.
  ASSERT_TRUE(logging::RotateLogFile(log_path_latest));

  // Check the condition after rotation: the log file is renamed to the second
  // candidate.
  {
    EXPECT_FALSE(base::PathExists(log_path_latest));
    EXPECT_TRUE(base::PathExists(exist_log_path));
    EXPECT_TRUE(base::PathExists(rotated_log_path));

    std::string buffer;
    // The first candidate is kept.
    base::ReadFileToString(exist_log_path, &buffer);
    EXPECT_EQ(buffer, kOldLogContent);
    // The second candidate is the previous latest log.
    base::ReadFileToString(rotated_log_path, &buffer);
    EXPECT_EQ(buffer, kLatestLogContent);
  }
}

#endif  // BUILDFLAG(IS_CHROMEOS)