Add ability to hide Shadow DOM attachments in report

vividus-framework · Oct 8, 2024 · 1077fa3 · 1077fa3
1 parent 9b44c31
commit 1077fa3
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 2 deletions.
diff --git a/docs/modules/plugins/partials/selenium-properties.adoc b/docs/modules/plugins/partials/selenium-properties.adoc
@@ -44,6 +44,12 @@ a|`true` +
 |`true`
 |Whether to publish the application source code on failure or not
 
+|`ui.publish-shadow-dom-source-on-failure`
+a|`true` +
+`false`
+|`true`
+|Whether to publish the source code of Shadow DOM elements on failure or not
+
 |`ui.context.self-healing`
 a|`true` +
 `false`

diff --git a/vividus-extension-selenium/src/main/resources/properties/defaults/default.properties b/vividus-extension-selenium/src/main/resources/properties/defaults/default.properties
@@ -7,6 +7,7 @@ ui.wait.timeout=PT1M
 ui.wait.polling-period=PT2S
 
 ui.publish-source-on-failure=true
+ui.publish-shadow-dom-source-on-failure=true
 
 screenshot.on-failure.debug-modes=
 

diff --git a/vividus-plugin-web-app/src/main/java/org/vividus/selenium/WebContextSourceCodeProvider.java b/vividus-plugin-web-app/src/main/java/org/vividus/selenium/WebContextSourceCodeProvider.java
@@ -37,6 +37,8 @@ public class WebContextSourceCodeProvider implements ContextSourceCodeProvider
  private final IUiContext uiContext;
  private final WebJavascriptActions webJavascriptActions;
 
+ private boolean collectShadowDomSourceCode;
+
  protected WebContextSourceCodeProvider(IUiContext uiContext, WebJavascriptActions webJavascriptActions)
  {
  this.uiContext = uiContext;
@@ -62,7 +64,10 @@ else if (searchContext instanceof WebDriver webDriver)
  {
  sources.put(APPLICATION_SOURCE_CODE, sourceCode);
  }
- sources.putAll(getShadowDomSourceCode(elementInContext, searchContext));
+ if (collectShadowDomSourceCode)
+ {
+ sources.putAll(getShadowDomSourceCode(elementInContext, searchContext));
+ }
  return sources;
  }
 
@@ -103,4 +108,9 @@ private String getElementSource(SearchContext searchContext)
  return null;
  }
  }
+
+ public void setCollectShadowDomSourceCode(boolean collectShadowDomSourceCode)
+ {
+ this.collectShadowDomSourceCode = collectShadowDomSourceCode;
+ }
 }
diff --git a/vividus-plugin-web-app/src/main/resources/vividus-plugin/spring.xml b/vividus-plugin-web-app/src/main/resources/vividus-plugin/spring.xml
@@ -216,7 +216,9 @@
  <bean class="org.vividus.ui.web.monitor.PublishingWebScreenshotOnFailureMonitor"
  parent="abstractPublishingScreenshotOnFailureMonitor"/>
 
- <bean class="org.vividus.selenium.WebContextSourceCodeProvider" />
+ <bean class="org.vividus.selenium.WebContextSourceCodeProvider">
+ <property name="collectShadowDomSourceCode" value="${ui.publish-shadow-dom-source-on-failure}" />
+ </bean>
 
  <bean class="org.vividus.ui.listener.SourceCodePublishingOnFailureListener" lazy-init="false">
  <property name="publishSourceOnFailure" value="${ui.publish-source-on-failure}" />

diff --git a/...-plugin-web-app/src/test/java/org/vividus/selenium/WebContextSourceCodeProviderTests.java b/...-plugin-web-app/src/test/java/org/vividus/selenium/WebContextSourceCodeProviderTests.java
@@ -20,6 +20,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verifyNoInteractions;
 import static org.mockito.Mockito.when;
 
 import java.util.List;
@@ -73,6 +74,7 @@ class WebContextSourceCodeProviderTests
  @Test
  void shouldReturnWholePageForDriverContext()
  {
+ sourceCodeProvider.setCollectShadowDomSourceCode(true);
  var webDriver = mock(WebDriver.class);
  when(uiContext.getSearchContext()).thenReturn(webDriver);
  var pageSource = "<html/>";
@@ -85,9 +87,23 @@ void shouldReturnWholePageForDriverContext()
  sourceCodeProvider.getSourceCode());
  }
 
+ @SuppressFBWarnings("VA_FORMAT_STRING_USES_NEWLINE")
+ @Test
+ void shouldReturnWholePageForDriverContextNoShadowDom()
+ {
+ sourceCodeProvider.setCollectShadowDomSourceCode(false);
+ var webDriver = mock(WebDriver.class);
+ when(uiContext.getSearchContext()).thenReturn(webDriver);
+ var pageSource = "<html></html>";
+ when(webDriver.getPageSource()).thenReturn(pageSource);
+ assertEquals(Map.of(APPLICATION_SOURCE_CODE, pageSource), sourceCodeProvider.getSourceCode());
+ verifyNoInteractions(webJavascriptActions);
+ }
+
  @Test
  void shouldReturnElementSourceForElementContext()
  {
+ sourceCodeProvider.setCollectShadowDomSourceCode(true);
  var webElement = mock(WebElement.class);
  when(uiContext.getSearchContext()).thenReturn(webElement);
  var elementSource = "<div/>";
@@ -101,6 +117,7 @@ void shouldReturnElementSourceForElementContext()
  @Test
  void shouldHandleStaleElementsCorrectly()
  {
+ sourceCodeProvider.setCollectShadowDomSourceCode(true);
  var webElement = mock(WebElement.class);
  when(uiContext.getSearchContext()).thenReturn(webElement);
  when(webJavascriptActions.executeScript(OUTER_HTML_SCRIPT, webElement)).thenThrow(
@@ -113,6 +130,7 @@ void shouldHandleStaleElementsCorrectly()
  @Test
  void shouldReturnEmptyValueForNullSearchContext()
  {
+ sourceCodeProvider.setCollectShadowDomSourceCode(true);
  when(uiContext.getSearchContext()).thenReturn(null);
  when(webJavascriptActions.executeScript(any(String.class))).thenReturn(Map.of());
  assertEquals(Map.of(), sourceCodeProvider.getSourceCode());