Recent changes to Defining own Types

Defining own Types modified by Michael Bulla

Michael Bulla — Tue, 12 Nov 2013 13:01:09 -0000

--- v2
+++ v3
@@ -117,8 +117,7 @@
 ~~~~~
 :::java
 WebdriverContext context = new WebdriverContext();
-IPoFactory factory = context.getFactory();
-factory.setDefaultElementFactory(new GxtElementFactory());
+context.setDefaultElementFactory(new GxtElementFactory());
 ~~~~~

 # Defining own Webelement
@@ -156,7 +155,7 @@

 ~~~~~
 :::java
-factory.getDefaultElementFactory().addImplClassForElement(ISpecialElement.class, SpecialElement .class);
+context.getDefaultElementFactory().addImplClassForElement(ISpecialElement.class, SpecialElement .class);
 ~~~~~

 # Defining your own Configuration

Defining own Types modified by Michael Bulla

Michael Bulla — Tue, 12 Nov 2013 12:00:23 -0000

--- v1
+++ v2
@@ -51,6 +51,12 @@
 ~~~~~

 # Using other Element-implementations
+In your tests you wish to type into some kind of textbox, something like a ITextBox, but that textbox may be implemented in many ways in your application, f.e. it may be an Input, an Textarea or a rich edit Textbox.
+
+Sometime you need to help PopperFW to decide the right implementation. PopperFW supports deciding the right implementation at three levels
+
+## Element-Level
+At element level you may annotate an Locator-method with the @Type-annotation to define the datatype to use (Regard that the given datatype has to implement the Interface of the method):

 ~~~~~
 :::java
@@ -65,6 +71,56 @@
 }
 ~~~~~

+## PageObject-Level
+At page level you may define an element factory to decide for what interface which implementation to use
+
+~~~~~
+:::java
+@ElementFactory(GxtElementFactory.class)
+@Page(name="Element Factory")
+public interface ManyTypesWithElementFactoryPO {
+   @PageAccessor(uri="/pages/severalTypes.html")
+   void open();
+   
+   @Locator(name="Button", id="button_normal")
+   IButton button();  // will return a GxtCheckbox instead of DefaultCheckbox
+   
+   @Locator(name="Checkbox", id="checkbox_normal")
+   ICheckbox checkbox(); // will return a GxtCheckbox instead of DefaultCheckbox
+}
+
+public class GxtElementFactory implements IElementFactory {
+   private static final Map, Class> impls = new HashMap, Class>();
+   static {
+       impls.put(IButton.class, GxtButton.class);
+       impls.put(ICheckbox.class, GxtCheckbox.class);
+   }
+   
+   @Override
+   public Class getImplClassForElement(Class clazz) {
+       return impls.get(clazz);
+   }
+
+   @Override
+   public void addImplClassForElement(
+           Class interfaceClass,
+           Class targetClass) {
+       impls.put(interfaceClass, targetClass);
+   }
+}
+
+~~~~~
+
+## Application-Level
+If you want to use a special ElementFactory for your Whole application you may register it in IPoFactory
+
+~~~~~
+:::java
+WebdriverContext context = new WebdriverContext();
+IPoFactory factory = context.getFactory();
+factory.setDefaultElementFactory(new GxtElementFactory());
+~~~~~
+
 # Defining own Webelement

 ~~~~~
@@ -96,67 +152,11 @@
 }
 ~~~~~

-# Defining own ElementFactory
-
-~~~~~
-:::java
-
-public class GxtElementFactory implements IElementFactory {
-   private static final Map, Class> impls = new HashMap, Class>();
-   static {
-       impls.put(IButton.class, GxtButton.class);
-       impls.put(ICheckbox.class, GxtCheckbox.class);
-       impls.put(IFileupload.class, GxtFileupload.class);
-       impls.put(IImage.class, GxtImage.class);
-       impls.put(ILabel.class, GxtLabel.class);
-       impls.put(ILink.class, GxtLink.class);
-       impls.put(IRadioButton.class, GxtRadioButton.class);
-       impls.put(ISelectBox.class, GxtSelectBox.class);
-       impls.put(ITextBox.class, GxtTextBox.class);
-   }
-   @Override
-   public Class getImplClassForElement(Class clazz) {
-       return impls.get(clazz);
-   }
-}
-
-@ElementFactory(GxtElementFactory.class)
-@Page(name="Many Types With Element Factory")
-public interface ManyTypesWithElementFactoryPO {
-   @PageAccessor(uri="/pages/severalTypes.html")
-   void open();
-   
-   @Locator(name="Button", id="button_normal")
-   IButton button();
-   
-   @Locator(name="Checkbox", id="checkbox_normal")
-   ICheckbox checkbox();
-   
-   @Locator(name="Fileupload", id="file_normal")
-   IFileupload fileupload();
-   
-   @Locator(name="Label", id="label_normal")
-   ILabel label();
-   
-   @Locator(name="Image", id="image_normal")
-   IImage image();
-   
-   @Locator(name="Link", id="link_normal")
-   ILink link();
-   
-   @Locator(name="Radio", id="radio1")
-   IRadioButton radiobutton();
-   
-   @Locator(name="Select", id="normal_select")
-   ISelectBox select();
-   
-   @Locator(name="Textbox", id="textbox_normal")
-   ITextBox textbox();
-   
-   @Locator(name="Textarea", id="textarea_normal")
-   @Type(TextArea.class)
-   ITextBox textarea();
-}
+When defining a new type of Element (like ISpecialElement) you may register the implementation in DefaultElementFactory without overwriting an existing type.
+
+~~~~~
+:::java
+factory.getDefaultElementFactory().addImplClassForElement(ISpecialElement.class, SpecialElement .class);
 ~~~~~

 # Defining your own Configuration

Defining own Types modified by Michael Bulla

Michael Bulla — Tue, 12 Nov 2013 11:27:32 -0000

Defining own Locators
Using other Element-implementations
Defining own Webelement
Defining own ElementFactory
Defining your own Configuration

Defining own Locators

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@ImplementedBy(MyOwnValidatorImpl.class)
public @interface MyOwnLocator {
    String value();
}

public class MyOwnValidatorImpl implements ILocatorProcessor<MyOwnLocator>{

    public MyOwnValidatorImpl(WebDriver webdriver, WebdriverContext context) {
        super();
        if (webdriver == null) {
            throw new IllegalArgumentException("webdriver may not be null");
        }
        if (context == null) {
            throw new IllegalArgumentException("context may not be null");
        }
    }

    @Override
    public Loc getLocator(MyOwnLocator constraintAnnotation, LocatorContextInformation info) {
        if (constraintAnnotation.value().equals("42")) {
            return Loc.id("idLocator");
            // using parameter-syntax must be implemented yourself
        }

        throw new RuntimeException("no valid Syntax");
    }
}

@Page(name="Self Implemented Locator")
public interface SelfImplementedLocator {
    @PageAccessor(uri="/pages/defaultAnnotations.html")
    void open();

    @Locator(name="Valid Locator")
    @MyOwnLocator("42")
    ILabel valid(String param1, Long param2);

    @Locator(name="Not Valid Locator")
    @MyOwnLocator("666")
    ILabel notValid(String param1, Long param2);
}

Using other Element-implementations

@Page(name="Page with textarea")
public interface TextareaPO {
    @PageAccessor(uri="/pages/severalTypes.html")
    void open();

    @Locator(name="Textarea", id="textarea_normal")
    @Type(TextArea.class)
    ITextBox textarea();
}

Defining own Webelement

public interface ISpecialElement {
    public void doSomethingSpecial();
}

public class SpecialElement extends AbstractWebElement implements ISpecialElement {

    public DefaultLabel(String name, PageObjectImplementation parent, Loc loc, WebdriverContext context) {
        super(name, parent, loc, context);
    }

    @Override
    public void doSomethingSpecial() {
        getDriver()...
    }
}

@Page(name="Page with special element")
public interface TextareaPO {
    @PageAccessor(uri="/pages/severalTypes.html")
    void open();

    @Locator(name="Textarea", id="textarea_normal")
    @Type(SpecialElement.class)
    ISpecialElement special();
}

Defining own ElementFactory

public class GxtElementFactory implements IElementFactory {
    private static final Map<Class<? extends IWebElement>, Class<? extends IWebElement>> impls = new HashMap<Class<? extends IWebElement>, Class<? extends IWebElement>>();
    static {
        impls.put(IButton.class, GxtButton.class);
        impls.put(ICheckbox.class, GxtCheckbox.class);
        impls.put(IFileupload.class, GxtFileupload.class);
        impls.put(IImage.class, GxtImage.class);
        impls.put(ILabel.class, GxtLabel.class);
        impls.put(ILink.class, GxtLink.class);
        impls.put(IRadioButton.class, GxtRadioButton.class);
        impls.put(ISelectBox.class, GxtSelectBox.class);
        impls.put(ITextBox.class, GxtTextBox.class);
    }
    @Override
    public Class<? extends IWebElement> getImplClassForElement(Class<? extends IWebElement> clazz) {
        return impls.get(clazz);
    }
}

@ElementFactory(GxtElementFactory.class)
@Page(name="Many Types With Element Factory")
public interface ManyTypesWithElementFactoryPO {
    @PageAccessor(uri="/pages/severalTypes.html")
    void open();

    @Locator(name="Button", id="button_normal")
    IButton button();

    @Locator(name="Checkbox", id="checkbox_normal")
    ICheckbox checkbox();

    @Locator(name="Fileupload", id="file_normal")
    IFileupload fileupload();

    @Locator(name="Label", id="label_normal")
    ILabel label();

    @Locator(name="Image", id="image_normal")
    IImage image();

    @Locator(name="Link", id="link_normal")
    ILink link();

    @Locator(name="Radio", id="radio1")
    IRadioButton radiobutton();

    @Locator(name="Select", id="normal_select")
    ISelectBox select();

    @Locator(name="Textbox", id="textbox_normal")
    ITextBox textbox();

    @Locator(name="Textarea", id="textarea_normal")
    @Type(TextArea.class)
    ITextBox textarea();
}

Defining your own Configuration

public class MyConfiguration implements IWebdriverConfig {

    @Override
    public WebDriver createDriver() {
        return new FirefoxDriver();
    }

    @Override
    public Browser getBrowser() {
        return Browser.FIREFOX;
    }

    @Override
    public String getBaseUrl() {
        return "http://localhost:8080";
    }
}

public class LoginTest {
    protected IPoFactory factory;

    @Before
    public void setup() {
        WebdriverContext context = new WebdriverContext();
        context.setConfig(new MyConfiguration());
        factory = context.getFactory();
    }

    @Test
    public void testLogin() {
        Login login = factory.createPage(Login.class);
        login.open();
        login.usernameTextbox().type("Michael");
        login.passwordTextbox().type("secret");
        login.submitLoginButton().click();
    }
}