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 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/variations/seed_reader_writer.h"
#include "base/base64.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/mock_entropy_provider.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/task_environment.h"
#include "base/threading/thread.h"
#include "base/timer/mock_timer.h"
#include "base/version_info/channel.h"
#include "components/prefs/testing_pref_service.h"
#include "components/variations/pref_names.h"
#include "components/variations/variations_seed_store.h"
#include "components/variations/variations_test_utils.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/zlib/google/compression_utils.h"
namespace variations {
namespace {
using ::testing::IsEmpty;
using ::testing::TestWithParam;
using ::testing::Values;
const base::FilePath::CharType kSeedFilename[] = FILE_PATH_LITERAL("TestSeed");
// Used for clients that do not participate in SeedFiles experiment.
constexpr char kNoGroup[] = "";
// Compresses `data` using Gzip compression.
std::string Gzip(const std::string& data) {
std::string compressed;
CHECK(compression::GzipCompress(data, &compressed));
return compressed;
}
// Creates, serializes, and then Gzip compresses a test seed.
std::string CreateCompressedVariationsSeed() {
VariationsSeed seed;
seed.add_study()->set_name("TestStudy");
std::string serialized_seed;
seed.SerializeToString(&serialized_seed);
return Gzip(serialized_seed);
}
struct SeedReaderWriterTestParams {
using TupleT =
std::tuple<SeedFieldsPrefs, std::string_view, version_info::Channel>;
SeedReaderWriterTestParams(SeedFieldsPrefs seed_fields_prefs,
std::string_view field_trial_group,
version_info::Channel channel)
: seed_fields_prefs(seed_fields_prefs),
field_trial_group(field_trial_group),
channel(channel) {}
explicit SeedReaderWriterTestParams(const TupleT& t)
: SeedReaderWriterTestParams(std::get<0>(t),
std::get<1>(t),
std::get<2>(t)) {}
SeedFieldsPrefs seed_fields_prefs;
std::string_view field_trial_group;
version_info::Channel channel;
};
struct ExpectedFieldTrialGroupTestParams {
using TupleT = std::tuple<SeedFieldsPrefs, version_info::Channel>;
ExpectedFieldTrialGroupTestParams(
variations::SeedFieldsPrefs seed_fields_prefs,
version_info::Channel channel)
: seed_fields_prefs(seed_fields_prefs), channel(channel) {}
explicit ExpectedFieldTrialGroupTestParams(const TupleT& t)
: ExpectedFieldTrialGroupTestParams(std::get<0>(t), std::get<1>(t)) {}
variations::SeedFieldsPrefs seed_fields_prefs;
version_info::Channel channel;
};
class SeedReaderWriterTestBase {
public:
SeedReaderWriterTestBase()
: file_writer_thread_("SeedReaderWriter Test thread"),
entropy_providers_(std::make_unique<const MockEntropyProviders>(
MockEntropyProviders::Results{.low_entropy =
kAlwaysUseLastGroup})) {
VariationsSeedStore::RegisterPrefs(local_state_.registry());
scoped_feature_list_.InitWithEmptyFeatureAndFieldTrialLists();
file_writer_thread_.Start();
CHECK(temp_dir_.CreateUniqueTempDir());
temp_seed_file_path_ = temp_dir_.GetPath().Append(kSeedFilename);
}
~SeedReaderWriterTestBase() = default;
protected:
base::test::ScopedFeatureList scoped_feature_list_;
base::test::TaskEnvironment task_environment_;
base::FilePath temp_seed_file_path_;
base::Thread file_writer_thread_;
base::ScopedTempDir temp_dir_;
TestingPrefServiceSimple local_state_;
base::MockOneShotTimer timer_;
std::unique_ptr<const MockEntropyProviders> entropy_providers_;
};
class ExpectedFieldTrialGroupChannelsTest
: public SeedReaderWriterTestBase,
public TestWithParam<ExpectedFieldTrialGroupTestParams> {};
class ExpectedFieldTrialGroupAllChannelsTest
: public ExpectedFieldTrialGroupChannelsTest {};
class ExpectedFieldTrialGroupPreStableTest
: public ExpectedFieldTrialGroupChannelsTest {};
class ExpectedFieldTrialGroupStableTest
: public SeedReaderWriterTestBase,
public TestWithParam<SeedFieldsPrefs> {};
class ExpectedFieldTrialGroupUnknownTest
: public SeedReaderWriterTestBase,
public TestWithParam<SeedFieldsPrefs> {};
INSTANTIATE_TEST_SUITE_P(
All,
ExpectedFieldTrialGroupAllChannelsTest,
::testing::ConvertGenerator<ExpectedFieldTrialGroupTestParams::TupleT>(
::testing::Combine(::testing::Values(kRegularSeedFieldsPrefs,
kSafeSeedFieldsPrefs),
::testing::Values(version_info::Channel::UNKNOWN,
version_info::Channel::CANARY,
version_info::Channel::DEV,
version_info::Channel::BETA,
version_info::Channel::STABLE))));
// If empty seed file dir given, client is not assigned a group.
TEST_P(ExpectedFieldTrialGroupAllChannelsTest, NoSeedFileDir) {
SeedReaderWriter seed_reader_writer(
&local_state_, /*seed_file_dir=*/base::FilePath(), kSeedFilename,
GetParam().seed_fields_prefs, GetParam().channel,
entropy_providers_.get(), file_writer_thread_.task_runner());
EXPECT_THAT(base::FieldTrialList::FindFullName(kSeedFileTrial), IsEmpty());
}
// If no entropy provider given, client is not assigned a group.
TEST_P(ExpectedFieldTrialGroupAllChannelsTest, NoEntropyProvider) {
SeedReaderWriter seed_reader_writer(
&local_state_, /*seed_file_dir=*/temp_dir_.GetPath(), kSeedFilename,
GetParam().seed_fields_prefs, GetParam().channel,
/*entropy_providers=*/nullptr, file_writer_thread_.task_runner());
EXPECT_THAT(base::FieldTrialList::FindFullName(kSeedFileTrial), IsEmpty());
}
INSTANTIATE_TEST_SUITE_P(
All,
ExpectedFieldTrialGroupPreStableTest,
::testing::ConvertGenerator<ExpectedFieldTrialGroupTestParams::TupleT>(
::testing::Combine(::testing::Values(kRegularSeedFieldsPrefs,
kSafeSeedFieldsPrefs),
::testing::Values(version_info::Channel::CANARY,
version_info::Channel::DEV,
version_info::Channel::BETA))));
// If channel is pre-stable, client is assigned a group.
TEST_P(ExpectedFieldTrialGroupPreStableTest, PreStable) {
SeedReaderWriter seed_reader_writer(
&local_state_, /*seed_file_dir=*/temp_dir_.GetPath(), kSeedFilename,
GetParam().seed_fields_prefs, GetParam().channel,
entropy_providers_.get(), file_writer_thread_.task_runner());
EXPECT_THAT(base::FieldTrialList::FindFullName(kSeedFileTrial),
::testing::AnyOf(kControlGroup, kSeedFilesGroup));
}
INSTANTIATE_TEST_SUITE_P(All,
ExpectedFieldTrialGroupStableTest,
::testing::Values(kRegularSeedFieldsPrefs,
kSafeSeedFieldsPrefs));
// If channel is stable, trial has been registered.
TEST_P(ExpectedFieldTrialGroupStableTest, Stable) {
SeedReaderWriter seed_reader_writer(
&local_state_, /*seed_file_dir=*/temp_dir_.GetPath(), kSeedFilename,
GetParam(), version_info::Channel::STABLE, entropy_providers_.get(),
file_writer_thread_.task_runner());
EXPECT_TRUE(base::FieldTrialList::TrialExists(kSeedFileTrial));
}
INSTANTIATE_TEST_SUITE_P(All,
ExpectedFieldTrialGroupUnknownTest,
::testing::Values(kRegularSeedFieldsPrefs,
kSafeSeedFieldsPrefs));
// If channel is unknown, client is not assigned a group.
TEST_P(ExpectedFieldTrialGroupUnknownTest, Unknown) {
SeedReaderWriter seed_reader_writer(
&local_state_, /*seed_file_dir=*/temp_dir_.GetPath(), kSeedFilename,
GetParam(), version_info::Channel::UNKNOWN, entropy_providers_.get(),
file_writer_thread_.task_runner());
EXPECT_THAT(base::FieldTrialList::FindFullName(kSeedFileTrial), IsEmpty());
}
class SeedReaderWriterGroupTest
: public SeedReaderWriterTestBase,
public TestWithParam<SeedReaderWriterTestParams> {
public:
SeedReaderWriterGroupTest() {
SetUpSeedFileTrial(std::string(GetParam().field_trial_group));
}
};
class SeedReaderWriterSeedFilesGroupTest : public SeedReaderWriterGroupTest {};
class SeedReaderWriterLocalStateGroupsTest : public SeedReaderWriterGroupTest {
};
class SeedReaderWriterAllGroupsTest : public SeedReaderWriterGroupTest {};
// Verifies clients in SeedFiles group write seeds to a seed file.
TEST_P(SeedReaderWriterSeedFilesGroupTest, WriteSeed) {
ASSERT_EQ(base::FieldTrialList::FindFullName(kSeedFileTrial),
GetParam().field_trial_group);
// Initialize seed_reader_writer with test thread and timer.
SeedReaderWriter seed_reader_writer(
&local_state_, /*seed_file_dir=*/temp_dir_.GetPath(), kSeedFilename,
GetParam().seed_fields_prefs, GetParam().channel,
entropy_providers_.get(), file_writer_thread_.task_runner());
seed_reader_writer.SetTimerForTesting(&timer_);
// Create and store seed.
const std::string compressed_seed = CreateCompressedVariationsSeed();
const std::string base64_compressed_seed =
base::Base64Encode(compressed_seed);
const base::Time seed_date = base::Time::Now();
const base::Time fetch_time = base::Time::Now();
seed_reader_writer.StoreValidatedSeedInfo(ValidatedSeedInfo{
.compressed_seed_data = compressed_seed,
.base64_seed_data = base64_compressed_seed,
.signature = "signature",
.milestone = 2,
.seed_date = seed_date,
.client_fetch_time = fetch_time,
});
// Force write.
timer_.Fire();
file_writer_thread_.FlushForTesting();
// Verify that a seed was written to a seed file.
std::string seed_file_data;
ASSERT_TRUE(base::ReadFileToString(temp_seed_file_path_, &seed_file_data));
EXPECT_EQ(seed_file_data, compressed_seed);
// Verify that the seed data is loaded correctly.
EXPECT_EQ(seed_reader_writer.GetSeedData().storage_format,
StoredSeed::StorageFormat::kCompressed);
EXPECT_EQ(seed_reader_writer.GetSeedData().data, compressed_seed);
EXPECT_EQ(seed_reader_writer.GetSeedData().signature, "signature");
EXPECT_EQ(seed_reader_writer.GetSeedData().milestone, 2);
EXPECT_EQ(seed_reader_writer.GetSeedData().seed_date, seed_date);
EXPECT_EQ(seed_reader_writer.GetSeedData().client_fetch_time, fetch_time);
}
// Verifies that a seed is cleared from a seed file for clients in the SeedFiles
// group.
TEST_P(SeedReaderWriterSeedFilesGroupTest, ClearSeed) {
ASSERT_EQ(base::FieldTrialList::FindFullName(kSeedFileTrial),
GetParam().field_trial_group);
// Create and store seed in a seed file.
const std::string compressed_seed = CreateCompressedVariationsSeed();
ASSERT_TRUE(base::WriteFile(temp_seed_file_path_, compressed_seed));
// Store other fields in local state prefs.
local_state_.SetString(GetParam().seed_fields_prefs.signature, "signature");
local_state_.SetInteger(GetParam().seed_fields_prefs.milestone, 92);
local_state_.SetTime(GetParam().seed_fields_prefs.seed_date,
base::Time::Now());
// Initialize seed_reader_writer with test thread and timer.
SeedReaderWriter seed_reader_writer(
&local_state_, /*seed_file_dir=*/temp_dir_.GetPath(), kSeedFilename,
GetParam().seed_fields_prefs, GetParam().channel,
entropy_providers_.get(), file_writer_thread_.task_runner());
seed_reader_writer.SetTimerForTesting(&timer_);
// Verify seed was loaded correctly.
ASSERT_THAT(seed_reader_writer.GetSeedData().data, Not(IsEmpty()));
ASSERT_THAT(seed_reader_writer.GetSeedData().signature, Not(IsEmpty()));
ASSERT_NE(seed_reader_writer.GetSeedData().milestone, 0);
ASSERT_FALSE(seed_reader_writer.GetSeedData().seed_date.is_null());
// Clear seed and force write.
seed_reader_writer.ClearSeedInfo();
timer_.Fire();
file_writer_thread_.FlushForTesting();
// Verify seed cleared correctly in a seed file.
// File should be empty.
std::string seed_file_data;
ASSERT_TRUE(base::ReadFileToString(temp_seed_file_path_, &seed_file_data));
EXPECT_THAT(seed_file_data, IsEmpty());
// Returned seed data should be empty.
EXPECT_THAT(seed_reader_writer.GetSeedData().data, IsEmpty());
EXPECT_THAT(seed_reader_writer.GetSeedData().signature, IsEmpty());
EXPECT_EQ(seed_reader_writer.GetSeedData().milestone, 0);
EXPECT_TRUE(seed_reader_writer.GetSeedData().seed_date.is_null());
// Local state prefs should be cleared.
EXPECT_THAT(local_state_.GetString(GetParam().seed_fields_prefs.seed),
IsEmpty());
EXPECT_THAT(local_state_.GetString(GetParam().seed_fields_prefs.signature),
IsEmpty());
EXPECT_EQ(local_state_.GetInteger(GetParam().seed_fields_prefs.milestone), 0);
EXPECT_EQ(local_state_.GetTime(GetParam().seed_fields_prefs.seed_date),
base::Time());
}
// Verifies clients in SeedFiles group read seeds from the seed file.
TEST_P(SeedReaderWriterSeedFilesGroupTest, ReadSeedFileBasedSeed) {
ASSERT_EQ(base::FieldTrialList::FindFullName(kSeedFileTrial),
GetParam().field_trial_group);
// Create and store seed.
const std::string compressed_seed = CreateCompressedVariationsSeed();
ASSERT_TRUE(base::WriteFile(temp_seed_file_path_, compressed_seed));
const std::string_view seed_data_field = GetParam().seed_fields_prefs.seed;
local_state_.SetString(seed_data_field, "unused seed");
// Initialize seed_reader_writer with test thread.
base::HistogramTester histogram_tester;
SeedReaderWriter seed_reader_writer(
&local_state_, /*seed_file_dir=*/temp_dir_.GetPath(), kSeedFilename,
GetParam().seed_fields_prefs, GetParam().channel,
entropy_providers_.get(), file_writer_thread_.task_runner());
// Ensure seed data loaded from seed file.
ASSERT_EQ(StoredSeed::StorageFormat::kCompressed,
seed_reader_writer.GetSeedData().storage_format);
ASSERT_EQ(compressed_seed, seed_reader_writer.GetSeedData().data);
histogram_tester.ExpectUniqueSample(
base::StrCat(
{"Variations.SeedFileRead.",
base::Contains(seed_data_field, "Safe") ? "Safe" : "Latest"}),
/*sample=*/1, /*expected_bucket_count=*/1);
}
// Verifies clients in SeedFiles group do not crash if reading empty seed file.
TEST_P(SeedReaderWriterSeedFilesGroupTest, ReadEmptySeedFile) {
ASSERT_EQ(base::FieldTrialList::FindFullName(kSeedFileTrial),
GetParam().field_trial_group);
// Create and store seed.
const std::string compressed_seed = CreateCompressedVariationsSeed();
ASSERT_TRUE(base::WriteFile(temp_seed_file_path_, ""));
const std::string_view seed_data_field = GetParam().seed_fields_prefs.seed;
local_state_.SetString(seed_data_field, "unused seed");
// Initialize seed_reader_writer with test thread.
base::HistogramTester histogram_tester;
SeedReaderWriter seed_reader_writer(
&local_state_, /*seed_file_dir=*/temp_dir_.GetPath(), kSeedFilename,
GetParam().seed_fields_prefs, GetParam().channel,
entropy_providers_.get(), file_writer_thread_.task_runner());
histogram_tester.ExpectUniqueSample(
base::StrCat(
{"Variations.SeedFileRead.",
base::Contains(seed_data_field, "Safe") ? "Safe" : "Latest"}),
/*sample=*/1, /*expected_bucket_count=*/1);
// Ensure seed data loaded from seed file.
ASSERT_EQ(StoredSeed::StorageFormat::kCompressed,
seed_reader_writer.GetSeedData().storage_format);
ASSERT_EQ("", seed_reader_writer.GetSeedData().data);
}
// Verifies clients in SeedFiles group read seeds from local state prefs if no
// seed file found.
TEST_P(SeedReaderWriterSeedFilesGroupTest, ReadMissingSeedFile) {
ASSERT_EQ(base::FieldTrialList::FindFullName(kSeedFileTrial),
GetParam().field_trial_group);
// Create and store seed.
const std::string compressed_seed = CreateCompressedVariationsSeed();
const std::string_view seed_data_field = GetParam().seed_fields_prefs.seed;
local_state_.SetString(seed_data_field, base::Base64Encode(compressed_seed));
// Initialize seed_reader_writer with test thread.
base::HistogramTester histogram_tester;
SeedReaderWriter seed_reader_writer(
&local_state_, /*seed_file_dir=*/temp_dir_.GetPath(), kSeedFilename,
GetParam().seed_fields_prefs, GetParam().channel,
entropy_providers_.get(), file_writer_thread_.task_runner());
// Ensure read failed due to seed file not existing.
histogram_tester.ExpectUniqueSample(
base::StrCat(
{"Variations.SeedFileRead.",
base::Contains(seed_data_field, "Safe") ? "Safe" : "Latest"}),
/*sample=*/0, /*expected_bucket_count=*/1);
// Ensure seed data from local state prefs is loaded and decoded.
ASSERT_EQ(StoredSeed::StorageFormat::kCompressed,
seed_reader_writer.GetSeedData().storage_format);
ASSERT_EQ(compressed_seed, seed_reader_writer.GetSeedData().data);
}
INSTANTIATE_TEST_SUITE_P(
All,
SeedReaderWriterSeedFilesGroupTest,
::testing::ConvertGenerator<SeedReaderWriterTestParams::TupleT>(
::testing::Combine(::testing::Values(kRegularSeedFieldsPrefs,
kSafeSeedFieldsPrefs),
::testing::Values(kSeedFilesGroup),
::testing::Values(version_info::Channel::CANARY,
version_info::Channel::DEV,
version_info::Channel::BETA))));
// Verifies clients using local state to store seeds write seeds to Local State.
TEST_P(SeedReaderWriterLocalStateGroupsTest, WriteSeed) {
ASSERT_EQ(base::FieldTrialList::FindFullName(kSeedFileTrial),
GetParam().field_trial_group);
// Initialize seed_reader_writer with test thread and timer.
SeedReaderWriter seed_reader_writer(
&local_state_, /*seed_file_dir=*/temp_dir_.GetPath(), kSeedFilename,
GetParam().seed_fields_prefs, GetParam().channel,
entropy_providers_.get(), file_writer_thread_.task_runner());
seed_reader_writer.SetTimerForTesting(&timer_);
// Create and store seed.
const std::string compressed_seed = CreateCompressedVariationsSeed();
const std::string base64_compressed_seed =
base::Base64Encode(compressed_seed);
const base::Time seed_date = base::Time::Now();
const base::Time fetch_time = base::Time::Now();
seed_reader_writer.StoreValidatedSeedInfo(ValidatedSeedInfo{
.compressed_seed_data = compressed_seed,
.base64_seed_data = base64_compressed_seed,
.signature = "signature",
.milestone = 2,
.seed_date = seed_date,
.client_fetch_time = fetch_time,
});
// Ensure there's no pending write.
EXPECT_FALSE(timer_.IsRunning());
// Verify seed stored correctly, should only be found in Local State prefs.
EXPECT_FALSE(base::PathExists(temp_seed_file_path_));
EXPECT_EQ(local_state_.GetString(GetParam().seed_fields_prefs.seed),
base64_compressed_seed);
EXPECT_EQ(local_state_.GetString(GetParam().seed_fields_prefs.signature),
"signature");
EXPECT_EQ(local_state_.GetInteger(GetParam().seed_fields_prefs.milestone), 2);
EXPECT_EQ(local_state_.GetTime(GetParam().seed_fields_prefs.seed_date),
seed_date);
EXPECT_EQ(local_state_.GetTime(GetParam().seed_fields_prefs.client_fetch_time),
fetch_time);
}
// Verifies that a seed is cleared from Local State and that seed file is
// deleted if present for clients using local state to store seeds.
TEST_P(SeedReaderWriterLocalStateGroupsTest, ClearSeed) {
ASSERT_EQ(base::FieldTrialList::FindFullName(kSeedFileTrial),
GetParam().field_trial_group);
// Initialize seed_reader_writer with test thread and timer.
SeedReaderWriter seed_reader_writer(
&local_state_, /*seed_file_dir=*/temp_dir_.GetPath(), kSeedFilename,
GetParam().seed_fields_prefs, GetParam().channel,
entropy_providers_.get(), file_writer_thread_.task_runner());
// Create and store seed.
const std::string compressed_seed = CreateCompressedVariationsSeed();
ASSERT_TRUE(base::WriteFile(temp_seed_file_path_, compressed_seed));
local_state_.SetString(GetParam().seed_fields_prefs.seed,
base::Base64Encode(compressed_seed));
local_state_.SetString(GetParam().seed_fields_prefs.signature, "signature");
local_state_.SetInteger(GetParam().seed_fields_prefs.milestone, 92);
local_state_.SetTime(GetParam().seed_fields_prefs.seed_date,
base::Time::Now());
// Clear seed and force file delete.
seed_reader_writer.ClearSeedInfo();
file_writer_thread_.FlushForTesting();
// Returned seed data should be empty.
EXPECT_THAT(seed_reader_writer.GetSeedData().data, IsEmpty());
EXPECT_THAT(seed_reader_writer.GetSeedData().signature, IsEmpty());
EXPECT_EQ(seed_reader_writer.GetSeedData().milestone, 0);
EXPECT_TRUE(seed_reader_writer.GetSeedData().seed_date.is_null());
// Verify seed cleared correctly in Local State prefs and that seed file is
// deleted.
EXPECT_THAT(local_state_.GetString(GetParam().seed_fields_prefs.seed),
IsEmpty());
EXPECT_THAT(local_state_.GetString(GetParam().seed_fields_prefs.signature),
IsEmpty());
EXPECT_EQ(local_state_.GetInteger(GetParam().seed_fields_prefs.milestone), 0);
EXPECT_EQ(local_state_.GetTime(GetParam().seed_fields_prefs.seed_date),
base::Time());
EXPECT_EQ(local_state_.GetTime(GetParam().seed_fields_prefs.client_fetch_time),
base::Time());
EXPECT_FALSE(base::PathExists(temp_seed_file_path_));
}
// Verifies clients using local state to store seeds read seeds from local
// state.
TEST_P(SeedReaderWriterLocalStateGroupsTest, ReadLocalStateBasedSeed) {
ASSERT_EQ(base::FieldTrialList::FindFullName(kSeedFileTrial),
GetParam().field_trial_group);
// Create and store seed.
ASSERT_TRUE(base::WriteFile(temp_seed_file_path_, "unused seed"));
const std::string_view seed_data_field = GetParam().seed_fields_prefs.seed;
local_state_.SetString(seed_data_field,
base::Base64Encode(CreateCompressedVariationsSeed()));
// Initialize seed_reader_writer with test thread.
base::HistogramTester histogram_tester;
SeedReaderWriter seed_reader_writer(
&local_state_, /*seed_file_dir=*/temp_dir_.GetPath(), kSeedFilename,
GetParam().seed_fields_prefs, GetParam().channel,
entropy_providers_.get(), file_writer_thread_.task_runner());
// Ensure seed data loaded from prefs, not seed file.
ASSERT_EQ(StoredSeed::StorageFormat::kCompressedAndBase64Encoded,
seed_reader_writer.GetSeedData().storage_format);
ASSERT_EQ(local_state_.GetString(GetParam().seed_fields_prefs.seed),
seed_reader_writer.GetSeedData().data);
histogram_tester.ExpectTotalCount(
base::StrCat(
{"Variations.SeedFileRead.",
base::Contains(seed_data_field, "Safe") ? "Safe" : "Latest"}),
/*expected_count=*/0);
}
// Verifies that writing seeds with an empty path for `seed_file_dir` does not
// cause a crash.
TEST_P(SeedReaderWriterLocalStateGroupsTest, EmptySeedFilePathIsValid) {
ASSERT_EQ(base::FieldTrialList::FindFullName(kSeedFileTrial),
GetParam().field_trial_group);
// Initialize seed_reader_writer with test thread and timer and an empty file
// path.
SeedReaderWriter seed_reader_writer(
&local_state_,
/*seed_file_dir=*/base::FilePath(), kSeedFilename,
GetParam().seed_fields_prefs, GetParam().channel,
entropy_providers_.get(), file_writer_thread_.task_runner());
seed_reader_writer.SetTimerForTesting(&timer_);
// Create and store seed.
const std::string compressed_seed = CreateCompressedVariationsSeed();
const std::string base64_compressed_seed =
base::Base64Encode(compressed_seed);
const base::Time seed_date = base::Time::Now();
const base::Time fetch_time = base::Time::Now();
seed_reader_writer.StoreValidatedSeedInfo(ValidatedSeedInfo{
.compressed_seed_data = compressed_seed,
.base64_seed_data = base64_compressed_seed,
.signature = "signature",
.milestone = 2,
.seed_date = seed_date,
.client_fetch_time = fetch_time,
});
// Ensure there's no pending write.
EXPECT_FALSE(timer_.IsRunning());
// Verify seed stored correctly, should only be found in Local State prefs.
EXPECT_EQ(local_state_.GetString(GetParam().seed_fields_prefs.seed),
base64_compressed_seed);
EXPECT_EQ(local_state_.GetString(GetParam().seed_fields_prefs.signature),
"signature");
EXPECT_EQ(local_state_.GetInteger(GetParam().seed_fields_prefs.milestone), 2);
EXPECT_EQ(local_state_.GetTime(GetParam().seed_fields_prefs.seed_date),
seed_date);
EXPECT_EQ(local_state_.GetTime(GetParam().seed_fields_prefs.client_fetch_time),
fetch_time);
}
INSTANTIATE_TEST_SUITE_P(
NoGroup,
SeedReaderWriterLocalStateGroupsTest,
::testing::ConvertGenerator<SeedReaderWriterTestParams::TupleT>(
::testing::Combine(::testing::Values(kRegularSeedFieldsPrefs,
kSafeSeedFieldsPrefs),
::testing::Values(kNoGroup),
::testing::Values(version_info::Channel::UNKNOWN))));
INSTANTIATE_TEST_SUITE_P(
ControlAndDefaultGroup,
SeedReaderWriterLocalStateGroupsTest,
::testing::ConvertGenerator<SeedReaderWriterTestParams::TupleT>(
::testing::Combine(::testing::Values(kRegularSeedFieldsPrefs,
kSafeSeedFieldsPrefs),
::testing::Values(kControlGroup, kDefaultGroup),
::testing::Values(version_info::Channel::UNKNOWN,
version_info::Channel::CANARY,
version_info::Channel::DEV,
version_info::Channel::BETA,
version_info::Channel::STABLE))));
} // namespace
} // namespace variations
|