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 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519
|
// Copyright 2017 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/ui/webui/print_preview/print_preview_handler.h"
#include <array>
#include <map>
#include <optional>
#include <string>
#include <string_view>
#include <utility>
#include <vector>
#include "base/check.h"
#include "base/containers/flat_set.h"
#include "base/containers/span.h"
#include "base/i18n/number_formatting.h"
#include "base/json/json_writer.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/ref_counted_memory.h"
#include "base/memory/scoped_refptr.h"
#include "base/notreached.h"
#include "base/run_loop.h"
#include "base/strings/utf_string_conversions.h"
#include "base/test/icu_test_util.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/values_test_util.h"
#include "base/values.h"
#include "build/build_config.h"
#include "chrome/browser/printing/print_preview_dialog_controller.h"
#include "chrome/browser/printing/print_test_utils.h"
#include "chrome/browser/printing/print_view_manager.h"
#include "chrome/browser/ui/webui/print_preview/fake_print_render_frame.h"
#include "chrome/browser/ui/webui/print_preview/policy_settings.h"
#include "chrome/browser/ui/webui/print_preview/print_preview_metrics.h"
#include "chrome/browser/ui/webui/print_preview/print_preview_ui.h"
#include "chrome/browser/ui/webui/print_preview/print_preview_utils.h"
#include "chrome/browser/ui/webui/print_preview/printer_handler.h"
#include "chrome/common/pref_names.h"
#include "chrome/test/base/testing_browser_process.h"
#include "chrome/test/base/testing_profile.h"
#include "components/enterprise/buildflags/buildflags.h"
#include "components/prefs/pref_service.h"
#include "components/sync_preferences/testing_pref_service_syncable.h"
#include "content/public/browser/render_frame_host.h"
#include "content/public/browser/web_contents.h"
#include "content/public/browser/web_ui_controller.h"
#include "content/public/test/browser_task_environment.h"
#include "content/public/test/navigation_simulator.h"
#include "content/public/test/test_renderer_host.h"
#include "content/public/test/test_web_ui.h"
#include "printing/backend/test_print_backend.h"
#include "printing/buildflags/buildflags.h"
#include "printing/mojom/print.mojom.h"
#include "printing/printing_features.h"
#include "testing/gtest/include/gtest/gtest.h"
#if BUILDFLAG(ENABLE_OOP_PRINTING)
#include "chrome/browser/printing/oop_features.h"
#include "chrome/browser/printing/print_backend_service_test_impl.h"
#include "chrome/services/printing/public/mojom/print_backend_service.mojom.h"
#include "mojo/public/cpp/bindings/remote.h"
#endif
#if BUILDFLAG(ENTERPRISE_CONTENT_ANALYSIS)
#include "chrome/browser/enterprise/connectors/common.h"
#include "chrome/browser/enterprise/connectors/test/deep_scanning_test_utils.h"
#include "chrome/browser/enterprise/connectors/test/fake_content_analysis_delegate.h"
#include "chrome/browser/policy/dm_token_utils.h"
#if BUILDFLAG(ENTERPRISE_LOCAL_CONTENT_ANALYSIS)
#include "chrome/browser/enterprise/connectors/test/fake_content_analysis_sdk_manager.h" // nogncheck
#endif // BUILDFLAG(ENTERPRISE_LOCAL_CONTENT_ANALYSIS)
#endif // BUILDFLAG(ENTERPRISE_CONTENT_ANALYSIS)
#if BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(ENTERPRISE_CONTENT_ANALYSIS)
#include "chrome/test/base/testing_profile_manager.h"
#endif
#if BUILDFLAG(IS_CHROMEOS)
#include "chrome/browser/ash/crosapi/crosapi_manager.h"
#include "chrome/browser/ash/crosapi/test_local_printer_ash.h"
#include "chromeos/ash/components/login/login_state/login_state.h"
#include "chromeos/crosapi/mojom/local_printer.mojom.h"
#endif
namespace printing {
namespace {
const char kDummyInitiatorName[] = "TestInitiator";
const char16_t kDummyInitiatorName16[] = u"TestInitiator";
const char kEmptyPrinterName[] = "EmptyPrinter";
const char kTestData[] = "abc";
#if BUILDFLAG(ENTERPRISE_LOCAL_CONTENT_ANALYSIS)
constexpr char kFakeDmToken[] = "fake-dm-token";
constexpr char kCallbackId[] = "test-callback-id-1";
#endif // BUILDFLAG(ENTERPRISE_LOCAL_CONTENT_ANALYSIS)
// Array of all mojom::PrinterTypes.
constexpr std::array kAllTypes{mojom::PrinterType::kExtension,
mojom::PrinterType::kPdf,
mojom::PrinterType::kLocal};
// Array of all mojom::PrinterTypes that have working PrinterHandlers.
constexpr std::array kAllSupportedTypes{mojom::PrinterType::kExtension,
mojom::PrinterType::kPdf,
mojom::PrinterType::kLocal};
// Both printer types that implement PrinterHandler::StartGetPrinters().
constexpr std::array kFetchableTypes{mojom::PrinterType::kExtension,
mojom::PrinterType::kLocal};
struct PrinterInfo {
std::string id;
bool is_default;
base::Value::Dict basic_info;
base::Value::Dict capabilities;
};
PrinterInfo GetSimplePrinterInfo(const std::string& name, bool is_default) {
PrinterInfo simple_printer;
simple_printer.id = name;
simple_printer.is_default = is_default;
simple_printer.basic_info.Set("printer_name", simple_printer.id);
simple_printer.basic_info.Set("printer_description", "Printer for test");
simple_printer.basic_info.Set("printer_status", 1);
base::Value::Dict cdd;
base::Value::Dict capabilities;
simple_printer.capabilities.Set("printer", simple_printer.basic_info.Clone());
simple_printer.capabilities.Set("capabilities", cdd.Clone());
return simple_printer;
}
PrinterInfo GetEmptyPrinterInfo() {
PrinterInfo empty_printer;
empty_printer.id = kEmptyPrinterName;
empty_printer.is_default = false;
empty_printer.basic_info.Set("printer_name", empty_printer.id);
empty_printer.basic_info.Set("printer_description",
"Printer with no capabilities");
empty_printer.basic_info.Set("printer_status", 0);
empty_printer.capabilities.Set("printer", empty_printer.basic_info.Clone());
return empty_printer;
}
base::Value::Dict GetPrintPreviewTicket() {
base::Value::Dict print_ticket =
test::GetPrintTicket(mojom::PrinterType::kLocal);
// Make some modifications to match a preview print ticket.
print_ticket.Set(kSettingPageRange, base::Value());
print_ticket.Set(kIsFirstRequest, true);
print_ticket.Set(kPreviewRequestID, 0);
print_ticket.Set(kSettingPreviewModifiable, false);
print_ticket.Remove(kSettingPageWidth);
print_ticket.Remove(kSettingPageHeight);
print_ticket.Remove(kSettingShowSystemDialog);
return print_ticket;
}
base::Value::List ConstructPreviewArgs(std::string_view callback_id,
const base::Value::Dict& print_ticket) {
base::Value::List args;
args.Append(callback_id);
std::string json;
base::JSONWriter::Write(base::Value(print_ticket.Clone()), &json);
args.Append(json);
return args;
}
UserActionBuckets GetUserActionForPrinterType(mojom::PrinterType type) {
switch (type) {
case mojom::PrinterType::kExtension:
return UserActionBuckets::kPrintWithExtension;
case mojom::PrinterType::kPdf:
return UserActionBuckets::kPrintToPdf;
case mojom::PrinterType::kLocal:
return UserActionBuckets::kPrintToPrinter;
}
NOTREACHED();
}
// Checks whether |histograms| was updated correctly by a job with a printer
// type |type| with arguments generated by GetPrintTicket().
void CheckHistograms(const base::HistogramTester& histograms,
mojom::PrinterType type) {
static constexpr PrintSettingsBuckets kPopulatedPrintSettingsBuckets[] = {
PrintSettingsBuckets::kPortrait, PrintSettingsBuckets::kColor,
PrintSettingsBuckets::kCollate, PrintSettingsBuckets::kDuplex,
PrintSettingsBuckets::kTotal, PrintSettingsBuckets::kDefaultMedia,
};
for (auto bucket : kPopulatedPrintSettingsBuckets) {
histograms.ExpectBucketCount("PrintPreview.PrintSettings", bucket, 1);
}
// All other PrintPreview.PrintSettings buckets should be empty.
histograms.ExpectTotalCount("PrintPreview.PrintSettings",
std::size(kPopulatedPrintSettingsBuckets));
const UserActionBuckets user_action = GetUserActionForPrinterType(type);
histograms.ExpectBucketCount("PrintPreview.UserAction", user_action, 1);
// Only one PrintPreview.UserAction bucket should have been populated.
histograms.ExpectTotalCount("PrintPreview.UserAction", 1);
histograms.ExpectBucketCount("PrintPreview.PrintDocumentType",
PrintDocumentTypeBuckets::kHtmlDocument, 1);
histograms.ExpectBucketCount("PrintPreview.PrintDocumentType",
PrintDocumentTypeBuckets::kPdfDocument, 0);
}
class TestPrinterHandler : public PrinterHandler {
public:
explicit TestPrinterHandler(const std::vector<PrinterInfo>& printers) {
SetPrinters(printers);
}
TestPrinterHandler(const TestPrinterHandler&) = delete;
TestPrinterHandler& operator=(const TestPrinterHandler&) = delete;
~TestPrinterHandler() override = default;
void Reset() override {}
void GetDefaultPrinter(DefaultPrinterCallback cb) override {
std::move(cb).Run(default_printer_);
}
void StartGetPrinters(AddedPrintersCallback added_printers_callback,
GetPrintersDoneCallback done_callback) override {
if (!printers_.empty()) {
added_printers_callback.Run(printers_.Clone());
}
std::move(done_callback).Run();
}
void StartGetCapability(const std::string& destination_id,
GetCapabilityCallback callback) override {
std::move(callback).Run(printer_capabilities_[destination_id].Clone());
}
void StartGrantPrinterAccess(const std::string& printer_id,
GetPrinterInfoCallback callback) override {}
void StartPrint(const std::u16string& job_title,
base::Value::Dict settings,
scoped_refptr<base::RefCountedMemory> print_data,
PrintCallback callback) override {
std::move(callback).Run(base::Value());
}
void SetPrinters(const std::vector<PrinterInfo>& printers) {
printers_.clear();
for (const auto& printer : printers) {
if (printer.is_default) {
default_printer_ = printer.id;
}
printers_.Append(printer.basic_info.Clone());
printer_capabilities_[printer.id] = printer.capabilities.Clone();
}
}
private:
std::string default_printer_;
base::Value::List printers_;
std::map<std::string, base::Value::Dict> printer_capabilities_;
};
class FakePrintPreviewUI : public PrintPreviewUI {
public:
FakePrintPreviewUI(content::WebUI* web_ui,
std::unique_ptr<PrintPreviewHandler> handler)
: PrintPreviewUI(web_ui, std::move(handler)) {}
FakePrintPreviewUI(const FakePrintPreviewUI&) = delete;
FakePrintPreviewUI& operator=(const FakePrintPreviewUI&) = delete;
~FakePrintPreviewUI() override = default;
void GetPrintPreviewDataForIndex(
int index,
scoped_refptr<base::RefCountedMemory>* data) const override {
*data = base::MakeRefCounted<base::RefCountedStaticMemory>(
base::byte_span_from_cstring(kTestData));
}
void OnPrintPreviewRequest(int request_id) override {}
void OnCancelPendingPreviewRequest() override {}
void OnHidePreviewDialog() override {}
void OnClosePrintPreviewDialog() override {}
};
class TestPrintPreviewPrintRenderFrame final : public FakePrintRenderFrame {
public:
explicit TestPrintPreviewPrintRenderFrame(
blink::AssociatedInterfaceProvider* provider)
: FakePrintRenderFrame(provider) {}
TestPrintPreviewPrintRenderFrame(const TestPrintPreviewPrintRenderFrame&) =
delete;
TestPrintPreviewPrintRenderFrame& operator=(
const TestPrintPreviewPrintRenderFrame&) = delete;
~TestPrintPreviewPrintRenderFrame() override = default;
const base::Value::Dict& GetSettings() { return settings_; }
void SetCompletionClosure(base::OnceClosure closure) {
closure_ = std::move(closure);
}
private:
// FakePrintRenderFrame:
void PrintPreview(base::Value::Dict settings) override {
settings_ = std::move(settings);
std::move(closure_).Run();
}
base::OnceClosure closure_;
base::Value::Dict settings_;
};
class TestPrintPreviewHandler : public PrintPreviewHandler {
public:
TestPrintPreviewHandler(std::unique_ptr<PrinterHandler> printer_handler,
content::WebContents* initiator)
: test_printer_handler_(std::move(printer_handler)),
initiator_(initiator) {}
TestPrintPreviewHandler(const TestPrintPreviewHandler&) = delete;
TestPrintPreviewHandler& operator=(const TestPrintPreviewHandler&) = delete;
~TestPrintPreviewHandler() override = default;
PrinterHandler* GetPrinterHandler(mojom::PrinterType printer_type) override {
called_for_type_.insert(printer_type);
return test_printer_handler_.get();
}
void BadMessageReceived() override { bad_messages_++; }
content::WebContents* GetInitiator() override { return initiator_; }
bool CalledOnlyForType(mojom::PrinterType printer_type) {
return (called_for_type_.size() == 1 &&
*called_for_type_.begin() == printer_type);
}
bool NotCalled() { return called_for_type_.empty(); }
void reset_calls() { called_for_type_.clear(); }
int bad_messages() { return bad_messages_; }
private:
int bad_messages_ = 0;
base::flat_set<mojom::PrinterType> called_for_type_;
std::unique_ptr<PrinterHandler> test_printer_handler_;
const raw_ptr<content::WebContents, DanglingUntriaged> initiator_;
};
#if BUILDFLAG(ENTERPRISE_CONTENT_ANALYSIS)
class TestPrintPreviewHandlerForContentAnalysis
: public TestPrintPreviewHandler {
public:
TestPrintPreviewHandlerForContentAnalysis(
std::unique_ptr<PrinterHandler> printer_handler,
content::WebContents* web_contents)
: TestPrintPreviewHandler(std::move(printer_handler), web_contents) {}
~TestPrintPreviewHandlerForContentAnalysis() override = default;
bool print_called_after_scan() const { return print_called_after_scan_; }
private:
void FinishHandleDoPrint(UserActionBuckets user_action,
base::Value::Dict settings,
scoped_refptr<base::RefCountedMemory> data,
const std::string& callback_id) override {
ASSERT_EQ(base::as_string_view(*data), kTestData);
print_called_after_scan_ = true;
PrintPreviewHandler::FinishHandleDoPrint(user_action, std::move(settings),
data, callback_id);
}
bool print_called_after_scan_ = false;
};
#endif // BUILDFLAG(ENTERPRISE_CONTENT_ANALYSIS)
} // namespace
class PrintPreviewHandlerTest : public testing::Test {
public:
PrintPreviewHandlerTest() = default;
PrintPreviewHandlerTest(const PrintPreviewHandlerTest&) = delete;
PrintPreviewHandlerTest& operator=(const PrintPreviewHandlerTest&) = delete;
~PrintPreviewHandlerTest() override = default;
void SetProfileForInitialSettings(TestingProfile* profile) {
auto* dialog_controller = PrintPreviewDialogController::GetInstance();
CHECK(dialog_controller);
if (preview_web_contents_) {
dialog_controller->DisassociateWebContentsesForTesting(
preview_web_contents_.get());
}
preview_web_contents_ = content::WebContents::Create(
content::WebContents::CreateParams(profile));
web_ui_->set_web_contents(preview_web_contents_.get());
dialog_controller->AssociateWebContentsesForTesting(
initiator_web_contents_.get(), preview_web_contents_.get());
}
void SetUp() override {
test_print_backend_ = base::MakeRefCounted<TestPrintBackend>();
PrintBackend::SetPrintBackendForTesting(test_print_backend_.get());
#if BUILDFLAG(ENABLE_OOP_PRINTING)
if (IsOopPrintingEnabled()) {
print_backend_service_ = PrintBackendServiceTestImpl::LaunchForTesting(
test_remote_, test_print_backend_, /*sandboxed=*/true);
}
#endif
#if BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(ENTERPRISE_CONTENT_ANALYSIS)
ASSERT_TRUE(testing_profile_manager_.SetUp());
#endif
#if BUILDFLAG(IS_CHROMEOS)
local_printer_ = std::make_unique<TestLocalPrinterAsh>(&profile_, nullptr);
ash::LoginState::Initialize();
manager_ = std::make_unique<crosapi::CrosapiManager>();
#endif
// Create the initiator.
initiator_web_contents_ = content::WebContents::Create(
content::WebContents::CreateParams(&profile_));
content::WebContents* initiator = initiator_web_contents_.get();
// Ensure the initiator has a RenderFrameHost with a live RenderFrame, as
// the print code will not bother to send IPCs to a non-live RenderFrame.
content::NavigationSimulator::NavigateAndCommitFromDocument(
GURL("about:blank"), initiator->GetPrimaryMainFrame());
// Create the print preview.
web_ui_ = std::make_unique<content::TestWebUI>();
SetProfileForInitialSettings(&profile_);
// Create the PrintViewManager and put it to work.
PrintViewManager::CreateForWebContents(initiator);
PrintViewManager::FromWebContents(initiator)->PrintPreviewNow(
initiator->GetPrimaryMainFrame(), false);
printers_.push_back(GetSimplePrinterInfo(test::kPrinterName, true));
auto printer_handler = CreatePrinterHandler(printers_);
printer_handler_ = printer_handler.get();
auto preview_handler = CreateHandler(std::move(printer_handler), initiator);
handler_ = preview_handler.get();
handler_->set_web_ui(web_ui());
#if BUILDFLAG(IS_CHROMEOS)
handler_->local_printer_ = local_printer_.get();
#endif
auto preview_ui = std::make_unique<FakePrintPreviewUI>(
web_ui(), std::move(preview_handler));
preview_ui->SetInitiatorTitle(kDummyInitiatorName16);
web_ui()->SetController(std::move(preview_ui));
}
void TearDown() override {
#if BUILDFLAG(IS_CHROMEOS)
manager_.reset();
ash::LoginState::Shutdown();
#endif
PrintViewManager::FromWebContents(initiator_web_contents_.get())
->PrintPreviewDone();
auto* dialog_controller = PrintPreviewDialogController::GetInstance();
CHECK(dialog_controller);
dialog_controller->DisassociateWebContentsesForTesting(
preview_web_contents_.get());
PrintBackend::SetPrintBackendForTesting(/*print_backend=*/nullptr);
}
#if BUILDFLAG(IS_CHROMEOS)
void DisableAshChrome() { handler_->local_printer_ = nullptr; }
#endif
virtual std::unique_ptr<TestPrinterHandler> CreatePrinterHandler(
const std::vector<PrinterInfo>& printers) {
return std::make_unique<TestPrinterHandler>(printers);
}
virtual std::unique_ptr<TestPrintPreviewHandler> CreateHandler(
std ::unique_ptr<TestPrinterHandler> printer_handler,
content::WebContents* web_contents) {
return std::make_unique<TestPrintPreviewHandler>(std::move(printer_handler),
web_contents);
}
void Initialize() { InitializeWithLocale("en"); }
void InitializeWithLocale(const std::string& locale) {
// Sending this message will enable javascript, so it must always be called
// before any other messages are sent.
base::Value::List args;
args.Append("test-callback-id-0");
auto* browser_process = TestingBrowserProcess::GetGlobal();
std::string original_locale = browser_process->GetApplicationLocale();
{
// Set locale since the delimiters checked in VerifyInitialSettings()
// depend on it. This has to be done in several ways to make various
// locale code sync up correctly.
browser_process->SetApplicationLocale(locale);
base::test::ScopedRestoreICUDefaultLocale scoped_locale(locale);
base::ResetFormattersForTesting();
handler()->HandleGetInitialSettings(args);
}
// Reset again now that |scoped_locale| has been destroyed.
browser_process->SetApplicationLocale(original_locale);
base::ResetFormattersForTesting();
// In response to get initial settings, the initial settings are sent back.
ASSERT_EQ(1u, web_ui()->call_data().size());
}
void AssertWebUIEventFired(const content::TestWebUI::CallData& data,
const std::string& event_id) {
EXPECT_EQ("cr.webUIListenerCallback", data.function_name());
ASSERT_TRUE(data.arg1()->is_string());
EXPECT_EQ(event_id, data.arg1()->GetString());
}
void CheckWebUIResponse(const content::TestWebUI::CallData& data,
const std::string& callback_id_in,
bool expect_success) {
EXPECT_EQ("cr.webUIResponse", data.function_name());
ASSERT_TRUE(data.arg1()->is_string());
EXPECT_EQ(callback_id_in, data.arg1()->GetString());
ASSERT_TRUE(data.arg2()->is_bool());
EXPECT_EQ(expect_success, data.arg2()->GetBool());
}
void ValidateInitialSettings(const content::TestWebUI::CallData& data,
const std::string& default_printer_name,
const std::string& initiator_title) {
ValidateInitialSettingsForLocale(data, default_printer_name,
initiator_title, "en", ",", ".");
}
// Validates the initial settings structure in the response matches the
// print_preview.NativeInitialSettings type in
// chrome/browser/resources/print_preview/native_layer.js. Checks that:
// - |default_printer_name| is the printer name returned
// - |initiator_title| is the initiator title returned
// Also validates that delimiters are correct for |locale| (set in
// InitializeWithLocale()) with the associated |thousands_delimiter| and
// |decimal_delimiter|.
// Assumes "test-callback-id-0" was used as the callback id.
void ValidateInitialSettingsForLocale(
const content::TestWebUI::CallData& data,
const std::string& default_printer_name,
const std::string& initiator_title,
const std::string& locale,
const std::string& thousands_delimiter,
const std::string& decimal_delimiter) {
CheckWebUIResponse(data, "test-callback-id-0", true);
const base::Value::Dict& settings = data.arg3()->GetDict();
ASSERT_TRUE(settings.FindBool("isInKioskAutoPrintMode").has_value());
ASSERT_TRUE(settings.FindBool("isInAppKioskMode").has_value());
const std::string* actual_locale = settings.FindString("uiLocale");
ASSERT_TRUE(actual_locale);
EXPECT_EQ(locale, *actual_locale);
const std::string* actual_thousands_delimiter =
settings.FindString("thousandsDelimiter");
ASSERT_TRUE(actual_thousands_delimiter);
EXPECT_EQ(thousands_delimiter, *actual_thousands_delimiter);
const std::string* actual_decimal_delimiter =
settings.FindString("decimalDelimiter");
ASSERT_TRUE(actual_decimal_delimiter);
EXPECT_EQ(decimal_delimiter, *actual_decimal_delimiter);
ASSERT_TRUE(settings.FindInt("unitType").has_value());
ASSERT_TRUE(settings.FindBool("previewModifiable").has_value());
const std::string* title = settings.FindString("documentTitle");
ASSERT_TRUE(title);
EXPECT_EQ(initiator_title, *title);
ASSERT_TRUE(settings.FindBool("documentHasSelection").has_value());
ASSERT_TRUE(settings.FindBool("shouldPrintSelectionOnly").has_value());
const std::string* printer = settings.FindString("printerName");
ASSERT_TRUE(printer);
EXPECT_EQ(default_printer_name, *printer);
ASSERT_TRUE(settings.FindBool("pdfPrinterDisabled").has_value());
ASSERT_TRUE(settings.FindBool("destinationsManaged").has_value());
}
// Returns |policy_name| entry from initial settings policies.
const base::Value::Dict* GetInitialSettingsPolicy(
const base::Value::Dict& settings,
const std::string& policy_name) {
const base::Value::Dict* policies = settings.FindDict("policies");
if (!policies) {
return nullptr;
}
return policies->FindDict(policy_name);
}
// Validates the initial settings value policies structure in the response
// matches the print_preview.Policies type in
// chrome/browser/resources/print_preview/native_layer.js.
// Assumes "test-callback-id-0" was used as the callback id.
void ValidateInitialSettingsValuePolicy(
const content::TestWebUI::CallData& data,
const std::string& policy_name,
std::optional<base::Value> expected_policy_value) {
CheckWebUIResponse(data, "test-callback-id-0", true);
const base::Value::Dict& settings = data.arg3()->GetDict();
const base::Value::Dict* policy =
GetInitialSettingsPolicy(settings, policy_name);
const base::Value* policy_value = policy ? policy->Find("value") : nullptr;
ASSERT_EQ(expected_policy_value.has_value(), !!policy_value);
if (expected_policy_value.has_value()) {
EXPECT_EQ(expected_policy_value.value(), *policy_value);
}
}
// Validates the initial settings allowed/default mode policies structure in
// the response matches the print_preview.Policies type in
// chrome/browser/resources/print_preview/native_layer.js.
// Assumes "test-callback-id-0" was used as the callback id.
void ValidateInitialSettingsAllowedDefaultModePolicy(
const content::TestWebUI::CallData& data,
const std::string& policy_name,
std::optional<base::Value> expected_allowed_mode,
std::optional<base::Value> expected_default_mode) {
CheckWebUIResponse(data, "test-callback-id-0", true);
const base::Value::Dict& settings = data.arg3()->GetDict();
const base::Value::Dict* policy =
GetInitialSettingsPolicy(settings, policy_name);
const base::Value* allowed_mode =
policy ? policy->Find("allowedMode") : nullptr;
const base::Value* default_mode =
policy ? policy->Find("defaultMode") : nullptr;
ASSERT_EQ(expected_allowed_mode.has_value(), !!allowed_mode);
if (expected_allowed_mode.has_value()) {
EXPECT_EQ(expected_allowed_mode.value(), *allowed_mode);
}
ASSERT_EQ(expected_default_mode.has_value(), !!default_mode);
if (expected_default_mode.has_value()) {
EXPECT_EQ(expected_default_mode.value(), *default_mode);
}
}
// Simulates a 'getPrinters' Web UI message by constructing the arguments and
// making the call to the handler.
void SendGetPrinters(mojom::PrinterType type,
const std::string& callback_id_in) {
base::Value::List args;
args.Append(callback_id_in);
args.Append(static_cast<int>(type));
handler()->HandleGetPrinters(args);
}
// Validates that the printers-added Web UI event has been fired for
// |expected-type| with 1 printer. This should be the second most recent call,
// as the resolution of the getPrinters() promise will be the most recent.
void ValidatePrinterTypeAdded(mojom::PrinterType expected_type) {
const size_t call_data_size = web_ui()->call_data().size();
ASSERT_GE(call_data_size, 2u);
const content::TestWebUI::CallData& add_data =
*web_ui()->call_data()[call_data_size - 2];
AssertWebUIEventFired(add_data, "printers-added");
const auto type =
static_cast<mojom::PrinterType>(add_data.arg2()->GetInt());
EXPECT_EQ(expected_type, type);
ASSERT_TRUE(add_data.arg3());
const base::Value::List& printer_list = add_data.arg3()->GetList();
ASSERT_EQ(printer_list.size(), 1u);
EXPECT_TRUE(printer_list[0].GetDict().FindString("printer_name"));
}
// Simulates a 'getPrinterCapabilities' Web UI message by constructing the
// arguments and making the call to the handler.
void SendGetPrinterCapabilities(mojom::PrinterType type,
const std::string& callback_id_in,
const std::string& printer_name) {
base::Value::List args;
args.Append(callback_id_in);
args.Append(printer_name);
args.Append(static_cast<int>(type));
handler()->HandleGetPrinterCapabilities(args);
}
// Validates that a printer capabilities promise was resolved/rejected.
void ValidatePrinterCapabilities(const std::string& callback_id_in,
bool expect_resolved) {
const content::TestWebUI::CallData& data = *web_ui()->call_data().back();
CheckWebUIResponse(data, callback_id_in, expect_resolved);
if (expect_resolved) {
ASSERT_TRUE(data.arg3());
const base::Value::Dict& settings = data.arg3()->GetDict();
EXPECT_TRUE(settings.FindDict(kSettingCapabilities));
}
}
blink::AssociatedInterfaceProvider*
GetInitiatorAssociatedInterfaceProvider() {
return initiator_web_contents_->GetPrimaryMainFrame()
->GetRemoteAssociatedInterfaces();
}
sync_preferences::TestingPrefServiceSyncable* prefs() {
return profile_.GetTestingPrefService();
}
content::TestWebUI* web_ui() { return web_ui_.get(); }
TestPrintPreviewHandler* handler() { return handler_; }
TestingProfile* profile() { return &profile_; }
TestPrinterHandler* printer_handler() { return printer_handler_; }
std::vector<PrinterInfo>& printers() { return printers_; }
#if BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(ENTERPRISE_CONTENT_ANALYSIS)
TestingProfileManager* testing_profile_manager() {
return &testing_profile_manager_;
}
#endif
private:
content::BrowserTaskEnvironment task_environment_;
#if BUILDFLAG(IS_CHROMEOS) || BUILDFLAG(ENTERPRISE_CONTENT_ANALYSIS)
TestingProfileManager testing_profile_manager_{
TestingBrowserProcess::GetGlobal()};
#endif
#if BUILDFLAG(IS_CHROMEOS)
std::unique_ptr<TestLocalPrinterAsh> local_printer_;
std::unique_ptr<crosapi::CrosapiManager> manager_;
#endif
TestingProfile profile_;
scoped_refptr<TestPrintBackend> test_print_backend_;
#if BUILDFLAG(ENABLE_OOP_PRINTING)
mojo::Remote<mojom::PrintBackendService> test_remote_;
std::unique_ptr<PrintBackendServiceTestImpl> print_backend_service_;
#endif
std::unique_ptr<content::TestWebUI> web_ui_;
content::RenderViewHostTestEnabler rvh_test_enabler_;
std::unique_ptr<content::WebContents> preview_web_contents_;
std::unique_ptr<content::WebContents> initiator_web_contents_;
std::vector<PrinterInfo> printers_;
raw_ptr<TestPrinterHandler> printer_handler_;
raw_ptr<TestPrintPreviewHandler> handler_;
};
TEST_F(PrintPreviewHandlerTest, InitialSettingsSimple) {
Initialize();
// Verify initial settings were sent.
ValidateInitialSettings(*web_ui()->call_data().back(), test::kPrinterName,
kDummyInitiatorName);
}
TEST_F(PrintPreviewHandlerTest, InitialSettingsHiLocale) {
InitializeWithLocale("hi");
// Verify initial settings were sent for Hindi.
ValidateInitialSettingsForLocale(*web_ui()->call_data().back(),
test::kPrinterName, kDummyInitiatorName,
"hi", ",", ".");
}
TEST_F(PrintPreviewHandlerTest, InitialSettingsRuLocale) {
InitializeWithLocale("ru");
// Verify initial settings were sent for Russian.
ValidateInitialSettingsForLocale(*web_ui()->call_data().back(),
test::kPrinterName, kDummyInitiatorName,
"ru", "\xC2\xA0", ",");
}
TEST_F(PrintPreviewHandlerTest, InitialSettingsNoPolicies) {
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(*web_ui()->call_data().back(),
"headerFooter", std::nullopt,
std::nullopt);
ValidateInitialSettingsAllowedDefaultModePolicy(*web_ui()->call_data().back(),
"cssBackground", std::nullopt,
std::nullopt);
ValidateInitialSettingsAllowedDefaultModePolicy(
*web_ui()->call_data().back(), "mediaSize", std::nullopt, std::nullopt);
ValidateInitialSettingsValuePolicy(*web_ui()->call_data().back(), "sheets",
std::nullopt);
}
#if BUILDFLAG(IS_CHROMEOS)
TEST_F(PrintPreviewHandlerTest, InitialSettingsNoAsh) {
DisableAshChrome();
Initialize();
// Verify initial settings were sent.
ValidateInitialSettings(*web_ui()->call_data().back(), test::kPrinterName,
kDummyInitiatorName);
// Verify policy settings are empty.
ValidateInitialSettingsAllowedDefaultModePolicy(*web_ui()->call_data().back(),
"headerFooter", std::nullopt,
std::nullopt);
ValidateInitialSettingsAllowedDefaultModePolicy(*web_ui()->call_data().back(),
"cssBackground", std::nullopt,
std::nullopt);
ValidateInitialSettingsAllowedDefaultModePolicy(
*web_ui()->call_data().back(), "mediaSize", std::nullopt, std::nullopt);
ValidateInitialSettingsValuePolicy(*web_ui()->call_data().back(), "sheets",
std::nullopt);
}
#endif
TEST_F(PrintPreviewHandlerTest, InitialSettingsRestrictHeaderFooterEnabled) {
// Set a pref with allowed value.
prefs()->SetManagedPref(prefs::kPrintHeaderFooter,
std::make_unique<base::Value>(true));
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(
*web_ui()->call_data().back(), "headerFooter", base::Value(true),
std::nullopt);
}
TEST_F(PrintPreviewHandlerTest, InitialSettingsRestrictHeaderFooterDisabled) {
// Set a pref with allowed value.
prefs()->SetManagedPref(prefs::kPrintHeaderFooter,
std::make_unique<base::Value>(false));
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(
*web_ui()->call_data().back(), "headerFooter", base::Value(false),
std::nullopt);
}
TEST_F(PrintPreviewHandlerTest, InitialSettingsEnableHeaderFooter) {
// Set a pref that should take priority over StickySettings.
prefs()->SetBoolean(prefs::kPrintHeaderFooter, true);
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(*web_ui()->call_data().back(),
"headerFooter", std::nullopt,
base::Value(true));
}
TEST_F(PrintPreviewHandlerTest, InitialSettingsDisableHeaderFooter) {
// Set a pref that should take priority over StickySettings.
prefs()->SetBoolean(prefs::kPrintHeaderFooter, false);
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(*web_ui()->call_data().back(),
"headerFooter", std::nullopt,
base::Value(false));
}
TEST_F(PrintPreviewHandlerTest,
InitialSettingsRestrictBackgroundGraphicsEnabled) {
// Set a pref with allowed value.
prefs()->SetInteger(prefs::kPrintingAllowedBackgroundGraphicsModes, 1);
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(*web_ui()->call_data().back(),
"cssBackground",
base::Value(1), std::nullopt);
}
TEST_F(PrintPreviewHandlerTest,
InitialSettingsRestrictBackgroundGraphicsDisabled) {
// Set a pref with allowed value.
prefs()->SetInteger(prefs::kPrintingAllowedBackgroundGraphicsModes, 2);
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(*web_ui()->call_data().back(),
"cssBackground",
base::Value(2), std::nullopt);
}
TEST_F(PrintPreviewHandlerTest, InitialSettingsEnableBackgroundGraphics) {
// Set a pref that should take priority over StickySettings.
prefs()->SetInteger(prefs::kPrintingBackgroundGraphicsDefault, 1);
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(*web_ui()->call_data().back(),
"cssBackground", std::nullopt,
base::Value(1));
}
TEST_F(PrintPreviewHandlerTest, InitialSettingsDisableBackgroundGraphics) {
// Set a pref that should take priority over StickySettings.
prefs()->SetInteger(prefs::kPrintingBackgroundGraphicsDefault, 2);
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(*web_ui()->call_data().back(),
"cssBackground", std::nullopt,
base::Value(2));
}
TEST_F(PrintPreviewHandlerTest, InitialSettingsDefaultPaperSizeName) {
const char kExpectedInitialSettingsPolicy[] = R"(
{
"width": 148000,
"height": 210000
})";
// Set a pref that should take priority over StickySettings.
const char kPrintingPaperSizeDefaultName[] = R"(
{
"name": "iso_a5_148x210mm"
})";
prefs()->Set(prefs::kPrintingPaperSizeDefault,
base::test::ParseJson(kPrintingPaperSizeDefaultName));
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(
*web_ui()->call_data().back(), "mediaSize", std::nullopt,
base::test::ParseJson(kExpectedInitialSettingsPolicy));
}
TEST_F(PrintPreviewHandlerTest, InitialSettingsDefaultPaperSizeCustomSize) {
const char kExpectedInitialSettingsPolicy[] = R"(
{
"width": 148000,
"height": 210000
})";
// Set a pref that should take priority over StickySettings.
const char kPrintingPaperSizeDefaultCustomSize[] = R"(
{
"name": "custom",
"custom_size": {
"width": 148000,
"height": 210000
}
})";
prefs()->Set(prefs::kPrintingPaperSizeDefault,
base::test::ParseJson(kPrintingPaperSizeDefaultCustomSize));
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(
*web_ui()->call_data().back(), "mediaSize", std::nullopt,
base::test::ParseJson(kExpectedInitialSettingsPolicy));
}
#if BUILDFLAG(IS_CHROMEOS)
TEST_F(PrintPreviewHandlerTest, InitialSettingsMaxSheetsAllowedPolicy) {
prefs()->SetInteger(prefs::kPrintingMaxSheetsAllowed, 2);
Initialize();
ValidateInitialSettingsValuePolicy(*web_ui()->call_data().back(), "sheets",
base::Value(2));
}
TEST_F(PrintPreviewHandlerTest, InitialSettingsEnableColorAndMonochrome) {
// Set a pref that should take priority over StickySettings.
prefs()->SetInteger(prefs::kPrintingAllowedColorModes, 3);
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(
*web_ui()->call_data().back(), "color", base::Value(3), std::nullopt);
}
TEST_F(PrintPreviewHandlerTest, InitialSettingsDefaultColor) {
// Set a pref that should take priority over StickySettings.
prefs()->SetInteger(prefs::kPrintingColorDefault, 2);
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(
*web_ui()->call_data().back(), "color", std::nullopt, base::Value(2));
}
TEST_F(PrintPreviewHandlerTest, InitialSettingsEnableSimplexAndDuplex) {
// Set a pref that should take priority over StickySettings.
prefs()->SetInteger(prefs::kPrintingAllowedDuplexModes, 7);
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(
*web_ui()->call_data().back(), "duplex", base::Value(7), std::nullopt);
}
TEST_F(PrintPreviewHandlerTest, InitialSettingsDefaultSimplex) {
// Set a pref that should take priority over StickySettings.
prefs()->SetInteger(prefs::kPrintingDuplexDefault, 1);
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(
*web_ui()->call_data().back(), "duplex", std::nullopt, base::Value(1));
}
TEST_F(PrintPreviewHandlerTest, InitialSettingsRestrictPin) {
// Set a pref that should take priority over StickySettings.
prefs()->SetInteger(prefs::kPrintingAllowedPinModes, 1);
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(
*web_ui()->call_data().back(), "pin", base::Value(1), std::nullopt);
}
TEST_F(PrintPreviewHandlerTest, InitialSettingsDefaultNoPin) {
// Set a pref that should take priority over StickySettings.
prefs()->SetInteger(prefs::kPrintingPinDefault, 2);
Initialize();
ValidateInitialSettingsAllowedDefaultModePolicy(
*web_ui()->call_data().back(), "pin", std::nullopt, base::Value(2));
}
#endif // BUILDFLAG(IS_CHROMEOS)
TEST_F(PrintPreviewHandlerTest, GetPrinters) {
base::HistogramTester histogram_tester;
Initialize();
// Check all three printer types that implement
for (size_t i = 0; i < std::size(kFetchableTypes); i++) {
mojom::PrinterType type = kFetchableTypes[i];
std::string callback_id_in =
"test-callback-id-" + base::NumberToString(i + 1);
handler()->reset_calls();
SendGetPrinters(type, callback_id_in);
EXPECT_TRUE(handler()->CalledOnlyForType(type));
// Start with 1 call from initial settings, then add 2 more for each loop
// iteration (one for printers-added, and one for the response).
ASSERT_EQ(1u + 2 * (i + 1), web_ui()->call_data().size());
ValidatePrinterTypeAdded(type);
// Verify getPrinters promise was resolved successfully.
const content::TestWebUI::CallData& data = *web_ui()->call_data().back();
CheckWebUIResponse(data, callback_id_in, true);
}
histogram_tester.ExpectTotalCount("PrintPreview.GetPrintersTime.Extension",
1);
histogram_tester.ExpectTotalCount("PrintPreview.GetPrintersTime.Local", 1);
histogram_tester.ExpectTotalCount("PrintPreview.GetPrintersTime.PDF", 0);
}
// Validates the 'printing.printer_type_deny_list' pref by placing the extension
// printer type on a deny list. A 'getPrinters' Web UI message is
// then called both fetchable printer types; only local printers should
// be successfully fetched.
TEST_F(PrintPreviewHandlerTest, GetNoDenyListPrinters) {
base::Value::List deny_list;
deny_list.Append("extension");
prefs()->SetList(prefs::kPrinterTypeDenyList, std::move(deny_list));
Initialize();
size_t expected_callbacks = 1;
for (size_t i = 0; i < std::size(kFetchableTypes); i++) {
mojom::PrinterType type = kFetchableTypes[i];
std::string callback_id_in =
"test-callback-id-" + base::NumberToString(i + 1);
handler()->reset_calls();
SendGetPrinters(type, callback_id_in);
// Start with 1 call from initial settings, then add 2 more for each printer
// type that isn't on the deny list (one for printers-added, and one for the
// response), and only 1 more for each type on the deny list (just for
// response).
const bool is_allowed_type = type == mojom::PrinterType::kLocal;
EXPECT_EQ(is_allowed_type, handler()->CalledOnlyForType(type));
expected_callbacks += is_allowed_type ? 2 : 1;
ASSERT_EQ(expected_callbacks, web_ui()->call_data().size());
if (is_allowed_type) {
ValidatePrinterTypeAdded(type);
}
// Verify getPrinters promise was resolved successfully.
const content::TestWebUI::CallData& data = *web_ui()->call_data().back();
CheckWebUIResponse(data, callback_id_in, true);
}
}
TEST_F(PrintPreviewHandlerTest, GetPrinterCapabilities) {
// Add an empty printer to the handler.
printers().push_back(GetEmptyPrinterInfo());
printer_handler()->SetPrinters(printers());
// Initial settings first to enable javascript.
Initialize();
// Check all four printer types that implement
// PrinterHandler::StartGetCapability().
for (size_t i = 0; i < std::size(kAllSupportedTypes); i++) {
mojom::PrinterType type = kAllSupportedTypes[i];
std::string callback_id_in =
"test-callback-id-" + base::NumberToString(i + 1);
handler()->reset_calls();
SendGetPrinterCapabilities(type, callback_id_in, test::kPrinterName);
EXPECT_TRUE(handler()->CalledOnlyForType(type));
// Start with 1 call from initial settings, then add 1 more for each loop
// iteration.
ASSERT_EQ(1u + (i + 1), web_ui()->call_data().size());
ValidatePrinterCapabilities(callback_id_in, /*expect_resolved=*/true);
}
// Run through the loop again, this time with a printer that has no
// capabilities.
for (size_t i = 0; i < std::size(kAllSupportedTypes); i++) {
mojom::PrinterType type = kAllSupportedTypes[i];
std::string callback_id_in =
"test-callback-id-" +
base::NumberToString(i + std::size(kAllSupportedTypes) + 1);
handler()->reset_calls();
SendGetPrinterCapabilities(type, callback_id_in, kEmptyPrinterName);
EXPECT_TRUE(handler()->CalledOnlyForType(type));
// Start with 1 call from initial settings plus
// std::size(kAllSupportedTypes) from first loop, then add 1 more for each
// loop iteration.
ASSERT_EQ(1u + std::size(kAllSupportedTypes) + (i + 1),
web_ui()->call_data().size());
ValidatePrinterCapabilities(callback_id_in, /*expect_resolved=*/false);
}
}
// Validates the 'printing.printer_type_deny_list' pref by placing the local and
// PDF printer types on the deny list. A 'getPrinterCapabilities' Web UI message
// is then called for all supported printer types; only extension
// printer capabilities should be successfully fetched.
TEST_F(PrintPreviewHandlerTest, GetNoDenyListPrinterCapabilities) {
base::Value::List deny_list;
deny_list.Append("local");
deny_list.Append("pdf");
prefs()->SetList(prefs::kPrinterTypeDenyList, std::move(deny_list));
Initialize();
// Check all four printer types that implement
// PrinterHandler::StartGetCapability().
for (size_t i = 0; i < std::size(kAllSupportedTypes); i++) {
mojom::PrinterType type = kAllSupportedTypes[i];
std::string callback_id_in =
"test-callback-id-" + base::NumberToString(i + 1);
handler()->reset_calls();
SendGetPrinterCapabilities(type, callback_id_in, test::kPrinterName);
const bool is_allowed_type = type == mojom::PrinterType::kExtension;
EXPECT_EQ(is_allowed_type, handler()->CalledOnlyForType(type));
// Start with 1 call from initial settings, then add 1 more for each loop
// iteration.
ASSERT_EQ(1u + (i + 1), web_ui()->call_data().size());
ValidatePrinterCapabilities(callback_id_in, is_allowed_type);
}
}
TEST_F(PrintPreviewHandlerTest, GetPrinterCapabilitiesContinuousMedia) {
// Add two media sizes to our printer - one with discrete sizes and one with
// continuous feed. The continuous feed media should get filtered out when
// the capabilities are retrieved.
base::Value::Dict media_1;
media_1.Set("width_microns", 100);
media_1.Set("height_microns", 200);
base::Value::Dict media_2;
media_2.Set("width_microns", 300);
media_2.Set("is_continuous_feed", true);
// After filtering, the expected media will just have the discrete media.
base::Value::List expected_media;
expected_media.Append(media_1.Clone());
base::Value::List option_list;
option_list.Append(std::move(media_1));
option_list.Append(std::move(media_2));
base::Value::Dict media_size;
media_size.Set("option", std::move(option_list));
base::Value::Dict printer;
printer.Set("media_size", std::move(media_size));
base::Value::Dict cdd;
cdd.Set("printer", std::move(printer));
ASSERT_EQ(1u, printers().size());
printers()[0].capabilities.Set(kSettingCapabilities, std::move(cdd));
printer_handler()->SetPrinters(printers());
const base::Value::Dict* capabilities =
printers()[0].capabilities.FindDict(kSettingCapabilities);
ASSERT_TRUE(capabilities);
const base::Value::List* options = GetMediaSizeOptionsFromCdd(*capabilities);
ASSERT_TRUE(options);
EXPECT_EQ(2u, options->size());
// Initial settings first to enable javascript.
Initialize();
std::string callback_id_in = "test-callback-id";
handler()->reset_calls();
SendGetPrinterCapabilities(mojom::PrinterType::kLocal, callback_id_in,
test::kPrinterName);
ASSERT_EQ(2u, web_ui()->call_data().size());
// Validate printer capabilities only has one media type (the continuous feed
// option should get filtered out).
const content::TestWebUI::CallData& data = *web_ui()->call_data().back();
CheckWebUIResponse(data, callback_id_in, true);
ASSERT_TRUE(data.arg3()->is_dict());
const base::Value::Dict& settings = data.arg3()->GetDict();
capabilities = settings.FindDict(kSettingCapabilities);
ASSERT_TRUE(capabilities);
options = GetMediaSizeOptionsFromCdd(*capabilities);
ASSERT_TRUE(options);
EXPECT_EQ(expected_media, *options);
}
TEST_F(PrintPreviewHandlerTest, Print) {
Initialize();
// All printer types can print.
for (size_t i = 0; i < std::size(kAllTypes); i++) {
base::HistogramTester histograms;
handler()->reset_calls();
// Send print preview request.
base::Value::Dict preview_ticket = GetPrintPreviewTicket();
preview_ticket.Set(kPreviewRequestID, static_cast<int>(i));
std::string preview_callback_id =
"test-callback-id-" + base::NumberToString(2 * i + 1);
base::Value::List preview_list_args =
ConstructPreviewArgs(preview_callback_id, preview_ticket);
handler()->HandleGetPreview(preview_list_args);
// Send printing request.
mojom::PrinterType type = kAllTypes[i];
base::Value::List print_args;
std::string print_callback_id =
"test-callback-id-" + base::NumberToString(2 * (i + 1));
print_args.Append(print_callback_id);
base::Value print_ticket(test::GetPrintTicket(type));
std::string json;
base::JSONWriter::Write(print_ticket, &json);
print_args.Append(json);
handler()->HandleDoPrint(print_args);
CheckHistograms(histograms, type);
// Verify correct PrinterHandler was called.
EXPECT_TRUE(handler()->CalledOnlyForType(type));
// Verify print promise was resolved successfully.
const content::TestWebUI::CallData& data = *web_ui()->call_data().back();
CheckWebUIResponse(data, print_callback_id, true);
}
}
TEST_F(PrintPreviewHandlerTest, GetPreview) {
Initialize();
base::RunLoop run_loop;
TestPrintPreviewPrintRenderFrame print_render_frame(
GetInitiatorAssociatedInterfaceProvider());
print_render_frame.SetCompletionClosure(run_loop.QuitClosure());
base::Value::Dict print_ticket = GetPrintPreviewTicket();
base::Value::List list_args =
ConstructPreviewArgs("test-callback-id-1", print_ticket);
handler()->HandleGetPreview(list_args);
run_loop.Run();
// Verify that the preview was requested from the renderer with the
// appropriate settings.
const base::Value::Dict& preview_params = print_render_frame.GetSettings();
bool preview_id_found = false;
for (auto it : preview_params) {
if (it.first == kPreviewUIID) { // This is added by the handler.
preview_id_found = true;
continue;
}
const base::Value* value_in = print_ticket.Find(it.first);
ASSERT_TRUE(value_in);
EXPECT_EQ(*value_in, it.second);
}
EXPECT_TRUE(preview_id_found);
}
TEST_F(PrintPreviewHandlerTest, SendPreviewUpdates) {
Initialize();
base::RunLoop run_loop;
TestPrintPreviewPrintRenderFrame print_render_frame(
GetInitiatorAssociatedInterfaceProvider());
print_render_frame.SetCompletionClosure(run_loop.QuitClosure());
const char callback_id_in[] = "test-callback-id-1";
base::Value::Dict print_ticket = GetPrintPreviewTicket();
base::Value::List list_args =
ConstructPreviewArgs(callback_id_in, print_ticket);
handler()->HandleGetPreview(list_args);
run_loop.Run();
const base::Value::Dict& preview_params = print_render_frame.GetSettings();
// Read the preview UI ID and request ID
std::optional<int> request_value = preview_params.FindInt(kPreviewRequestID);
ASSERT_TRUE(request_value.has_value());
int preview_request_id = request_value.value();
std::optional<int> ui_value = preview_params.FindInt(kPreviewUIID);
ASSERT_TRUE(ui_value.has_value());
int preview_ui_id = ui_value.value();
// Simulate renderer responses: PageLayoutReady, PageCountReady,
// PagePreviewReady, and OnPrintPreviewReady will be called in that order.
base::Value::Dict layout;
layout.Set(kSettingMarginTop, 34.0);
layout.Set(kSettingMarginLeft, 34.0);
layout.Set(kSettingMarginBottom, 34.0);
layout.Set(kSettingMarginRight, 34.0);
layout.Set(kSettingContentWidth, 544.0);
layout.Set(kSettingContentHeight, 700.0);
layout.Set(kSettingPrintableAreaX, 17);
layout.Set(kSettingPrintableAreaY, 17);
layout.Set(kSettingPrintableAreaWidth, 578);
layout.Set(kSettingPrintableAreaHeight, 734);
handler()->SendPageLayoutReady(std::move(layout),
/*all_pages_have_custom_size,=*/false,
/*all_pages_have_custom_orientation,=*/false,
preview_request_id);
// Verify that page-layout-ready webUI event was fired.
AssertWebUIEventFired(*web_ui()->call_data().back(), "page-layout-ready");
// 1 page document. Modifiable so send default 100 scaling.
handler()->SendPageCountReady(1, 100, preview_request_id);
AssertWebUIEventFired(*web_ui()->call_data().back(), "page-count-ready");
// Page at index 0 is ready.
handler()->SendPagePreviewReady(0, preview_ui_id, preview_request_id);
AssertWebUIEventFired(*web_ui()->call_data().back(), "page-preview-ready");
// Print preview is ready.
handler()->OnPrintPreviewReady(preview_ui_id, preview_request_id);
CheckWebUIResponse(*web_ui()->call_data().back(), callback_id_in, true);
// Renderer responses have been as expected.
EXPECT_EQ(handler()->bad_messages(), 0);
// None of these should work since there has been no new preview request.
// Check that there are no new web UI messages sent.
size_t message_count = web_ui()->call_data().size();
handler()->SendPageLayoutReady(base::Value::Dict(),
/*all_pages_have_custom_size,=*/false,
/*all_pages_have_custom_orientation,=*/false,
preview_request_id);
EXPECT_EQ(message_count, web_ui()->call_data().size());
handler()->SendPageCountReady(1, -1, 0);
EXPECT_EQ(message_count, web_ui()->call_data().size());
handler()->OnPrintPreviewReady(0, 0);
EXPECT_EQ(message_count, web_ui()->call_data().size());
// Handler should have tried to kill the renderer for each of these.
EXPECT_EQ(handler()->bad_messages(), 3);
}
class FailingTestPrinterHandler : public TestPrinterHandler {
public:
explicit FailingTestPrinterHandler(const std::vector<PrinterInfo>& printers)
: TestPrinterHandler(printers) {}
FailingTestPrinterHandler(const FailingTestPrinterHandler&) = delete;
FailingTestPrinterHandler& operator=(const FailingTestPrinterHandler&) =
delete;
~FailingTestPrinterHandler() override = default;
void StartGetCapability(const std::string& destination_id,
GetCapabilityCallback callback) override {
std::move(callback).Run(base::Value::Dict());
}
};
class PrintPreviewHandlerFailingTest : public PrintPreviewHandlerTest {
public:
PrintPreviewHandlerFailingTest() = default;
PrintPreviewHandlerFailingTest(const PrintPreviewHandlerFailingTest&) =
delete;
PrintPreviewHandlerFailingTest& operator=(
const PrintPreviewHandlerFailingTest&) = delete;
~PrintPreviewHandlerFailingTest() override = default;
std::unique_ptr<TestPrinterHandler> CreatePrinterHandler(
const std::vector<PrinterInfo>& printers) override {
return std::make_unique<FailingTestPrinterHandler>(printers);
}
};
// This test is similar to PrintPreviewHandlerTest.GetPrinterCapabilities, but
// uses FailingTestPrinterHandler instead of TestPrinterHandler. As a result,
// StartGetCapability() always fails, to exercise its callback's failure
// handling path. Failure is different from getting no capabilities.
TEST_F(PrintPreviewHandlerFailingTest, GetPrinterCapabilities) {
// Add an empty printer to the handler.
printers().push_back(GetEmptyPrinterInfo());
printer_handler()->SetPrinters(printers());
// Initial settings first to enable javascript.
Initialize();
// Check all four printer types that implement
// PrinterHandler::StartGetCapability().
for (size_t i = 0; i < std::size(kAllSupportedTypes); i++) {
mojom::PrinterType type = kAllSupportedTypes[i];
handler()->reset_calls();
base::Value::List args;
std::string callback_id_in =
"test-callback-id-" + base::NumberToString(i + 1);
args.Append(callback_id_in);
args.Append(test::kPrinterName);
args.Append(static_cast<int>(type));
handler()->HandleGetPrinterCapabilities(args);
EXPECT_TRUE(handler()->CalledOnlyForType(type));
// Start with 1 call from initial settings, then add 1 more for each loop
// iteration.
ASSERT_EQ(1u + (i + 1), web_ui()->call_data().size());
// Verify printer capabilities promise was rejected.
const content::TestWebUI::CallData& data = *web_ui()->call_data().back();
CheckWebUIResponse(data, callback_id_in, false);
const base::Value* settings = data.arg3();
ASSERT_TRUE(settings);
EXPECT_TRUE(settings->is_none());
}
}
#if BUILDFLAG(ENTERPRISE_LOCAL_CONTENT_ANALYSIS)
class ContentAnalysisPrintPreviewHandlerTest
: public PrintPreviewHandlerTest,
public testing::WithParamInterface<bool> {
public:
void SetUp() override {
enterprise_connectors::ContentAnalysisDelegate::SetFactoryForTesting(
base::BindRepeating(
&enterprise_connectors::test::FakeContentAnalysisDelegate::Create,
run_loop_.QuitClosure(),
base::BindRepeating(
&ContentAnalysisPrintPreviewHandlerTest::ScanningResponse,
base::Unretained(this)),
kFakeDmToken));
enterprise_connectors::ContentAnalysisDelegate::DisableUIForTesting();
PrintPreviewHandlerTest::SetUp();
// Set the policy that enables local content analysis for print.
enterprise_connectors::test::SetAnalysisConnector(
profile()->GetPrefs(), enterprise_connectors::AnalysisConnector::PRINT,
R"({
"service_provider": "local_system_agent",
"enable": [ {"url_list": ["*"], "tags": ["dlp"]} ],
"block_until_verdict": 1
})");
}
void TearDown() override {
PrintPreviewHandlerTest::TearDown();
enterprise_connectors::ContentAnalysisDelegate::EnableUIAfterTesting();
}
std::unique_ptr<TestPrintPreviewHandler> CreateHandler(
std ::unique_ptr<TestPrinterHandler> printer_handler,
content::WebContents* web_contents) override {
return std::make_unique<TestPrintPreviewHandlerForContentAnalysis>(
std::move(printer_handler), web_contents);
}
bool scanning_allows_print() const { return GetParam(); }
enterprise_connectors::ContentAnalysisResponse ScanningResponse(
const std::string& content,
const base::FilePath& path) {
enterprise_connectors::ContentAnalysisResponse response;
auto* result = response.add_results();
result->set_tag("dlp");
result->set_status(
enterprise_connectors::ContentAnalysisResponse::Result::SUCCESS);
if (!scanning_allows_print()) {
auto* rule = result->add_triggered_rules();
rule->set_rule_name("blocking_rule_name");
rule->set_action(enterprise_connectors::TriggeredRule::BLOCK);
}
return response;
}
void WaitForScan() { run_loop_.Run(); }
private:
base::RunLoop run_loop_;
// This installs a fake SDK manager that creates fake SDK clients when
// its GetClient() method is called. This is needed so that calls to
// ContentAnalysisSdkManager::Get()->GetClient() do not fail.
enterprise_connectors::FakeContentAnalysisSdkManager sdk_manager_;
};
TEST_P(ContentAnalysisPrintPreviewHandlerTest, LocalScanBeforePrinting) {
TestingProfile* main_profile =
testing_profile_manager()->CreateTestingProfile("Main Profile");
SetProfileForInitialSettings(main_profile);
Initialize();
base::Value::List print_args;
print_args.Append(kCallbackId);
base::Value print_ticket(test::GetPrintTicket(kAllTypes[0]));
std::string json;
base::JSONWriter::Write(print_ticket, &json);
print_args.Append(json);
handler()->HandleDoPrint(print_args);
WaitForScan();
auto* print_preview_handler =
static_cast<TestPrintPreviewHandlerForContentAnalysis*>(handler());
// Check if printing was allowed or not depending on the parameter.
ASSERT_EQ(print_preview_handler->print_called_after_scan(),
scanning_allows_print());
// Verify that printing went through or not based on the parameter.
const content::TestWebUI::CallData& data = *web_ui()->call_data().back();
CheckWebUIResponse(data, kCallbackId, scanning_allows_print());
}
INSTANTIATE_TEST_SUITE_P(All,
ContentAnalysisPrintPreviewHandlerTest,
/*scanning_allows_print=*/testing::Bool());
#endif // BUILDFLAG(ENTERPRISE_LOCAL_CONTENT_ANALYSIS)
} // namespace printing
|