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 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
|
// 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/browser/media/webrtc/webrtc_log_uploader.h"
#include <stddef.h>
#include <string>
#include <utility>
#include "base/containers/span.h"
#include "base/files/file.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/functional/bind.h"
#include "base/run_loop.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_split.h"
#include "base/task/sequenced_task_runner.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/task_environment.h"
#include "base/test/test_future.h"
#include "base/time/time.h"
#include "testing/gtest/include/gtest/gtest.h"
const char kTestTime[] = "time";
const char kTestReportId[] = "report-id";
const char kTestLocalId[] = "local-id";
class WebRtcLogUploaderTest : public testing::Test {
public:
WebRtcLogUploaderTest() = default;
bool VerifyNumberOfLines(int expected_lines) {
std::vector<std::string> lines = GetLinesFromListFile();
EXPECT_EQ(expected_lines, static_cast<int>(lines.size()));
return expected_lines == static_cast<int>(lines.size());
}
bool VerifyLastLineHasAllInfo() {
std::string last_line = GetLastLineFromListFile();
if (last_line.empty())
return false;
std::vector<std::string> line_parts = base::SplitString(
last_line, ",", base::TRIM_WHITESPACE, base::SPLIT_WANT_ALL);
EXPECT_EQ(4u, line_parts.size());
if (4u != line_parts.size())
return false;
// The times (indices 0 and 3) is the time when the info was written to the
// file which we don't know, so just verify that it's not empty.
EXPECT_FALSE(line_parts[0].empty());
EXPECT_STREQ(kTestReportId, line_parts[1].c_str());
EXPECT_STREQ(kTestLocalId, line_parts[2].c_str());
EXPECT_FALSE(line_parts[3].empty());
return true;
}
// Verify that the last line contains the correct info for a local storage.
bool VerifyLastLineHasLocalStorageInfoOnly() {
std::string last_line = GetLastLineFromListFile();
if (last_line.empty())
return false;
std::vector<std::string> line_parts = base::SplitString(
last_line, ",", base::TRIM_WHITESPACE, base::SPLIT_WANT_ALL);
EXPECT_EQ(4u, line_parts.size());
if (4u != line_parts.size())
return false;
EXPECT_TRUE(line_parts[0].empty());
EXPECT_TRUE(line_parts[1].empty());
EXPECT_STREQ(kTestLocalId, line_parts[2].c_str());
EXPECT_FALSE(line_parts[3].empty());
return true;
}
// Verify that the last line contains the correct info for an upload.
bool VerifyLastLineHasUploadInfoOnly() {
std::string last_line = GetLastLineFromListFile();
if (last_line.empty())
return false;
std::vector<std::string> line_parts = base::SplitString(
last_line, ",", base::TRIM_WHITESPACE, base::SPLIT_WANT_ALL);
EXPECT_EQ(4u, line_parts.size());
if (4u != line_parts.size())
return false;
EXPECT_FALSE(line_parts[0].empty());
EXPECT_STREQ(kTestReportId, line_parts[1].c_str());
EXPECT_TRUE(line_parts[2].empty());
EXPECT_FALSE(line_parts[3].empty());
return true;
}
bool AddLinesToTestFile(int number_of_lines) {
base::File test_list_file(test_list_path_,
base::File::FLAG_OPEN | base::File::FLAG_APPEND);
EXPECT_TRUE(test_list_file.IsValid());
if (!test_list_file.IsValid())
return false;
for (int i = 0; i < number_of_lines; ++i) {
EXPECT_TRUE(test_list_file.WriteAtCurrentPosAndCheck(
base::byte_span_from_cstring(kTestTime)));
EXPECT_TRUE(test_list_file.WriteAtCurrentPosAndCheck(
base::byte_span_from_cstring(",")));
EXPECT_TRUE(test_list_file.WriteAtCurrentPosAndCheck(
base::byte_span_from_cstring(kTestReportId)));
EXPECT_TRUE(test_list_file.WriteAtCurrentPosAndCheck(
base::byte_span_from_cstring(",")));
EXPECT_TRUE(test_list_file.WriteAtCurrentPosAndCheck(
base::byte_span_from_cstring(kTestLocalId)));
EXPECT_TRUE(test_list_file.WriteAtCurrentPosAndCheck(
base::byte_span_from_cstring(",")));
EXPECT_TRUE(test_list_file.WriteAtCurrentPos(
base::byte_span_from_cstring(kTestTime)));
EXPECT_TRUE(test_list_file.WriteAtCurrentPosAndCheck(
base::byte_span_from_cstring("\n")));
}
return true;
}
std::vector<std::string> GetLinesFromListFile() {
std::string contents;
int read = base::ReadFileToString(test_list_path_, &contents);
EXPECT_GT(read, 0);
if (read == 0)
return std::vector<std::string>();
// Since every line should end with '\n', the last line should be empty. So
// we expect at least two lines including the final empty. Remove the empty
// line before returning.
std::vector<std::string> lines = base::SplitString(
contents, "\n", base::TRIM_WHITESPACE, base::SPLIT_WANT_ALL);
EXPECT_GT(lines.size(), 1u);
if (lines.size() < 2)
return std::vector<std::string>();
EXPECT_TRUE(lines.back().empty());
if (!lines.back().empty())
return std::vector<std::string>();
lines.pop_back();
return lines;
}
std::string GetLastLineFromListFile() {
std::vector<std::string> lines = GetLinesFromListFile();
EXPECT_GT(lines.size(), 0u);
if (lines.empty())
return std::string();
return lines[lines.size() - 1];
}
void VerifyRtpDumpInMultipart(const std::string& post_data,
const std::string& dump_name,
const std::string& dump_content) {
std::vector<std::string> lines = base::SplitStringUsingSubstr(
post_data, "\r\n", base::TRIM_WHITESPACE, base::SPLIT_WANT_ALL);
std::string name_line = "Content-Disposition: form-data; name=\"";
name_line.append(dump_name);
name_line.append("\"");
name_line.append("; filename=\"");
name_line.append(dump_name);
name_line.append(".gz\"");
size_t i = 0;
for (; i < lines.size(); ++i) {
if (lines[i] == name_line)
break;
}
// The RTP dump takes 4 lines: content-disposition, content-type, empty
// line, dump content.
EXPECT_LT(i, lines.size() - 3);
EXPECT_EQ("Content-Type: application/gzip", lines[i + 1]);
EXPECT_EQ("", lines[i + 2]);
EXPECT_EQ(dump_content, lines[i + 3]);
}
std::string GetValueFromMultipart(const std::string& post_data,
const std::string& value_name) {
std::vector<std::string> lines = base::SplitStringUsingSubstr(
post_data, "\r\n", base::TRIM_WHITESPACE, base::SPLIT_WANT_ALL);
std::string name_line = "Content-Disposition: form-data; name=\"";
name_line.append(value_name);
name_line.append("\"");
size_t i = 0;
for (; i < lines.size(); ++i) {
if (lines[i] == name_line) {
break;
}
}
EXPECT_LT(i, lines.size() - 2);
return lines[i + 2];
}
static void AddLocallyStoredLogInfoToUploadListFile(
WebRtcLogUploader* log_uploader,
const base::FilePath& upload_list_path,
const std::string& local_log_id) {
base::RunLoop run_loop;
log_uploader->background_task_runner()->PostTaskAndReply(
FROM_HERE,
base::BindOnce(
&WebRtcLogUploader::AddLocallyStoredLogInfoToUploadListFile,
base::Unretained(log_uploader), upload_list_path, local_log_id),
run_loop.QuitClosure());
run_loop.Run();
}
void FlushRunLoop() {
base::RunLoop run_loop;
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, run_loop.QuitClosure());
run_loop.Run();
}
base::test::TaskEnvironment task_environment_;
base::FilePath test_list_path_;
};
TEST_F(WebRtcLogUploaderTest, AddLocallyStoredLogInfoToUploadListFile) {
// Get a temporary filename. We don't want the file to exist to begin with
// since that's the normal use case, hence the delete.
ASSERT_TRUE(base::CreateTemporaryFile(&test_list_path_));
EXPECT_TRUE(base::DeleteFile(test_list_path_));
std::unique_ptr<WebRtcLogUploader> webrtc_log_uploader(
new WebRtcLogUploader());
AddLocallyStoredLogInfoToUploadListFile(webrtc_log_uploader.get(),
test_list_path_, kTestLocalId);
AddLocallyStoredLogInfoToUploadListFile(webrtc_log_uploader.get(),
test_list_path_, kTestLocalId);
ASSERT_TRUE(VerifyNumberOfLines(2));
ASSERT_TRUE(VerifyLastLineHasLocalStorageInfoOnly());
const int expected_line_limit = 50;
ASSERT_TRUE(AddLinesToTestFile(expected_line_limit - 2));
ASSERT_TRUE(VerifyNumberOfLines(expected_line_limit));
ASSERT_TRUE(VerifyLastLineHasAllInfo());
AddLocallyStoredLogInfoToUploadListFile(webrtc_log_uploader.get(),
test_list_path_, kTestLocalId);
ASSERT_TRUE(VerifyNumberOfLines(expected_line_limit));
ASSERT_TRUE(VerifyLastLineHasLocalStorageInfoOnly());
ASSERT_TRUE(AddLinesToTestFile(10));
ASSERT_TRUE(VerifyNumberOfLines(60));
ASSERT_TRUE(VerifyLastLineHasAllInfo());
AddLocallyStoredLogInfoToUploadListFile(webrtc_log_uploader.get(),
test_list_path_, kTestLocalId);
ASSERT_TRUE(VerifyNumberOfLines(expected_line_limit));
ASSERT_TRUE(VerifyLastLineHasLocalStorageInfoOnly());
webrtc_log_uploader->Shutdown();
FlushRunLoop();
}
TEST_F(WebRtcLogUploaderTest, AddUploadedLogInfoToUploadListFile) {
// Get a temporary filename. We don't want the file to exist to begin with
// since that's the normal use case, hence the delete.
ASSERT_TRUE(base::CreateTemporaryFile(&test_list_path_));
EXPECT_TRUE(base::DeleteFile(test_list_path_));
std::unique_ptr<WebRtcLogUploader> webrtc_log_uploader(
new WebRtcLogUploader());
AddLocallyStoredLogInfoToUploadListFile(webrtc_log_uploader.get(),
test_list_path_, kTestLocalId);
ASSERT_TRUE(VerifyNumberOfLines(1));
ASSERT_TRUE(VerifyLastLineHasLocalStorageInfoOnly());
webrtc_log_uploader->AddUploadedLogInfoToUploadListFile(
test_list_path_, kTestLocalId, kTestReportId);
ASSERT_TRUE(VerifyNumberOfLines(1));
ASSERT_TRUE(VerifyLastLineHasAllInfo());
// Use a local ID that should not be found in the list.
webrtc_log_uploader->AddUploadedLogInfoToUploadListFile(
test_list_path_, "dummy id", kTestReportId);
ASSERT_TRUE(VerifyNumberOfLines(2));
ASSERT_TRUE(VerifyLastLineHasUploadInfoOnly());
webrtc_log_uploader->Shutdown();
FlushRunLoop();
}
TEST_F(WebRtcLogUploaderTest, AddRtpDumpsToPostedData) {
base::ScopedTempDir temp_dir;
ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
std::string post_data;
auto webrtc_log_uploader = std::make_unique<WebRtcLogUploader>();
webrtc_log_uploader->OverrideUploadWithBufferForTesting(&post_data);
// Create the fake dump files.
const base::FilePath incoming_dump = temp_dir.GetPath().AppendASCII("recv");
const base::FilePath outgoing_dump = temp_dir.GetPath().AppendASCII("send");
const std::string incoming_dump_content = "dummy incoming";
const std::string outgoing_dump_content = "dummy outgoing";
base::WriteFile(incoming_dump, incoming_dump_content);
base::WriteFile(outgoing_dump, outgoing_dump_content);
WebRtcLogUploader::UploadDoneData upload_done_data;
upload_done_data.paths.directory = temp_dir.GetPath().AppendASCII("log");
upload_done_data.paths.incoming_rtp_dump = incoming_dump;
upload_done_data.paths.outgoing_rtp_dump = outgoing_dump;
std::unique_ptr<WebRtcLogBuffer> log(new WebRtcLogBuffer());
log->SetComplete();
base::RunLoop run_loop;
webrtc_log_uploader->background_task_runner()->PostTaskAndReply(
FROM_HERE,
base::BindOnce(&WebRtcLogUploader::OnLoggingStopped,
base::Unretained(webrtc_log_uploader.get()),
std::move(log), std::make_unique<WebRtcLogMetaDataMap>(),
std::move(upload_done_data),
/*is_text_log_upload_allowed=*/true),
run_loop.QuitClosure());
run_loop.Run();
VerifyRtpDumpInMultipart(post_data, "rtpdump_recv", incoming_dump_content);
VerifyRtpDumpInMultipart(post_data, "rtpdump_send", outgoing_dump_content);
webrtc_log_uploader->Shutdown();
FlushRunLoop();
}
TEST_F(WebRtcLogUploaderTest, DisableUploadOfMultipartData) {
base::test::TestFuture<bool, const std::string&, const std::string&> future;
base::ScopedTempDir temp_dir;
ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
std::string post_data;
auto webrtc_log_uploader = std::make_unique<WebRtcLogUploader>();
webrtc_log_uploader->OverrideUploadWithBufferForTesting(&post_data);
// Create the fake dump files.
const base::FilePath incoming_dump = temp_dir.GetPath().AppendASCII("recv");
const base::FilePath outgoing_dump = temp_dir.GetPath().AppendASCII("send");
const std::string incoming_dump_content = "dummy incoming";
const std::string outgoing_dump_content = "dummy outgoing";
base::WriteFile(incoming_dump, incoming_dump_content);
base::WriteFile(outgoing_dump, outgoing_dump_content);
WebRtcLogUploader::UploadDoneData upload_done_data;
upload_done_data.paths.directory = temp_dir.GetPath().AppendASCII("log");
upload_done_data.paths.incoming_rtp_dump = incoming_dump;
upload_done_data.paths.outgoing_rtp_dump = outgoing_dump;
upload_done_data.callback = future.GetCallback();
std::unique_ptr<WebRtcLogBuffer> log(new WebRtcLogBuffer());
log->SetComplete();
base::RunLoop run_loop;
webrtc_log_uploader->background_task_runner()->PostTaskAndReply(
FROM_HERE,
base::BindOnce(&WebRtcLogUploader::OnLoggingStopped,
base::Unretained(webrtc_log_uploader.get()),
std::move(log), std::make_unique<WebRtcLogMetaDataMap>(),
std::move(upload_done_data),
/*is_text_log_upload_allowed=*/false),
run_loop.QuitClosure());
run_loop.Run();
EXPECT_FALSE(future.Get<0>());
EXPECT_EQ("", future.Get<1>());
EXPECT_EQ(WebRtcLogUploader::kLogUploadDisabledMsg, future.Get<2>());
webrtc_log_uploader->Shutdown();
FlushRunLoop();
}
TEST_F(WebRtcLogUploaderTest, ProductHasNoSuffixWithoutFeature) {
base::test::ScopedFeatureList feature_list;
feature_list.InitAndDisableFeature(kWebRTCLogUploadSuffix);
base::ScopedTempDir temp_dir;
ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
std::string post_data;
auto webrtc_log_uploader = std::make_unique<WebRtcLogUploader>();
webrtc_log_uploader->OverrideUploadWithBufferForTesting(&post_data);
WebRtcLogUploader::UploadDoneData upload_done_data;
upload_done_data.paths.directory = temp_dir.GetPath().AppendASCII("log");
std::unique_ptr<WebRtcLogBuffer> log(new WebRtcLogBuffer());
log->SetComplete();
base::RunLoop run_loop;
webrtc_log_uploader->background_task_runner()->PostTaskAndReply(
FROM_HERE,
base::BindOnce(&WebRtcLogUploader::OnLoggingStopped,
base::Unretained(webrtc_log_uploader.get()),
std::move(log), std::make_unique<WebRtcLogMetaDataMap>(),
std::move(upload_done_data),
/*is_text_log_upload_allowed=*/true),
run_loop.QuitClosure());
run_loop.Run();
// Version should have a webrtc suffix, Product should not.
EXPECT_EQ(GetValueFromMultipart(post_data, "prod").find("_webrtc"),
std::string::npos);
EXPECT_NE(GetValueFromMultipart(post_data, "ver").find("-webrtc"),
std::string::npos);
webrtc_log_uploader->Shutdown();
FlushRunLoop();
}
TEST_F(WebRtcLogUploaderTest, ProductHasSuffixWithFeature) {
base::test::ScopedFeatureList feature_list;
feature_list.InitAndEnableFeature(kWebRTCLogUploadSuffix);
base::ScopedTempDir temp_dir;
ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
std::string post_data;
auto webrtc_log_uploader = std::make_unique<WebRtcLogUploader>();
webrtc_log_uploader->OverrideUploadWithBufferForTesting(&post_data);
WebRtcLogUploader::UploadDoneData upload_done_data;
upload_done_data.paths.directory = temp_dir.GetPath().AppendASCII("log");
std::unique_ptr<WebRtcLogBuffer> log(new WebRtcLogBuffer());
log->SetComplete();
base::RunLoop run_loop;
webrtc_log_uploader->background_task_runner()->PostTaskAndReply(
FROM_HERE,
base::BindOnce(&WebRtcLogUploader::OnLoggingStopped,
base::Unretained(webrtc_log_uploader.get()),
std::move(log), std::make_unique<WebRtcLogMetaDataMap>(),
std::move(upload_done_data),
/*is_text_log_upload_allowed=*/true),
run_loop.QuitClosure());
run_loop.Run();
// Product should have a webrtc suffix, Version should not.
EXPECT_NE(GetValueFromMultipart(post_data, "prod").find("_webrtc"),
std::string::npos);
EXPECT_EQ(GetValueFromMultipart(post_data, "ver").find("-webrtc"),
std::string::npos);
webrtc_log_uploader->Shutdown();
FlushRunLoop();
}
|