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 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446
|
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chromeos/printing/ppd_metadata_manager.h"
#include <memory>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
#include "base/containers/flat_map.h"
#include "base/functional/bind.h"
#include "base/memory/raw_ptr.h"
#include "base/run_loop.h"
#include "base/task/sequenced_task_runner.h"
#include "base/test/bind.h"
#include "base/test/simple_test_clock.h"
#include "base/test/task_environment.h"
#include "base/time/clock.h"
#include "chromeos/printing/fake_printer_config_cache.h"
#include "chromeos/printing/ppd_metadata_matchers.h"
#include "chromeos/printing/ppd_metadata_parser.h"
#include "chromeos/printing/ppd_provider.h"
#include "chromeos/printing/printer_config_cache.h"
#include "testing/gmock/include/gmock/gmock-matchers.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace chromeos {
namespace {
using ::testing::ElementsAre;
using ::testing::Pair;
using ::testing::StrEq;
using ::testing::UnorderedElementsAre;
// Arbitrarily chosen TimeDelta used in test cases that are not
// time-senstive.
constexpr base::TimeDelta kArbitraryTimeDelta = base::Seconds(30LL);
// Arbitrarily malformed JSON used to exercise code paths in which
// parsing fails.
constexpr std::string_view kInvalidJson = "blah blah invalid JSON";
// Caller may bind a default-constructed base::RepeatingClosure to
// any Catch*() method, indicating that they don't want anything run.
class PpdMetadataManagerTest : public ::testing::Test {
public:
// Callback method appropriate for passing to
// PpdMetadataManager::GetManufacturers().
void CatchGetManufacturers(base::RepeatingClosure quit_closure,
PpdProvider::CallbackResultCode code,
const std::vector<std::string>& manufacturers) {
results_.get_manufacturers_code = code;
results_.manufacturers = manufacturers;
if (quit_closure) {
quit_closure.Run();
}
}
// Callback method appropriate for passing to
// PpdMetadataManager::GetPrinters().
void CatchGetPrinters(base::RepeatingClosure quit_closure,
bool succeeded,
const ParsedPrinters& printers) {
results_.get_printers_succeeded = succeeded;
results_.printers = printers;
if (quit_closure) {
quit_closure.Run();
}
}
// Callback method appropriate for passing to
// PpdMetadataManager::FindAllEmmsAvailableInIndex().
void CatchFindAllEmmsAvailableInIndex(
base::RepeatingClosure quit_closure,
const base::flat_map<std::string, ParsedIndexValues>& values) {
results_.available_effective_make_and_model_strings = values;
if (quit_closure) {
quit_closure.Run();
}
}
// Callback method appropriate for passing to
// PpdMetadataManager::FindDeviceInUsbIndex().
void CatchFindDeviceInUsbIndex(base::RepeatingClosure quit_closure,
const std::string& value) {
results_.effective_make_and_model_string_from_usb_index = value;
if (quit_closure) {
quit_closure.Run();
}
}
// Callback method appropriate for passing to
// PpdMetadataManager::GetUsbManufacturerName().
void CatchGetUsbManufacturerName(base::RepeatingClosure quit_closure,
const std::string& value) {
results_.usb_manufacturer_name = value;
if (quit_closure) {
quit_closure.Run();
}
}
// Callback method appropriate for passing to
// PpdMetadataManager::SplitMakeAndModel().
void CatchSplitMakeAndModel(base::RepeatingClosure quit_closure,
PpdProvider::CallbackResultCode code,
const std::string& make,
const std::string& model) {
results_.split_make_and_model_code = code;
results_.split_make = make;
results_.split_model = model;
if (quit_closure) {
quit_closure.Run();
}
}
protected:
// Convenience container that organizes all callback results.
struct CallbackLandingArea {
CallbackLandingArea() : get_printers_succeeded(false) {}
~CallbackLandingArea() = default;
// Landing area for PpdMetadataManager::GetManufacturers().
PpdProvider::CallbackResultCode get_manufacturers_code;
std::vector<std::string> manufacturers;
// Landing area for PpdMetadataManager::GetPrinters().
bool get_printers_succeeded;
ParsedPrinters printers;
// Landing area for
// PpdMetadataManager::FindAllEmmsAvailableInIndex().
base::flat_map<std::string, ParsedIndexValues>
available_effective_make_and_model_strings;
// Landing area for
// PpdMetadataManager::FindDeviceInUsbIndex().
std::string effective_make_and_model_string_from_usb_index;
// Landing area for
// PpdMetadataManager::GetUsbManufacturerName().
std::string usb_manufacturer_name;
// Landing area for PpdMetadataManager::SplitMakeAndModel().
PpdProvider::CallbackResultCode split_make_and_model_code;
std::string split_make;
std::string split_model;
};
PpdMetadataManagerTest()
: task_environment_(base::test::TaskEnvironment::MainThreadType::IO),
manager_(PpdMetadataManager::Create(
PpdIndexChannel::kProduction,
&clock_,
std::make_unique<FakePrinterConfigCache>())) {}
// Borrows and returns a pointer to the config cache owned by the
// |manager_|.
//
// Useful for adjusting availability of (fake) network resources.
FakePrinterConfigCache* GetFakeCache() {
return reinterpret_cast<FakePrinterConfigCache*>(
manager_->GetPrinterConfigCacheForTesting());
}
// Holder for all callback results.
CallbackLandingArea results_;
// Environment for task schedulers.
base::test::TaskEnvironment task_environment_;
// Controlled clock that dispenses times of Fetch().
base::SimpleTestClock clock_;
// Class under test.
std::unique_ptr<PpdMetadataManager> manager_;
};
// Verifies that the manager can fetch, parse, and return a list of
// manufacturers from the Chrome OS Printing serving root.
TEST_F(PpdMetadataManagerTest, CanGetManufacturers) {
GetFakeCache()->SetFetchResponseForTesting(
"metadata_v3/manufacturers-en.json",
R"({ "filesMap": {
"It": "Never_Ends-en.json",
"You Are": "Always-en.json",
"Playing": "Yellow_Car-en.json"
} })");
base::RunLoop loop;
auto callback = base::BindOnce(&PpdMetadataManagerTest::CatchGetManufacturers,
base::Unretained(this), loop.QuitClosure());
auto call = base::BindOnce(&PpdMetadataManager::GetManufacturers,
base::Unretained(manager_.get()),
kArbitraryTimeDelta, std::move(callback));
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(FROM_HERE,
std::move(call));
loop.Run();
ASSERT_EQ(results_.get_manufacturers_code,
PpdProvider::CallbackResultCode::SUCCESS);
// PpdProvider::ResolveManufacturersCallback specifies that the list
// shall be sorted.
EXPECT_THAT(results_.manufacturers,
ElementsAre(StrEq("It"), StrEq("Playing"), StrEq("You Are")));
}
// Verifies that the manager fails the ResolveManufacturersCallback
// when it fails to fetch the manufacturers metadata.
TEST_F(PpdMetadataManagerTest, FailsToGetManufacturersOnFetchFailure) {
// In this test case, we do _not_ populate the fake config cache with
// the appropriate metadata, causing the fetch to fail.
base::RunLoop loop;
auto callback = base::BindOnce(&PpdMetadataManagerTest::CatchGetManufacturers,
base::Unretained(this), loop.QuitClosure());
auto call = base::BindOnce(&PpdMetadataManager::GetManufacturers,
base::Unretained(manager_.get()),
kArbitraryTimeDelta, std::move(callback));
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(FROM_HERE,
std::move(call));
loop.Run();
ASSERT_EQ(results_.get_manufacturers_code,
PpdProvider::CallbackResultCode::SERVER_ERROR);
}
// Verifies that the manager fails the ResolveManufacturersCallback
// when it fails to parse the manufacturers metadata.
TEST_F(PpdMetadataManagerTest, FailsToGetManufacturersOnParseFailure) {
// Known interaction: the manager will fetch manufacturers metadata.
GetFakeCache()->SetFetchResponseForTesting(
"metadata_v3/manufacturers-en.json", kInvalidJson);
base::RunLoop loop;
auto callback = base::BindOnce(&PpdMetadataManagerTest::CatchGetManufacturers,
base::Unretained(this), loop.QuitClosure());
auto call = base::BindOnce(&PpdMetadataManager::GetManufacturers,
base::Unretained(manager_.get()),
kArbitraryTimeDelta, std::move(callback));
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(FROM_HERE,
std::move(call));
loop.Run();
ASSERT_EQ(results_.get_manufacturers_code,
PpdProvider::CallbackResultCode::INTERNAL_ERROR);
}
// Verifies that the manager fetches manufacturers metadata anew when
// caller asks it for metadata fresher than what it has cached.
TEST_F(PpdMetadataManagerTest, CanGetManufacturersTimeSensitive) {
// Known interaction: the manager will fetch manufacturers metadata.
GetFakeCache()->SetFetchResponseForTesting(
"metadata_v3/manufacturers-en.json",
R"({ "filesMap": {
"It": "Never_Ends-en.json",
"You Are": "Always-en.json",
"Playing": "Yellow_Car-en.json"
} })");
base::RunLoop loop;
auto callback = base::BindOnce(&PpdMetadataManagerTest::CatchGetManufacturers,
base::Unretained(this), loop.QuitClosure());
// t = 0s: caller requests a list of manufacturers from |manager_|,
// using metadata parsed within the last thirty seconds. |manager_|
// performs a live fetch for the manufacturers metadata.
manager_->GetManufacturers(base::Seconds(30), std::move(callback));
loop.Run();
ASSERT_EQ(results_.get_manufacturers_code,
PpdProvider::CallbackResultCode::SUCCESS);
// PpdProvider::ResolveManufacturersCallback specifies that the list
// shall be sorted.
EXPECT_THAT(results_.manufacturers,
ElementsAre(StrEq("It"), StrEq("Playing"), StrEq("You Are")));
// Mutates the test data, ensuring that if the metadata manager
// attempts a live fetch from the PrinterConfigCache, it will get
// different data in response.
GetFakeCache()->SetFetchResponseForTesting(
"metadata_v3/manufacturers-en.json",
R"({ "filesMap": {
"It": "Never_Ends-en.json",
"You Are": "Always-en.json"
} })");
// Jams the result code to something bad to require that the
// |manager_| positively answer us.
results_.get_manufacturers_code =
PpdProvider::CallbackResultCode::INTERNAL_ERROR;
base::RunLoop second_loop;
auto second_callback =
base::BindOnce(&PpdMetadataManagerTest::CatchGetManufacturers,
base::Unretained(this), second_loop.QuitClosure());
// t = 0s: caller requests a list of manufacturers from |manager_|.
// |manager_| responds using the cached metadata without performing
// a live fetch.
manager_->GetManufacturers(base::Seconds(30), std::move(second_callback));
second_loop.Run();
// We assert that the results are unchanged from before.
ASSERT_EQ(results_.get_manufacturers_code,
PpdProvider::CallbackResultCode::SUCCESS);
EXPECT_THAT(results_.manufacturers,
ElementsAre(StrEq("It"), StrEq("Playing"), StrEq("You Are")));
// t = 31s
clock_.Advance(base::Seconds(31));
// Jams the result code to something bad to require that the
// |manager_| positively answer us.
results_.get_manufacturers_code =
PpdProvider::CallbackResultCode::INTERNAL_ERROR;
base::RunLoop third_loop;
auto third_callback =
base::BindOnce(&PpdMetadataManagerTest::CatchGetManufacturers,
base::Unretained(this), third_loop.QuitClosure());
// t = 31s: caller requests a list of manufacturers from |manager_|.
// |manager_| does not have sufficiently fresh metadata, so it
// performs a live fetch.
manager_->GetManufacturers(base::Seconds(30), std::move(third_callback));
third_loop.Run();
// We assert that the results have changed.
ASSERT_EQ(results_.get_manufacturers_code,
PpdProvider::CallbackResultCode::SUCCESS);
EXPECT_THAT(results_.manufacturers,
ElementsAre(StrEq("It"), StrEq("You Are")));
}
// Verifies that the manager can fetch, parse, and return a map of
// printers metadata from the Chrome OS Printing serving root.
TEST_F(PpdMetadataManagerTest, CanGetPrinters) {
// Bypasses prerequisite call to PpdMetadataManager::GetManufacturers().
ASSERT_TRUE(manager_->SetManufacturersForTesting(R"(
{
"filesMap": {
"Manufacturer A": "Manufacturer_A-en.json",
"Manufacturer B": "Manufacturer_B-en.json"
}
}
)"));
// Known interaction: the manager will fetch printers metadata named
// by the manufacturers map above.
GetFakeCache()->SetFetchResponseForTesting(
"metadata_v3/Manufacturer_A-en.json", R"(
{
"printers": [ {
"emm": "some emm a",
"name": "Some Printer A"
}, {
"emm": "some emm b",
"name": "Some Printer B"
} ]
}
)");
base::RunLoop loop;
auto callback = base::BindOnce(&PpdMetadataManagerTest::CatchGetPrinters,
base::Unretained(this), loop.QuitClosure());
auto call = base::BindOnce(&PpdMetadataManager::GetPrinters,
base::Unretained(manager_.get()), "Manufacturer A",
kArbitraryTimeDelta, std::move(callback));
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(FROM_HERE,
std::move(call));
loop.Run();
ASSERT_TRUE(results_.get_printers_succeeded);
EXPECT_THAT(
results_.printers,
UnorderedElementsAre(ParsedPrinterLike("Some Printer A", "some emm a"),
ParsedPrinterLike("Some Printer B", "some emm b")));
}
// Verifies that the manager fails the GetPrintersCallback when it fails
// to fetch the printers metadata.
TEST_F(PpdMetadataManagerTest, FailsToGetPrintersOnFetchFailure) {
// Bypasses prerequisite call to PpdMetadataManager::GetManufacturers().
ASSERT_TRUE(manager_->SetManufacturersForTesting(R"(
{
"filesMap": {
"Manufacturer A": "Manufacturer_A-en.json",
"Manufacturer B": "Manufacturer_B-en.json"
}
}
)"));
// This test is set up like the CanGetPrinters test case above, but we
// elect _not_ to provide a response for any printers metadata,
// causing the fetch to fail.
//
// We set the result value to the opposite of what's expected to
// observe the change.
results_.get_printers_succeeded = true;
base::RunLoop loop;
auto callback = base::BindOnce(&PpdMetadataManagerTest::CatchGetPrinters,
base::Unretained(this), loop.QuitClosure());
auto call = base::BindOnce(&PpdMetadataManager::GetPrinters,
base::Unretained(manager_.get()), "Manufacturer A",
kArbitraryTimeDelta, std::move(callback));
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(FROM_HERE,
std::move(call));
loop.Run();
EXPECT_FALSE(results_.get_printers_succeeded);
}
// Verifies that the manager fails the GetPrintersCallback when it fails
// to parse the printers metadata.
TEST_F(PpdMetadataManagerTest, FailsToGetPrintersOnParseFailure) {
// Bypasses prerequisite call to PpdMetadataManager::GetManufacturers().
ASSERT_TRUE(manager_->SetManufacturersForTesting(R"(
{
"filesMap": {
"Manufacturer A": "Manufacturer_A-en.json",
"Manufacturer B": "Manufacturer_B-en.json"
}
}
)"));
// This test is set up like the CanGetPrinters test case above, but we
// elect to provide a malformed JSON response for the printers
// metadata, which will cause the manager to fail parsing.
//
// Known interaction: the manager will fetch the printers metadata
// named by the map above.
GetFakeCache()->SetFetchResponseForTesting(
"metadata_v3/Manufacturer_A-en.json", kInvalidJson);
// We set the result value to the opposite of what's expected to
// observe the change.
results_.get_printers_succeeded = true;
base::RunLoop loop;
auto callback = base::BindOnce(&PpdMetadataManagerTest::CatchGetPrinters,
base::Unretained(this), loop.QuitClosure());
auto call = base::BindOnce(&PpdMetadataManager::GetPrinters,
base::Unretained(manager_.get()), "Manufacturer A",
kArbitraryTimeDelta, std::move(callback));
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(FROM_HERE,
std::move(call));
loop.Run();
EXPECT_FALSE(results_.get_printers_succeeded);
}
// Verifies that the manager fetches printers metadata anew when caller
// asks it for metadata fresher than what it has cached.
TEST_F(PpdMetadataManagerTest, CanGetPrintersTimeSensitive) {
// Bypasses prerequisite call to PpdMetadataManager::GetManufacturers().
ASSERT_TRUE(manager_->SetManufacturersForTesting(R"(
{
"filesMap": {
"Manufacturer A": "Manufacturer_A-en.json",
"Manufacturer B": "Manufacturer_B-en.json"
}
}
)"));
// Known interaction: the manager will fetch printers metadata named
// by the manufacturers map above.
GetFakeCache()->SetFetchResponseForTesting(
"metadata_v3/Manufacturer_A-en.json", R"(
{
"printers": [ {
"emm": "some emm a",
"name": "Some Printer A"
}, {
"emm": "some emm b",
"name": "Some Printer B"
} ]
}
)");
// t = 0s: caller requests the printers for "Manufacturer A."
// |manager_| parses and caches the metadata successfully.
base::RunLoop loop;
auto callback = base::BindOnce(&PpdMetadataManagerTest::CatchGetPrinters,
base::Unretained(this), loop.QuitClosure());
manager_->GetPrinters("Manufacturer A", base::Seconds(30),
std::move(callback));
loop.Run();
ASSERT_TRUE(results_.get_printers_succeeded);
EXPECT_THAT(
results_.printers,
UnorderedElementsAre(ParsedPrinterLike("Some Printer A", "some emm a"),
ParsedPrinterLike("Some Printer B", "some emm b")));
// We change the data served by the PrinterConfigCache.
GetFakeCache()->SetFetchResponseForTesting(
"metadata_v3/Manufacturer_A-en.json", R"(
{
"printers": [ {
"emm": "some emm c",
"name": "Some Printer C"
}, {
"emm": "some emm d",
"name": "Some Printer D"
} ]
}
)");
// Jams the results to some bad value, requiring that the manager
// answer us positively.
results_.get_printers_succeeded = false;
base::RunLoop second_loop;
auto second_callback =
base::BindOnce(&PpdMetadataManagerTest::CatchGetPrinters,
base::Unretained(this), second_loop.QuitClosure());
// t = 0s: caller requests the printers for "Manufacturer A."
// |manager_| re-uses the cached metadata.
manager_->GetPrinters("Manufacturer A", base::Seconds(30),
std::move(second_callback));
second_loop.Run();
// We assert that the results are unchanged from before.
ASSERT_TRUE(results_.get_printers_succeeded);
EXPECT_THAT(
results_.printers,
UnorderedElementsAre(ParsedPrinterLike("Some Printer A", "some emm a"),
ParsedPrinterLike("Some Printer B", "some emm b")));
// t = 31s
clock_.Advance(base::Seconds(31));
// Jams the results to some bad value, requiring that the manager
// answer us positively.
results_.get_printers_succeeded = false;
// t = 31s: caller requests the printers for "Manufacturer A."
// |manager_| does not have sufficiently fresh metadata, so it
// performs a live fetch.
base::RunLoop third_loop;
auto third_callback =
base::BindOnce(&PpdMetadataManagerTest::CatchGetPrinters,
base::Unretained(this), third_loop.QuitClosure());
manager_->GetPrinters("Manufacturer A", base::Seconds(30),
std::move(third_callback));
third_loop.Run();
// We assert that the results have changed.
ASSERT_TRUE(results_.get_printers_succeeded);
EXPECT_THAT(
results_.printers,
UnorderedElementsAre(ParsedPrinterLike("Some Printer C", "some emm c"),
ParsedPrinterLike("Some Printer D", "some emm d")));
}
// Verifies that the manager can find all effective-make-and-model
// strings in forward index metadata.
TEST_F(PpdMetadataManagerTest, CanFindAllAvailableEmmsInIndex) {
// Known interaction: the manager will fetch forward index metadata
// numbered 14, 15, and 16.
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/index-14.json", R"(
{
"ppdIndex": {
"some printer a": {
"ppdMetadata": [ {
"name": "some-ppd-basename-a.ppd.gz"
} ]
}
}
})");
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/index-15.json", R"(
{
"ppdIndex": {
"some printer b": {
"ppdMetadata": [ {
"name": "some-ppd-basename-b.ppd.gz"
} ]
}
}
})");
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/index-16.json", R"(
{
"ppdIndex": {
"some printer c": {
"ppdMetadata": [ {
"name": "some-ppd-basename-c.ppd.gz"
} ]
}
}
})");
base::RunLoop loop;
auto callback =
base::BindOnce(&PpdMetadataManagerTest::CatchFindAllEmmsAvailableInIndex,
base::Unretained(this), loop.QuitClosure());
manager_->FindAllEmmsAvailableInIndex(
{"some printer a", "some printer b", "some printer c"},
kArbitraryTimeDelta, std::move(callback));
loop.Run();
EXPECT_THAT(results_.available_effective_make_and_model_strings,
UnorderedElementsAre(
ParsedIndexEntryLike(
"some printer a",
UnorderedElementsAre(ParsedIndexLeafWithPpdBasename(
"some-ppd-basename-a.ppd.gz"))),
ParsedIndexEntryLike(
"some printer b",
UnorderedElementsAre(ParsedIndexLeafWithPpdBasename(
"some-ppd-basename-b.ppd.gz"))),
ParsedIndexEntryLike(
"some printer c",
UnorderedElementsAre(ParsedIndexLeafWithPpdBasename(
"some-ppd-basename-c.ppd.gz")))));
}
// Verifies that the manager invokes the
// FindAllAvailableEmmsInIndexCallback with a partially filled argument
// if it fails to fetch some of the necessary metadata.
TEST_F(PpdMetadataManagerTest,
CanPartiallyFindAllAvailableEmmsInIndexWithFetchFailure) {
// Known interaction: the manager will fetch forward index metadata
// numbered 14, 15, and 16.
//
// We deliberately omit forward index metadata no. 14 to simulate a
// fetch failure.
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/index-15.json", R"(
{
"ppdIndex": {
"some printer b": {
"ppdMetadata": [ {
"name": "some-ppd-basename-b.ppd.gz"
} ]
}
}
})");
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/index-16.json", R"(
{
"ppdIndex": {
"some printer c": {
"ppdMetadata": [ {
"name": "some-ppd-basename-c.ppd.gz"
} ]
}
}
})");
base::RunLoop loop;
auto callback =
base::BindOnce(&PpdMetadataManagerTest::CatchFindAllEmmsAvailableInIndex,
base::Unretained(this), loop.QuitClosure());
manager_->FindAllEmmsAvailableInIndex(
{"some printer a", "some printer b", "some printer c"},
kArbitraryTimeDelta, std::move(callback));
loop.Run();
// The manager was unable to get the forward index metadata that would
// contain information for effective-make-and-model string
// "some printer a," but the other results should avail themselves.
EXPECT_THAT(results_.available_effective_make_and_model_strings,
UnorderedElementsAre(
ParsedIndexEntryLike(
"some printer b",
UnorderedElementsAre(ParsedIndexLeafWithPpdBasename(
"some-ppd-basename-b.ppd.gz"))),
ParsedIndexEntryLike(
"some printer c",
UnorderedElementsAre(ParsedIndexLeafWithPpdBasename(
"some-ppd-basename-c.ppd.gz")))));
}
// Verifies that the manager invokes the
// FindAllAvailableEmmsInIndexCallback with a partially filled argument
// if it fails to parse some of the necessary metadata.
TEST_F(PpdMetadataManagerTest,
CanPartiallyFindAllAvailableEmmsInIndexWithParseFailure) {
// Known interaction: the manager will fetch forward index metadata
// numbered 14, 15, and 16.
//
// We deliberately serve malformed JSON that will fail to parse for
// indices nos. 14 and 15 to exercise the manager's handling of parse
// failures.
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/index-14.json",
kInvalidJson);
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/index-15.json",
kInvalidJson);
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/index-16.json", R"(
{
"ppdIndex": {
"some printer c": {
"ppdMetadata": [ {
"name": "some-ppd-basename-c.ppd.gz"
} ]
}
}
})");
base::RunLoop loop;
auto callback =
base::BindOnce(&PpdMetadataManagerTest::CatchFindAllEmmsAvailableInIndex,
base::Unretained(this), loop.QuitClosure());
manager_->FindAllEmmsAvailableInIndex(
{"some printer a", "some printer b", "some printer c"},
kArbitraryTimeDelta, std::move(callback));
loop.Run();
// The manager was unable to parse the forward index metadata that would
// contain information for effective-make-and-model strings
// "some printer a" and for "some printer b," but the last string
// "some printer c" should avail itself.
EXPECT_THAT(
results_.available_effective_make_and_model_strings,
UnorderedElementsAre(ParsedIndexEntryLike(
"some printer c", UnorderedElementsAre(ParsedIndexLeafWithPpdBasename(
"some-ppd-basename-c.ppd.gz")))));
}
// Verifies that the manager fetches forward index metadata anew when
// the caller asks it for metadata fresher than what it has cached.
TEST_F(PpdMetadataManagerTest, CanFindAllAvailableEmmsInIndexTimeSensitive) {
// Known interaction: the manager will fetch forward index metadata
// numbered 14, 15, and 16.
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/index-14.json", R"(
{
"ppdIndex": {
"some printer a": {
"ppdMetadata": [ {
"name": "some-ppd-basename-a.ppd.gz"
} ]
}
}
})");
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/index-15.json", R"(
{
"ppdIndex": {
"some printer b": {
"ppdMetadata": [ {
"name": "some-ppd-basename-b.ppd.gz"
} ]
}
}
})");
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/index-16.json", R"(
{
"ppdIndex": {
"some printer c": {
"ppdMetadata": [ {
"name": "some-ppd-basename-c.ppd.gz"
} ]
}
}
})");
base::RunLoop loop;
auto callback =
base::BindOnce(&PpdMetadataManagerTest::CatchFindAllEmmsAvailableInIndex,
base::Unretained(this), loop.QuitClosure());
// t = 0s: caller requests the |manager_| to search forward index
// metadata for three effective-make-and-model strings. |manager_|
// fetches the appropriate forward index metadata (nos. 14, 15, and
// 16) and caches the result.
manager_->FindAllEmmsAvailableInIndex(
{"some printer a", "some printer b", "some printer c"}, base::Seconds(30),
std::move(callback));
loop.Run();
EXPECT_THAT(results_.available_effective_make_and_model_strings,
UnorderedElementsAre(
ParsedIndexEntryLike(
"some printer a",
UnorderedElementsAre(ParsedIndexLeafWithPpdBasename(
"some-ppd-basename-a.ppd.gz"))),
ParsedIndexEntryLike(
"some printer b",
UnorderedElementsAre(ParsedIndexLeafWithPpdBasename(
"some-ppd-basename-b.ppd.gz"))),
ParsedIndexEntryLike(
"some printer c",
UnorderedElementsAre(ParsedIndexLeafWithPpdBasename(
"some-ppd-basename-c.ppd.gz")))));
// We drop forward index metadata nos. 14 and 15 now. If the
// |manager_| attempts to fetch these again, it will fail to do so.
GetFakeCache()->Drop("metadata_v3/index-14.json");
GetFakeCache()->Drop("metadata_v3/index-15.json");
// Resets the results to require that the |manager_| answer us
// positively.
results_.available_effective_make_and_model_strings = {};
base::RunLoop second_loop;
auto second_callback =
base::BindOnce(&PpdMetadataManagerTest::CatchFindAllEmmsAvailableInIndex,
base::Unretained(this), second_loop.QuitClosure());
// t = 0s: caller requests the |manager_| to search forward index
// metadata for the same three effective-make-and-model strings.
// Caller requests this using metadata fetched within the last thirty
// seconds, so |manager_| does not perform a live fetch of the data.
manager_->FindAllEmmsAvailableInIndex(
{"some printer a", "some printer b", "some printer c"}, base::Seconds(30),
std::move(second_callback));
second_loop.Run();
// We expect the results to be unchanged.
EXPECT_THAT(results_.available_effective_make_and_model_strings,
UnorderedElementsAre(
ParsedIndexEntryLike(
"some printer a",
UnorderedElementsAre(ParsedIndexLeafWithPpdBasename(
"some-ppd-basename-a.ppd.gz"))),
ParsedIndexEntryLike(
"some printer b",
UnorderedElementsAre(ParsedIndexLeafWithPpdBasename(
"some-ppd-basename-b.ppd.gz"))),
ParsedIndexEntryLike(
"some printer c",
UnorderedElementsAre(ParsedIndexLeafWithPpdBasename(
"some-ppd-basename-c.ppd.gz")))));
// t = 31s
clock_.Advance(base::Seconds(31));
base::RunLoop third_loop;
auto third_callback =
base::BindOnce(&PpdMetadataManagerTest::CatchFindAllEmmsAvailableInIndex,
base::Unretained(this), third_loop.QuitClosure());
// t = 31s: caller requests the |manager_| to search forward index
// metadata for the same three effective-make-and-model strings.
// Caller requests this using metadata fetched within the last thirty
// thirds; |manager_| sees that its cached metadata is too old, and
// so performs a live fetch.
//
// Since we previously blocked forward index metadata nos. 14 and 15
// from being served, the |manager_| will fail to fetch these.
manager_->FindAllEmmsAvailableInIndex(
{"some printer a", "some printer b", "some printer c"}, base::Seconds(30),
std::move(third_callback));
third_loop.Run();
// We expect the results to have changed.
EXPECT_THAT(
results_.available_effective_make_and_model_strings,
UnorderedElementsAre(ParsedIndexEntryLike(
"some printer c", UnorderedElementsAre(ParsedIndexLeafWithPpdBasename(
"some-ppd-basename-c.ppd.gz")))));
}
// Verifies that the manager can find a USB device by fetching and
// parsing USB index metadata.
TEST_F(PpdMetadataManagerTest, CanFindDeviceInUsbIndex) {
// Known interaction: hex(1138) == 0x472. To fetch USB index metadata
// for a manufacturer with vendor ID 1138, the manager will fetch
// the metadata with the following name.
//
// This USB index describes one product for vendor ID 1138; its
// product ID is 13.
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/usb-0472.json", R"({
"usbIndex": {
"13": {
"effectiveMakeAndModel": "some printer a"
}
}
})");
base::RunLoop loop;
auto callback =
base::BindOnce(&PpdMetadataManagerTest::CatchFindDeviceInUsbIndex,
base::Unretained(this), loop.QuitClosure());
manager_->FindDeviceInUsbIndex(1138, 13, kArbitraryTimeDelta,
std::move(callback));
loop.Run();
EXPECT_THAT(results_.effective_make_and_model_string_from_usb_index,
StrEq("some printer a"));
}
// Verifies that the manager invokes the FindDeviceInUsbIndexCallback
// with an empty argument if it fails to fetch the appropriate USB
// index.
TEST_F(PpdMetadataManagerTest, FailsToFindDeviceInUsbIndexOnFetchFailure) {
// Known interaction: hex(1138) == 0x472. To fetch USB index metadata
// for a manufacturer with vendor ID 1138, the manager will fetch
// the metadata with the following name.
//
// We populate nothing in the fake serving root, so any fetch request
// from the manager will fail.
// Jams the landing area to have a non-empty string. We expect the
// callback to fire with an empty string, which should empty this.
results_.effective_make_and_model_string_from_usb_index =
"non-empty string that will fail this test if it persists";
base::RunLoop loop;
auto callback =
base::BindOnce(&PpdMetadataManagerTest::CatchFindDeviceInUsbIndex,
base::Unretained(this), loop.QuitClosure());
manager_->FindDeviceInUsbIndex(1138, 13, kArbitraryTimeDelta,
std::move(callback));
loop.Run();
EXPECT_TRUE(results_.effective_make_and_model_string_from_usb_index.empty());
}
// Verifies that the manager invokes the FindDeviceInUsbIndexCallback
// with an empty argument if it fails to parse the appropriate USB
// index.
TEST_F(PpdMetadataManagerTest, FailsToFindDeviceInUsbIndexOnParseFailure) {
// Known interaction: hex(1138) == 0x472. To fetch USB index metadata
// for a manufacturer with vendor ID 1138, the manager will fetch
// the metadata with the following name.
//
// We populate the fake serving root with invalid JSON for the USB
// index metadata that the manager will fetch and fail to parse.
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/usb-0472.json",
kInvalidJson);
// Jams the landing area to have a non-empty string. We expect the
// callback to fire with an empty string, which should empty this.
results_.effective_make_and_model_string_from_usb_index =
"non-empty string that will fail this test if it persists";
base::RunLoop loop;
auto callback =
base::BindOnce(&PpdMetadataManagerTest::CatchFindDeviceInUsbIndex,
base::Unretained(this), loop.QuitClosure());
manager_->FindDeviceInUsbIndex(1138, 13, kArbitraryTimeDelta,
std::move(callback));
loop.Run();
EXPECT_TRUE(results_.effective_make_and_model_string_from_usb_index.empty());
}
// Verifies that the manager fetches USB index metadata anew when caller
// asks it for metadata fresher than what it has cached.
TEST_F(PpdMetadataManagerTest, CanFindDeviceInUsbIndexTimeSensitive) {
// Known interaction: hex(1138) == 0x472. To fetch USB index metadata
// for a manufacturer with vendor ID 1138, the manager will fetch
// the metadata with the following name.
//
// This USB index describes one product for vendor ID 1138; its
// product ID is 13.
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/usb-0472.json", R"({
"usbIndex": {
"13": {
"effectiveMakeAndModel": "some printer a"
}
}
})");
base::RunLoop loop;
auto callback =
base::BindOnce(&PpdMetadataManagerTest::CatchFindDeviceInUsbIndex,
base::Unretained(this), loop.QuitClosure());
// t = 0s: caller requests |manager_| to name a device with vendor ID
// 1138 and product ID 13. |manager_| fetches, parses, and caches
// the appropriate USB index metadata.
manager_->FindDeviceInUsbIndex(1138, 13, kArbitraryTimeDelta,
std::move(callback));
loop.Run();
EXPECT_THAT(results_.effective_make_and_model_string_from_usb_index,
StrEq("some printer a"));
// Sets the serving root to mutate the served USB index metadata; the
// device with product ID 13 now has the effective-make-and-model
// string "some printer b." If the |manager_| fetches this metadata
// anew, then it will observe the changed effective-make-and-model
// string.
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/usb-0472.json", R"({
"usbIndex": {
"13": {
"effectiveMakeAndModel": "some printer b"
}
}
})");
// Jams the landing area to hold a test-failing string. We expect
// the successful callback to overwrite this.
results_.effective_make_and_model_string_from_usb_index =
"non-empty string that will fail this test if it persists";
base::RunLoop second_loop;
auto second_callback =
base::BindOnce(&PpdMetadataManagerTest::CatchFindDeviceInUsbIndex,
base::Unretained(this), second_loop.QuitClosure());
// t = 0s: caller requests |manager_| to name a device with vendor ID
// 1138 and product ID 13. It asks that |manager_| do so with metadata
// parsed within the last 30 seconds. |manager_| responds with the
// cached USB index metadata without incurring a live fetch.
manager_->FindDeviceInUsbIndex(1138, 13, base::Seconds(30),
std::move(second_callback));
second_loop.Run();
// The manager will have responded with the cached
// effective-make-and-model string "some printer a."
EXPECT_THAT(results_.effective_make_and_model_string_from_usb_index,
StrEq("some printer a"));
// t = 31s
clock_.Advance(base::Seconds(31));
// Jams the landing area to hold a test-failing string. We expect
// the successful callback to overwrite this.
results_.effective_make_and_model_string_from_usb_index =
"non-empty string that will fail this test if it persists";
base::RunLoop third_loop;
auto third_callback =
base::BindOnce(&PpdMetadataManagerTest::CatchFindDeviceInUsbIndex,
base::Unretained(this), third_loop.QuitClosure());
// t = 31s: caller requests |manager_| to name a device with vendor ID
// 1138 and product ID 13. It asks that |manager_| do so with metadata
// parsed within the last 30 seconds. |manager_| sees that the cached
// USB index metadata is too stale, and so incurs a live fetch. The
// fetch exposes the changed metadata.
manager_->FindDeviceInUsbIndex(1138, 13, base::Seconds(30),
std::move(third_callback));
third_loop.Run();
// The manager will have responded with the new and changed
// effective-make-and-model string "some printer b."
EXPECT_THAT(results_.effective_make_and_model_string_from_usb_index,
StrEq("some printer b"));
}
// Verifies that the manager can determine a USB manufacturer name
// by fetching and searching the USB vendor ID map.
TEST_F(PpdMetadataManagerTest, CanGetUsbManufacturerName) {
// Known interaction: |manager_| shall fetch the USB vendor ID map.
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/usb_vendor_ids.json",
R"({
"entries": [ {
"vendorId": 1138,
"vendorName": "Some Vendor Name"
} ]
})");
base::RunLoop loop;
auto callback =
base::BindOnce(&PpdMetadataManagerTest::CatchGetUsbManufacturerName,
base::Unretained(this), loop.QuitClosure());
manager_->GetUsbManufacturerName(1138, kArbitraryTimeDelta,
std::move(callback));
loop.Run();
EXPECT_THAT(results_.usb_manufacturer_name, StrEq("Some Vendor Name"));
}
// Verifies that the manager invokes the GetUsbManufacturerNameCallback
// with an empty argument if it fails to fetch the USB vendor ID map.
TEST_F(PpdMetadataManagerTest, FailsToGetUsbManufacturerNameOnFetchFailure) {
// Known interaction: |manager_| shall fetch the USB vendor ID map.
//
// We deliberately don't set any fetch response in the fake serving
// root; |manager_| will fail to fetch the USB vendor ID map. However,
// we do jam the landing area with a sentinel value to ensure that the
// callback does fire with an empty string.
results_.usb_manufacturer_name =
"non-empty string that will fail this test if it persists";
base::RunLoop loop;
auto callback =
base::BindOnce(&PpdMetadataManagerTest::CatchGetUsbManufacturerName,
base::Unretained(this), loop.QuitClosure());
manager_->GetUsbManufacturerName(1138, kArbitraryTimeDelta,
std::move(callback));
loop.Run();
EXPECT_TRUE(results_.usb_manufacturer_name.empty());
}
// Verifies that the manager invokes the GetUsbManufacturerNameCallback
// with an empty argument if it fails to parse the USB vendor ID map.
TEST_F(PpdMetadataManagerTest, FailsToGetUsbManufacturerNameOnParseFailure) {
// Known interaction: |manager_| shall fetch the USB vendor ID map.
//
// We deliberately set a malformed response in the serving root;
// |manager_| will fetch the USB vendor ID map successfully, but will
// fail to parse it.
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/usb_vendor_ids.json",
kInvalidJson);
// We also jam the landing area with a sentinel value to ensure that
// the callback fires with an empty string.
results_.usb_manufacturer_name =
"non-empty string that will fail this test if it persists";
base::RunLoop loop;
auto callback =
base::BindOnce(&PpdMetadataManagerTest::CatchGetUsbManufacturerName,
base::Unretained(this), loop.QuitClosure());
manager_->GetUsbManufacturerName(1138, kArbitraryTimeDelta,
std::move(callback));
loop.Run();
EXPECT_TRUE(results_.usb_manufacturer_name.empty());
}
// Verifies that the manager fetches the USB vendor ID map anew if the
// caller calls GetUsbManufacturerName() asking for metadata fresher
// than what it has cached.
TEST_F(PpdMetadataManagerTest, CanGetUsbManufacturerNameTimeSensitive) {
// Known interaction: |manager_| shall fetch the USB vendor ID map.
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/usb_vendor_ids.json",
R"({
"entries": [ {
"vendorId": 1138,
"vendorName": "Vendor One One Three Eight"
} ]
})");
base::RunLoop loop;
auto callback =
base::BindOnce(&PpdMetadataManagerTest::CatchGetUsbManufacturerName,
base::Unretained(this), loop.QuitClosure());
// t = 0s: caller requests the name of a USB manufacturer whose vendor
// ID is 1138. |manager_| fetches, parses, and caches the USB vendor
// ID map, responding with the name.
manager_->GetUsbManufacturerName(1138, base::Seconds(30),
std::move(callback));
loop.Run();
EXPECT_THAT(results_.usb_manufacturer_name,
StrEq("Vendor One One Three Eight"));
// Mutates the USB vendor ID map served by the fake serving root.
// If the |manager_| fetches it now, it will see a changed name for
// the USB manufacturer with vendor ID 1138.
GetFakeCache()->SetFetchResponseForTesting("metadata_v3/usb_vendor_ids.json",
R"({
"entries": [ {
"vendorId": 1138,
"vendorName": "One One Three Eight LLC"
} ]
})");
base::RunLoop second_loop;
auto second_callback =
base::BindOnce(&PpdMetadataManagerTest::CatchGetUsbManufacturerName,
base::Unretained(this), second_loop.QuitClosure());
// t = 0s: caller requests the name of a USB manufacturer whose vendor
// ID is 1138. |manager_| responds with the previously fetched
// metadata.
manager_->GetUsbManufacturerName(1138, base::Seconds(30),
std::move(second_callback));
second_loop.Run();
// Since |manager_| has not fetched the mutated USB vendor ID map,
// the results are unchanged from before.
EXPECT_THAT(results_.usb_manufacturer_name,
StrEq("Vendor One One Three Eight"));
// t = 31s
clock_.Advance(base::Seconds(31));
base::RunLoop third_loop;
auto third_callback =
base::BindOnce(&PpdMetadataManagerTest::CatchGetUsbManufacturerName,
base::Unretained(this), third_loop.QuitClosure());
// t = 31s: caller requests the name of a USB manufacturer whose
// vendor ID is 1138. |manager_| notices that its cached metadata is
// too stale and performs a live fetch, receiving the mutated
// USB vendor ID map.
manager_->GetUsbManufacturerName(1138, base::Seconds(30),
std::move(third_callback));
third_loop.Run();
// Since |manager_| has not fetched the mutated USB vendor ID map,
// the results are unchanged from before.
EXPECT_THAT(results_.usb_manufacturer_name, StrEq("One One Three Eight LLC"));
}
// Verifies that the manager can split an effective-make-and-model
// string into its constituent parts (make and model).
TEST_F(PpdMetadataManagerTest, CanSplitMakeAndModel) {
// Known interaction: asking the manager to split the string
// "Hello there!" will cause it to fetch the reverse index metadata
// with shard number 2.
GetFakeCache()->SetFetchResponseForTesting(
"metadata_v3/reverse_index-en-02.json", R"(
{
"reverseIndex": {
"Hello there!": {
"manufacturer": "General",
"model": "Kenobi"
}
}
}
)");
base::RunLoop loop;
auto callback =
base::BindOnce(&PpdMetadataManagerTest::CatchSplitMakeAndModel,
base::Unretained(this), loop.QuitClosure());
auto call = base::BindOnce(&PpdMetadataManager::SplitMakeAndModel,
base::Unretained(manager_.get()), "Hello there!",
kArbitraryTimeDelta, std::move(callback));
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(FROM_HERE,
std::move(call));
loop.Run();
ASSERT_EQ(results_.split_make_and_model_code,
PpdProvider::CallbackResultCode::SUCCESS);
EXPECT_THAT(results_.split_make, StrEq("General"));
EXPECT_THAT(results_.split_model, StrEq("Kenobi"));
}
// Verifies that the manager fails the ReverseLookupCallback when it
// fails to fetch the necessary metadata from the Chrome OS Printing
// serving root.
TEST_F(PpdMetadataManagerTest, FailsToSplitMakeAndModelOnFetchFailure) {
// Known interaction: asking the manager to split the string
// "Hello there!" will cause it to fetch the reverse index metadata
// with shard number 2.
//
// We elect _not_ to fake a value for this s.t. the fetch will fail.
base::RunLoop loop;
auto callback =
base::BindOnce(&PpdMetadataManagerTest::CatchSplitMakeAndModel,
base::Unretained(this), loop.QuitClosure());
auto call = base::BindOnce(&PpdMetadataManager::SplitMakeAndModel,
base::Unretained(manager_.get()), "Hello there!",
kArbitraryTimeDelta, std::move(callback));
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(FROM_HERE,
std::move(call));
loop.Run();
EXPECT_EQ(results_.split_make_and_model_code,
PpdProvider::CallbackResultCode::SERVER_ERROR);
}
// Verifies that the manager fails the ReverseLookupCallback when it
// fails to parse the necessary metadata from the Chrome OS Printing
// serving root.
TEST_F(PpdMetadataManagerTest, FailsToSplitMakeAndModelOnParseFailure) {
// Known interaction: asking the manager to split the string
// "Hello there!" will cause it to fetch the reverse index metadata
// with shard number 2.
//
// We fake a fetch value that is invalid JSON s.t. the manager
// will fail to parse it.
GetFakeCache()->SetFetchResponseForTesting(
"metadata_v3/reverse_index-en-02.json", kInvalidJson);
base::RunLoop loop;
auto callback =
base::BindOnce(&PpdMetadataManagerTest::CatchSplitMakeAndModel,
base::Unretained(this), loop.QuitClosure());
auto call = base::BindOnce(&PpdMetadataManager::SplitMakeAndModel,
base::Unretained(manager_.get()), "Hello there!",
kArbitraryTimeDelta, std::move(callback));
base::SequencedTaskRunner::GetCurrentDefault()->PostTask(FROM_HERE,
std::move(call));
loop.Run();
ASSERT_EQ(results_.split_make_and_model_code,
PpdProvider::CallbackResultCode::INTERNAL_ERROR);
}
// Verifies that the manager fetches reverse index metadata anew when
// caller asks it for metadata fresher than what it has cached.
TEST_F(PpdMetadataManagerTest, CanSplitMakeAndModelTimeSensitive) {
// Known interaction: asking the manager to split the string
// "Hello there!" will cause it to fetch the reverse index metadata
// with shard number 2.
GetFakeCache()->SetFetchResponseForTesting(
"metadata_v3/reverse_index-en-02.json", R"(
{
"reverseIndex": {
"Hello there!": {
"manufacturer": "General",
"model": "Kenobi"
}
}
}
)");
base::RunLoop loop;
auto callback =
base::BindOnce(&PpdMetadataManagerTest::CatchSplitMakeAndModel,
base::Unretained(this), loop.QuitClosure());
// t = 0s: caller requests that |manager_| split the
// effective-make-and-model string "Hello there!" using metadata
// parsed within the last thirty seconds. |manager_| fetches the
// appropriate reverse index metadata.
manager_->SplitMakeAndModel("Hello there!", base::Seconds(30),
std::move(callback));
loop.Run();
ASSERT_EQ(results_.split_make_and_model_code,
PpdProvider::CallbackResultCode::SUCCESS);
EXPECT_THAT(results_.split_make, StrEq("General"));
EXPECT_THAT(results_.split_model, StrEq("Kenobi"));
// Mutates the reverse index metadata we serve.
GetFakeCache()->SetFetchResponseForTesting(
"metadata_v3/reverse_index-en-02.json", R"(
{
"reverseIndex": {
"Hello there!": {
"manufacturer": "You are",
"model": "a bold one!"
}
}
}
)");
// Jams the result to a bad value, requiring that the |manager_|
// answer us positively.
results_.split_make_and_model_code =
PpdProvider::CallbackResultCode::INTERNAL_ERROR;
base::RunLoop second_loop;
auto second_callback =
base::BindOnce(&PpdMetadataManagerTest::CatchSplitMakeAndModel,
base::Unretained(this), second_loop.QuitClosure());
// t = 0s: caller requests that |manager_| split the
// effective-make-and-model string "Hello there!"
// |manager_| re-uses the cached reverse index metadata.
manager_->SplitMakeAndModel("Hello there!", base::Seconds(30),
std::move(second_callback));
second_loop.Run();
// We assert that the results are currently unchanged.
ASSERT_EQ(results_.split_make_and_model_code,
PpdProvider::CallbackResultCode::SUCCESS);
EXPECT_THAT(results_.split_make, StrEq("General"));
EXPECT_THAT(results_.split_model, StrEq("Kenobi"));
// t = 31s
clock_.Advance(base::Seconds(31));
// Jams the result to a bad value, requiring that the |manager_|
// answer us positively.
results_.split_make_and_model_code =
PpdProvider::CallbackResultCode::INTERNAL_ERROR;
base::RunLoop third_loop;
auto third_callback =
base::BindOnce(&PpdMetadataManagerTest::CatchSplitMakeAndModel,
base::Unretained(this), third_loop.QuitClosure());
// t = 31s: caller requests that |manager_| split the
// effective-make-and-model string "Hello there!"
// |manager_| doesn't have sufficiently fresh metadata, so it performs
// a live fetch.
manager_->SplitMakeAndModel("Hello there!", base::Seconds(30),
std::move(third_callback));
third_loop.Run();
// We assert that the live fetch changed the results.
ASSERT_EQ(results_.split_make_and_model_code,
PpdProvider::CallbackResultCode::SUCCESS);
EXPECT_THAT(results_.split_make, StrEq("You are"));
EXPECT_THAT(results_.split_model, StrEq("a bold one!"));
}
class PpdMetadataManagerBase : public ::testing::Test {
public:
explicit PpdMetadataManagerBase(PpdIndexChannel channel)
: task_environment_(base::test::TaskEnvironment::MainThreadType::IO) {
auto cache = std::make_unique<FakePrinterConfigCache>();
cache_ = cache.get();
manager_ = PpdMetadataManager::Create(channel, &clock_, std::move(cache));
}
~PpdMetadataManagerBase() override = default;
protected:
bool CallGetManufacturers() {
base::RunLoop loop;
bool result;
auto callback = [&loop, &result](PpdProvider::CallbackResultCode param1,
const std::vector<std::string>& param2) {
result = (param1 == PpdProvider::CallbackResultCode::SUCCESS);
loop.Quit();
};
manager_->GetManufacturers(kArbitraryTimeDelta,
base::BindLambdaForTesting(callback));
loop.Run();
return result;
}
// Environment for task schedulers.
base::test::TaskEnvironment task_environment_;
// Controlled clock that dispenses times of Fetch().
base::SimpleTestClock clock_;
// Class under test.
std::unique_ptr<PpdMetadataManager> manager_;
raw_ptr<FakePrinterConfigCache> cache_;
};
class PpdMetadataManagerForStagingChannelTest : public PpdMetadataManagerBase {
public:
PpdMetadataManagerForStagingChannelTest()
: PpdMetadataManagerBase(PpdIndexChannel::kStaging) {}
~PpdMetadataManagerForStagingChannelTest() override = default;
};
TEST_F(PpdMetadataManagerForStagingChannelTest, CanGetManufacturers) {
cache_->SetFetchResponseForTesting(
"metadata_v3_staging/manufacturers-en.json",
R"({ "filesMap": {"It":"test-en.json"}})");
EXPECT_TRUE(CallGetManufacturers());
}
class PpdMetadataManagerForDevChannelTest : public PpdMetadataManagerBase {
public:
PpdMetadataManagerForDevChannelTest()
: PpdMetadataManagerBase(PpdIndexChannel::kDev) {}
~PpdMetadataManagerForDevChannelTest() override = default;
};
TEST_F(PpdMetadataManagerForDevChannelTest, CanGetManufacturers) {
cache_->SetFetchResponseForTesting("metadata_v3_dev/manufacturers-en.json",
R"({ "filesMap": {"It":"test-en.json"}})");
EXPECT_TRUE(CallGetManufacturers());
}
} // namespace
} // namespace chromeos
|