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
|
/*
* Copyright (c) 2021, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package lib;
import java.awt.BorderLayout;
import java.awt.Dimension;
import java.awt.GridLayout;
import java.io.File;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;
import java.util.function.Supplier;
import javax.imageio.ImageIO;
import javax.swing.BorderFactory;
import javax.swing.JEditorPane;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JSplitPane;
import javax.swing.JTextArea;
import javax.swing.border.BevelBorder;
import static java.awt.BorderLayout.CENTER;
import static java.awt.BorderLayout.NORTH;
import static java.awt.BorderLayout.SOUTH;
import static java.io.File.separator;
import static javax.swing.SwingUtilities.invokeAndWait;
/**
* A frame which can be used to display manual test descriptions as well as, in case of a failure,
* enter failure reason and capture the screen.
*/
public class ManualTestFrame extends JFrame {
private boolean alreadyFailed = false;
private ManualTestFrame(String testName, String headerText,
Consumer<JEditorPane> instructions,
Consumer<TestResult> listener) throws IOException {
super(testName);
JLabel statusLabel = new JLabel("Follow test description, select \"Pass\" or \"Fail\"");
statusLabel.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
JSplitPane split = new JSplitPane(JSplitPane.VERTICAL_SPLIT);
PassFailPane[] passFail = new PassFailPane[1];
FailureReasonPane failureReason = new FailureReasonPane(reason -> {
passFail[0].setFailEnabled(!reason.isEmpty());
});
ScreenImagePane image = new ScreenImagePane(e -> {
listener.accept(new TestResult(e));
dispose();
});
JPanel failureInfoPane = new JPanel();
failureInfoPane.setLayout(new GridLayout(1, 2, 10, 10));
failureInfoPane.add(failureReason);
failureInfoPane.add(image);
failureInfoPane.setVisible(false);
JPanel main = new JPanel();
main.setLayout(new BorderLayout(10, 10));
DescriptionPane description = new DescriptionPane(instructions);
main.add(description, CENTER);
passFail[0] = new PassFailPane((status) -> {
if (status) {
listener.accept(new TestResult());
dispose();
} else {
if (!alreadyFailed) {
alreadyFailed = true;
split.setDividerLocation(.5);
failureInfoPane.setVisible(true);
pack();
image.capture();
failureReason.requestFocus();
statusLabel.setText("Enter failure reason, re-take screenshot, push \"Fail\"");
} else {
listener.accept(new TestResult(failureReason.getReason(), image.getImage()));
dispose();
}
}
});
main.add(passFail[0], SOUTH);
split.setLeftComponent(main);
split.setRightComponent(failureInfoPane);
split.setDividerLocation(1.);
getContentPane().setLayout(new BorderLayout());
if (headerText != null) {
JTextArea warningLabel = new JTextArea(headerText);
warningLabel.setBorder(BorderFactory.createBevelBorder(BevelBorder.LOWERED));
warningLabel.setEditable(false);
warningLabel.setFocusable(false);
getContentPane().add(warningLabel, NORTH);
}
getContentPane().add(statusLabel, SOUTH);
getContentPane().add(split, CENTER);
setPreferredSize(new Dimension(800, 600));
pack();
setDefaultCloseOperation(DO_NOTHING_ON_CLOSE);
setVisible(true);
}
/**
* Show a test control frame which allows a user to either pass or fail the test.
*
* @param testName name of the testcase
* @param headerText information to the user to wait for the test frame.
* @param instructions test instruction for the user
* @return Returning supplier blocks till the test is passed or failed by the user.
* @throws InterruptedException exception
* @throws InvocationTargetException exception
*/
public static Supplier<TestResult> showUI(String testName,
String headerText,
Consumer<JEditorPane> instructions)
throws InterruptedException, InvocationTargetException {
AtomicReference<TestResult> resultContainer = new AtomicReference<>();
CountDownLatch latch = new CountDownLatch(1);
invokeAndWait(() -> {
try {
new ManualTestFrame(testName, headerText, instructions, (status) -> {
resultContainer.set(status);
latch.countDown();
});
} catch (IOException e) {
resultContainer.set(new TestResult(e));
e.printStackTrace();
}
});
return () -> {
try {
int timeout = Integer.getInteger("timeout", 10);
System.out.println("timeout value : " + timeout);
if (!latch.await(timeout, TimeUnit.MINUTES)) {
throw new RuntimeException("Timeout : User failed to " +
"take decision on the test result.");
}
} catch (InterruptedException e) {
return new TestResult(e);
}
return resultContainer.get();
};
}
/**
* Checks the TestResult after user interacted with the manual TestFrame
* and the test UI.
*
* @param result Instance of the TestResult
* @param testName name of the testcase
* @throws IOException exception
*/
public static void handleResult(TestResult result, String testName) throws IOException {
if (result != null) {
System.err.println("Failure reason: \n" + result.getFailureDescription());
if (result.getScreenCapture() != null) {
File screenDump = new File(System.getProperty("test.classes") + separator + testName + ".png");
System.err.println("Saving screen image to " + screenDump.getAbsolutePath());
ImageIO.write(result.getScreenCapture(), "png", screenDump);
}
Throwable e = result.getException();
if (e != null) {
throw new RuntimeException(e);
} else {
if (!result.getStatus())
throw new RuntimeException("Test failed!");
}
} else {
throw new RuntimeException("No result returned!");
}
}
}
|
