OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef CHROME_BROWSER_CHROMEOS_LOGIN_SCREENSHOT_TESTER_H_ | 5 #ifndef CHROME_BROWSER_CHROMEOS_LOGIN_SCREENSHOT_TESTER_H_ |
6 #define CHROME_BROWSER_CHROMEOS_LOGIN_SCREENSHOT_TESTER_H_ | 6 #define CHROME_BROWSER_CHROMEOS_LOGIN_SCREENSHOT_TESTER_H_ |
7 | 7 |
8 #include <string> | |
9 | |
10 #include "base/base_export.h" | 8 #include "base/base_export.h" |
11 #include "base/bind_internal.h" | 9 #include "base/bind_internal.h" |
12 #include "base/files/file_path.h" | 10 #include "base/files/file_path.h" |
13 #include "base/macros.h" | 11 #include "base/macros.h" |
14 #include "base/memory/ref_counted_memory.h" | 12 #include "base/memory/ref_counted_memory.h" |
15 #include "base/memory/weak_ptr.h" | 13 #include "base/memory/weak_ptr.h" |
16 #include "base/run_loop.h" | 14 #include "base/run_loop.h" |
17 | 15 |
18 namespace chromeos { | 16 namespace chromeos { |
19 | 17 |
20 // A class that allows taking, saving and comparing screnshots while | 18 // A class that allows taking, saving and comparing screnshots while |
21 // running tests. | 19 // running tests. |
22 class ScreenshotTester { | 20 class ScreenshotTester { |
23 public: | 21 public: |
24 ScreenshotTester(); | 22 ScreenshotTester(); |
25 virtual ~ScreenshotTester(); | 23 virtual ~ScreenshotTester(); |
26 | 24 |
27 // Returns true if the screenshots should be taken and will be taken, | 25 // Returns true if the screenshots should be taken and will be taken, |
28 // false otherwise. Also gets all the information from the command line | 26 // false otherwise. Also gets all the information from the command line |
29 // swithes. | 27 // swithes. |
30 bool TryInitialize(); | 28 bool TryInitialize(); |
31 | 29 |
32 // Does all the work that has been stated through switches: | 30 // Does all the work that has been stated through switches: |
33 // updates golden screenshot or takes a new screenshot and compares it | 31 // updates golden screenshot or takes a new screenshot and compares it |
34 // with the golden one. |test_name| is the name of the test from which | 32 // with the golden one (this part is not implemented yet). |
35 // we run this method. | 33 void Run(const std::string& file_name); |
36 void Run(const std::string& test_name); | |
37 | 34 |
38 private: | 35 private: |
39 typedef scoped_refptr<base::RefCountedBytes> PNGFile; | 36 typedef scoped_refptr<base::RefCountedBytes> PNGFile; |
40 | 37 |
41 // Takes a screenshot and returns it. | 38 // Takes a screenshot and puts it to |screenshot_| field. |
42 PNGFile TakeScreenshot(); | 39 void TakeScreenshot(); |
43 | 40 |
44 // Saves |png_data| as a new golden screenshot for test |test_name_|. | 41 // Saves |png_data| as a new golden screenshot for this test. |
45 void UpdateGoldenScreenshot(PNGFile png_data); | 42 void UpdateGoldenScreenshot(const std::string& file_name, PNGFile png_data); |
46 | |
47 // Saves an image |png_data|, assuming it is a .png file. | |
48 // Returns true if image was saved successfully. | |
49 bool SaveImage(const std::string& file_name, | |
50 const base::FilePath& screenshot_dir, | |
51 PNGFile png_data); | |
52 | 43 |
53 // Saves |png_data| as a current screenshot. | 44 // Saves |png_data| as a current screenshot. |
54 void ReturnScreenshot(const PNGFile& screenshot, PNGFile png_data); | 45 void ReturnScreenshot(PNGFile png_data); |
55 | |
56 // Loads golden screenshot from the disk. Fails if there is no | |
57 // golden screenshot for test |test_name_|. | |
58 PNGFile LoadGoldenScreenshot(); | |
59 | |
60 // Compares two given screenshots and saves |sample| | |
61 // and difference between |sample| and |model|, if they differ in any pixel. | |
62 void CompareScreenshots(PNGFile model, PNGFile sample); | |
63 | |
64 // Name of the test from which Run() method has been called. | |
65 // Used for generating names for screenshot files. | |
66 std::string test_name_; | |
67 | 46 |
68 // Path to the directory for golden screenshots. | 47 // Path to the directory for golden screenshots. |
69 base::FilePath golden_screenshots_dir_; | 48 base::FilePath screenshot_dest_; |
70 | |
71 // Path to the directory where screenshots that failed comparing | |
72 // and difference between them and golden ones will be stored. | |
73 base::FilePath artifacts_dir_; | |
74 | 49 |
75 // |run_loop_| and |run_loop_quitter_| are used to synchronize | 50 // |run_loop_| and |run_loop_quitter_| are used to synchronize |
76 // with ui::GrabWindowSnapshotAsync. | 51 // with ui::GrabWindowSnapshotAsync. |
77 base::RunLoop run_loop_; | 52 base::RunLoop run_loop_; |
78 base::Closure run_loop_quitter_; | 53 base::Closure run_loop_quitter_; |
79 | 54 |
80 // Is true when we're in test mode: | 55 // Current screenshot. |
81 // comparing golden screenshots and current ones. | 56 PNGFile screenshot_; |
82 bool test_mode_; | |
83 | 57 |
| 58 // Is true when we running updating golden screenshots mode. |
| 59 bool update_golden_screenshot_; |
84 base::WeakPtrFactory<ScreenshotTester> weak_factory_; | 60 base::WeakPtrFactory<ScreenshotTester> weak_factory_; |
85 | 61 |
86 DISALLOW_COPY_AND_ASSIGN(ScreenshotTester); | 62 DISALLOW_COPY_AND_ASSIGN(ScreenshotTester); |
87 }; | 63 }; |
88 | 64 |
89 } // namespace chromeos | 65 } // namespace chromeos |
90 | 66 |
91 #endif // CHROME_BROWSER_CHROMEOS_LOGIN_SCREENSHOT_TESTER_H_ | 67 #endif // CHROME_BROWSER_CHROMEOS_LOGIN_SCREENSHOT_TESTER_H_ |
OLD | NEW |