Merge branch 'develop'

pogen4selenium-api/pom.xml

@@ -9,7 +9,7 @@
     <parent>
         <groupId>io.toolisticon.pogen4selenium</groupId>
         <artifactId>pogen4selenium</artifactId>
-        <version>0.4.1</version>
+        <version>0.5.0</version>
     </parent>
 
     <name>pogen4selenium-api</name>

pogen4selenium-api/src/main/java/io/toolisticon/pogen4selenium/api/Action.java

@@ -0,0 +1,20 @@
+package io.toolisticon.pogen4selenium.api;
+
+import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ * Meta-Annotation to allow custom annotations.
+ * 
+ */
+
+@Documented
+@Retention(RUNTIME)
+@Target(ANNOTATION_TYPE)
+public @interface Action {
+
+}

pogen4selenium-api/src/main/java/io/toolisticon/pogen4selenium/api/ActionClick.java

@@ -7,6 +7,16 @@
 
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)
+@Action
 public @interface ActionClick {
+
+	/**
+	 * The locator type to use. Can be ELEMENT for using a generated element or any kind of locator provided by selenium.
+	 * @return the locator to use.
+	 */
+	_By by() default _By.ELEMENT;
+
+	/** The locator string to use. */
 	String value();
+
 }

pogen4selenium-api/src/main/java/io/toolisticon/pogen4selenium/api/ActionMoveToAndClick.java

@@ -7,6 +7,16 @@
 
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)
+@Action
 public @interface ActionMoveToAndClick {
+
+	/**
+	 * The locator type to use. Can be ELEMENT for using a generated element or any kind of locator provided by selenium.
+	 * @return the locator to use.
+	 */
+	_By by() default _By.ELEMENT;
+
+	/** The locator string to use. */
 	String value();
+
 }

pogen4selenium-api/src/main/java/io/toolisticon/pogen4selenium/api/ActionWrite.java

@@ -7,6 +7,16 @@
 
 @Target(ElementType.PARAMETER)
 @Retention(RetentionPolicy.RUNTIME)
+@Action
 public @interface ActionWrite {
+
+	/**
+	 * The locator type to use. Can be ELEMENT for using a generated element or any kind of locator provided by selenium.
+	 * @return the locator to use.
+	 */
+	_By by() default _By.ELEMENT;
+
+	/** The locator string to use. */
 	String value();
+
 }

pogen4selenium-api/src/main/java/io/toolisticon/pogen4selenium/runtime/PageObjectParentImpl.java

@@ -87,38 +87,50 @@ protected void waitUntilUrl(String urlRegex) {
     	wait.until(ExpectedConditions.urlMatches(urlRegex));
 	}
 
-	protected void waitForElementToBeClickable(String xpath) {
+
+	protected void waitForElementToBeInteractable(String xpath) {
+		waitForElementToBeInteractable(By.xpath(xpath));
+	}
+
+	protected WebElement waitForElementToBeInteractable(By by) {
 		Wait<WebDriver> wait =
     	        new FluentWait<>(driver)
     	            .withTimeout(Duration.ofSeconds(15))
     	            .pollingEvery(Duration.ofMillis(300))
     	            .ignoring(ElementNotInteractableException.class);
 
-    	wait.until(ExpectedConditions.elementToBeClickable(By.xpath(xpath)));
+    	return wait.until(ExpectedConditions.elementToBeClickable(by));
 	}
 
-	protected void waitForElementToBeClickable(WebElement element) {
+	protected WebElement waitForElementToBeInteractable(WebElement element) {
+		if(element == null) {
+			return null;
+		}
+
 		Wait<WebDriver> wait =
     	        new FluentWait<>(driver)
     	            .withTimeout(Duration.ofSeconds(15))
     	            .pollingEvery(Duration.ofMillis(300))
-    	            .ignoring(NullPointerException.class);
+    	            .ignoring(ElementNotInteractableException.class);
 
-    	wait.until(ExpectedConditions.elementToBeClickable(element));
+    	return wait.until(ExpectedConditions.elementToBeClickable(element));
 	}
 
 	protected void waitForElementToBePresent(String xpath) {
+		waitForElementToBePresent(By.xpath(xpath));
+	}
+
+	protected WebElement waitForElementToBePresent(By by) {
 		Wait<WebDriver> wait =
     	        new FluentWait<>(driver)
     	            .withTimeout(Duration.ofSeconds(15))
     	            .pollingEvery(Duration.ofMillis(300))
     	            .ignoring(NoSuchElementException.class);
 
-    	wait.until(ExpectedConditions.presenceOfElementLocated(By.xpath(xpath)));
+    	return wait.until(ExpectedConditions.presenceOfElementLocated(by));
+
 	}
 
-
-
 	protected void waitForElementToBeAbsent(String xpath) {
 		Wait<WebDriver> wait =
     	        new FluentWait<>(driver)

pogen4selenium-example/pom.xml

@@ -9,7 +9,7 @@
     <parent>
         <groupId>io.toolisticon.pogen4selenium</groupId>
         <artifactId>pogen4selenium</artifactId>
-        <version>0.4.1</version>
+        <version>0.5.0</version>
     </parent>
 
     <name>pogen4selenium-example</name>
@@ -33,7 +33,7 @@
         <dependency>
             <groupId>io.toolisticon.pogen4selenium</groupId>
             <artifactId>pogen4selenium-api</artifactId>
-            <version>0.4.1</version>
+            <version>0.5.0</version>
         </dependency>
 
         <dependency>

pogen4selenium-example/src/main/java/io/toolisticon/pogen4selenium/example/withoutpagefactory/TestPagePageObject.java

@@ -0,0 +1,53 @@
+package io.toolisticon.pogen4selenium.example.withoutpagefactory;
+
+import java.util.List;
+
+import org.openqa.selenium.WebDriver;
+
+import io.toolisticon.pogen4selenium.api.ActionMoveToAndClick;
+import io.toolisticon.pogen4selenium.api.ActionWrite;
+import io.toolisticon.pogen4selenium.api._By;
+import io.toolisticon.pogen4selenium.api.ExtractData;
+import io.toolisticon.pogen4selenium.api.ExtractDataValue;
+import io.toolisticon.pogen4selenium.api.ExtractDataValue.Kind;
+import io.toolisticon.pogen4selenium.api.PageObject;
+import io.toolisticon.pogen4selenium.api.PageObjectElement;
+import io.toolisticon.pogen4selenium.api.PageObjectParent;
+import io.toolisticon.pogen4selenium.api.Pause;
+
+@PageObject
+public interface TestPagePageObject extends PageObjectParent<TestPagePageObject>{
+
+	static final String DATA_EXTRACTION_FROM_TABLE_XPATH = "//table//tr[contains(@class,'data')]";
+
+
+	TestPagePageObject writeToInputField(@ActionWrite(by=_By.ID, value="input_field") String value);
+
+	@ExtractDataValue(by=_By.ID, value = "input_field", kind=Kind.ATTRIBUTE, name="value")
+	String readInputFieldValue();
+
+	@ActionMoveToAndClick(by=_By.XPATH, value = "//fieldset[@name='counter']/input[@type='button']")
+	@Pause(value = 500L)
+	TestPagePageObject clickCounterIncrementButton();	
+
+	@ExtractData(by = io.toolisticon.pogen4selenium.api._By.XPATH, value = DATA_EXTRACTION_FROM_TABLE_XPATH)
+	List<TestPageTableEntry> getTableEntries();
+
+	@ExtractData(by = io.toolisticon.pogen4selenium.api._By.XPATH, value = DATA_EXTRACTION_FROM_TABLE_XPATH)
+	TestPageTableEntry getFirstTableEntry();
+
+	@ExtractDataValue(by = _By.XPATH, value="//fieldset[@name='counter']/span[@id='counter']")
+	String getCounter();
+
+	// you can always provide your own methods and logic
+	default String providedGetCounter() {
+		return getDriver().findElement(org.openqa.selenium.By.xpath("//fieldset[@name='counter']/span[@id='counter']")).getText();
+	}
+
+	// Custom entry point for starting your tests
+	public static TestPagePageObject init(WebDriver driver) {
+		driver.get("http://localhost:9090/start");
+		return new TestPagePageObjectImpl(driver);
+	}
+
+}

pogen4selenium-example/src/main/java/io/toolisticon/pogen4selenium/example/withoutpagefactory/TestPageTableEntry.java

@@ -0,0 +1,23 @@
+package io.toolisticon.pogen4selenium.example.withoutpagefactory;
+
+import io.toolisticon.pogen4selenium.api._By;
+import io.toolisticon.pogen4selenium.api.DataObject;
+import io.toolisticon.pogen4selenium.api.ExtractDataValue;
+import io.toolisticon.pogen4selenium.api.ExtractDataValue.Kind;
+
+@DataObject
+public interface TestPageTableEntry {
+
+	@ExtractDataValue(by = _By.XPATH, value = "./td[1]")
+	String name();
+
+	@ExtractDataValue(by = _By.XPATH, value = "./td[2]")
+	String age();
+
+	@ExtractDataValue(by = _By.XPATH, value = "./td[3]/a",  kind = Kind.ATTRIBUTE, name = "href")
+	String link();
+
+	@ExtractDataValue(by = _By.XPATH, value = "./td[3]/a", kind = Kind.TEXT)
+	String linkText();
+
+}

pogen4selenium-example/src/main/java/io/toolisticon/pogen4selenium/example/withpagefactory/TestPagePageObject.java

@@ -0,0 +1,62 @@
+package io.toolisticon.pogen4selenium.example.withpagefactory;
+
+import java.util.List;
+
+import org.openqa.selenium.WebDriver;
+
+import io.toolisticon.pogen4selenium.api.ActionMoveToAndClick;
+import io.toolisticon.pogen4selenium.api.ActionWrite;
+import io.toolisticon.pogen4selenium.api._By;
+import io.toolisticon.pogen4selenium.api.ExtractData;
+import io.toolisticon.pogen4selenium.api.ExtractDataValue;
+import io.toolisticon.pogen4selenium.api.ExtractDataValue.Kind;
+import io.toolisticon.pogen4selenium.api.PageObject;
+import io.toolisticon.pogen4selenium.api.PageObjectElement;
+import io.toolisticon.pogen4selenium.api.PageObjectParent;
+import io.toolisticon.pogen4selenium.api.Pause;
+
+@PageObject
+public interface TestPagePageObject extends PageObjectParent<TestPagePageObject>{
+
+	static final String DATA_EXTRACTION_FROM_TABLE_XPATH = "//table//tr[contains(@class,'data')]";
+
+	@PageObjectElement(elementVariableName=TestPagePageObject.INPUT_FIELD_ID, by = _By.ID,  value="input_field" )
+	static final String INPUT_FIELD_ID = "inputField";
+
+	@PageObjectElement(elementVariableName=TestPagePageObject.COUNTER_INCREMENT_BUTTON_ID, by = _By.XPATH,  value="//fieldset[@name='counter']/input[@type='button']" )
+	static final String COUNTER_INCREMENT_BUTTON_ID = "counterIncrementButton";
+
+	@PageObjectElement(elementVariableName=TestPagePageObject.DATA_EXTRACTION_FROM_TABLE_ID, by = _By.XPATH,  value=DATA_EXTRACTION_FROM_TABLE_XPATH )
+	static final String DATA_EXTRACTION_FROM_TABLE_ID= "dataExtractionFromTable";
+
+	TestPagePageObject writeToInputField(@ActionWrite(INPUT_FIELD_ID) String value);
+
+	@ExtractDataValue(by=_By.ELEMENT, value = INPUT_FIELD_ID, kind=Kind.ATTRIBUTE, name="value")
+	String readInputFieldValue();
+
+	@ActionMoveToAndClick(COUNTER_INCREMENT_BUTTON_ID)
+	@Pause(value = 500L)
+	TestPagePageObject clickCounterIncrementButton();	
+
+	@ExtractData(by = io.toolisticon.pogen4selenium.api._By.ELEMENT, value = DATA_EXTRACTION_FROM_TABLE_ID)
+	List<TestPageTableEntry> getTableEntries();
+
+	@ExtractData(by = io.toolisticon.pogen4selenium.api._By.ELEMENT, value = DATA_EXTRACTION_FROM_TABLE_ID)
+	TestPageTableEntry getFirstTableEntry();
+
+
+	@ExtractDataValue(by = _By.XPATH, value="//fieldset[@name='counter']/span[@id='counter']")
+	String getCounter();
+
+	// you can always provide your own methods and logic
+	default String providedGetCounter() {
+		return getDriver().findElement(org.openqa.selenium.By.xpath("//fieldset[@name='counter']/span[@id='counter']")).getText();
+	}
+
+	// Custom entry point for starting your tests
+	public static TestPagePageObject init(WebDriver driver) {
+		driver.get("http://localhost:9090/start");
+		return new TestPagePageObjectImpl(driver);
+	}
+
+}

pogen4selenium-example/src/main/java/io/toolisticon/pogen4selenium/example/withpagefactory/TestPageTableEntry.java

@@ -0,0 +1,23 @@
+package io.toolisticon.pogen4selenium.example.withpagefactory;
+
+import io.toolisticon.pogen4selenium.api._By;
+import io.toolisticon.pogen4selenium.api.DataObject;
+import io.toolisticon.pogen4selenium.api.ExtractDataValue;
+import io.toolisticon.pogen4selenium.api.ExtractDataValue.Kind;
+
+@DataObject
+public interface TestPageTableEntry {
+
+	@ExtractDataValue(by = _By.XPATH, value = "./td[1]")
+	String name();
+
+	@ExtractDataValue(by = _By.XPATH, value = "./td[2]")
+	String age();
+
+	@ExtractDataValue(by = _By.XPATH, value = "./td[3]/a",  kind = Kind.ATTRIBUTE, name = "href")
+	String link();
+
+	@ExtractDataValue(by = _By.XPATH, value = "./td[3]/a", kind = Kind.TEXT)
+	String linkText();
+
+}