From fcfa4d775b88dd83521a16717d851aeb228105fc Mon Sep 17 00:00:00 2001 From: Joanna Janaszek Date: Mon, 21 Jan 2019 08:03:44 +0100 Subject: [PATCH 1/4] add loggers in collector/modifier --- .../accessibility/AccessibilityCollector.java | 6 ++++ .../ExecuteJavaScriptModifier.java | 1 + .../common/modifiers/hide/HideModifier.java | 1 + .../common/modifiers/login/LoginModifier.java | 1 + .../replacetext/ReplaceTextModifier.java | 1 + .../resolution/ResolutionModifier.java | 1 + .../modifiers/scroll/ScrollModifier.java | 5 ++++ .../WaitForImageCompletionModifier.java | 1 + .../javascript/JavaScriptJobExecutor.java | 2 +- report/src/main/webapp/package-lock.json | 28 ++++++++++++++----- 10 files changed, 39 insertions(+), 8 deletions(-) diff --git a/core/jobs/src/main/java/com/cognifide/aet/job/common/collectors/accessibility/AccessibilityCollector.java b/core/jobs/src/main/java/com/cognifide/aet/job/common/collectors/accessibility/AccessibilityCollector.java index 381d30ab5..ebce1103a 100644 --- a/core/jobs/src/main/java/com/cognifide/aet/job/common/collectors/accessibility/AccessibilityCollector.java +++ b/core/jobs/src/main/java/com/cognifide/aet/job/common/collectors/accessibility/AccessibilityCollector.java @@ -33,6 +33,8 @@ import org.apache.commons.io.IOUtils; import org.apache.commons.lang3.StringUtils; import org.osgi.framework.BundleContext; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; public class AccessibilityCollector implements CollectorJob { @@ -42,6 +44,8 @@ public class AccessibilityCollector implements CollectorJob { private static final String PARAM_STANDARD = "standard"; private static final String DEFAULT_STANDARD = "WCAG2AA"; + private static final Logger LOGGER = LoggerFactory.getLogger(AccessibilityCollector.class); + private final ArtifactsDAO artifactsDAO; private final BundleContext context; private final CollectorProperties properties; @@ -60,8 +64,10 @@ public class AccessibilityCollector implements CollectorJob { @Override public CollectorStepResult collect() throws ProcessingException { String script = getScriptFromFile(); + LOGGER.debug("Executing Accessibility Collector"); final String html = jsExecutor.execute(DOCUMENT_OUTER_HTML_SCRIPT) .getExecutionResultAsString(); + LOGGER.debug("Executing Accessibility Collector"); final String json = jsExecutor.execute(script, standard).getExecutionResultAsString(); List issues = parseIssues(json); getElementsPositions(issues, html); diff --git a/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/executejavascript/ExecuteJavaScriptModifier.java b/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/executejavascript/ExecuteJavaScriptModifier.java index fe24ffc86..6f2731031 100644 --- a/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/executejavascript/ExecuteJavaScriptModifier.java +++ b/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/executejavascript/ExecuteJavaScriptModifier.java @@ -56,6 +56,7 @@ public CollectorStepResult collect() throws ProcessingException { CollectorStepResult result; String jsSnippet = getJsSnippet(); try { + LOG.debug("Executing Java Script Modifier"); jsExecutor.execute(jsSnippet); result = CollectorStepResult.newModifierResult(); } catch (ProcessingException ex) { diff --git a/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/hide/HideModifier.java b/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/hide/HideModifier.java index d57a3fe07..a89b03943 100644 --- a/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/hide/HideModifier.java +++ b/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/hide/HideModifier.java @@ -104,6 +104,7 @@ private void hideElements(By locator, boolean leaveBlankSpace) throws Processing .waitForElementToBePresent(webDriver, locator, getTimeoutInSeconds()); List webElements = webDriver.findElements(locator); + LOG.debug("Executing Hide Modifier"); for (WebElement element : webElements) { jsExecutor.execute(script, element); } diff --git a/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/login/LoginModifier.java b/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/login/LoginModifier.java index df4e03f7f..a9dffbc22 100644 --- a/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/login/LoginModifier.java +++ b/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/login/LoginModifier.java @@ -96,6 +96,7 @@ private void loginToForm() throws ProcessingException { LoginFormComponent form = new LoginFormComponent(webDriver, config.getLoginInputSelector(), config.getPasswordInputSelector(), config.getSubmitButtonSelector(), new JavaScriptJobExecutor(webDriver)); + LOGGER.debug("Executing Login Modifier"); form.login(config.getLogin(), config.getPassword()); } diff --git a/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/replacetext/ReplaceTextModifier.java b/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/replacetext/ReplaceTextModifier.java index 9d6a1146f..b5940a224 100644 --- a/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/replacetext/ReplaceTextModifier.java +++ b/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/replacetext/ReplaceTextModifier.java @@ -99,6 +99,7 @@ private void replaceElements() throws ProcessingException { .waitForElementToBePresent(webDriver, elementLocator, getTimeoutInSeconds()); List webElements = webDriver.findElements(elementLocator); + LOG.debug("Executing Replace Text Modifier"); for (WebElement element : webElements) { jsExecutor.execute(script, element, value); } diff --git a/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/resolution/ResolutionModifier.java b/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/resolution/ResolutionModifier.java index 6df29d030..9b64c72b9 100644 --- a/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/resolution/ResolutionModifier.java +++ b/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/resolution/ResolutionModifier.java @@ -121,6 +121,7 @@ private int calculateWindowHeight() { Supplier heightSupplier = () -> { int heightResult = HEIGHT_NOT_CALCULATED; try { + LOG.debug("Executing Resolution Modifier"); heightResult = Integer.parseInt( jsExecutor.execute(JAVASCRIPT_GET_BODY_HEIGHT).getExecutionResultAsString()); } catch (ProcessingException e) { diff --git a/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/scroll/ScrollModifier.java b/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/scroll/ScrollModifier.java index 4c3e34080..6a0ac7dba 100644 --- a/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/scroll/ScrollModifier.java +++ b/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/scroll/ScrollModifier.java @@ -20,11 +20,15 @@ import com.cognifide.aet.job.api.exceptions.ParametersException; import com.cognifide.aet.job.api.exceptions.ProcessingException; import com.cognifide.aet.job.common.utils.javascript.JavaScriptJobExecutor; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + import java.util.Map; class ScrollModifier implements CollectorJob { static final String NAME = "scroll"; + private static final Logger LOG = LoggerFactory.getLogger(ScrollModifier.class); private final ScrollModifierParamsParser parametersParser; private final JavaScriptJobExecutor jsExecutor; @@ -42,6 +46,7 @@ public void setParameters(Map params) throws ParametersException @Override public CollectorStepResult collect() throws ProcessingException { String jsSnippet = parametersParser.getJavaScriptSnippet(); + LOG.debug("Executing Scroll Modifier"); jsExecutor.execute(jsSnippet); return CollectorStepResult.newModifierResult(); } diff --git a/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/waitfor/imagecompletion/WaitForImageCompletionModifier.java b/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/waitfor/imagecompletion/WaitForImageCompletionModifier.java index b14ff53b2..8c24f7a2f 100644 --- a/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/waitfor/imagecompletion/WaitForImageCompletionModifier.java +++ b/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/waitfor/imagecompletion/WaitForImageCompletionModifier.java @@ -65,6 +65,7 @@ private Boolean waitForImageCompletion(WebDriver webDriver) { Boolean complete; WebElement element = webDriver.findElement(getLocator()); try { + LOGGER.debug("Executing Wait For Image Completion Modifier"); complete = (Boolean) jsExecutor.execute("return arguments[0].complete", element) .getExecutionResult() .orElse(false); diff --git a/core/jobs/src/main/java/com/cognifide/aet/job/common/utils/javascript/JavaScriptJobExecutor.java b/core/jobs/src/main/java/com/cognifide/aet/job/common/utils/javascript/JavaScriptJobExecutor.java index ee73809b5..e5ca09b93 100644 --- a/core/jobs/src/main/java/com/cognifide/aet/job/common/utils/javascript/JavaScriptJobExecutor.java +++ b/core/jobs/src/main/java/com/cognifide/aet/job/common/utils/javascript/JavaScriptJobExecutor.java @@ -48,7 +48,7 @@ public JavaScriptJobResult execute(String jsSnippet, Object... elements) private JavaScriptJobResult executeJs(String jsSnippet, Object... elements) { if (LOGGER.isDebugEnabled()) { - LOGGER.debug("Executing JavaScript command: {} on page: {}", jsSnippet, currentUrl); + LOGGER.trace("Executing JavaScript command: {} on page: {}", jsSnippet, currentUrl); } Object jsResult = executor.executeScript(jsSnippet, elements); return new JavaScriptJobResult(jsResult); diff --git a/report/src/main/webapp/package-lock.json b/report/src/main/webapp/package-lock.json index 92ec69283..360117353 100644 --- a/report/src/main/webapp/package-lock.json +++ b/report/src/main/webapp/package-lock.json @@ -5379,12 +5379,14 @@ "balanced-match": { "version": "1.0.0", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "brace-expansion": { "version": "1.1.11", "bundled": true, "dev": true, + "optional": true, "requires": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -5399,17 +5401,20 @@ "code-point-at": { "version": "1.1.0", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "concat-map": { "version": "0.0.1", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "console-control-strings": { "version": "1.1.0", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "core-util-is": { "version": "1.0.2", @@ -5526,7 +5531,8 @@ "inherits": { "version": "2.0.3", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "ini": { "version": "1.3.5", @@ -5538,6 +5544,7 @@ "version": "1.0.0", "bundled": true, "dev": true, + "optional": true, "requires": { "number-is-nan": "^1.0.0" } @@ -5552,6 +5559,7 @@ "version": "3.0.4", "bundled": true, "dev": true, + "optional": true, "requires": { "brace-expansion": "^1.1.7" } @@ -5559,12 +5567,14 @@ "minimist": { "version": "0.0.8", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "minipass": { "version": "2.2.4", "bundled": true, "dev": true, + "optional": true, "requires": { "safe-buffer": "^5.1.1", "yallist": "^3.0.0" @@ -5583,6 +5593,7 @@ "version": "0.5.1", "bundled": true, "dev": true, + "optional": true, "requires": { "minimist": "0.0.8" } @@ -5663,7 +5674,8 @@ "number-is-nan": { "version": "1.0.1", "bundled": true, - "dev": true + "dev": true, + "optional": true }, "object-assign": { "version": "4.1.1", @@ -5675,6 +5687,7 @@ "version": "1.4.0", "bundled": true, "dev": true, + "optional": true, "requires": { "wrappy": "1" } @@ -5796,6 +5809,7 @@ "version": "1.0.2", "bundled": true, "dev": true, + "optional": true, "requires": { "code-point-at": "^1.0.0", "is-fullwidth-code-point": "^1.0.0", From c7ed4380caf22f63d09b534da708d2cf2459d153 Mon Sep 17 00:00:00 2001 From: Joanna Janaszek Date: Mon, 21 Jan 2019 08:26:55 +0100 Subject: [PATCH 2/4] update changelog --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 97a9e0f4f..3bdb89457 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,7 +25,8 @@ All notable changes to AET will be documented in this file. - [PR-404](https://github.com/Cognifide/aet/pull/404) Added missing tooltip for conditional tests - [PR-408](https://github.com/Cognifide/aet/pull/408) Advanced Screen Comparision button layout fix - [PR-410](https://github.com/Cognifide/aet/pull/410) Notification that displays when exclude-elements are not found on page now shows what specific elements were not found([#372](https://github.com/Cognifide/aet/issues/372)) - +- [PR-468](https://github.com/Cognifide/aet/pull/468) Add loggers in collector/modifier([#446](https://github.com/Cognifide/aet/issues/446)) + ## Version 3.1.0 - [PR-409](https://github.com/Cognifide/aet/pull/409) Added sources link in "view source" url From 715fb661727a24d59904e4de1f44d91b6d35fd7d Mon Sep 17 00:00:00 2001 From: Joanna Janaszek Date: Mon, 21 Jan 2019 08:44:27 +0100 Subject: [PATCH 3/4] update changelog --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3bdb89457..864f9048f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ All notable changes to AET will be documented in this file. ## Unreleased **List of changes that are finished but not yet released in any final version.** +- [PR-468](https://github.com/Cognifide/aet/pull/468) Add loggers in collector/modifier([#446](https://github.com/Cognifide/aet/issues/446)) ## Version 3.2.0 @@ -25,7 +26,6 @@ All notable changes to AET will be documented in this file. - [PR-404](https://github.com/Cognifide/aet/pull/404) Added missing tooltip for conditional tests - [PR-408](https://github.com/Cognifide/aet/pull/408) Advanced Screen Comparision button layout fix - [PR-410](https://github.com/Cognifide/aet/pull/410) Notification that displays when exclude-elements are not found on page now shows what specific elements were not found([#372](https://github.com/Cognifide/aet/issues/372)) -- [PR-468](https://github.com/Cognifide/aet/pull/468) Add loggers in collector/modifier([#446](https://github.com/Cognifide/aet/issues/446)) ## Version 3.1.0 From ae9ff4203af992200d9bf5340b3e2bbee1a7ef72 Mon Sep 17 00:00:00 2001 From: Joanna Janaszek Date: Mon, 28 Jan 2019 08:42:50 +0100 Subject: [PATCH 4/4] code refactor --- .../common/collectors/accessibility/AccessibilityCollector.java | 1 - .../modifiers/executejavascript/ExecuteJavaScriptModifier.java | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/core/jobs/src/main/java/com/cognifide/aet/job/common/collectors/accessibility/AccessibilityCollector.java b/core/jobs/src/main/java/com/cognifide/aet/job/common/collectors/accessibility/AccessibilityCollector.java index ebce1103a..af1a504d0 100644 --- a/core/jobs/src/main/java/com/cognifide/aet/job/common/collectors/accessibility/AccessibilityCollector.java +++ b/core/jobs/src/main/java/com/cognifide/aet/job/common/collectors/accessibility/AccessibilityCollector.java @@ -67,7 +67,6 @@ public CollectorStepResult collect() throws ProcessingException { LOGGER.debug("Executing Accessibility Collector"); final String html = jsExecutor.execute(DOCUMENT_OUTER_HTML_SCRIPT) .getExecutionResultAsString(); - LOGGER.debug("Executing Accessibility Collector"); final String json = jsExecutor.execute(script, standard).getExecutionResultAsString(); List issues = parseIssues(json); getElementsPositions(issues, html); diff --git a/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/executejavascript/ExecuteJavaScriptModifier.java b/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/executejavascript/ExecuteJavaScriptModifier.java index 6f2731031..caa328221 100644 --- a/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/executejavascript/ExecuteJavaScriptModifier.java +++ b/core/jobs/src/main/java/com/cognifide/aet/job/common/modifiers/executejavascript/ExecuteJavaScriptModifier.java @@ -56,7 +56,7 @@ public CollectorStepResult collect() throws ProcessingException { CollectorStepResult result; String jsSnippet = getJsSnippet(); try { - LOG.debug("Executing Java Script Modifier"); + LOG.debug("Executing JavaScript Modifier"); jsExecutor.execute(jsSnippet); result = CollectorStepResult.newModifierResult(); } catch (ProcessingException ex) {