1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #include "base/command_line.h"
6 #include "base/file_util.h"
7 #include "base/files/file_enumerator.h"
8 #include "base/files/file_path.h"
9 #include "base/message_loop/message_loop.h"
10 #include "base/path_service.h"
11 #include "base/process/process.h"
12 #include "base/strings/string_util.h"
13 #include "base/strings/utf_string_conversions.h"
14 #include "base/test/test_file_util.h"
15 #include "base/threading/simple_thread.h"
16 #include "chrome/browser/chrome_notification_types.h"
17 #include "chrome/browser/printing/print_job.h"
18 #include "chrome/browser/printing/print_view_manager.h"
19 #include "chrome/browser/ui/browser.h"
20 #include "chrome/browser/ui/browser_commands.h"
21 #include "chrome/browser/ui/tabs/tab_strip_model.h"
22 #include "chrome/common/chrome_paths.h"
23 #include "chrome/common/chrome_switches.h"
24 #include "chrome/test/base/in_process_browser_test.h"
25 #include "chrome/test/base/ui_test_utils.h"
26 #include "content/public/browser/notification_observer.h"
27 #include "content/public/browser/notification_registrar.h"
28 #include "content/public/browser/notification_service.h"
29 #include "net/test/spawned_test_server/spawned_test_server.h"
30 #include "printing/image.h"
31 #include "printing/printing_test.h"
35 using printing::Image;
37 const char kGenerateSwitch[] = "print-layout-generate";
39 class PrintingLayoutTest : public PrintingTest<InProcessBrowserTest>,
40 public content::NotificationObserver {
42 PrintingLayoutTest() {
43 base::FilePath browser_directory;
44 PathService::Get(chrome::DIR_APP, &browser_directory);
45 emf_path_ = browser_directory.AppendASCII("metafile_dumps");
48 virtual void SetUp() OVERRIDE {
49 // Make sure there is no left overs.
50 CleanupDumpDirectory();
51 InProcessBrowserTest::SetUp();
54 virtual void TearDown() OVERRIDE {
55 InProcessBrowserTest::TearDown();
56 base::DeleteFile(emf_path_, true);
59 virtual void SetUpCommandLine(CommandLine* command_line) OVERRIDE {
60 command_line->AppendSwitchPath(switches::kDebugPrint, emf_path_);
65 registrar_.Add(this, chrome::NOTIFICATION_PRINT_JOB_EVENT,
66 content::NotificationService::AllSources());
68 content::WebContents* web_contents =
69 browser()->tab_strip_model()->GetActiveWebContents();
70 printing::PrintViewManager::FromWebContents(web_contents)->PrintNow();
71 content::RunMessageLoop();
72 registrar_.RemoveAll();
75 virtual void Observe(int type,
76 const content::NotificationSource& source,
77 const content::NotificationDetails& details) {
78 ASSERT_EQ(chrome::NOTIFICATION_PRINT_JOB_EVENT, type);
79 switch (content::Details<printing::JobEventDetails>(details)->type()) {
80 case printing::JobEventDetails::JOB_DONE: {
82 base::MessageLoop::current()->PostTask(
83 FROM_HERE, base::MessageLoop::QuitClosure());
86 case printing::JobEventDetails::USER_INIT_CANCELED:
87 case printing::JobEventDetails::FAILED: {
90 base::MessageLoop::current()->PostTask(
91 FROM_HERE, base::MessageLoop::QuitClosure());
94 case printing::JobEventDetails::NEW_DOC:
95 case printing::JobEventDetails::USER_INIT_DONE:
96 case printing::JobEventDetails::DEFAULT_INIT_DONE:
97 case printing::JobEventDetails::NEW_PAGE:
98 case printing::JobEventDetails::PAGE_DONE:
99 case printing::JobEventDetails::DOC_DONE:
100 case printing::JobEventDetails::ALL_PAGES_REQUESTED: {
111 // Finds the dump for the last print job and compares it to the data named
112 // |verification_name|. Compares the saved printed job pixels with the test
113 // data pixels and returns the percentage of different pixels; 0 for success,
114 // [0, 100] for failure.
115 double CompareWithResult(const std::wstring& verification_name) {
116 base::FilePath test_result(ScanFiles(verification_name));
117 if (test_result.value().empty()) {
118 // 100% different, the print job buffer is not there.
122 base::FilePath base_path(ui_test_utils::GetTestFilePath(
123 base::FilePath().AppendASCII("printing"), base::FilePath()));
124 base::FilePath emf(base_path.Append(verification_name + L".emf"));
125 base::FilePath png(base_path.Append(verification_name + L".png"));
127 base::FilePath cleartype(
128 base_path.Append(verification_name + L"_cleartype.png"));
129 // Looks for Cleartype override.
130 if (base::PathExists(cleartype) && IsClearTypeEnabled())
133 if (GenerateFiles()) {
134 // Copy the .emf and generate an .png.
135 base::CopyFile(test_result, emf);
136 Image emf_content(emf);
137 emf_content.SaveToPng(png);
138 // Saving is always fine.
141 // File compare between test and result.
142 Image emf_content(emf);
143 Image test_content(test_result);
144 Image png_content(png);
145 double diff_emf = emf_content.PercentageDifferent(test_content);
147 EXPECT_EQ(0., diff_emf) << base::WideToUTF8(verification_name) <<
148 " original size:" << emf_content.size().ToString() <<
149 " result size:" << test_content.size().ToString();
151 // Backup the result emf file.
152 base::FilePath failed(
153 base_path.Append(verification_name + L"_failed.emf"));
154 base::CopyFile(test_result, failed);
157 // This verification is only to know that the EMF rendering stays
159 double diff_png = emf_content.PercentageDifferent(png_content);
160 EXPECT_EQ(0., diff_png) << base::WideToUTF8(verification_name) <<
161 " original size:" << emf_content.size().ToString() <<
162 " result size:" << test_content.size().ToString();
164 // Backup the rendered emf file to detect the rendering difference.
165 base::FilePath rendering(
166 base_path.Append(verification_name + L"_rendering.png"));
167 emf_content.SaveToPng(rendering);
169 return std::max(diff_png, diff_emf);
173 // Makes sure the directory exists and is empty.
174 void CleanupDumpDirectory() {
175 EXPECT_TRUE(file_util::DieFileDie(emf_path_, true));
176 EXPECT_TRUE(base::CreateDirectory(emf_path_));
179 // Returns if Clear Type is currently enabled.
180 static bool IsClearTypeEnabled() {
182 if (SystemParametersInfo(SPI_GETCLEARTYPE, 0, &ct_enabled, 0) && ct_enabled)
185 if (SystemParametersInfo(SPI_GETFONTSMOOTHINGTYPE, 0, &smoothing, 0) &&
186 smoothing == FE_FONTSMOOTHINGCLEARTYPE)
192 // Verifies that there is one .emf and one .prn file in the dump directory.
193 // Returns the path of the .emf file and deletes the .prn file.
194 std::wstring ScanFiles(const std::wstring& verification_name) {
195 // Try to 10 seconds.
196 std::wstring emf_file;
197 std::wstring prn_file;
198 bool found_emf = false;
199 bool found_prn = false;
200 for (int i = 0; i < 100; ++i) {
201 base::FileEnumerator enumerator(emf_path_, false,
202 base::FileEnumerator::FILES);
208 while (!(file = enumerator.Next()).empty()) {
209 std::wstring ext = file.Extension();
210 if (base::strcasecmp(base::WideToUTF8(ext).c_str(), ".emf") == 0) {
211 EXPECT_FALSE(found_emf) << "Found a leftover .EMF file: \"" <<
212 emf_file << "\" and \"" << file.value() <<
213 "\" when looking for \"" << verification_name << "\"";
215 emf_file = file.value();
218 if (base::strcasecmp(base::WideToUTF8(ext).c_str(), ".prn") == 0) {
219 EXPECT_FALSE(found_prn) << "Found a leftover .PRN file: \"" <<
220 prn_file << "\" and \"" << file.value() <<
221 "\" when looking for \"" << verification_name << "\"";
222 prn_file = file.value();
224 base::DeleteFile(file, false);
229 if (found_emf && found_prn)
231 base::PlatformThread::Sleep(base::TimeDelta::FromMilliseconds(100));
233 EXPECT_TRUE(found_emf) << ".PRN file is: " << prn_file;
234 EXPECT_TRUE(found_prn) << ".EMF file is: " << emf_file;
238 static bool GenerateFiles() {
239 return CommandLine::ForCurrentProcess()->HasSwitch(kGenerateSwitch);
242 base::FilePath emf_path_;
243 content::NotificationRegistrar registrar_;
245 DISALLOW_COPY_AND_ASSIGN(PrintingLayoutTest);
248 class PrintingLayoutTextTest : public PrintingLayoutTest {
249 typedef PrintingLayoutTest Parent;
251 // Returns if the test is disabled.
252 // http://crbug.com/64869 Until the issue is fixed, disable the test if
253 // ClearType is enabled.
254 static bool IsTestCaseDisabled() {
255 return Parent::IsTestCaseDisabled() || IsClearTypeEnabled();
259 // Finds the first dialog window owned by owner_process.
260 HWND FindDialogWindow(DWORD owner_process) {
261 HWND dialog_window(NULL);
263 dialog_window = FindWindowEx(NULL,
270 // The dialog must be owned by our target process.
271 DWORD process_id = 0;
272 GetWindowThreadProcessId(dialog_window, &process_id);
273 if (process_id == owner_process)
276 return dialog_window;
279 // Tries to close a dialog window.
280 bool CloseDialogWindow(HWND dialog_window) {
281 LRESULT res = SendMessage(dialog_window, DM_GETDEFID, 0, 0);
284 EXPECT_EQ(DC_HASDEFID, HIWORD(res));
285 WORD print_button_id = LOWORD(res);
290 reinterpret_cast<LPARAM>(GetDlgItem(dialog_window, print_button_id)));
294 // Dismiss the first dialog box owned by owner_process by "executing" the
296 class DismissTheWindow : public base::DelegateSimpleThread::Delegate {
299 : owner_process_(base::Process::Current().pid()) {
305 // First enumerate the windows.
306 dialog_window = FindDialogWindow(owner_process_);
310 if (CloseDialogWindow(dialog_window)) {
314 base::PlatformThread::Sleep(base::TimeDelta::FromMilliseconds(10));
317 // Now verify that it indeed closed itself.
318 while (IsWindow(dialog_window)) {
319 CloseDialogWindow(dialog_window);
320 base::PlatformThread::Sleep(base::TimeDelta::FromMilliseconds(10));
324 DWORD owner_process() { return owner_process_; }
327 DWORD owner_process_;
332 // Fails, see http://crbug.com/7721.
333 IN_PROC_BROWSER_TEST_F(PrintingLayoutTextTest, DISABLED_Complex) {
334 if (IsTestCaseDisabled())
337 DismissTheWindow dismisser;
338 base::DelegateSimpleThread close_printdlg_thread(&dismisser,
339 "close_printdlg_thread");
341 // Print a document, check its output.
342 ASSERT_TRUE(test_server()->Start());
344 ui_test_utils::NavigateToURL(
345 browser(), test_server()->GetURL("files/printing/test1.html"));
346 close_printdlg_thread.Start();
348 close_printdlg_thread.Join();
349 EXPECT_EQ(0., CompareWithResult(L"test1"));
354 const wchar_t* result;
357 const TestPool kTestPool[] = {
359 "files/printing/test2.html", L"test2",
361 "files/printing/test3.html", L"test3",
363 "files/printing/test4.html", L"test4",
366 // http://crbug.com/7721
367 IN_PROC_BROWSER_TEST_F(PrintingLayoutTest, DISABLED_ManyTimes) {
368 if (IsTestCaseDisabled())
371 ASSERT_TRUE(test_server()->Start());
373 DismissTheWindow dismisser;
375 ASSERT_GT(arraysize(kTestPool), 0u);
376 for (int i = 0; i < arraysize(kTestPool); ++i) {
378 CleanupDumpDirectory();
379 const TestPool& test = kTestPool[i % arraysize(kTestPool)];
380 ui_test_utils::NavigateToURL(browser(), test_server()->GetURL(test.source));
381 base::DelegateSimpleThread close_printdlg_thread1(&dismisser,
382 "close_printdlg_thread");
383 EXPECT_EQ(NULL, FindDialogWindow(dismisser.owner_process()));
384 close_printdlg_thread1.Start();
386 close_printdlg_thread1.Join();
387 EXPECT_EQ(0., CompareWithResult(test.result)) << test.result;
388 CleanupDumpDirectory();
389 base::DelegateSimpleThread close_printdlg_thread2(&dismisser,
390 "close_printdlg_thread");
391 EXPECT_EQ(NULL, FindDialogWindow(dismisser.owner_process()));
392 close_printdlg_thread2.Start();
394 close_printdlg_thread2.Join();
395 EXPECT_EQ(0., CompareWithResult(test.result)) << test.result;
396 CleanupDumpDirectory();
397 base::DelegateSimpleThread close_printdlg_thread3(&dismisser,
398 "close_printdlg_thread");
399 EXPECT_EQ(NULL, FindDialogWindow(dismisser.owner_process()));
400 close_printdlg_thread3.Start();
402 close_printdlg_thread3.Join();
403 EXPECT_EQ(0., CompareWithResult(test.result)) << test.result;
404 CleanupDumpDirectory();
405 base::DelegateSimpleThread close_printdlg_thread4(&dismisser,
406 "close_printdlg_thread");
407 EXPECT_EQ(NULL, FindDialogWindow(dismisser.owner_process()));
408 close_printdlg_thread4.Start();
410 close_printdlg_thread4.Join();
411 EXPECT_EQ(0., CompareWithResult(test.result)) << test.result;
415 // Prints a popup and immediately closes it. Disabled because it crashes.
416 IN_PROC_BROWSER_TEST_F(PrintingLayoutTest, DISABLED_Delayed) {
417 if (IsTestCaseDisabled())
420 ASSERT_TRUE(test_server()->Start());
423 bool is_timeout = true;
424 GURL url = test_server()->GetURL("files/printing/popup_delayed_print.htm");
425 ui_test_utils::NavigateToURL(browser(), url);
427 DismissTheWindow dismisser;
428 base::DelegateSimpleThread close_printdlg_thread(&dismisser,
429 "close_printdlg_thread");
430 close_printdlg_thread.Start();
431 close_printdlg_thread.Join();
433 // Force a navigation elsewhere to verify that it's fine with it.
434 url = test_server()->GetURL("files/printing/test1.html");
435 ui_test_utils::NavigateToURL(browser(), url);
437 chrome::CloseWindow(browser());
438 content::RunAllPendingInMessageLoop();
440 EXPECT_EQ(0., CompareWithResult(L"popup_delayed_print"))
441 << L"popup_delayed_print";
444 // Prints a popup and immediately closes it. http://crbug.com/7721
445 IN_PROC_BROWSER_TEST_F(PrintingLayoutTest, DISABLED_IFrame) {
446 if (IsTestCaseDisabled())
449 ASSERT_TRUE(test_server()->Start());
452 GURL url = test_server()->GetURL("files/printing/iframe.htm");
453 ui_test_utils::NavigateToURL(browser(), url);
455 DismissTheWindow dismisser;
456 base::DelegateSimpleThread close_printdlg_thread(&dismisser,
457 "close_printdlg_thread");
458 close_printdlg_thread.Start();
459 close_printdlg_thread.Join();
461 // Force a navigation elsewhere to verify that it's fine with it.
462 url = test_server()->GetURL("files/printing/test1.html");
463 ui_test_utils::NavigateToURL(browser(), url);
465 chrome::CloseWindow(browser());
466 content::RunAllPendingInMessageLoop();
468 EXPECT_EQ(0., CompareWithResult(L"iframe")) << L"iframe";