#22: Support for @visible for embedded container page objects

Author: benhamidene

documentation/chapters/page-object.md

@@ -168,6 +168,8 @@ invoked.
 If the annotated field is a `List` or `PageObjectList` the value property of the annotation must be used to declare how many
 elements of the list should be visible.
 
+@Visble can be also used for embedded containers. If an embedded container is not annotated then is contained page object that are annotated with @Visible will not be verified at creation time.
+
 **Note:** The given number is not the number of page objects expected to be in the list! It is the number of expected _visible_ page objects in the list!
 
 **Properties:**

webtester-core/src/main/java/info/novatec/testit/webtester/internal/pageobjects/DefaultPageObjectFactory.java

@@ -9,6 +9,8 @@
 import java.lang.reflect.ParameterizedType;
 import java.util.Deque;
 import java.util.List;
+import java.util.Set;
+
 import javax.annotation.PostConstruct;
 
 import org.apache.commons.lang.StringUtils;
@@ -227,10 +229,34 @@ private boolean shouldExecuteMethod(Method method) {
     }
 
     private <T extends PageObject> void checkVisibilityOfAnnotatedFields(T pageInstance, Class<T> pageClazz) {
-        Deque<Class<?>> classStack = ReflectionUtils.getClassAncestry(pageClazz);
-        while (!classStack.isEmpty()) {
-            checkVisibilityOfAnnotatedFieldsOfClass(pageInstance, classStack.pop());
+        if (shouldCheckVisibilty(pageInstance)) {
+            Deque<Class<?>> classStack = ReflectionUtils.getClassAncestry(pageClazz);
+            while (!classStack.isEmpty()) {
+                checkVisibilityOfAnnotatedFieldsOfClass(pageInstance, classStack.pop());
+            }
+        }
+    }
+
+    private <T extends PageObject> boolean shouldCheckVisibilty(T pageInstance) {
+        PageObject parent = pageInstance.getParent();
+        if (parent == null) {
+            return true;
+        }
+
+        Set<Field> parentFields = ReflectionUtils.getAllFieldsOfClassHierarchy(parent.getClass());
+        for (Field field : parentFields) {
+            if (field.getDeclaringClass().isAssignableFrom(PageObject.class)) {
+                try {
+                    Object fieldValue = ReflectionUtils.forceGetFieldValue(field, parent);
+                    if (fieldValue != null && fieldValue.equals(pageInstance)) {
+                        return isAnnotatedWithVisible(field);
+                    }
+                } catch (ReflectiveOperationException e) {
+                    continue;
+                }
+            }
         }
+        return false;
     }
 
     private <T extends PageObject> void checkVisibilityOfAnnotatedFieldsOfClass(T pageInstance, Class<?> clazz) {

webtester-core/src/test/java/integration/annotations/VisibleIntegrationTest.java

@@ -1,20 +1,18 @@
 package integration.annotations;
 
-import java.util.List;
-
-import org.junit.Test;
-
-import integration.AbstractWebTesterIntegrationTest;
-
 import info.novatec.testit.webtester.api.annotations.IdentifyUsing;
 import info.novatec.testit.webtester.api.annotations.Visible;
-import info.novatec.testit.webtester.api.browser.Browser;
 import info.novatec.testit.webtester.api.enumerations.Method;
 import info.novatec.testit.webtester.api.exceptions.PageObjectFactoryException.VisiblePageObjectFieldException;
 import info.novatec.testit.webtester.api.exceptions.PageObjectFactoryException.VisiblePageObjectListFieldException;
 import info.novatec.testit.webtester.pageobjects.PageObject;
 import info.novatec.testit.webtester.pageobjects.TextField;
+import info.novatec.testit.webtester.utils.Asserts;
+import integration.AbstractWebTesterIntegrationTest;
+
+import java.util.List;
 
+import org.junit.Test;
 
 public class VisibleIntegrationTest extends AbstractWebTesterIntegrationTest {
 
@@ -25,36 +23,47 @@ protected String getHTMLFilePath() {
 
     @Test
     public void testThatVisibleAnnotationIsUsedToCheckVisibilityOfPageObject() {
-        getBrowser().create(SingleVisiblePage.class);
-        // nothing to assert because initialization was successful
+        SingleVisiblePage singleVisiblePage = getBrowser().create(SingleVisiblePage.class);
+        Asserts.assertVisible(singleVisiblePage);
     }
 
     @Test
     public void testThatVisibleAnnotationIsUsedToCheckVisibilityOfPageObjectList() {
-        getBrowser().create(MultiVisiblePage.class);
-        // nothing to assert because initialization was successful
+        MultiVisiblePage multiVisiblePage = getBrowser().create(MultiVisiblePage.class);
+        Asserts.assertVisible(multiVisiblePage);
     }
 
     @Test(expected = VisiblePageObjectFieldException.class)
     public void testThatVisibleAnnotationOnNonExistingPageObjectLeadsToException() {
-        Browser browser = getBrowser();
-        browser.getConfiguration().setWaitTimeout(1);
-        browser.open(getFormattedTestResourcePath("html/empty.html"), SingleVisiblePage.class);
+        getBrowser().create(InvisiblePage.class);
+        
     }
 
     @Test(expected = VisiblePageObjectListFieldException.class)
     public void testThatVisibleAnnotationOnPageObjectListLeadsToExceptionIfThereAreNotEnoughVisibleObjects() {
         getBrowser().create(MultiVisiblePageWrongCount.class);
     }
 
+    @Test
+    public void testThatAnnotationOnContentsOfInvisibleContainerBoNotLeadToException(){
+       getBrowser().create(PageWithInvisibleContainer.class);
+        
+    }
+    
     public static class SingleVisiblePage extends PageObject {
 
         @Visible
         @IdentifyUsing("textfield")
         TextField textfield;
 
     }
-
+    
+    public static class InvisiblePage extends PageObject{
+        @Visible
+        @IdentifyUsing(method = Method.ID , value="non:existing:field")
+        TextField invisibleTextField;
+    }
+    
     public static class MultiVisiblePage extends PageObject {
 
         @Visible(2)
@@ -70,5 +79,17 @@ public static class MultiVisiblePageWrongCount extends PageObject {
         List<TextField> multipleTextFields;
 
     }
+    
+    public static class InvisibleContainer extends PageObject{
+        @Visible
+        @IdentifyUsing("invisible:textfield")
+        TextField invisibleTextField;
+    }
+    
+    public static class PageWithInvisibleContainer extends PageObject{
+        
+        @IdentifyUsing("invisibleContainer")
+        InvisibleContainer invisibleContainer;
+    }
 
 }

webtester-core/src/test/resources/html/annotations/visible.html

@@ -19,9 +19,9 @@ <h3>This page contains elements for testing the functionality of
 			<tr>
 				<td>Multiple text fields - one invisible</td>
 				<td>
-					<input id="multi:textfield:1"><br>
-					<input id="multi:textfield:2"><br>
-					<input id="multi:textfield:3" style="display: none">
+					<input id="multi:textfield:1"/><br>
+					<input id="multi:textfield:2"/><br>
+					<input id="multi:textfield:3" style="display: none"/>
 				</td>
 			</tr>
 		</tbody>
@@ -30,6 +30,9 @@ <h3>This page contains elements for testing the functionality of
 	<br>
 	<br>
 	<hr>
-
+	
+	<div id="invisibleContainer" style="display: none">
+		<input id="invisible:textfield"/>
+	</div>
 </body>
 </html>