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
|
// Copyright 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
package org.chromium.chrome.browser.printing;
import android.annotation.SuppressLint;
import android.annotation.TargetApi;
import android.os.Build;
import android.os.CancellationSignal;
import android.os.ParcelFileDescriptor;
import android.print.PageRange;
import android.print.PrintAttributes;
import android.print.PrintDocumentAdapter;
import android.print.PrintDocumentInfo;
import android.support.test.filters.LargeTest;
import android.support.test.filters.MediumTest;
import android.support.test.filters.SmallTest;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.chromium.base.test.util.CallbackHelper;
import org.chromium.base.test.util.CommandLineFlags;
import org.chromium.base.test.util.Feature;
import org.chromium.base.test.util.MinAndroidSdkLevel;
import org.chromium.base.test.util.RetryOnFailure;
import org.chromium.base.test.util.TestFileUtil;
import org.chromium.base.test.util.UrlUtils;
import org.chromium.chrome.browser.ChromeActivity;
import org.chromium.chrome.browser.ChromeSwitches;
import org.chromium.chrome.browser.tab.Tab;
import org.chromium.chrome.browser.tabmodel.TabModelUtils;
import org.chromium.chrome.test.ChromeActivityTestRule;
import org.chromium.chrome.test.ChromeJUnit4ClassRunner;
import org.chromium.content_public.browser.test.util.TestThreadUtils;
import org.chromium.printing.PrintDocumentAdapterWrapper;
import org.chromium.printing.PrintDocumentAdapterWrapper.LayoutResultCallbackWrapper;
import org.chromium.printing.PrintDocumentAdapterWrapper.WriteResultCallbackWrapper;
import org.chromium.printing.PrintManagerDelegate;
import org.chromium.printing.PrintingControllerImpl;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
/**
* Tests Android printing.
* TODO(cimamoglu): Add a test with cancellation.
* TODO(cimamoglu): Add a test with multiple, stacked onLayout/onWrite calls.
* TODO(cimamoglu): Add a test which emulates Chromium failing to generate a PDF.
*/
@RunWith(ChromeJUnit4ClassRunner.class)
@RetryOnFailure
@SuppressLint("NewApi")
@MinAndroidSdkLevel(Build.VERSION_CODES.KITKAT)
@CommandLineFlags.Add({ChromeSwitches.DISABLE_FIRST_RUN_EXPERIENCE})
public class PrintingControllerTest {
@Rule
public final ChromeActivityTestRule<ChromeActivity> mActivityTestRule =
new ChromeActivityTestRule<>(ChromeActivity.class);
private static final String TEMP_FILE_NAME = "temp_print";
private static final String TEMP_FILE_EXTENSION = ".pdf";
private static final String PRINT_JOB_NAME = "foo";
private static final String URL = UrlUtils.encodeHtmlDataUri(
"<html><head></head><body>foo</body></html>");
private static final String PDF_PREAMBLE = "%PDF-1";
private static final long TEST_TIMEOUT = 20000L;
@Before
public void setUp() {
// Do nothing.
}
private static class LayoutResultCallbackWrapperMock implements LayoutResultCallbackWrapper {
@Override
public void onLayoutFinished(PrintDocumentInfo info, boolean changed) {}
@Override
public void onLayoutFailed(CharSequence error) {}
@Override
public void onLayoutCancelled() {}
}
private static class WriteResultCallbackWrapperMock implements WriteResultCallbackWrapper {
@Override
public void onWriteFinished(PageRange[] pages) {}
@Override
public void onWriteFailed(CharSequence error) {}
@Override
public void onWriteCancelled() {}
}
private static class WaitForOnWriteHelper extends CallbackHelper {
public void waitForCallback(String msg) throws TimeoutException {
waitForFirst(msg, TEST_TIMEOUT, TimeUnit.MILLISECONDS);
}
}
private static class TemporaryFileHandler implements AutoCloseable {
private File mTempFile;
private ParcelFileDescriptor mFileDescriptor;
public TemporaryFileHandler() throws IOException {
mTempFile = File.createTempFile(TEMP_FILE_NAME, TEMP_FILE_EXTENSION);
try {
mFileDescriptor =
ParcelFileDescriptor.open(mTempFile, ParcelFileDescriptor.MODE_READ_WRITE);
} catch (FileNotFoundException e) {
// Exception happened, can't continue, cleanup the file.
TestFileUtil.deleteFile(mTempFile.getAbsolutePath());
throw new FileNotFoundException();
}
}
ParcelFileDescriptor getFileDescriptor() {
return mFileDescriptor;
}
@Override
public void close() throws IOException {
try {
mFileDescriptor.close();
} finally {
TestFileUtil.deleteFile(mTempFile.getAbsolutePath());
}
}
}
private static class PrintingControllerImplPdfWritingDone extends PrintingControllerImpl {
private WaitForOnWriteHelper mWaitForOnWrite;
public PrintingControllerImplPdfWritingDone(
PrintDocumentAdapterWrapper printDocumentAdapterWrapper, String errorText,
WaitForOnWriteHelper waitForOnWrite) {
super(printDocumentAdapterWrapper, errorText);
mWaitForOnWrite = waitForOnWrite;
sInstance = this;
}
@Override
public void pdfWritingDone(int pageCount) {
mWaitForOnWrite.notifyCalled();
}
}
/**
* Test a basic printing flow by emulating the corresponding system calls to the printing
* controller: onStart, onLayout, onWrite, onFinish. Each one is called once, and in this
* order, in the UI thread.
*/
@Test
@TargetApi(Build.VERSION_CODES.KITKAT)
@LargeTest
@Feature({"Printing"})
public void testNormalPrintingFlow() throws Throwable {
if (!(Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT)) return;
mActivityTestRule.startMainActivityWithURL(URL);
final Tab currentTab = mActivityTestRule.getActivity().getActivityTab();
final PrintingControllerImpl printingController = createControllerOnUiThread();
startControllerOnUiThread(printingController, currentTab);
// {@link PrintDocumentAdapter#onStart} is always called first.
callStartOnUiThread(printingController);
// Create a temporary file to save the PDF.
final File tempFile = File.createTempFile(TEMP_FILE_NAME, TEMP_FILE_EXTENSION);
final ParcelFileDescriptor fileDescriptor =
ParcelFileDescriptor.open(tempFile, ParcelFileDescriptor.MODE_READ_WRITE);
// Use this to wait for PDF generation to complete, as it will happen asynchronously.
final WaitForOnWriteHelper onWriteFinishedCompleted = new WaitForOnWriteHelper();
final WriteResultCallbackWrapper writeResultCallback =
new WriteResultCallbackWrapperMock() {
@Override
public void onWriteFinished(PageRange[] pages) {
onWriteFinishedCompleted.notifyCalled();
}
};
final LayoutResultCallbackWrapper layoutResultCallback =
new LayoutResultCallbackWrapperMock() {
// Called on UI thread.
@Override
public void onLayoutFinished(PrintDocumentInfo info, boolean changed) {
printingController.onWrite(new PageRange[] {PageRange.ALL_PAGES},
fileDescriptor, new CancellationSignal(), writeResultCallback);
}
};
callLayoutOnUiThread(
printingController, null, createDummyPrintAttributes(), layoutResultCallback);
FileInputStream in = null;
try {
onWriteFinishedCompleted.waitForCallback("onWriteFinished callback never completed.");
Assert.assertTrue(tempFile.length() > 0);
in = new FileInputStream(tempFile);
byte[] b = new byte[PDF_PREAMBLE.length()];
in.read(b);
String preamble = new String(b);
Assert.assertEquals(PDF_PREAMBLE, preamble);
} finally {
if (in != null) in.close();
callFinishOnUiThread(printingController);
// Close the descriptor, if not closed already.
fileDescriptor.close();
TestFileUtil.deleteFile(tempFile.getAbsolutePath());
}
}
/**
* Test for http://crbug.com/528909
* Simulating while a printing job is triggered and about to call Android framework to show UI,
* the corresponding tab is closed, this behaviour is mostly from JavaScript code. Make sure we
* don't crash and won't call into framework.
*/
@Test
@TargetApi(Build.VERSION_CODES.KITKAT)
@MediumTest
@Feature({"Printing"})
public void testPrintCloseWindowBeforeStart() {
if (!(Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT)) return;
mActivityTestRule.startMainActivityWithURL(URL);
final Tab currentTab = mActivityTestRule.getActivity().getActivityTab();
final PrintingControllerImpl printingController = createControllerOnUiThread();
final PrintManagerDelegate mockPrintManagerDelegate =
mockPrintManagerDelegate(() -> Assert.fail("Shouldn't start a printing job."));
TestThreadUtils.runOnUiThreadBlocking(() -> {
printingController.setPendingPrint(
new TabPrinter(currentTab), mockPrintManagerDelegate, -1, -1);
TabModelUtils.closeCurrentTab(mActivityTestRule.getActivity().getCurrentTabModel());
Assert.assertFalse("currentTab should be closed already.", currentTab.isInitialized());
printingController.startPendingPrint();
});
}
/**
* Test for http://crbug.com/528909
* Simulating while a printing job is triggered and printing UI is showing, the corresponding
* tab is closed, this behaviour is mostly from JavaScript code. Make sure we don't crash and
* let framework notify user that we can't perform printing job.
*/
@Test
@TargetApi(Build.VERSION_CODES.KITKAT)
@LargeTest
@Feature({"Printing"})
public void testPrintCloseWindowBeforeOnWrite() throws Throwable {
if (!(Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT)) return;
mActivityTestRule.startMainActivityWithURL(URL);
final Tab currentTab = mActivityTestRule.getActivity().getActivityTab();
final PrintingControllerImpl printingController = createControllerOnUiThread();
startControllerOnUiThread(printingController, currentTab);
callStartOnUiThread(printingController);
final WaitForOnWriteHelper onWriteFinishedCompleted = new WaitForOnWriteHelper();
final LayoutResultCallbackWrapper layoutResultCallback =
new LayoutResultCallbackWrapperMock() {
@Override
public void onLayoutFinished(PrintDocumentInfo info, boolean changed) {
onWriteFinishedCompleted.notifyCalled();
}
};
callLayoutOnUiThread(
printingController, null, createDummyPrintAttributes(), layoutResultCallback);
onWriteFinishedCompleted.waitForCallback("onWriteFinished callback never completed.");
final WaitForOnWriteHelper onWriteFailedCompleted = new WaitForOnWriteHelper();
// Create a temporary file to save the PDF.
final File tempFile = File.createTempFile(TEMP_FILE_NAME, TEMP_FILE_EXTENSION);
final ParcelFileDescriptor fileDescriptor =
ParcelFileDescriptor.open(tempFile, ParcelFileDescriptor.MODE_READ_WRITE);
try {
TestThreadUtils.runOnUiThreadBlocking(() -> {
// Close tab.
TabModelUtils.closeCurrentTab(mActivityTestRule.getActivity().getCurrentTabModel());
Assert.assertFalse(
"currentTab should be closed already.", currentTab.isInitialized());
final WriteResultCallbackWrapper writeResultCallback =
new WriteResultCallbackWrapperMock() {
@Override
public void onWriteFailed(CharSequence error) {
onWriteFailedCompleted.notifyCalled();
}
};
// Call onWrite.
printingController.onWrite(new PageRange[] {PageRange.ALL_PAGES}, fileDescriptor,
new CancellationSignal(), writeResultCallback);
});
onWriteFailedCompleted.waitForCallback("onWriteFailed callback never completed.");
} finally {
// Proper cleanup.
callFinishOnUiThread(printingController);
// Close the descriptor, if not closed already.
fileDescriptor.close();
TestFileUtil.deleteFile(tempFile.getAbsolutePath());
}
}
/**
* Test for http://crbug.com/863297
* This bug shows Android printing framework could call |PrintDocumentAdapter.onFinish()|
* before one of |WriteResultCallback.onWrite{Cancelled, Failed, Finished}()| get called.
* Crash test, pass if there is no crash.
*/
@Test
@TargetApi(Build.VERSION_CODES.KITKAT)
@MediumTest
@Feature({"Printing"})
public void testCancelPrintBeforeWriteResultCallbacks() throws Throwable {
if (!(Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT)) return;
mActivityTestRule.startMainActivityWithURL(URL);
final WaitForOnWriteHelper onWriteHelper = new WaitForOnWriteHelper();
final Tab currentTab = mActivityTestRule.getActivity().getActivityTab();
final PrintingControllerImpl printingController =
TestThreadUtils.runOnUiThreadBlockingNoException(() -> {
return new PrintingControllerImplPdfWritingDone(
new PrintDocumentAdapterWrapper(), PRINT_JOB_NAME, onWriteHelper);
});
startControllerOnUiThread(printingController, currentTab);
callStartOnUiThread(printingController);
final WriteResultCallbackWrapper writeResultCallback =
new WriteResultCallbackWrapperMock() {
@Override
public void onWriteFinished(PageRange[] pages) {
Assert.fail("onWriteFinished shouldn't be called");
}
@Override
public void onWriteFailed(CharSequence error) {
Assert.fail("onWriteFailed shouldn't be called");
}
@Override
public void onWriteCancelled() {
Assert.fail("onWriteCancelled shouldn't be called");
}
};
try (TemporaryFileHandler handler = new TemporaryFileHandler()) {
final LayoutResultCallbackWrapper layoutResultCallback =
new LayoutResultCallbackWrapperMock() {
@Override
public void onLayoutFinished(PrintDocumentInfo info, boolean changed) {
printingController.onWrite(new PageRange[] {PageRange.ALL_PAGES},
handler.getFileDescriptor(), new CancellationSignal(),
writeResultCallback);
}
};
callLayoutOnUiThread(
printingController, null, createDummyPrintAttributes(), layoutResultCallback);
onWriteHelper.waitForCallback("pdfWritingDone never called");
callFinishOnUiThread(printingController);
}
}
/**
* Regresstion test for crbug.com/974581. In some cases, native printing code will fail without
* starting a printing task in Java side. pdfWritingDone() will be called with |pageCount| = 0
* in this case. We don't need to do anything for this in Java side for now.
*/
@Test
@SmallTest
@Feature({"Printing"})
public void testPdfWritingDoneCalledWithoutInitailizePrintingTask() {
if (!(Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT)) return;
mActivityTestRule.startMainActivityWithURL(URL);
final PrintingControllerImpl controller = createControllerOnUiThread();
// Calling pdfWritingDone() with |pageCount| = 0 before onWrite() was called. It shouldn't
// crash.
TestThreadUtils.runOnUiThreadBlocking(() -> controller.pdfWritingDone(0));
}
private PrintingControllerImpl createControllerOnUiThread() {
return TestThreadUtils.runOnUiThreadBlockingNoException(() -> {
return (PrintingControllerImpl) PrintingControllerImpl.create(
new PrintDocumentAdapterWrapper(), PRINT_JOB_NAME);
});
}
@TargetApi(Build.VERSION_CODES.KITKAT)
private PrintAttributes createDummyPrintAttributes() {
return new PrintAttributes.Builder()
.setMediaSize(PrintAttributes.MediaSize.ISO_A4)
.setResolution(new PrintAttributes.Resolution("foo", "bar", 300, 300))
.setMinMargins(PrintAttributes.Margins.NO_MARGINS)
.build();
}
private PrintManagerDelegate mockPrintManagerDelegate(final Runnable r) {
return new PrintManagerDelegate() {
@Override
public void print(String printJobName, PrintDocumentAdapter documentAdapter,
PrintAttributes attributes) {
if (r != null) r.run();
}
};
}
private void startControllerOnUiThread(final PrintingControllerImpl controller, final Tab tab) {
TestThreadUtils.runOnUiThreadBlocking(() -> {
controller.startPrint(new TabPrinter(tab),
/* non-op PrintManagerDelegate */ mockPrintManagerDelegate(null));
});
}
private void callStartOnUiThread(final PrintingControllerImpl controller) {
TestThreadUtils.runOnUiThreadBlocking(() -> controller.onStart());
}
private void callLayoutOnUiThread(final PrintingControllerImpl controller,
final PrintAttributes oldAttributes, final PrintAttributes newAttributes,
final LayoutResultCallbackWrapper layoutResultCallback) {
TestThreadUtils.runOnUiThreadBlocking(() -> {
controller.onLayout(oldAttributes, newAttributes, new CancellationSignal(),
layoutResultCallback, null);
});
}
private void callFinishOnUiThread(final PrintingControllerImpl controller) {
TestThreadUtils.runOnUiThreadBlocking(() -> controller.onFinish());
}
}
|
