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
|
// Copyright 2022 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/safe_browsing/extension_telemetry/extension_telemetry_persister.h"
#include <sstream>
#include "base/files/file_util.h"
#include "base/logging.h"
#include "base/path_service.h"
#include "base/task/bind_post_task.h"
#include "base/task/thread_pool.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/threading/sequence_bound.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/common/chrome_paths.h"
#include "chrome/test/base/testing_profile.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/test/browser_task_environment.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace safe_browsing {
namespace {
using WriteReportTrigger = ExtensionTelemetryPersister::WriteReportTrigger;
} // namespace
class ExtensionTelemetryPersisterTest : public ::testing::Test {
public:
ExtensionTelemetryPersisterTest();
void SetUp() override { ASSERT_EQ(persister_.is_null(), false); }
void CallbackHelper(std::string read) { read_string_ = read; }
void TearDown() override {
persister_.SynchronouslyResetForTest();
testing::Test::TearDown();
}
base::SequenceBound<safe_browsing::ExtensionTelemetryPersister> persister_;
int kMaxNumFilesPersisted = 10;
content::BrowserTaskEnvironment task_environment_;
TestingProfile profile_;
std::string read_string_;
base::HistogramTester histogram_tester_;
base::WeakPtrFactory<ExtensionTelemetryPersisterTest> weak_factory_{this};
};
ExtensionTelemetryPersisterTest::ExtensionTelemetryPersisterTest()
: task_environment_(base::test::TaskEnvironment::TimeSource::MOCK_TIME) {
persister_ = base::SequenceBound<ExtensionTelemetryPersister>(
base::ThreadPool::CreateSequencedTaskRunner(
{base::MayBlock(), base::TaskPriority::BEST_EFFORT,
base::TaskShutdownBehavior::CONTINUE_ON_SHUTDOWN}),
kMaxNumFilesPersisted, profile_.GetPath());
persister_.AsyncCall(&ExtensionTelemetryPersister::PersisterInit);
task_environment_.RunUntilIdle();
}
TEST_F(ExtensionTelemetryPersisterTest, WriteReadCheck) {
std::string written_string = "Test String 1";
persister_.AsyncCall(&ExtensionTelemetryPersister::WriteReport)
.WithArgs(written_string, WriteReportTrigger::kAtWriteInterval);
auto callback =
base::BindOnce(&ExtensionTelemetryPersisterTest::CallbackHelper,
weak_factory_.GetWeakPtr());
persister_.AsyncCall(&ExtensionTelemetryPersister::ReadReport)
.Then(std::move(callback));
task_environment_.RunUntilIdle();
EXPECT_EQ(written_string, read_string_);
}
TEST_F(ExtensionTelemetryPersisterTest, WritePastFullCacheCheck) {
read_string_ = "No File was read";
std::string written_string = "Test String 1";
for (int i = 0; i < 12; i++) {
persister_.AsyncCall(&ExtensionTelemetryPersister::WriteReport)
.WithArgs(written_string, WriteReportTrigger::kAtWriteInterval);
}
persister_.AsyncCall(&ExtensionTelemetryPersister::ClearPersistedFiles);
// After a clear no file should be there to read from.
auto callback =
base::BindOnce(&ExtensionTelemetryPersisterTest::CallbackHelper,
weak_factory_.GetWeakPtr());
persister_.AsyncCall(&ExtensionTelemetryPersister::ReadReport)
.Then(std::move(callback));
task_environment_.RunUntilIdle();
EXPECT_NE(written_string, read_string_);
}
TEST_F(ExtensionTelemetryPersisterTest, ReadFullCache) {
// Fully load persisted cache.
std::string written_string = "Test String 1";
for (int i = 0; i < 10; i++) {
persister_.AsyncCall(&ExtensionTelemetryPersister::WriteReport)
.WithArgs(written_string, WriteReportTrigger::kAtWriteInterval);
}
written_string = "Test String 2";
// Overwrite first 5 files.
for (int i = 0; i < 5; i++) {
persister_.AsyncCall(&ExtensionTelemetryPersister::WriteReport)
.WithArgs(written_string, WriteReportTrigger::kAtWriteInterval);
}
// Read should start at highest numbered file.
for (int i = 0; i < 5; i++) {
auto callback =
base::BindOnce(&ExtensionTelemetryPersisterTest::CallbackHelper,
weak_factory_.GetWeakPtr());
persister_.AsyncCall(&ExtensionTelemetryPersister::ReadReport)
.Then(std::move(callback));
task_environment_.RunUntilIdle();
EXPECT_EQ("Test String 1", read_string_);
}
// Files 0-4 should be different.
for (int i = 0; i < 5; i++) {
auto callback =
base::BindOnce(&ExtensionTelemetryPersisterTest::CallbackHelper,
weak_factory_.GetWeakPtr());
persister_.AsyncCall(&ExtensionTelemetryPersister::ReadReport)
.Then(std::move(callback));
task_environment_.RunUntilIdle();
EXPECT_EQ("Test String 2", read_string_);
}
auto callback =
base::BindOnce(&ExtensionTelemetryPersisterTest::CallbackHelper,
weak_factory_.GetWeakPtr());
persister_.AsyncCall(&ExtensionTelemetryPersister::ReadReport)
.Then(std::move(callback));
task_environment_.RunUntilIdle();
// Last read should not happen as all files have been read.
EXPECT_EQ("", read_string_);
}
TEST_F(ExtensionTelemetryPersisterTest, MultiProfile) {
TestingProfile profile_2;
base::SequenceBound<safe_browsing::ExtensionTelemetryPersister> persister_2 =
base::SequenceBound<ExtensionTelemetryPersister>(
base::ThreadPool::CreateSequencedTaskRunner(
{base::MayBlock(), base::TaskPriority::BEST_EFFORT,
base::TaskShutdownBehavior::CONTINUE_ON_SHUTDOWN}),
kMaxNumFilesPersisted, profile_2.GetPath());
persister_2.AsyncCall(&ExtensionTelemetryPersister::PersisterInit);
task_environment_.RunUntilIdle();
// Perform a simple read write test on two separate profiles.
std::string written_string = "Test String 1";
std::string written_string_2 = "Test String 2";
persister_.AsyncCall(&ExtensionTelemetryPersister::WriteReport)
.WithArgs(written_string, WriteReportTrigger::kAtWriteInterval);
persister_.AsyncCall(&ExtensionTelemetryPersister::WriteReport)
.WithArgs(written_string, WriteReportTrigger::kAtWriteInterval);
persister_2.AsyncCall(&ExtensionTelemetryPersister::WriteReport)
.WithArgs(written_string_2, WriteReportTrigger::kAtWriteInterval);
persister_2.AsyncCall(&ExtensionTelemetryPersister::WriteReport)
.WithArgs(written_string_2, WriteReportTrigger::kAtWriteInterval);
// Read through profile one persisted files
for (int i = 0; i < 2; i++) {
auto callback =
base::BindOnce(&ExtensionTelemetryPersisterTest::CallbackHelper,
weak_factory_.GetWeakPtr());
persister_.AsyncCall(&ExtensionTelemetryPersister::ReadReport)
.Then(std::move(callback));
task_environment_.RunUntilIdle();
EXPECT_EQ(written_string, read_string_);
}
// Last file read should fail since two files were written per profile.
auto callback =
base::BindOnce(&ExtensionTelemetryPersisterTest::CallbackHelper,
weak_factory_.GetWeakPtr());
persister_.AsyncCall(&ExtensionTelemetryPersister::ReadReport)
.Then(std::move(callback));
task_environment_.RunUntilIdle();
EXPECT_EQ("", read_string_);
// Repeat process for profile 2.
for (int i = 0; i < 2; i++) {
auto callback2 =
base::BindOnce(&ExtensionTelemetryPersisterTest::CallbackHelper,
weak_factory_.GetWeakPtr());
persister_2.AsyncCall(&ExtensionTelemetryPersister::ReadReport)
.Then(std::move(callback2));
task_environment_.RunUntilIdle();
EXPECT_EQ(written_string_2, read_string_);
}
auto callback2 =
base::BindOnce(&ExtensionTelemetryPersisterTest::CallbackHelper,
weak_factory_.GetWeakPtr());
persister_2.AsyncCall(&ExtensionTelemetryPersister::ReadReport)
.Then(std::move(callback2));
task_environment_.RunUntilIdle();
EXPECT_EQ("", read_string_);
}
TEST_F(ExtensionTelemetryPersisterTest, VerifyWriteResultHistograms) {
std::string written_string = "Test String 1";
persister_.AsyncCall(&ExtensionTelemetryPersister::WriteReport)
.WithArgs(written_string, WriteReportTrigger::kAtWriteInterval);
persister_.AsyncCall(&ExtensionTelemetryPersister::WriteReport)
.WithArgs(written_string, WriteReportTrigger::kAtShutdown);
task_environment_.RunUntilIdle();
histogram_tester_.ExpectUniqueSample(
"SafeBrowsing.ExtensionPersister.WriteResult", true, 2);
histogram_tester_.ExpectUniqueSample(
"SafeBrowsing.ExtensionPersister.WriteResult.AtWriteInterval", true, 1);
histogram_tester_.ExpectUniqueSample(
"SafeBrowsing.ExtensionPersister.WriteResult.AtShutdown", true, 1);
}
} // namespace safe_browsing
|