2222 */
2323package org .jemmy2ext ;
2424
25+ import java .awt .AWTException ;
2526import java .awt .Component ;
2627import java .awt .EventQueue ;
2728import java .awt .Frame ;
2829import java .awt .Graphics ;
2930import java .awt .Rectangle ;
3031import java .awt .Robot ;
32+ import java .awt .Toolkit ;
3133import java .awt .Window ;
3234import java .awt .image .BufferedImage ;
3335import java .io .BufferedOutputStream ;
3638import java .io .FileOutputStream ;
3739import java .io .IOException ;
3840import java .lang .reflect .InvocationTargetException ;
41+ import java .text .DateFormat ;
42+ import java .text .SimpleDateFormat ;
3943import java .util .ArrayList ;
4044import java .util .Collections ;
45+ import java .util .Date ;
4146import java .util .List ;
4247import java .util .function .Function ;
4348import java .util .function .Supplier ;
8388 */
8489public class JemmyExt {
8590
91+ private static Robot robot = null ;
92+
93+ public static Robot getRobot () {
94+ try {
95+ if (robot == null ) {
96+ robot = new Robot ();
97+ }
98+ return robot ;
99+ } catch (AWTException e ) {
100+ throw new RuntimeException (e );
101+ }
102+ }
103+
86104 /**
87105 * Statically referencing all the classes that are needed by tests so that
88106 * they're compiled by jtreg
@@ -151,78 +169,62 @@ public Boolean launch() throws Exception {
151169 });
152170 }
153171
154- public static void assertEquals (String string , StrictImageComparator comparator , BufferedImage expected , BufferedImage actual ) {
155- try {
156- assertTrue (string , comparator .compare (expected , actual ));
157- } catch (Error err ) {
158- save (expected , "expected.png" );
159- save (actual , "actual.png" );
160- throw err ;
161- }
172+ private static final DateFormat timestampFormat = new SimpleDateFormat ("yyyyMMddHHmmss" );
173+ private static String timeStamp () {
174+ return timestampFormat .format (new Date ());
162175 }
163176
164- public static void assertNotEquals (String string , StrictImageComparator comparator , BufferedImage notExpected , BufferedImage actual ) {
165- try {
166- assertFalse (string , comparator .compare (notExpected , actual ));
167- } catch (Error err ) {
168- save (notExpected , "notExpected.png" );
169- save (actual , "actual.png" );
170- throw err ;
171- }
177+ /**
178+ * Constructs filename with a timestamp.
179+ * @param name File name or a path without the extension
180+ * @param extension File extension (without the dot). Could be null,
181+ * in which case timestamp is simply added to the filename (no trailing dot).
182+ * @return file name
183+ */
184+ public static String timeStamp (String name , String extension ) {
185+ return name + "-" + timeStamp () +
186+ ((extension != null ) ? ("." + extension ) : "" );
187+ }
188+
189+ /**
190+ * Saves an image into a file. Filename will be constructed from the given fileID and
191+ * a timestamp.
192+ * @param image
193+ * @param fileID
194+ */
195+ public static void save (BufferedImage image , String fileID ) {
196+ doSave (image , timeStamp (fileID + "-" + lafShortName (), "png" ));
172197 }
173198
174- public static void save ( BufferedImage image , String filename ) {
175- String filepath = filename ;
199+ //Saves an image into a file with the provided filename
200+ private static void doSave ( BufferedImage image , String filename ) {
176201 try {
177- filepath = new File (filename ).getCanonicalPath ();
202+ String filepath = new File (filename ).getCanonicalPath ();
178203 System .out .println ("Saving screenshot to " + filepath );
179204 BufferedOutputStream file = new BufferedOutputStream (new FileOutputStream (filepath ));
180205 new PNGEncoder (file , PNGEncoder .COLOR_MODE ).encode (image );
181206 } catch (IOException ioe ) {
182- throw new RuntimeException ("Failed to save image to " + filepath , ioe );
207+ throw new RuntimeException ("Failed to save image to " + filename , ioe );
183208 }
184209 }
185210
186- /**
187- * Waits for a screen area taken by a component to not be completely black rectangle.
188- * @return last (non-black) image
189- * @throws TimeoutExpiredException if the waiting is unsuccessful
190- */
191- public static BufferedImage waitNotBlack (Robot rob , ComponentOperator operator , String imageName ) {
192- class NonBlackImageChooser implements ComponentChooser {
193- private BufferedImage image = null ;
194- @ Override
195- public boolean checkComponent (Component comp ) {
196- image = capture (rob , operator );
197- save (image , imageName );
198- return !isBlack (image );
199- }
200-
201- @ Override
202- public String getDescription () {
203- return "A non-black Image of " + operator ;
204- }
205- }
206- NonBlackImageChooser chooser = new NonBlackImageChooser ();
207- operator .waitState (chooser );
208- return chooser .image ;
209- }
210-
211211 /**
212212 * Waits for the displayed image to be still.
213+ * @param imageID an image ID with no extension. Timestamp and LAF information is added to the ID when saving.
213214 * @return last still image
214215 * @throws TimeoutExpiredException if the waiting is unsuccessful
215216 */
216- public static BufferedImage waitStillImage (Robot rob , ComponentOperator operator , String imageName ) {
217+ public static BufferedImage waitStillImage (ComponentOperator operator , String imageID ) {
217218 operator .getTimeouts ().setTimeout ("Waiter.TimeDelta" , 1000 );
219+ String timestampName = timeStamp (imageID + "-" + lafShortName (), "png" );
218220 class StillImageChooser implements ComponentChooser {
219221 private BufferedImage previousImage = null ;
220222 private final StrictImageComparator sComparator = new StrictImageComparator ();
221223
222224 @ Override
223225 public boolean checkComponent (Component comp ) {
224- BufferedImage currentImage = capture (rob , operator );
225- save (currentImage , imageName );
226+ BufferedImage currentImage = capture (operator );
227+ doSave (currentImage , timestampName );
226228 boolean compareResult = previousImage == null ? false : sComparator .compare (currentImage , previousImage );
227229 previousImage = currentImage ;
228230 return compareResult ;
@@ -241,22 +243,23 @@ public String getDescription() {
241243 /**
242244 * Waits for the displayed image to change.
243245 * @param reference image to compare to
246+ * @param imageID an image ID with no extension. Timestamp and LAF information is added to the ID when saving.
244247 * @return last (changed) image
245248 * @throws TimeoutExpiredException if the waiting is unsuccessful
246249 */
247- public static BufferedImage waitChangedImage (Robot rob ,
248- Supplier <BufferedImage > supplier ,
250+ public static BufferedImage waitChangedImage (Supplier <BufferedImage > supplier ,
249251 BufferedImage reference ,
250252 Timeouts timeouts ,
251- String imageName ) throws InterruptedException {
253+ String imageID ) throws InterruptedException {
252254 ImageComparator comparator = new StrictImageComparator ();
255+ String timestampName = timeStamp (imageID + "-" + lafShortName (), "png" );
253256 class ImageWaitable implements Waitable {
254257 BufferedImage image ;
255258
256259 @ Override
257260 public Object actionProduced (Object obj ) {
258261 image = supplier .get ();
259- save (image , imageName );
262+ doSave (image , timestampName );
260263 return comparator .compare (reference , image ) ? null : image ;
261264 }
262265
@@ -316,10 +319,10 @@ public String getDescription() {
316319 }
317320 }
318321
319- public static BufferedImage capture (Robot rob , ComponentOperator operator ) {
322+ public static BufferedImage capture (ComponentOperator operator ) {
320323 Rectangle boundary = new Rectangle (operator .getLocationOnScreen (),
321324 operator .getSize ());
322- return rob .createScreenCapture (boundary );
325+ return getRobot () .createScreenCapture (boundary );
323326 }
324327
325328 /**
@@ -400,26 +403,26 @@ public void registerRoot(Throwable t) {
400403 }
401404 }
402405
406+ private static String lafShortName () { return UIManager .getLookAndFeel ().getClass ().getSimpleName (); }
407+
403408 /**
404409 * Trying to capture as much information as possible. Currently it includes
405410 * full dump and a screenshot of the whole screen.
406411 */
407412 public static void captureAll () {
408- String lookAndFeelClassName = UIManager .getLookAndFeel ().getClass ().getSimpleName ();
409- PNGEncoder .captureScreen ("failure_" + lookAndFeelClassName + ".png" , PNGEncoder .COLOR_MODE );
413+ save (getRobot ().createScreenCapture (new Rectangle (Toolkit .getDefaultToolkit ().getScreenSize ())), "failure" );
410414 try {
411- Dumper .dumpAll ("dumpAll_ "lookAndFeelClassName + ". xml"
415+ Dumper .dumpAll (timeStamp ( "dumpAll- "lafShortName (), " xml") );
412416 } catch (FileNotFoundException ex ) {
413417 Logger .getLogger (JemmyExt .class .getName ()).log (Level .SEVERE , null , ex );
414418 }
415- captureWindows (lookAndFeelClassName );
419+ captureWindows ();
416420 }
417421
418422 /**
419423 * Captures each showing window image using Window.paint() method.
420- * @param lookAndFeelClassName
421424 */
422- private static void captureWindows (String lookAndFeelClassName ) {
425+ private static void captureWindows () {
423426 try {
424427 EventQueue .invokeAndWait (() -> {
425428 Window [] windows = Window .getWindows ();
@@ -434,10 +437,14 @@ private static void captureWindows(String lookAndFeelClassName) {
434437 g .dispose ();
435438
436439 try {
437- ImageIO .write (img , "png" , new File ("window_" + lookAndFeelClassName
438- + "_" + index ++ + ".png" ));
439- } catch (IOException e ) {
440- e .printStackTrace ();
440+ save (img , "window-" + index ++);
441+ } catch (RuntimeException e ) {
442+ if (e .getCause () instanceof IOException ) {
443+ System .err .println ("Failed to save screen images" );
444+ e .printStackTrace ();
445+ } else {
446+ throw e ;
447+ }
441448 }
442449 }
443450 });
0 commit comments