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
|
// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef PRINTING_BACKEND_TEST_PRINT_BACKEND_H_
#define PRINTING_BACKEND_TEST_PRINT_BACKEND_H_
#include <memory>
#include <string>
#include "base/containers/flat_map.h"
#include "build/build_config.h"
#include "printing/backend/print_backend.h"
#include "printing/mojom/print.mojom.h"
#if BUILDFLAG(IS_WIN)
#include "base/types/expected.h"
#endif // BUILDFLAG(IS_WIN)
namespace printing {
// PrintBackend which doesn't interact with the OS and responses
// can be overridden as necessary.
class TestPrintBackend : public PrintBackend {
public:
TestPrintBackend();
// PrintBackend overrides
mojom::ResultCode EnumeratePrinters(PrinterList& printer_list) override;
mojom::ResultCode GetDefaultPrinterName(
std::string& default_printer) override;
mojom::ResultCode GetPrinterBasicInfo(
const std::string& printer_name,
PrinterBasicInfo* printer_info) override;
mojom::ResultCode GetPrinterSemanticCapsAndDefaults(
const std::string& printer_name,
PrinterSemanticCapsAndDefaults* printer_info) override;
#if BUILDFLAG(IS_WIN)
mojom::ResultCode GetPrinterCapsAndDefaults(
const std::string& printer_name,
PrinterCapsAndDefaults* printer_info) override;
std::optional<gfx::Rect> GetPaperPrintableArea(
const std::string& printer_name,
const std::string& paper_vendor_id,
const gfx::Size& paper_size_um) override;
#endif
std::vector<std::string> GetPrinterDriverInfo(
const std::string& printer_name) override;
bool IsValidPrinter(const std::string& printer_name) override;
#if BUILDFLAG(IS_WIN)
base::expected<std::string, mojom::ResultCode>
GetXmlPrinterCapabilitiesForXpsDriver(
const std::string& printer_name) override;
#endif // BUILDFLAG(IS_WIN)
// Methods for test setup:
// Sets a default printer. The default is the empty string.
void SetDefaultPrinterName(const std::string& printer_name);
// Adds a printer to satisfy IsValidPrinter(), EnumeratePrinters(),
// GetPrinterBasicInfo(), GetPrinterSemanticCapsAndDefaults(), and
// GetXmlPrinterCapabilitiesForXpsDriver(). While `caps` can be null, it will
// cause queries for the capabilities to fail, and thus is likely not of
// interest for most tests. IsValidPrinter() will still show true even if
// `caps` is null, which provides the benefit of simulating a printer that
// exists in the system but cannot be queried. `info` can be null, which will
// result in queries for basic info to fail. Calling EnumeratePrinters() will
// include the identified `printer_name` even if either parameter is null.
void AddValidPrinter(const std::string& printer_name,
std::unique_ptr<PrinterSemanticCapsAndDefaults> caps,
std::unique_ptr<PrinterBasicInfo> info);
// Adds a printer which will cause a Mojom data validation error.
void AddInvalidDataPrinter(const std::string& printer_name);
// Adds a printer which will fail with an access-denied permission error for
// calls specific to a particular `printer_name`.
void AddAccessDeniedPrinter(const std::string& printer_name);
#if BUILDFLAG(IS_WIN)
// Sets the XML capabilities of an existing printer to be used by
// GetXmlPrinterCapabilitiesForXpsDriver(). `printer_name` must be a valid
// name of an added printer. Passing an empty `capabilities_xml` will cause
// GetXmlPrinterCapabilitiesForXpsDriver() to fail, otherwise any string will
// succeed.
void SetXmlCapabilitiesForPrinter(const std::string& printer_name,
const std::string& capabilities_xml);
#endif // BUILDFLAG(IS_WIN)
protected:
~TestPrintBackend() override;
private:
void AddPrinter(const std::string& printer_name,
std::unique_ptr<PrinterSemanticCapsAndDefaults> caps,
std::unique_ptr<PrinterBasicInfo> info,
bool blocked_by_permissions);
struct PrinterData {
PrinterData(std::unique_ptr<PrinterSemanticCapsAndDefaults> caps,
std::unique_ptr<PrinterBasicInfo> info,
bool blocked_by_permissions);
~PrinterData();
std::unique_ptr<PrinterSemanticCapsAndDefaults> caps;
std::unique_ptr<PrinterBasicInfo> info;
bool blocked_by_permissions = false;
#if BUILDFLAG(IS_WIN)
std::string capabilities_xml;
#endif // BUILDFLAG(IS_WIN)
};
std::string default_printer_name_;
// The values in `printer_map_` will not be null. The use of a pointer to
// PrinterData is just a workaround for the deleted copy assignment operator
// for the `caps` field, as that prevents the PrinterData container from
// being copied into the map.
base::flat_map<std::string, std::unique_ptr<PrinterData>> printer_map_;
};
} // namespace printing
#endif // PRINTING_BACKEND_TEST_PRINT_BACKEND_H_
|
