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 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684
|
// Copyright 2023 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/extensions/api/document_scan/document_scan_api_handler.h"
#include <memory>
#include <optional>
#include <string>
#include <utility>
#include <vector>
#include "base/auto_reset.h"
#include "base/functional/bind.h"
#include "base/memory/ref_counted.h"
#include "base/strings/stringprintf.h"
#include "base/test/test_future.h"
#include "base/values.h"
#include "chrome/browser/extensions/api/document_scan/document_scan_api.h"
#include "chrome/browser/extensions/api/document_scan/document_scan_test_utils.h"
#include "chrome/browser/extensions/api/document_scan/fake_document_scan_ash.h"
#include "chrome/browser/extensions/api/document_scan/scanner_discovery_runner.h"
#include "chrome/browser/extensions/api/document_scan/start_scan_runner.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/common/chrome_constants.h"
#include "chrome/common/pref_names.h"
#include "chrome/test/base/testing_browser_process.h"
#include "chrome/test/base/testing_profile.h"
#include "chrome/test/base/testing_profile_manager.h"
#include "chromeos/crosapi/mojom/document_scan.mojom.h"
#include "components/sync_preferences/testing_pref_service_syncable.h"
#include "content/public/test/browser_task_environment.h"
#include "extensions/browser/extension_registry.h"
#include "extensions/browser/unloaded_extension_reason.h"
#include "extensions/common/extension_builder.h"
#include "testing/gmock/include/gmock/gmock-matchers.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace extensions {
namespace {
using SimpleScanFuture =
base::test::TestFuture<std::optional<api::document_scan::ScanResults>,
std::optional<std::string>>;
using GetScannerListFuture =
base::test::TestFuture<api::document_scan::GetScannerListResponse>;
using OpenScannerFuture =
base::test::TestFuture<api::document_scan::OpenScannerResponse>;
using GetOptionGroupsFuture =
base::test::TestFuture<api::document_scan::GetOptionGroupsResponse>;
using CloseScannerFuture =
base::test::TestFuture<api::document_scan::CloseScannerResponse>;
using SetOptionsFuture =
base::test::TestFuture<api::document_scan::SetOptionsResponse>;
using StartScanFuture =
base::test::TestFuture<api::document_scan::StartScanResponse>;
using CancelScanFuture =
base::test::TestFuture<api::document_scan::CancelScanResponse>;
using ReadScanDataFuture =
base::test::TestFuture<api::document_scan::ReadScanDataResponse>;
// Fake extension info.
constexpr char kExtensionId[] = "abcdefghijklmnopqrstuvwxyz123456";
constexpr char kExtensionName[] = "DocumentScan API extension";
constexpr char kExtensionPermissionName[] = "documentScan";
// Scanner name used for tests.
constexpr char kVirtualUSBPrinterName[] = "DavieV Virtual USB Printer (USB)";
// Fake scan data.
constexpr char kScanDataItem[] = "PrettyPicture";
constexpr char kScanDataItemBase64[] =
"data:image/png;base64,UHJldHR5UGljdHVyZQ==";
class DocumentScanAPIHandlerTest : public testing::Test {
public:
DocumentScanAPIHandlerTest() = default;
DocumentScanAPIHandlerTest(const DocumentScanAPIHandlerTest&) = delete;
DocumentScanAPIHandlerTest& operator=(const DocumentScanAPIHandlerTest&) =
delete;
~DocumentScanAPIHandlerTest() override = default;
void SetUp() override {
profile_manager_ = std::make_unique<TestingProfileManager>(
TestingBrowserProcess::GetGlobal());
ASSERT_TRUE(profile_manager_->SetUp());
testing_profile_ =
profile_manager_->CreateTestingProfile(chrome::kInitialProfile);
extension_ = ExtensionBuilder(kExtensionName)
.SetID(kExtensionId)
.AddAPIPermission(kExtensionPermissionName)
.Build();
ExtensionRegistry::Get(testing_profile_)->AddEnabled(extension_);
document_scan_api_handler_ = DocumentScanAPIHandler::CreateForTesting(
testing_profile_, &document_scan_);
}
void TearDown() override {
document_scan_api_handler_.reset();
testing_profile_ = nullptr;
profile_manager_->DeleteTestingProfile(chrome::kInitialProfile);
}
FakeDocumentScanAsh& GetDocumentScan() { return document_scan_; }
protected:
std::unique_ptr<DocumentScanAPIHandler> document_scan_api_handler_;
scoped_refptr<const Extension> extension_;
// Send a notification that `extension` has been unloaded.
void UnloadExtension() {
document_scan_api_handler_->OnExtensionUnloaded(
testing_profile_, extension_.get(), UnloadedExtensionReason::UNINSTALL);
}
// Allow an extension to bypass user confirmation dialogs by adding it to the
// list of trusted document scan extensions.
void MarkExtensionTrusted(const ExtensionId extension_id) {
testing_profile_->GetTestingPrefService()->SetList(
prefs::kDocumentScanAPITrustedExtensions,
base::Value::List().Append(extension_id));
}
// "Discover" a scanner and return its unguessable token. After calling this,
// a test can use the returned scanner ID to open a scanner for further
// operations. If `unique_id` is true, a unique scanner ID will be used for
// the scanner that gets created. Otherwise, a constant ID will be used.
std::string CreateScannerIdForExtension(
scoped_refptr<const Extension> extension,
bool unique_id = true) {
auto scanner_info = CreateTestScannerInfo();
if (unique_id) {
static size_t counter = 0;
scanner_info->id =
base::StringPrintf("%s-%zu", scanner_info->id.c_str(), counter++);
}
const std::string the_scanner_id = scanner_info->id;
GetDocumentScan().AddScanner(std::move(scanner_info));
ScannerDiscoveryRunner::SetDiscoveryConfirmationResultForTesting(true);
GetScannerListFuture list_future;
document_scan_api_handler_->GetScannerList(
/*native_window=*/nullptr, extension, /*user_gesture=*/false, {},
list_future.GetCallback());
const api::document_scan::GetScannerListResponse& list_response =
list_future.Get();
for (const auto& scanner : list_response.scanners) {
if (scanner.scanner_id == the_scanner_id) {
return scanner.scanner_id;
}
}
return "";
}
// "Discover" a scanner and open that given scanner, returning the scanner
// handle. After calling this, a test can use the returned scanner handle for
// further operations. Note that this will always use a unique scanner ID for
// the scanner that is created.
std::string OpenScannerForExtension(
scoped_refptr<const Extension> extension) {
return OpenScannerWithId(extension, CreateScannerIdForExtension(extension));
}
// "Discover" and open a scanner, start a scan on that scanner, and return the
// job handle. After calling this, a test can use the returned job handle for
// further operations.
std::string StartScanForExtension(scoped_refptr<const Extension> extension) {
return StartScanForScannerHandle(extension, /*user_gesture=*/false,
OpenScannerForExtension(extension));
}
// Open the scanner with the given `scanner_id`, returning the scanner handle.
// This requires that the scanner has already been added to the fake document
// scan object. After calling this, a test can use the returned scanner
// handle for further operations.
std::string OpenScannerWithId(scoped_refptr<const Extension> extension,
const std::string& scanner_id) {
if (scanner_id.empty()) {
return "";
}
OpenScannerFuture future;
document_scan_api_handler_->OpenScanner(extension, scanner_id,
future.GetCallback());
const api::document_scan::OpenScannerResponse& response = future.Get();
return response.scanner_handle.value_or("");
}
// Start a scan for the scanner given by `scanner_handle`, returning the job
// handle. This requires that the scanner has already been added to the fake
// document scan object. After calling this, a test can use the returned job
// handle for further operations.
std::string StartScanForScannerHandle(
scoped_refptr<const Extension> extension,
bool user_gesture,
const std::string& scanner_handle) {
if (scanner_handle.empty()) {
return "";
}
base::AutoReset<std::optional<bool>> testing_scope =
StartScanRunner::SetStartScanConfirmationResultForTesting(true);
api::document_scan::StartScanOptions options;
StartScanFuture future;
document_scan_api_handler_->StartScan(
/*native_window=*/nullptr, extension, user_gesture, scanner_handle,
std::move(options), future.GetCallback());
const api::document_scan::StartScanResponse& response = future.Get();
return response.job.value_or("");
}
private:
content::BrowserTaskEnvironment task_environment_;
raw_ptr<TestingProfile> testing_profile_;
FakeDocumentScanAsh document_scan_;
std::unique_ptr<TestingProfileManager> profile_manager_;
};
TEST_F(DocumentScanAPIHandlerTest, SimpleScan_NoScannersAvailableError) {
SimpleScanFuture future;
document_scan_api_handler_->SimpleScan(extension_, {"image/png"},
future.GetCallback());
const auto& [scan_results, error] = future.Get();
EXPECT_FALSE(scan_results.has_value());
EXPECT_EQ("No scanners available", error);
}
TEST_F(DocumentScanAPIHandlerTest, SimpleScan_MissingMimeTypesError) {
SimpleScanFuture future;
document_scan_api_handler_->SimpleScan(extension_, {}, future.GetCallback());
const auto& [scan_results, error] = future.Get();
EXPECT_FALSE(scan_results.has_value());
EXPECT_EQ("Unsupported MIME types", error);
}
TEST_F(DocumentScanAPIHandlerTest, SimpleScan_UnsupportedMimeTypesError) {
SimpleScanFuture future;
document_scan_api_handler_->SimpleScan(extension_, {"image/tiff"},
future.GetCallback());
const auto& [scan_results, error] = future.Get();
EXPECT_FALSE(scan_results.has_value());
EXPECT_EQ("Unsupported MIME types", error);
}
TEST_F(DocumentScanAPIHandlerTest, SimpleScan_OpenFails) {
auto scanner_info = CreateTestScannerInfo();
auto open_response = crosapi::mojom::OpenScannerResponse::New();
open_response->scanner_id = scanner_info->id;
open_response->result = crosapi::mojom::ScannerOperationResult::kDeviceBusy;
// A scanner is returned in the list, but it can't be opened.
GetDocumentScan().AddScanner(std::move(scanner_info));
GetDocumentScan().SetOpenScannerResponse(open_response->scanner_id,
std::move(open_response));
SimpleScanFuture future;
document_scan_api_handler_->SimpleScan(extension_, {"image/png"},
future.GetCallback());
const auto& [scan_results, error] = future.Get();
EXPECT_FALSE(scan_results.has_value());
EXPECT_EQ("No scanners available", error);
}
TEST_F(DocumentScanAPIHandlerTest, SimpleScan_StartScanFails) {
auto scanner_info = CreateTestScannerInfo();
auto scan_response = crosapi::mojom::StartPreparedScanResponse::New();
scan_response->result = crosapi::mojom::ScannerOperationResult::kIoError;
GetDocumentScan().SetStartPreparedScanResponse(scanner_info->id,
std::move(scan_response));
GetDocumentScan().AddScanner(std::move(scanner_info));
SimpleScanFuture future;
document_scan_api_handler_->SimpleScan(extension_, {"image/png"},
future.GetCallback());
const auto& [scan_results, error] = future.Get();
EXPECT_FALSE(scan_results.has_value());
EXPECT_EQ("Failed to scan image", error);
}
TEST_F(DocumentScanAPIHandlerTest, SimpleScan_ScanImageError) {
GetDocumentScan().AddScanner(CreateTestScannerInfo());
GetDocumentScan().SetReadScanDataResponses(
std::nullopt, crosapi::mojom::ScannerOperationResult::kIoError);
SimpleScanFuture future;
document_scan_api_handler_->SimpleScan(extension_, {"image/png"},
future.GetCallback());
const auto& [scan_results, error] = future.Get();
EXPECT_FALSE(scan_results.has_value());
EXPECT_EQ("Failed to scan image", error);
}
TEST_F(DocumentScanAPIHandlerTest, SimpleScan_Success) {
GetDocumentScan().AddScanner(CreateTestScannerInfo());
const std::string data = kScanDataItem;
const std::vector<std::string> scan_data = {"", data.substr(0, 5),
data.substr(5)};
GetDocumentScan().SetReadScanDataResponses(
scan_data, crosapi::mojom::ScannerOperationResult::kEndOfData);
SimpleScanFuture future;
document_scan_api_handler_->SimpleScan(extension_, {"image/png"},
future.GetCallback());
const auto& [scan_results, error] = future.Get();
EXPECT_FALSE(error.has_value());
ASSERT_TRUE(scan_results.has_value());
// Verify the image data URL is the PNG image data URL prefix plus the base64
// representation of "PrettyPicture".
EXPECT_THAT(scan_results->data_urls,
testing::ElementsAre(kScanDataItemBase64));
EXPECT_EQ("image/png", scan_results->mime_type);
}
TEST_F(DocumentScanAPIHandlerTest, SimpleScan_TestingMIMETypeError) {
GetDocumentScan().AddScanner(CreateTestScannerInfo());
SimpleScanFuture future;
document_scan_api_handler_->SimpleScan(extension_, {"testing"},
future.GetCallback());
const auto& [scan_results, error] = future.Get();
EXPECT_FALSE(scan_results.has_value());
EXPECT_EQ("Virtual USB printer unavailable", error);
}
TEST_F(DocumentScanAPIHandlerTest, SimpleScan_TestingMIMETypeSuccess) {
GetDocumentScan().AddScanner(CreateTestScannerInfo());
auto test_scanner = CreateTestScannerInfo();
test_scanner->id = kVirtualUSBPrinterName;
test_scanner->display_name = kVirtualUSBPrinterName;
GetDocumentScan().AddScanner(std::move(test_scanner));
const std::vector<std::string> scan_data = {kScanDataItem};
GetDocumentScan().SetReadScanDataResponses(
scan_data, crosapi::mojom::ScannerOperationResult::kEndOfData);
SimpleScanFuture future;
document_scan_api_handler_->SimpleScan(extension_, {"image/png", "testing"},
future.GetCallback());
const auto& [scan_results, error] = future.Get();
EXPECT_FALSE(error.has_value());
ASSERT_TRUE(scan_results.has_value());
// Verify the image data URL is the PNG image data URL prefix plus the base64
// representation of "PrettyPicture".
EXPECT_THAT(scan_results->data_urls,
testing::ElementsAre(kScanDataItemBase64));
EXPECT_EQ("image/png", scan_results->mime_type);
}
TEST_F(DocumentScanAPIHandlerTest, GetScannerList_DiscoveryDenied) {
GetDocumentScan().AddScanner(CreateTestScannerInfo());
ScannerDiscoveryRunner::SetDiscoveryConfirmationResultForTesting(false);
api::document_scan::DeviceFilter filter;
GetScannerListFuture future;
document_scan_api_handler_->GetScannerList(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
std::move(filter), future.GetCallback());
const api::document_scan::GetScannerListResponse& response = future.Get();
EXPECT_EQ(response.result,
api::document_scan::OperationResult::kAccessDenied);
EXPECT_EQ(response.scanners.size(), 0U);
}
TEST_F(DocumentScanAPIHandlerTest, GetScannerList_DiscoveryApproved) {
GetDocumentScan().AddScanner(CreateTestScannerInfo());
ScannerDiscoveryRunner::SetDiscoveryConfirmationResultForTesting(true);
api::document_scan::DeviceFilter filter;
GetScannerListFuture future;
document_scan_api_handler_->GetScannerList(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
std::move(filter), future.GetCallback());
const api::document_scan::GetScannerListResponse& response = future.Get();
EXPECT_EQ(response.result, api::document_scan::OperationResult::kSuccess);
ASSERT_EQ(response.scanners.size(), 1U);
EXPECT_EQ(response.scanners[0].model, "Scanner");
}
TEST_F(DocumentScanAPIHandlerTest, GetScannerList_DiscoveryTrusted) {
GetDocumentScan().AddScanner(CreateTestScannerInfo());
MarkExtensionTrusted(kExtensionId);
// Confirmation will be denied, but it won't matter because the extension is
// trusted.
ScannerDiscoveryRunner::SetDiscoveryConfirmationResultForTesting(false);
api::document_scan::DeviceFilter filter;
GetScannerListFuture future;
document_scan_api_handler_->GetScannerList(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
std::move(filter), future.GetCallback());
const api::document_scan::GetScannerListResponse& response = future.Get();
EXPECT_EQ(response.result, api::document_scan::OperationResult::kSuccess);
ASSERT_EQ(response.scanners.size(), 1U);
EXPECT_EQ(response.scanners[0].model, "Scanner");
}
TEST_F(DocumentScanAPIHandlerTest,
GetScannerList_MultipleDiscoveryPreservesApproval) {
GetDocumentScan().AddScanner(CreateTestScannerInfo());
// First request is denied.
ScannerDiscoveryRunner::SetDiscoveryConfirmationResultForTesting(false);
api::document_scan::DeviceFilter filter;
GetScannerListFuture future1;
document_scan_api_handler_->GetScannerList(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
std::move(filter), future1.GetCallback());
const api::document_scan::GetScannerListResponse& response1 = future1.Get();
EXPECT_EQ(response1.result,
api::document_scan::OperationResult::kAccessDenied);
EXPECT_EQ(response1.scanners.size(), 0U);
// Second request is approved by the user.
ScannerDiscoveryRunner::SetDiscoveryConfirmationResultForTesting(true);
GetScannerListFuture future2;
document_scan_api_handler_->GetScannerList(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
std::move(filter), future2.GetCallback());
const api::document_scan::GetScannerListResponse& response2 = future2.Get();
EXPECT_EQ(response2.result, api::document_scan::OperationResult::kSuccess);
ASSERT_EQ(response2.scanners.size(), 1U);
EXPECT_EQ(response2.scanners[0].model, "Scanner");
// After approval, user-initiated request is approved without showing the
// dialog.
ScannerDiscoveryRunner::SetDiscoveryConfirmationResultForTesting(false);
GetScannerListFuture future3;
document_scan_api_handler_->GetScannerList(
/*native_window=*/nullptr, extension_, /*user_gesture=*/true,
std::move(filter), future3.GetCallback());
const api::document_scan::GetScannerListResponse& response3 = future3.Get();
EXPECT_EQ(response3.result, api::document_scan::OperationResult::kSuccess);
ASSERT_EQ(response3.scanners.size(), 1U);
EXPECT_EQ(response3.scanners[0].model, "Scanner");
// Unsolicited request is denied in spite of previous approval.
ScannerDiscoveryRunner::SetDiscoveryConfirmationResultForTesting(false);
GetScannerListFuture future4;
document_scan_api_handler_->GetScannerList(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
std::move(filter), future4.GetCallback());
const api::document_scan::GetScannerListResponse& response4 = future4.Get();
EXPECT_EQ(response4.result,
api::document_scan::OperationResult::kAccessDenied);
EXPECT_EQ(response4.scanners.size(), 0U);
// User-initiated request is no longer automatically approved because of
// previous denial.
ScannerDiscoveryRunner::SetDiscoveryConfirmationResultForTesting(false);
GetScannerListFuture future5;
document_scan_api_handler_->GetScannerList(
/*native_window=*/nullptr, extension_, /*user_gesture=*/true,
std::move(filter), future5.GetCallback());
const api::document_scan::GetScannerListResponse& response5 = future5.Get();
EXPECT_EQ(response5.result,
api::document_scan::OperationResult::kAccessDenied);
EXPECT_EQ(response5.scanners.size(), 0U);
}
TEST_F(DocumentScanAPIHandlerTest, GetScannerList_ApprovalFollowsExtension) {
GetDocumentScan().AddScanner(CreateTestScannerInfo());
auto extension2 = ExtensionBuilder("extension2")
.SetID("extension2id")
.AddAPIPermission(kExtensionPermissionName)
.Build();
// First request is approved by the user.
ScannerDiscoveryRunner::SetDiscoveryConfirmationResultForTesting(true);
api::document_scan::DeviceFilter filter;
GetScannerListFuture future1;
document_scan_api_handler_->GetScannerList(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
std::move(filter), future1.GetCallback());
const api::document_scan::GetScannerListResponse& response1 = future1.Get();
EXPECT_EQ(response1.result, api::document_scan::OperationResult::kSuccess);
ASSERT_EQ(response1.scanners.size(), 1U);
EXPECT_EQ(response1.scanners[0].model, "Scanner");
// First extension's saved approval doesn't apply to second extension.
ScannerDiscoveryRunner::SetDiscoveryConfirmationResultForTesting(false);
GetScannerListFuture future2;
document_scan_api_handler_->GetScannerList(
/*native_window=*/nullptr, extension2, /*user_gesture=*/true,
std::move(filter), future2.GetCallback());
const api::document_scan::GetScannerListResponse& response2 = future2.Get();
EXPECT_EQ(response2.result,
api::document_scan::OperationResult::kAccessDenied);
EXPECT_EQ(response2.scanners.size(), 0U);
// First extension's second request uses saved approval.
ScannerDiscoveryRunner::SetDiscoveryConfirmationResultForTesting(false);
GetScannerListFuture future3;
document_scan_api_handler_->GetScannerList(
/*native_window=*/nullptr, extension_, /*user_gesture=*/true,
std::move(filter), future3.GetCallback());
const api::document_scan::GetScannerListResponse& response3 = future3.Get();
EXPECT_EQ(response3.result, api::document_scan::OperationResult::kSuccess);
ASSERT_EQ(response3.scanners.size(), 1U);
EXPECT_EQ(response3.scanners[0].model, "Scanner");
}
TEST_F(DocumentScanAPIHandlerTest, GetScannerList_SameIdBetweenCalls) {
GetDocumentScan().AddScanner(CreateTestScannerInfo());
MarkExtensionTrusted(kExtensionId);
api::document_scan::DeviceFilter filter1;
GetScannerListFuture future1;
document_scan_api_handler_->GetScannerList(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
std::move(filter1), future1.GetCallback());
// Since the DocumentScanAsh service hasn't changed, the same ID should come
// back for the same device.
api::document_scan::DeviceFilter filter2;
GetScannerListFuture future2;
document_scan_api_handler_->GetScannerList(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
std::move(filter2), future2.GetCallback());
const api::document_scan::GetScannerListResponse& response1 = future1.Get();
const api::document_scan::GetScannerListResponse& response2 = future2.Get();
EXPECT_EQ(response1.result, api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response1.result, api::document_scan::OperationResult::kSuccess);
ASSERT_EQ(response1.scanners.size(), 1U);
ASSERT_EQ(response2.scanners.size(), 1U);
EXPECT_EQ(response1.scanners[0].scanner_id, response2.scanners[0].scanner_id);
}
TEST_F(DocumentScanAPIHandlerTest, OpenScanner_OpenBeforeListFails) {
OpenScannerFuture future;
document_scan_api_handler_->OpenScanner(extension_, "badscanner",
future.GetCallback());
const api::document_scan::OpenScannerResponse& response = future.Get();
EXPECT_EQ(response.scanner_id, "badscanner");
EXPECT_EQ(response.result, api::document_scan::OperationResult::kInvalid);
EXPECT_FALSE(response.scanner_handle.has_value());
EXPECT_FALSE(response.options.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, OpenScanner_OpenInvalidFails) {
std::string scanner_id = CreateScannerIdForExtension(extension_);
ASSERT_FALSE(scanner_id.empty());
// The extension got back a valid ID, but tries to open a different one.
OpenScannerFuture future;
std::string bad_id = scanner_id + "_invalid";
document_scan_api_handler_->OpenScanner(extension_, bad_id,
future.GetCallback());
const api::document_scan::OpenScannerResponse& response = future.Get();
EXPECT_EQ(response.scanner_id, bad_id);
EXPECT_EQ(response.result, api::document_scan::OperationResult::kInvalid);
EXPECT_FALSE(response.scanner_handle.has_value());
EXPECT_FALSE(response.options.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, OpenScanner_ReopenValidIdSucceeds) {
std::string scanner_id = CreateScannerIdForExtension(extension_);
ASSERT_FALSE(scanner_id.empty());
// The first open succeeds because the scanner is not open.
OpenScannerFuture future1;
document_scan_api_handler_->OpenScanner(extension_, scanner_id,
future1.GetCallback());
const api::document_scan::OpenScannerResponse& response1 = future1.Get();
// The second open succeeds because this is the same extension.
OpenScannerFuture future2;
document_scan_api_handler_->OpenScanner(extension_, scanner_id,
future2.GetCallback());
const api::document_scan::OpenScannerResponse& response2 = future2.Get();
EXPECT_EQ(response1.scanner_id, scanner_id);
EXPECT_EQ(response1.result, api::document_scan::OperationResult::kSuccess);
ASSERT_TRUE(response1.scanner_handle.has_value());
EXPECT_FALSE(response1.scanner_handle->empty());
ASSERT_TRUE(response1.options.has_value());
EXPECT_TRUE(response1.options->additional_properties.contains("option1"));
EXPECT_EQ(response2.scanner_id, scanner_id);
EXPECT_EQ(response2.result, api::document_scan::OperationResult::kSuccess);
ASSERT_TRUE(response2.scanner_handle.has_value());
EXPECT_FALSE(response2.scanner_handle->empty());
ASSERT_TRUE(response2.options.has_value());
EXPECT_TRUE(response2.options->additional_properties.contains("option1"));
}
TEST_F(DocumentScanAPIHandlerTest, OpenScanner_ReopenSameScannerSucceeds) {
std::string scanner_id = CreateScannerIdForExtension(extension_,
/*unique_id=*/false);
ASSERT_FALSE(scanner_id.empty());
// The first open succeeds because the scanner is not open.
OpenScannerFuture future1;
document_scan_api_handler_->OpenScanner(extension_, scanner_id,
future1.GetCallback());
const api::document_scan::OpenScannerResponse& response1 = future1.Get();
// GetScannerList returns a new token that points to the same underlying
// scanner created by CreateScannerId above.
std::string scanner_id2 = CreateScannerIdForExtension(extension_,
/*unique_id=*/false);
ASSERT_FALSE(scanner_id2.empty());
// Opening the second ID succeeds because this is the same extension.
OpenScannerFuture future2;
document_scan_api_handler_->OpenScanner(extension_, scanner_id2,
future2.GetCallback());
const api::document_scan::OpenScannerResponse& response2 = future2.Get();
EXPECT_EQ(response1.scanner_id, scanner_id);
EXPECT_EQ(response1.result, api::document_scan::OperationResult::kSuccess);
ASSERT_TRUE(response1.scanner_handle.has_value());
EXPECT_FALSE(response1.scanner_handle->empty());
ASSERT_TRUE(response1.options.has_value());
EXPECT_TRUE(response1.options->additional_properties.contains("option1"));
EXPECT_EQ(response2.scanner_id, scanner_id2);
EXPECT_EQ(response2.result, api::document_scan::OperationResult::kSuccess);
ASSERT_TRUE(response2.scanner_handle.has_value());
EXPECT_FALSE(response2.scanner_handle->empty());
ASSERT_TRUE(response2.options.has_value());
EXPECT_TRUE(response2.options->additional_properties.contains("option1"));
}
TEST_F(DocumentScanAPIHandlerTest, OpenScanner_SecondExtensionOpenFails) {
std::string scanner_id = CreateScannerIdForExtension(extension_,
/*unique_id=*/false);
ASSERT_FALSE(scanner_id.empty());
// The first open succeeds because the scanner is not open.
OpenScannerFuture open_future1;
document_scan_api_handler_->OpenScanner(extension_, scanner_id,
open_future1.GetCallback());
const api::document_scan::OpenScannerResponse& open_response1 =
open_future1.Get();
// Get a new token for the second extension that points to the same underlying
// scanner created by CreateScannerId above.
auto extension2 = ExtensionBuilder("extension2")
.SetID("extension2id")
.AddAPIPermission(kExtensionPermissionName)
.Build();
std::string scanner_id2 = CreateScannerIdForExtension(extension2,
/*unique_id=*/false);
ASSERT_FALSE(scanner_id2.empty());
// Opening the same scanner from a second extension fails because the scanner
// is already open.
OpenScannerFuture open_future2;
document_scan_api_handler_->OpenScanner(extension2, scanner_id2,
open_future2.GetCallback());
const api::document_scan::OpenScannerResponse& open_response2 =
open_future2.Get();
EXPECT_EQ(open_response1.scanner_id, scanner_id);
EXPECT_EQ(open_response1.result,
api::document_scan::OperationResult::kSuccess);
ASSERT_TRUE(open_response1.scanner_handle.has_value());
EXPECT_FALSE(open_response1.scanner_handle->empty());
ASSERT_TRUE(open_response1.options.has_value());
EXPECT_TRUE(
open_response1.options->additional_properties.contains("option1"));
EXPECT_EQ(open_response2.scanner_id, scanner_id2);
EXPECT_EQ(open_response2.result,
api::document_scan::OperationResult::kDeviceBusy);
EXPECT_FALSE(open_response2.scanner_handle.has_value());
EXPECT_FALSE(open_response2.options.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, OpenScanner_SecondOpenClosesFirstHandle) {
const std::string scanner_id = CreateScannerIdForExtension(extension_);
ASSERT_FALSE(scanner_id.empty());
// The first open succeeds because the scanner is not open.
OpenScannerFuture future1;
document_scan_api_handler_->OpenScanner(extension_, scanner_id,
future1.GetCallback());
const api::document_scan::OpenScannerResponse& response1 = future1.Get();
EXPECT_EQ(response1.scanner_id, scanner_id);
EXPECT_EQ(response1.result, api::document_scan::OperationResult::kSuccess);
ASSERT_TRUE(response1.scanner_handle.has_value());
EXPECT_FALSE(response1.scanner_handle->empty());
ASSERT_TRUE(response1.options.has_value());
EXPECT_TRUE(response1.options->additional_properties.contains("option1"));
// First GetOptionGroups succeeds because the scanner is open.
GetOptionGroupsFuture options_future1;
document_scan_api_handler_->GetOptionGroups(
extension_, *response1.scanner_handle, options_future1.GetCallback());
const api::document_scan::GetOptionGroupsResponse& options_response1 =
options_future1.Get();
EXPECT_EQ(options_response1.result,
api::document_scan::OperationResult::kSuccess);
EXPECT_TRUE(options_response1.groups.has_value());
// The second open succeeds because this is the same extension. This
// implicitly closes the first handle.
OpenScannerFuture future2;
document_scan_api_handler_->OpenScanner(extension_, scanner_id,
future2.GetCallback());
const api::document_scan::OpenScannerResponse& response2 = future2.Get();
EXPECT_EQ(response2.scanner_id, scanner_id);
EXPECT_EQ(response2.result, api::document_scan::OperationResult::kSuccess);
ASSERT_TRUE(response2.scanner_handle.has_value());
EXPECT_FALSE(response2.scanner_handle->empty());
ASSERT_TRUE(response2.options.has_value());
EXPECT_TRUE(response2.options->additional_properties.contains("option1"));
// Second GetOptionGroups for the original handle fails because the handle is
// now invalid.
GetOptionGroupsFuture options_future2;
document_scan_api_handler_->GetOptionGroups(
extension_, *response1.scanner_handle, options_future2.GetCallback());
const api::document_scan::GetOptionGroupsResponse& options_response2 =
options_future2.Get();
EXPECT_NE(options_response2.result,
api::document_scan::OperationResult::kSuccess);
EXPECT_FALSE(options_response2.groups.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, GetOptionGroups_NoScanner) {
GetOptionGroupsFuture future;
document_scan_api_handler_->GetOptionGroups(extension_, "badscanner",
future.GetCallback());
const api::document_scan::GetOptionGroupsResponse& response = future.Get();
EXPECT_EQ(response.scanner_handle, "badscanner");
EXPECT_EQ(response.result, api::document_scan::OperationResult::kInvalid);
EXPECT_FALSE(response.groups.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, GetOptionGroups_ValidScanner) {
std::string scanner_handle = OpenScannerForExtension(extension_);
EXPECT_FALSE(scanner_handle.empty());
GetOptionGroupsFuture future;
document_scan_api_handler_->GetOptionGroups(extension_, scanner_handle,
future.GetCallback());
const api::document_scan::GetOptionGroupsResponse& response = future.Get();
EXPECT_EQ(response.scanner_handle, scanner_handle);
EXPECT_EQ(response.result, api::document_scan::OperationResult::kSuccess);
ASSERT_TRUE(response.groups.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, CloseScanner_CloseBeforeOpenFails) {
CloseScannerFuture future;
document_scan_api_handler_->CloseScanner(extension_, "badscanner",
future.GetCallback());
const api::document_scan::CloseScannerResponse& response = future.Get();
EXPECT_EQ(response.scanner_handle, "badscanner");
EXPECT_EQ(response.result, api::document_scan::OperationResult::kInvalid);
}
TEST_F(DocumentScanAPIHandlerTest, CloseScanner_CloseInvalidHandleFails) {
std::string scanner_id = CreateScannerIdForExtension(extension_);
ASSERT_FALSE(scanner_id.empty());
OpenScannerFuture open_future;
document_scan_api_handler_->OpenScanner(extension_, scanner_id,
open_future.GetCallback());
const api::document_scan::OpenScannerResponse& open_response =
open_future.Get();
ASSERT_TRUE(open_response.scanner_handle.has_value());
const std::string& handle = open_response.scanner_handle.value();
// Closing a valid handle from a different extension fails because it isn't
// valid for the second extension.
auto extension2 = ExtensionBuilder("extension2")
.SetID("extension2id")
.AddAPIPermission(kExtensionPermissionName)
.Build();
CloseScannerFuture close_future1;
document_scan_api_handler_->CloseScanner(extension2, handle,
close_future1.GetCallback());
const api::document_scan::CloseScannerResponse& close_response1 =
close_future1.Get();
EXPECT_EQ(close_response1.scanner_handle, handle);
EXPECT_EQ(close_response1.result,
api::document_scan::OperationResult::kInvalid);
// Closing the handle from the original extension still succeeds.
CloseScannerFuture close_future2;
document_scan_api_handler_->CloseScanner(extension_, handle,
close_future2.GetCallback());
const api::document_scan::CloseScannerResponse& close_response2 =
close_future2.Get();
EXPECT_EQ(close_response2.scanner_handle, handle);
EXPECT_EQ(close_response2.result,
api::document_scan::OperationResult::kSuccess);
}
TEST_F(DocumentScanAPIHandlerTest, CloseScanner_DoubleCloseHandleFails) {
std::string scanner_id = CreateScannerIdForExtension(extension_);
ASSERT_FALSE(scanner_id.empty());
OpenScannerFuture open_future;
document_scan_api_handler_->OpenScanner(extension_, scanner_id,
open_future.GetCallback());
const api::document_scan::OpenScannerResponse& open_response =
open_future.Get();
ASSERT_TRUE(open_response.scanner_handle.has_value());
const std::string& handle = open_response.scanner_handle.value();
// First call succeeds because the handle is valid.
CloseScannerFuture close_future1;
document_scan_api_handler_->CloseScanner(extension_, handle,
close_future1.GetCallback());
const api::document_scan::CloseScannerResponse& close_response1 =
close_future1.Get();
EXPECT_EQ(close_response1.scanner_handle, handle);
EXPECT_EQ(close_response1.result,
api::document_scan::OperationResult::kSuccess);
// Closing the same handle again fails.
CloseScannerFuture close_future2;
document_scan_api_handler_->CloseScanner(extension_, handle,
close_future2.GetCallback());
const api::document_scan::CloseScannerResponse& close_response2 =
close_future2.Get();
EXPECT_EQ(close_response2.scanner_handle, handle);
EXPECT_EQ(close_response2.result,
api::document_scan::OperationResult::kInvalid);
}
TEST_F(DocumentScanAPIHandlerTest, SetOptions_SetBeforeOpenFails) {
SetOptionsFuture future;
document_scan_api_handler_->SetOptions(
extension_, "badscanner",
CreateTestOptionSettingList(2, api::document_scan::OptionType::kInt),
future.GetCallback());
const api::document_scan::SetOptionsResponse& response = future.Get();
EXPECT_EQ(response.scanner_handle, "badscanner");
ASSERT_EQ(response.results.size(), 2U);
for (const auto& result : response.results) {
EXPECT_EQ(result.result, api::document_scan::OperationResult::kInvalid);
}
EXPECT_FALSE(response.options.has_value());
}
// Tests the special mappings for TYPE_FIXED options. Also indirectly tests
// getting back multiple results and an updated set of options.
TEST_F(DocumentScanAPIHandlerTest, SetOptions_FixedTypeMappings) {
std::string scanner_id = CreateScannerIdForExtension(extension_);
ASSERT_FALSE(scanner_id.empty());
OpenScannerFuture open_future;
document_scan_api_handler_->OpenScanner(extension_, scanner_id,
open_future.GetCallback());
const api::document_scan::OpenScannerResponse& open_response =
open_future.Get();
ASSERT_TRUE(open_response.scanner_handle.has_value());
const std::string& handle = open_response.scanner_handle.value();
// FIXED containing no value: OK.
// FIXED containing one int: Mapped.
// FIXED containing int list: Mapped.
// FIXED containing string: Wrong type.
// FIXED containing one fixed: OK.
// FIXED containing fixed list with decimals: OK.
// FIXED containing fixed list without decimals: OK.
auto settings =
CreateTestOptionSettingList(7, api::document_scan::OptionType::kFixed);
// settings[0] has no value.
settings[1].value.emplace();
settings[1].value->as_integer = 3;
settings[2].value.emplace();
settings[2].value->as_integers = {3, 5};
settings[3].value.emplace();
settings[3].value->as_string = "oops";
settings[4].value.emplace();
settings[4].value->as_number = 2.5;
settings[5].value.emplace();
settings[5].value->as_numbers = {2.5, -1.25};
settings[6].value.emplace();
settings[6].value->as_numbers = {2.0, -1.0};
SetOptionsFuture future;
document_scan_api_handler_->SetOptions(
extension_, handle, std::move(settings), future.GetCallback());
const api::document_scan::SetOptionsResponse& response = future.Get();
EXPECT_EQ(response.scanner_handle, handle);
ASSERT_EQ(response.results.size(), 7U);
EXPECT_EQ(response.results[0].result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.results[1].result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.results[2].result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.results[3].result,
api::document_scan::OperationResult::kWrongType);
EXPECT_EQ(response.results[4].result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.results[5].result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.results[6].result,
api::document_scan::OperationResult::kSuccess);
// Verify that all supplied options are present, but assume the option value
// conversions have already been tested by the TypeConverter unit tests.
ASSERT_TRUE(response.options.has_value());
for (size_t i = 1; i <= 7; i++) {
EXPECT_TRUE(response.options->additional_properties.contains(
base::StringPrintf("option%zu", i)));
}
}
// Tests the special mappings for TYPE_INT options.
TEST_F(DocumentScanAPIHandlerTest, SetOptions_IntTypeMappings) {
std::string scanner_id = CreateScannerIdForExtension(extension_);
ASSERT_FALSE(scanner_id.empty());
OpenScannerFuture open_future;
document_scan_api_handler_->OpenScanner(extension_, scanner_id,
open_future.GetCallback());
const api::document_scan::OpenScannerResponse& open_response =
open_future.Get();
ASSERT_TRUE(open_response.scanner_handle.has_value());
const std::string& handle = open_response.scanner_handle.value();
// INT containing no value: OK.
// INT containing one int: OK.
// INT containing int list: OK.
// INT containing string: Wrong type.
// INT containing one fixed with no fractional part: Mapped.
// INT containing one too-large fixed with no fractional part: Wrong type.
// INT containing one too-small fixed with no fractional part: Wrong type.
// INT containing one fixed with non-zero fractional part: Wrong type.
// INT containing fixed list with no fractional part: Mapped.
// INT containing fixed list with non-zero fractional part: Wrong type.
// INT containing fixed list with mixed fractional part: Wrong type.
// INT containing fixed list with mixed too-small part: Wrong type.
// INT containing fixed list with mixed too-large part: Wrong type.
auto settings =
CreateTestOptionSettingList(13, api::document_scan::OptionType::kInt);
// settings[0] has no value.
settings[1].value.emplace();
settings[1].value->as_integer = 3;
settings[2].value.emplace();
settings[2].value->as_integers = {3, 5};
settings[3].value.emplace();
settings[3].value->as_string = "oops";
settings[4].value.emplace();
settings[4].value->as_number = 2.0;
settings[5].value.emplace();
settings[5].value->as_number = 1e300;
settings[6].value.emplace();
settings[6].value->as_number = -1e300;
settings[7].value.emplace();
settings[7].value->as_number = 2.5;
settings[8].value.emplace();
settings[8].value->as_numbers = {2.0, -1.0};
settings[9].value.emplace();
settings[9].value->as_numbers = {2.5, -1.25};
settings[10].value.emplace();
settings[10].value->as_numbers = {4.0, -1.25};
settings[11].value.emplace();
settings[11].value->as_numbers = {4.0, -1e300};
settings[12].value.emplace();
settings[12].value->as_numbers = {4.0, 1e300};
SetOptionsFuture future;
document_scan_api_handler_->SetOptions(
extension_, handle, std::move(settings), future.GetCallback());
const api::document_scan::SetOptionsResponse& response = future.Get();
EXPECT_EQ(response.scanner_handle, handle);
ASSERT_EQ(response.results.size(), 13U);
EXPECT_EQ(response.results[0].result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.results[1].result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.results[2].result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.results[3].result,
api::document_scan::OperationResult::kWrongType);
EXPECT_EQ(response.results[4].result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.results[5].result,
api::document_scan::OperationResult::kWrongType);
EXPECT_EQ(response.results[6].result,
api::document_scan::OperationResult::kWrongType);
EXPECT_EQ(response.results[7].result,
api::document_scan::OperationResult::kWrongType);
EXPECT_EQ(response.results[8].result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.results[9].result,
api::document_scan::OperationResult::kWrongType);
EXPECT_EQ(response.results[10].result,
api::document_scan::OperationResult::kWrongType);
EXPECT_EQ(response.results[11].result,
api::document_scan::OperationResult::kWrongType);
EXPECT_EQ(response.results[12].result,
api::document_scan::OperationResult::kWrongType);
// Verify that all supplied options are present, but assume the option value
// conversions have already been tested by the TypeConverter unit tests.
ASSERT_TRUE(response.options.has_value());
for (size_t i = 1; i <= 13; i++) {
EXPECT_TRUE(response.options->additional_properties.contains(
base::StringPrintf("option%zu", i)));
}
}
TEST_F(DocumentScanAPIHandlerTest, SetOptions_BoolTypeMappings) {
std::string scanner_id = CreateScannerIdForExtension(extension_);
ASSERT_FALSE(scanner_id.empty());
OpenScannerFuture open_future;
document_scan_api_handler_->OpenScanner(extension_, scanner_id,
open_future.GetCallback());
const api::document_scan::OpenScannerResponse& open_response =
open_future.Get();
ASSERT_TRUE(open_response.scanner_handle.has_value());
const std::string& handle = open_response.scanner_handle.value();
// BOOL containing no value: OK.
// BOOL containing boolean: OK.
// BOOL containing string: Wrong type.
// BOOL containing int: Wrong type.
// BOOL containing fixed: Wrong type.
// BOOL containing int list: Wrong type.
// BOOL containing fixed list: Wrong type.
auto settings =
CreateTestOptionSettingList(7, api::document_scan::OptionType::kBool);
// settings[0] has no value.
settings[1].value.emplace();
settings[1].value->as_boolean = false;
settings[2].value.emplace();
settings[2].value->as_string = "oops";
settings[3].value.emplace();
settings[3].value->as_integer = 1;
settings[4].value.emplace();
settings[4].value->as_number = 1.5;
settings[5].value.emplace();
settings[5].value->as_integers = {1, 2};
settings[6].value.emplace();
settings[6].value->as_numbers = {1.5, 2.5};
SetOptionsFuture future;
document_scan_api_handler_->SetOptions(
extension_, handle, std::move(settings), future.GetCallback());
const api::document_scan::SetOptionsResponse& response = future.Get();
EXPECT_EQ(response.scanner_handle, handle);
ASSERT_EQ(response.results.size(), 7U);
EXPECT_EQ(response.results[0].result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.results[1].result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.results[2].result,
api::document_scan::OperationResult::kWrongType);
EXPECT_EQ(response.results[3].result,
api::document_scan::OperationResult::kWrongType);
EXPECT_EQ(response.results[4].result,
api::document_scan::OperationResult::kWrongType);
EXPECT_EQ(response.results[5].result,
api::document_scan::OperationResult::kWrongType);
EXPECT_EQ(response.results[6].result,
api::document_scan::OperationResult::kWrongType);
// Verify that all supplied options are present, but assume the option value
// conversions have already been tested by the TypeConverter unit tests.
ASSERT_TRUE(response.options.has_value());
for (size_t i = 1; i <= 7; i++) {
EXPECT_TRUE(response.options->additional_properties.contains(
base::StringPrintf("option%zu", i)));
}
}
TEST_F(DocumentScanAPIHandlerTest, SetOptions_StringTypeMappings) {
std::string scanner_id = CreateScannerIdForExtension(extension_);
ASSERT_FALSE(scanner_id.empty());
OpenScannerFuture open_future;
document_scan_api_handler_->OpenScanner(extension_, scanner_id,
open_future.GetCallback());
const api::document_scan::OpenScannerResponse& open_response =
open_future.Get();
ASSERT_TRUE(open_response.scanner_handle.has_value());
const std::string& handle = open_response.scanner_handle.value();
// STRING containing no value: OK.
// STRING containing string: OK.
// STRING containing boolean: Wrong type.
// STRING containing int: Wrong type.
// STRING containing fixed: Wrong type.
// STRING containing int list: Wrong type.
// STRING containing fixed list: Wrong type.
auto settings =
CreateTestOptionSettingList(7, api::document_scan::OptionType::kString);
// settings[0] has no value.
settings[1].value.emplace();
settings[1].value->as_string = "string";
settings[2].value.emplace();
settings[2].value->as_boolean = true;
settings[3].value.emplace();
settings[3].value->as_integer = 1;
settings[4].value.emplace();
settings[4].value->as_number = 1.5;
settings[5].value.emplace();
settings[5].value->as_integers = {1, 2};
settings[6].value.emplace();
settings[6].value->as_numbers = {1.5, 2.5};
SetOptionsFuture future;
document_scan_api_handler_->SetOptions(
extension_, handle, std::move(settings), future.GetCallback());
const api::document_scan::SetOptionsResponse& response = future.Get();
EXPECT_EQ(response.scanner_handle, handle);
ASSERT_EQ(response.results.size(), 7U);
EXPECT_EQ(response.results[0].result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.results[1].result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.results[2].result,
api::document_scan::OperationResult::kWrongType);
EXPECT_EQ(response.results[3].result,
api::document_scan::OperationResult::kWrongType);
EXPECT_EQ(response.results[4].result,
api::document_scan::OperationResult::kWrongType);
EXPECT_EQ(response.results[5].result,
api::document_scan::OperationResult::kWrongType);
EXPECT_EQ(response.results[6].result,
api::document_scan::OperationResult::kWrongType);
// Verify that all supplied options are present, but assume the option value
// conversions have already been tested by the TypeConverter unit tests.
ASSERT_TRUE(response.options.has_value());
for (size_t i = 1; i <= 7; i++) {
EXPECT_TRUE(response.options->additional_properties.contains(
base::StringPrintf("option%zu", i)));
}
}
TEST_F(DocumentScanAPIHandlerTest, StartScan_PermissionDenied) {
// There is a check for a valid scanner handle even before the permissions
// check, so even though this test will simulate a deny permission, there has
// to be a valid scanner.
std::string scanner_handle = OpenScannerForExtension(extension_);
EXPECT_FALSE(scanner_handle.empty());
base::AutoReset<std::optional<bool>> testing_scope =
StartScanRunner::SetStartScanConfirmationResultForTesting(false);
api::document_scan::StartScanOptions options;
StartScanFuture future;
document_scan_api_handler_->StartScan(
/*native_window=*/nullptr, extension_, /*user_gesture=*/true,
scanner_handle, std::move(options), future.GetCallback());
const api::document_scan::StartScanResponse& response = future.Get();
EXPECT_EQ(response.result,
api::document_scan::OperationResult::kAccessDenied);
EXPECT_EQ(response.scanner_handle, scanner_handle);
EXPECT_FALSE(response.job.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, StartScan_PermissionApproved) {
std::string scanner_handle = OpenScannerForExtension(extension_);
EXPECT_FALSE(scanner_handle.empty());
base::AutoReset<std::optional<bool>> testing_scope =
StartScanRunner::SetStartScanConfirmationResultForTesting(true);
api::document_scan::StartScanOptions options;
StartScanFuture future;
document_scan_api_handler_->StartScan(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
scanner_handle, std::move(options), future.GetCallback());
const api::document_scan::StartScanResponse& response = future.Get();
EXPECT_EQ(response.result, api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.scanner_handle, scanner_handle);
EXPECT_TRUE(response.job.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, StartScan_PermissionApprovedSameHandle) {
const std::string scanner_handle = OpenScannerForExtension(extension_);
EXPECT_FALSE(scanner_handle.empty());
base::AutoReset<std::optional<bool>> testing_scope =
StartScanRunner::SetStartScanConfirmationResultForTesting(true);
api::document_scan::StartScanOptions options;
StartScanFuture future;
document_scan_api_handler_->StartScan(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
scanner_handle, std::move(options), future.GetCallback());
const api::document_scan::StartScanResponse& response = future.Get();
EXPECT_EQ(response.result, api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.scanner_handle, scanner_handle);
EXPECT_TRUE(response.job.has_value());
// Set the confirmation result to false. This shouldn't matter since this
// scanner is already approved.
base::AutoReset<std::optional<bool>> testing_scope2 =
StartScanRunner::SetStartScanConfirmationResultForTesting(false);
StartScanFuture future2;
document_scan_api_handler_->StartScan(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
scanner_handle, std::move(options), future2.GetCallback());
const api::document_scan::StartScanResponse& response2 = future2.Get();
EXPECT_EQ(response2.result, api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response2.scanner_handle, scanner_handle);
EXPECT_TRUE(response2.job.has_value());
}
TEST_F(DocumentScanAPIHandlerTest,
StartScan_PermissionApprovedSameScannerNewHandle) {
const std::string scanner_id = CreateScannerIdForExtension(extension_);
const std::string scanner_handle1 = OpenScannerWithId(extension_, scanner_id);
EXPECT_FALSE(scanner_handle1.empty());
base::AutoReset<std::optional<bool>> testing_scope =
StartScanRunner::SetStartScanConfirmationResultForTesting(true);
api::document_scan::StartScanOptions options;
StartScanFuture future;
document_scan_api_handler_->StartScan(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
scanner_handle1, std::move(options), future.GetCallback());
const api::document_scan::StartScanResponse& response = future.Get();
EXPECT_EQ(response.result, api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.scanner_handle, scanner_handle1);
EXPECT_TRUE(response.job.has_value());
// New handle pointing to the same scanner.
const std::string scanner_handle2 = OpenScannerWithId(extension_, scanner_id);
EXPECT_FALSE(scanner_handle2.empty());
EXPECT_NE(scanner_handle2, scanner_handle1);
// Set the confirmation result to false. Starting subsequent scans will be
// denied unless they come from a user gesture.
base::AutoReset<std::optional<bool>> testing_scope2 =
StartScanRunner::SetStartScanConfirmationResultForTesting(false);
// Denied because the scan isn't initiated by a user gesture.
StartScanFuture future2;
document_scan_api_handler_->StartScan(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
scanner_handle2, std::move(options), future2.GetCallback());
const api::document_scan::StartScanResponse& response2 = future2.Get();
EXPECT_EQ(response2.scanner_handle, scanner_handle2);
EXPECT_NE(response2.result, api::document_scan::OperationResult::kSuccess);
EXPECT_FALSE(response2.job.has_value());
// Allowed because the same scanner was previously approved and this is a user
// gesture.
StartScanFuture future3;
document_scan_api_handler_->StartScan(
/*native_window=*/nullptr, extension_, /*user_gesture=*/true,
scanner_handle2, std::move(options), future3.GetCallback());
const api::document_scan::StartScanResponse& response3 = future3.Get();
EXPECT_EQ(response3.result, api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response3.scanner_handle, scanner_handle2);
EXPECT_TRUE(response3.job.has_value());
// Allowed without a user gesture because the previous call marked the handle
// as approved.
StartScanFuture future4;
document_scan_api_handler_->StartScan(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
scanner_handle2, std::move(options), future4.GetCallback());
const api::document_scan::StartScanResponse& response4 = future4.Get();
EXPECT_EQ(response4.result, api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response4.scanner_handle, scanner_handle2);
EXPECT_TRUE(response4.job.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, StartScan_ExtensionTrusted) {
std::string scanner_handle = OpenScannerForExtension(extension_);
EXPECT_FALSE(scanner_handle.empty());
MarkExtensionTrusted(kExtensionId);
// Confirmation will be denied, but it won't matter because the extension is
// trusted.
base::AutoReset<std::optional<bool>> testing_scope =
StartScanRunner::SetStartScanConfirmationResultForTesting(false);
api::document_scan::StartScanOptions options;
StartScanFuture future;
document_scan_api_handler_->StartScan(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
scanner_handle, std::move(options), future.GetCallback());
const api::document_scan::StartScanResponse& response = future.Get();
EXPECT_EQ(response.result, api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response.scanner_handle, scanner_handle);
EXPECT_TRUE(response.job.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, StartScan_HandleNotOpen) {
// If the scanner handle has not been opened, this will fail.
base::AutoReset<std::optional<bool>> testing_scope =
StartScanRunner::SetStartScanConfirmationResultForTesting(true);
api::document_scan::StartScanOptions options;
StartScanFuture future;
document_scan_api_handler_->StartScan(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false,
"scanner-handle", std::move(options), future.GetCallback());
const api::document_scan::StartScanResponse& response = future.Get();
EXPECT_EQ(response.result, api::document_scan::OperationResult::kInvalid);
EXPECT_EQ(response.scanner_handle, "scanner-handle");
EXPECT_FALSE(response.job.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, StartScan_HandleNotMine) {
MarkExtensionTrusted(kExtensionId);
std::string scanner_handle = OpenScannerForExtension(extension_);
EXPECT_FALSE(scanner_handle.empty());
// Trying to start a scan using extension2 will fail since that extension is
// not authorized to use the scanner handle opened for the first extension.
auto extension2 = ExtensionBuilder("extension2")
.SetID("extension2id")
.AddAPIPermission(kExtensionPermissionName)
.Build();
api::document_scan::StartScanOptions options;
StartScanFuture future;
document_scan_api_handler_->StartScan(
/*native_window=*/nullptr, extension2, /*user_gesture=*/false,
scanner_handle, std::move(options), future.GetCallback());
const api::document_scan::StartScanResponse& response = future.Get();
EXPECT_EQ(response.result, api::document_scan::OperationResult::kInvalid);
EXPECT_EQ(response.scanner_handle, scanner_handle);
EXPECT_FALSE(response.job.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, CancelScan_InvalidJob) {
// Since this job-handle is not valid, an error should get returned.
CancelScanFuture future;
document_scan_api_handler_->CancelScan(extension_, "job-handle",
future.GetCallback());
const api::document_scan::CancelScanResponse& response = future.Get();
EXPECT_EQ(response.result, api::document_scan::OperationResult::kInvalid);
EXPECT_EQ(response.job, "job-handle");
}
TEST_F(DocumentScanAPIHandlerTest, CancelScan_ValidJob) {
// Start a scan so we can get a valid job handle, and then attempt to cancel
// the scan using that job handle.
std::string job_handle = StartScanForExtension(extension_);
EXPECT_FALSE(job_handle.empty());
CancelScanFuture cancel_future;
document_scan_api_handler_->CancelScan(extension_, job_handle,
cancel_future.GetCallback());
const api::document_scan::CancelScanResponse& cancel_response =
cancel_future.Get();
EXPECT_EQ(cancel_response.result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(cancel_response.job, job_handle);
}
TEST_F(DocumentScanAPIHandlerTest, CancelScan_HandleNotMine) {
std::string job_handle = StartScanForExtension(extension_);
EXPECT_FALSE(job_handle.empty());
auto extension2 = ExtensionBuilder("extension2")
.SetID("extension2id")
.AddAPIPermission(kExtensionPermissionName)
.Build();
// Trying to cancel the scan using extension2 will fail since that extension
// is not authorized to use the job handle opened for the first extension.
CancelScanFuture cancel_future;
document_scan_api_handler_->CancelScan(extension2, job_handle,
cancel_future.GetCallback());
const api::document_scan::CancelScanResponse& cancel_response =
cancel_future.Get();
EXPECT_EQ(cancel_response.result,
api::document_scan::OperationResult::kInvalid);
EXPECT_EQ(cancel_response.job, job_handle);
}
TEST_F(DocumentScanAPIHandlerTest, CancelScan_GetListClears) {
// After a `GetScannerList`, the job handles should be cleared.
std::string job_handle = StartScanForExtension(extension_);
EXPECT_FALSE(job_handle.empty());
GetScannerListFuture list_future;
document_scan_api_handler_->GetScannerList(
/*native_window=*/nullptr, extension_, /*user_gesture=*/false, {},
list_future.GetCallback());
const api::document_scan::GetScannerListResponse& list_response =
list_future.Get();
EXPECT_EQ(list_response.result,
api::document_scan::OperationResult::kSuccess);
// This cancel should fail because the GetScannerList call cleared active
// handles.
CancelScanFuture cancel_future;
document_scan_api_handler_->CancelScan(extension_, job_handle,
cancel_future.GetCallback());
const api::document_scan::CancelScanResponse& cancel_response =
cancel_future.Get();
EXPECT_EQ(cancel_response.result,
api::document_scan::OperationResult::kInvalid);
EXPECT_EQ(cancel_response.job, job_handle);
}
TEST_F(DocumentScanAPIHandlerTest, ReadScanData_ReadBeforeStartFails) {
MarkExtensionTrusted(kExtensionId);
ReadScanDataFuture future;
document_scan_api_handler_->ReadScanData(extension_, "job-handle",
future.GetCallback());
const api::document_scan::ReadScanDataResponse& response = future.Get();
EXPECT_EQ(response.result, api::document_scan::OperationResult::kInvalid);
EXPECT_EQ(response.job, "job-handle");
EXPECT_FALSE(response.data.has_value());
EXPECT_FALSE(response.estimated_completion.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, ReadScanData_ReadFromOpenHandleSucceeds) {
MarkExtensionTrusted(kExtensionId);
std::string scanner_handle = OpenScannerForExtension(extension_);
EXPECT_FALSE(scanner_handle.empty());
std::string job_handle = StartScanForScannerHandle(
extension_, /*user_gesture=*/false, scanner_handle);
EXPECT_FALSE(job_handle.empty());
const std::vector<std::string> scan_data = {kScanDataItem, kScanDataItem, ""};
GetDocumentScan().SetReadScanDataResponses(
scan_data, crosapi::mojom::ScannerOperationResult::kEndOfData);
// First read succeeds because the job is open.
ReadScanDataFuture read_future1;
document_scan_api_handler_->ReadScanData(extension_, job_handle,
read_future1.GetCallback());
const api::document_scan::ReadScanDataResponse& read_response1 =
read_future1.Get();
EXPECT_EQ(read_response1.result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(read_response1.job, job_handle);
EXPECT_TRUE(read_response1.data.has_value());
EXPECT_TRUE(read_response1.estimated_completion.has_value());
// Second read succeeds because the job is still open.
ReadScanDataFuture read_future2;
document_scan_api_handler_->ReadScanData(extension_, job_handle,
read_future2.GetCallback());
const api::document_scan::ReadScanDataResponse& read_response2 =
read_future2.Get();
EXPECT_EQ(read_response2.result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(read_response2.job, job_handle);
EXPECT_TRUE(read_response2.data.has_value());
EXPECT_TRUE(read_response2.estimated_completion.has_value());
// Canceling the job closes the handle.
document_scan_api_handler_->CancelScan(extension_, job_handle,
base::DoNothing());
// Third read gets a cancelled status because the job is cancelled but still
// valid.
ReadScanDataFuture read_future3;
document_scan_api_handler_->ReadScanData(extension_, job_handle,
read_future3.GetCallback());
const api::document_scan::ReadScanDataResponse& read_response3 =
read_future3.Get();
EXPECT_EQ(read_response3.result,
api::document_scan::OperationResult::kCancelled);
EXPECT_EQ(read_response3.job, job_handle);
EXPECT_FALSE(read_response3.data.has_value());
EXPECT_FALSE(read_response3.estimated_completion.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, ReadScanData_ReadFromClosedScannerFails) {
MarkExtensionTrusted(kExtensionId);
std::string scanner_handle = OpenScannerForExtension(extension_);
EXPECT_FALSE(scanner_handle.empty());
std::string job_handle = StartScanForScannerHandle(
extension_, /*user_gesture=*/false, scanner_handle);
EXPECT_FALSE(job_handle.empty());
const std::vector<std::string> scan_data = {kScanDataItem, kScanDataItem, ""};
GetDocumentScan().SetReadScanDataResponses(
scan_data, crosapi::mojom::ScannerOperationResult::kEndOfData);
// First read succeeds because the job is open.
ReadScanDataFuture read_future1;
document_scan_api_handler_->ReadScanData(extension_, job_handle,
read_future1.GetCallback());
const api::document_scan::ReadScanDataResponse& read_response1 =
read_future1.Get();
EXPECT_EQ(read_response1.result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(read_response1.job, job_handle);
EXPECT_TRUE(read_response1.data.has_value());
EXPECT_TRUE(read_response1.estimated_completion.has_value());
// Closing the scanner handle also invalidates the job handle.
document_scan_api_handler_->CloseScanner(extension_, scanner_handle,
base::DoNothing());
// Second read fails because the job is no longer valid.
ReadScanDataFuture read_future2;
document_scan_api_handler_->ReadScanData(extension_, job_handle,
read_future2.GetCallback());
const api::document_scan::ReadScanDataResponse& read_response2 =
read_future2.Get();
EXPECT_NE(read_response2.result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(read_response2.job, job_handle);
EXPECT_FALSE(read_response2.data.has_value());
EXPECT_FALSE(read_response2.estimated_completion.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, ReadScanData_ReadFromReopenedScannerFails) {
MarkExtensionTrusted(kExtensionId);
const std::string scanner_id = CreateScannerIdForExtension(extension_);
ASSERT_FALSE(scanner_id.empty());
const std::vector<std::string> scan_data = {kScanDataItem, kScanDataItem, ""};
GetDocumentScan().SetReadScanDataResponses(
scan_data, crosapi::mojom::ScannerOperationResult::kEndOfData);
// The first open succeeds because the scanner is not open.
OpenScannerFuture open_future1;
document_scan_api_handler_->OpenScanner(extension_, scanner_id,
open_future1.GetCallback());
const api::document_scan::OpenScannerResponse& open_response1 =
open_future1.Get();
EXPECT_EQ(open_response1.result,
api::document_scan::OperationResult::kSuccess);
ASSERT_TRUE(open_response1.scanner_handle.has_value());
EXPECT_FALSE(open_response1.scanner_handle->empty());
const std::string job_handle = StartScanForScannerHandle(
extension_, /*user_gesture=*/false, *open_response1.scanner_handle);
EXPECT_FALSE(job_handle.empty());
// First read succeeds because the job is open.
ReadScanDataFuture read_future1;
document_scan_api_handler_->ReadScanData(extension_, job_handle,
read_future1.GetCallback());
const api::document_scan::ReadScanDataResponse& read_response1 =
read_future1.Get();
EXPECT_EQ(read_response1.result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(read_response1.job, job_handle);
EXPECT_TRUE(read_response1.data.has_value());
EXPECT_TRUE(read_response1.estimated_completion.has_value());
// Reopening the same scanner ID also invalidates the job handle.
OpenScannerFuture open_future2;
document_scan_api_handler_->OpenScanner(extension_, scanner_id,
open_future2.GetCallback());
const api::document_scan::OpenScannerResponse& open_response2 =
open_future2.Get();
EXPECT_EQ(open_response2.result,
api::document_scan::OperationResult::kSuccess);
ASSERT_TRUE(open_response2.scanner_handle.has_value());
EXPECT_FALSE(open_response2.scanner_handle->empty());
// Second read fails because the job is no longer valid.
ReadScanDataFuture read_future2;
document_scan_api_handler_->ReadScanData(extension_, job_handle,
read_future2.GetCallback());
const api::document_scan::ReadScanDataResponse& read_response2 =
read_future2.Get();
EXPECT_NE(read_response2.result,
api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(read_response2.job, job_handle);
EXPECT_FALSE(read_response2.data.has_value());
EXPECT_FALSE(read_response2.estimated_completion.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, UnloadExtension) {
// Test when an extension gets unloaded, handles for that extension are closed
// but handles for a second extension are not affected.
MarkExtensionTrusted(kExtensionId);
const std::string scanner_handle = OpenScannerForExtension(extension_);
EXPECT_FALSE(scanner_handle.empty());
auto extension2 = ExtensionBuilder("extension2")
.SetID("extension2id")
.AddAPIPermission(kExtensionPermissionName)
.Build();
MarkExtensionTrusted("extension2id");
const std::string scanner_handle2 = OpenScannerForExtension(extension2);
EXPECT_FALSE(scanner_handle2.empty());
UnloadExtension();
// Once the extension is unloaded, the state for this extension gets cleared,
// so trying to start a scan with the scanner handle should fail.
api::document_scan::StartScanOptions options;
StartScanFuture future;
document_scan_api_handler_->StartScan(
/*native_window=*/nullptr, extension_, /*user_gesture=*/true,
scanner_handle, std::move(options), future.GetCallback());
const api::document_scan::StartScanResponse& response = future.Get();
EXPECT_EQ(response.result, api::document_scan::OperationResult::kInvalid);
EXPECT_EQ(response.scanner_handle, scanner_handle);
EXPECT_FALSE(response.job.has_value());
// However, the second extension should still work as usual.
api::document_scan::StartScanOptions options2;
StartScanFuture future2;
document_scan_api_handler_->StartScan(
/*native_window=*/nullptr, extension2, /*user_gesture=*/true,
scanner_handle2, std::move(options2), future2.GetCallback());
const api::document_scan::StartScanResponse& response2 = future2.Get();
EXPECT_EQ(response2.result, api::document_scan::OperationResult::kSuccess);
EXPECT_EQ(response2.scanner_handle, scanner_handle2);
EXPECT_TRUE(response2.job.has_value());
}
TEST_F(DocumentScanAPIHandlerTest, Shutdown) {
// At shutdown, all handles for all extensions get closed.
MarkExtensionTrusted(kExtensionId);
const std::string scanner_handle = OpenScannerForExtension(extension_);
EXPECT_FALSE(scanner_handle.empty());
auto extension2 = ExtensionBuilder("extension2")
.SetID("extension2id")
.AddAPIPermission(kExtensionPermissionName)
.Build();
MarkExtensionTrusted("extension2id");
const std::string scanner_handle2 = OpenScannerForExtension(extension2);
EXPECT_FALSE(scanner_handle2.empty());
document_scan_api_handler_->Shutdown();
// Trying to start a scan with either closed scanner handle will fail.
api::document_scan::StartScanOptions options;
StartScanFuture future;
document_scan_api_handler_->StartScan(
/*native_window=*/nullptr, extension_, /*user_gesture=*/true,
scanner_handle, std::move(options), future.GetCallback());
const api::document_scan::StartScanResponse& response = future.Get();
EXPECT_EQ(response.result, api::document_scan::OperationResult::kInvalid);
EXPECT_EQ(response.scanner_handle, scanner_handle);
EXPECT_FALSE(response.job.has_value());
api::document_scan::StartScanOptions options2;
StartScanFuture future2;
document_scan_api_handler_->StartScan(
/*native_window=*/nullptr, extension2, /*user_gesture=*/true,
scanner_handle2, std::move(options2), future2.GetCallback());
const api::document_scan::StartScanResponse& response2 = future2.Get();
EXPECT_EQ(response2.result, api::document_scan::OperationResult::kInvalid);
EXPECT_EQ(response2.scanner_handle, scanner_handle2);
EXPECT_FALSE(response2.job.has_value());
}
} // namespace
} // namespace extensions
|