Merge pull request #131 from telekom/refactoring/page-loaded

Added Page.pageLoaded() callback
telekom · Sep 29, 2021 · 1e74024 · 1e74024
2 parents ddfda1a + 01847d7
commit 1e74024
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 0 deletions.
diff --git a/docs/src/docs/pageobject/pageobjects-callback-methods.adoc b/docs/src/docs/pageobject/pageobjects-callback-methods.adoc
@@ -0,0 +1,17 @@
+= Page loaded callback
+
+You can add a custom action if a page was loaded successfully.
+
+[source,java]
+----
+public class MyPage extends Page {
+
+    ...
+
+    @Override
+    protected void pageLoaded() {
+        super.pageLoaded();
+        // Add here your custom action
+    }
+}
+----
diff --git a/docs/src/docs/pageobjects.adoc b/docs/src/docs/pageobjects.adoc
@@ -4,6 +4,7 @@ include::pageobject/pageobjects-overview.adoc[leveloffset=+1]
 include::pageobject/pageobjects-instantiation.adoc[leveloffset=+1]
 include::pageobject/pageobjects-responsive.adoc[leveloffset=+1]
 include::pageobject/pageobjects-check-annotations.adoc[leveloffset=+1]
+include::pageobject/pageobjects-callback-methods.adoc[leveloffset=+1]
 include::pageobject/pageobjects-error-handling.adoc[leveloffset=+1]
 include::pageobject/pageobjects-timeout-setting.adoc[leveloffset=+1]
 include::pageobject/pageobjects-assertions.adoc[leveloffset=+1]

diff --git a/driver-ui/src/main/java/eu/tsystems/mms/tic/testframework/pageobjects/AbstractPage.java b/driver-ui/src/main/java/eu/tsystems/mms/tic/testframework/pageobjects/AbstractPage.java
@@ -208,6 +208,11 @@ private void pCheckPage(final boolean findNot, final boolean fast, final boolean
         }
 
         screenShotOnPageLoad();
+        pageLoaded();
+    }
+
+    protected void pageLoaded() {
+
     }
 
     protected void checkPagePreparation() {

diff --git a/...sts/src/test/java/eu/tsystems/mms/tic/testframework/test/pagefactory/PageFactoryTest.java b/...sts/src/test/java/eu/tsystems/mms/tic/testframework/test/pagefactory/PageFactoryTest.java
@@ -36,12 +36,14 @@
 import eu.tsystems.mms.tic.testframework.core.pageobjects.testdata.ResponsiveWebTestPage_Min_600px;
 import eu.tsystems.mms.tic.testframework.core.testpage.TestPage;
 import eu.tsystems.mms.tic.testframework.execution.testng.AssertCollector;
+import eu.tsystems.mms.tic.testframework.pageobjects.Page;
 import eu.tsystems.mms.tic.testframework.pageobjects.factory.PageFactory;
 import eu.tsystems.mms.tic.testframework.webdrivermanager.AbstractWebDriverRequest;
 import eu.tsystems.mms.tic.testframework.webdrivermanager.UnspecificWebDriverRequest;
 import eu.tsystems.mms.tic.testframework.webdrivermanager.WebDriverManager;
 import eu.tsystems.mms.tic.testframework.webdrivermanager.WebDriverManagerConfig;
 import java.net.MalformedURLException;
+import java.util.concurrent.atomic.AtomicBoolean;
 import org.openqa.selenium.WebDriver;
 import org.testng.Assert;
 import org.testng.annotations.AfterClass;
@@ -146,4 +148,21 @@ public void testT08_CheckNot() {
         final PageWithExistingElement pageWithExistingElement = PageFactory.create(PageWithExistingElement.class, driver);
         final PageWithNotExistingElementWithoutCheckPage pageWithNotExistingElement = PageFactory.checkNot(PageWithNotExistingElementWithoutCheckPage.class, driver);
     }
+
+    @Test
+    public void test_pageLoadedCallback() {
+        WebDriver webDriver = getWebDriver();
+        AtomicBoolean atomicBoolean = new AtomicBoolean();
+
+        Page testPage = new Page(webDriver) {
+            @Override
+            protected void pageLoaded() {
+                super.pageLoaded();
+                atomicBoolean.set(true);
+            }
+        };
+
+        testPage.checkPage();
+        Assert.assertTrue(atomicBoolean.get());
+    }
 }