32 | * public static class WatchmanTest {
33 | *
34 | * @Rule
35 | * public MethodRule logRule = new LoggingTestWatchman(...);
36 | *
37 | * @Test
38 | * public void fails() {
39 | * fail("I'm a loser baby, so why don't you kill me?");
40 | * }
41 | *
42 | *
43 | * This class should not have any or WebDriver or actual Report Writing dependencies/imports, only JUnit.
44 | *
45 | * @author Michael Vorburger
46 | */
47 | public class LoggingTestWatchman extends TestWatchman {
48 |
49 | private final TestCaseReportWriter reportWriter;
50 |
51 | public LoggingTestWatchman(TestCaseReportWriter reportWriter) {
52 | this.reportWriter = reportWriter;
53 | }
54 |
55 | @Override
56 | public void starting(FrameworkMethod method) {
57 | reportWriter.clearInfoString();
58 | reportWriter.createNewTestReportFile(method, getReportFileName(method));
59 | reportWriter.info("Start Test: " + testName(method));
60 | reportWriter.getPackageName("Start Test: " + testName(method) + " :Package Name " + packageName(method));
61 | reportWriter.addTestClassNameToJS(createPackageNamewithTestName(method));
62 | }
63 |
64 | @Override
65 | public void finished(FrameworkMethod method) {
66 | reportWriter.info("End Test: " + testName(method));
67 | }
68 |
69 | @Override
70 | public void failed(Throwable t, FrameworkMethod method) {
71 | reportWriter.info("STACKTRACE:" + getStackTrace(t));
72 | reportWriter.info("Failed: " + testName(method));
73 | reportWriter.addFailedTestClassNameToJS(createPackageNamewithTestName(method));
74 | }
75 |
76 | @Override
77 | public void succeeded(FrameworkMethod method) {
78 | reportWriter.info("Test succeeded: " + testName(method));
79 | super.succeeded(method);
80 | }
81 |
82 | private String getStackTrace(Throwable throwable) {
83 | Writer writer = new StringWriter();
84 | PrintWriter printWriter = new PrintWriter(writer);
85 | throwable.printStackTrace(printWriter);
86 | return writer.toString();
87 | }
88 |
89 | private String testName(FrameworkMethod method) {
90 | return method.getMethod().getDeclaringClass().getCanonicalName() + "." + method.getName();
91 | }
92 |
93 | private String packageName(FrameworkMethod method) {
94 | return method.getMethod().getDeclaringClass().getPackage().getName();
95 | }
96 |
97 | private String extractPackageName(String fullPackageName) {
98 | int indx = fullPackageName.lastIndexOf(".");
99 | fullPackageName = fullPackageName.substring(indx + 1, fullPackageName.length());
100 | return fullPackageName.toUpperCase();
101 | }
102 |
103 | private String getReportFileName(FrameworkMethod method) {
104 | return extractPackageName(packageName(method)) + "/"
105 | + getLogFileName(method.getMethod().getDeclaringClass().getCanonicalName(),
106 | method.getMethod().getDeclaringClass().getCanonicalName()
107 | + "." + method.getName())
108 | + "_log.html";
109 | }
110 |
111 | private String getLogFileName(String className, String methodName) {
112 | int indx = methodName.lastIndexOf(".");
113 | methodName = methodName.substring(indx + 1, methodName.length());
114 |
115 | return methodName;
116 | }
117 |
118 | private String createPackageNamewithTestName(FrameworkMethod method) {
119 | String methodName = method.getName();
120 | String packageName = extractPackageName(packageName(method));
121 | return packageName + "." + methodName;
122 | }
123 |
124 | }
125 |
--------------------------------------------------------------------------------
/webdriver-reporting/src/main/java/ch/vorburger/webdriver/reporting/LoggingWebDriverEventListener.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2011 Michael Vorburger & other contributors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package ch.vorburger.webdriver.reporting;
18 |
19 | import java.io.File;
20 |
21 | import org.openqa.selenium.JavascriptExecutor;
22 | import org.openqa.selenium.OutputType;
23 | import org.openqa.selenium.StaleElementReferenceException;
24 | import org.openqa.selenium.TakesScreenshot;
25 | import org.openqa.selenium.WebDriver;
26 | import org.openqa.selenium.WebDriverException;
27 | import org.openqa.selenium.WebElement;
28 | import org.openqa.selenium.support.events.AbstractWebDriverEventListener;
29 | import org.openqa.selenium.support.events.EventFiringWebDriver;
30 |
31 |
32 | /**
33 | * A WebDriverEventListener which logs method calls.
34 | *
35 | * This class should not have any JUnit or I/O dependencies/imports, only WebDriver.
36 | *
37 | * @author Michael Vorburger
38 | */
39 | public class LoggingWebDriverEventListener extends AbstractWebDriverEventListener {
40 |
41 | private final TestCaseReportWriter clsObj;
42 |
43 | public LoggingWebDriverEventListener(TestCaseReportWriter object) {
44 | clsObj = object;
45 | }
46 |
47 | @Override
48 | public void beforeClickOn(WebElement element, WebDriver driver) {
49 | // try {
50 | // if (getTagNameSafely(element) != null) {
51 | // if ((getTagNameSafely(element).equalsIgnoreCase("span"))
52 | // || (getTagNameSafely(element).equalsIgnoreCase("button"))
53 | // || (getTagNameSafely(element).equalsIgnoreCase("div"))
54 | // || (getTagNameSafely(element).equalsIgnoreCase("img"))) {
55 |
56 | logAndTakeSnapShot(driver, element, "Before Clicking");
57 | // }
58 | // }
59 | // } catch (RuntimeException e) {
60 | // }
61 | }
62 |
63 | @Override
64 | public void beforeNavigateBack(WebDriver driver) {
65 | }
66 |
67 | @Override
68 | public void afterChangeValueOf(WebElement element, WebDriver driver) {
69 | try {
70 | String tagName = getTagNameSafely(element);
71 | if ("input".equalsIgnoreCase(tagName) || "select".equalsIgnoreCase(tagName) ) {
72 | logAndTakeSnapShot(driver, element, "Setting value '" + getValueSafely(element) + "' on");
73 | }
74 | } catch (RuntimeException e) {
75 | // "Shit happens" - guess we can't log this one then :-(
76 | }
77 | }
78 |
79 | @Override
80 | public void afterClickOn(WebElement element, WebDriver driver) {
81 | logAndTakeSnapShot(driver, element, "After Clicking");
82 | }
83 |
84 | @Override
85 | public void beforeNavigateForward(WebDriver driver) {
86 | clsObj.infoWithFlag(" navigateForward");
87 | }
88 |
89 | @Override
90 | public void beforeNavigateTo(String url, WebDriver driver) {
91 | clsObj.infoWithFlag(" Go to URL " + url);
92 | }
93 |
94 | /**
95 | * This method will take snap shots of screens and save them.
96 | *
97 | * @param driver WebDriver
98 | * @param element WebElement
99 | * @param log message from the action
100 | */
101 | protected void logAndTakeSnapShot(WebDriver driver, WebElement element, String log) {
102 | addStyleBeforeSnapShot(element, driver);
103 |
104 | if (driver instanceof EventFiringWebDriver) {
105 | EventFiringWebDriver eventFiringWebDriver = (EventFiringWebDriver) driver;
106 | driver = eventFiringWebDriver.getWrappedDriver();
107 | }
108 | if (driver instanceof TakesScreenshot) {
109 | TakesScreenshot takesScreenshotWebDriver = (TakesScreenshot) driver;
110 | File srcFile = takesScreenshotWebDriver.getScreenshotAs(OutputType.FILE);
111 | log(element, log, srcFile);
112 | removeStyleafterSnapShot(element, driver);
113 | } else {
114 | log(element, log, null);
115 | }
116 | }
117 |
118 | /**
119 | * Log, with a screenshot.
120 | *
121 | * @param element the WebElement, to give context, can be null if the previous message already gave it
122 | * @param message the message to log, never null
123 | * @param screenshot the Screenshot File, can be null if no screenshot is to be logged. The File is copied.
124 | */
125 | private void log(WebElement element, String message, File screenshot) {
126 | StringBuilder sb = new StringBuilder();
127 | sb.append(message);
128 | if (element != null) {
129 | sb.append(" ");
130 | String userVisibleLabel = getUserVisibleText(element);
131 | if (userVisibleLabel != null) {
132 | sb.append("'" + userVisibleLabel + "', ");
133 | }
134 | sb.append("element");
135 | if (getAttributeSafely(element, "id") != null) {
136 | String id = getAttributeSafely(element, "id");
137 | sb.append(" with ID " + id);
138 | }
139 | // Show the name only if there is no ID (id is stronger)
140 | else if (getAttributeSafely(element, "name") != null) {
141 | sb.append(" with name " + element.getAttribute("name"));
142 | }
143 | }
144 | clsObj.infoWithFlagAndScreenshot(sb.toString(), screenshot);
145 | }
146 |
147 | /**
148 | * Clearest is an element text (content), if none (e.g. icons) try title, else alt.
149 | */
150 | private String getUserVisibleText(WebElement element) {
151 | String text = getTextSafely(element);
152 | String title = getAttributeSafely(element, "title");
153 | String alt = getAttributeSafely(element, "alt");
154 | if ((text != null) && (!text.trim().isEmpty())) {
155 | return text;
156 | } else if (title != null) {
157 | return title;
158 | } else if (alt != null) {
159 | return alt;
160 | } else {
161 | return null;
162 | }
163 | }
164 |
165 | private String getTextSafely(WebElement element) {
166 | try {
167 | return element.getText();
168 | } catch (Exception e) {
169 | // If we couldn't get the attribute, something is wrong, it probably
170 | // doesn't have one, so let's just return null:
171 | return null;
172 | }
173 | }
174 |
175 | private String getAttributeSafely(WebElement element, String attributeName) {
176 | try {
177 | return element.getAttribute(attributeName);
178 | } catch (WebDriverException e) {
179 | // If we couldn't get the attribute, something is wrong, it probably
180 | // doesn't have one, so let's just return null:
181 | return null;
182 | }
183 | }
184 |
185 | private String getValueSafely(WebElement element) {
186 | return getAttributeSafely(element, "value");
187 | }
188 |
189 | private String getTagNameSafely(WebElement element) {
190 | try {
191 | return element.getTagName();
192 | } catch (WebDriverException e) {
193 | // If we couldn't get the attribute, something is wrong, it probably
194 | // doesn't have one, so let's just return null:
195 | return null;
196 | }
197 | }
198 |
199 | public void addStyleBeforeSnapShot(WebElement element, WebDriver driver) {
200 | String webElementId;
201 | if (element != null) {
202 | try {
203 | webElementId = element.getAttribute("id");
204 | } catch (StaleElementReferenceException e) {
205 | webElementId = null;
206 | }
207 |
208 | if (webElementId != null && ! webElementId.isEmpty() && driver instanceof JavascriptExecutor) {
209 | try {
210 | ((JavascriptExecutor) driver).executeScript("document.getElementById('" + webElementId
211 | + "').setAttribute('style','border:solid 2px #73A6FF;background:#EFF5FF;')", "");
212 | } catch (Throwable e) {
213 | // Highlight ON didn't work, tant pis.
214 | }
215 | }
216 | }
217 | }
218 |
219 | public void removeStyleafterSnapShot(WebElement element, WebDriver driver) {
220 | String webElementId;
221 | if (element != null) {
222 | webElementId = getAttributeSafely(element, "id");
223 |
224 | if (webElementId != null && ! webElementId.isEmpty() && driver instanceof JavascriptExecutor) {
225 | try {
226 | ((JavascriptExecutor) driver).executeScript("document.getElementById('" + webElementId
227 | + "').setAttribute('style','border:;background:;')", "");
228 | } catch (Throwable e) {
229 | // Highlight OFF didn't work, tant pis.
230 | }
231 | }
232 | }
233 | }
234 | }
235 |
--------------------------------------------------------------------------------
/webdriver-reporting/src/main/java/ch/vorburger/webdriver/reporting/TestCaseReportWriter.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2011 Michael Vorburger & other contributors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package ch.vorburger.webdriver.reporting;
18 |
19 | import java.io.BufferedWriter;
20 | import java.io.File;
21 | import java.io.FileWriter;
22 | import java.io.IOException;
23 | import java.net.URL;
24 | import java.util.LinkedList;
25 | import java.util.List;
26 |
27 | import org.apache.commons.io.FileUtils;
28 | import org.junit.runners.model.FrameworkMethod;
29 |
30 | /**
31 | * Report Writer.
32 | *
33 | * This class should not have any JUnit or WebDriver dependencies/imports, only I/O.
34 | *
35 | * @author Nasir Raza
36 | * @author Michael Vorburger
37 | */
38 | public class TestCaseReportWriter
39 | {
40 | private static final String START_TEST = "Start";
41 | private static final String END_TEST = "End";
42 | private static final String LOG_FLAG = "Logflag";
43 | private static final String LINE_SEP = System.getProperty("line.separator");
44 | private static final String APPENDED_JS = "jquery-ui-1.8.5.custom.min.js";
45 | private final static String SCREENSHOTS_DIR_NAME = "screenshots/";
46 |
47 | private final List