EDIT

5.x/modules/cdm_dataportal/test/java/dataportal-selenium-tests/src/main/java/eu/etaxonomy/dataportal/elements/ClassificationTreeBlock.java -text

5.x/modules/cdm_dataportal/test/java/dataportal-selenium-tests/src/main/java/eu/etaxonomy/dataportal/elements/ClassificationTreeElement.java -text

		<selenium-version>2.21.0</selenium-version>

// $Id$

/**

* Copyright (C) 2012 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.dataportal.elements;

import org.openqa.selenium.By;

import org.openqa.selenium.Dimension;

import org.openqa.selenium.Point;

import org.openqa.selenium.WebElement;

import org.openqa.selenium.remote.RemoteWebElement;

import com.sun.corba.se.impl.interceptors.PINoOpHandlerImpl;

/**

 *

 * <div class="cdm_taxontree_scroller_xy">

 * <ul class="cdm_taxontree"><li

 *

 * @author andreas

 * @date May 21, 2012

 *

 */

public class ClassificationTreeBlock extends DrupalBlock {

    private ClassificationTreeElement focusedElement;

    private RemoteWebElement viewPortElement;

    public ClassificationTreeElement getFocusedElement(){

        return focusedElement;

    }

    public ClassificationTreeBlock(WebElement element) {

        super(element);

        focusedElement = new ClassificationTreeElement(element.findElement(By.className("focused")));

        viewPortElement = (RemoteWebElement)element.findElement(By.className("cdm_taxontree_scroller_xy"));

    }

    public Point positionInViewPort(ClassificationTreeElement element){

        Point elementLocation = ((RemoteWebElement)element.getElement()).getLocationOnScreenOnceScrolledIntoView();

        Point viewPortLocation = viewPortElement.getLocationOnScreenOnceScrolledIntoView();

        return new Point(elementLocation.x - viewPortLocation.x, elementLocation.y - viewPortLocation.y);

    }

    public boolean isVisibleInViewPort(ClassificationTreeElement element){

        Point elementOffset = positionInViewPort(element);

        Dimension viewPortDimension = viewPortElement.getSize();

        return elementOffset.y < viewPortDimension.height;

    }

}

// $Id$

/**

* Copyright (C) 2012 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.dataportal.elements;

import org.openqa.selenium.By;

import org.openqa.selenium.WebElement;

/**

 * @author andreas

 * @date May 21, 2012

 *

 */

public class ClassificationTreeElement extends BaseElement {

    private String taxonName;

    private String linkUrl;

    private boolean isFocused;

    public String getTaxonName() {

        return taxonName;

    }

    public String getLinkUrl() {

        return linkUrl;

    }

    public boolean isFocused() {

        return isFocused;

    }

    public ClassificationTreeElement(WebElement element) {

        super(element);

        taxonName = element.getText();

        for(String classAttribute : getClassAttributes()){

            if(classAttribute.equals("focused")){

                isFocused = true;

                break;

            }

        }

        linkUrl = element.findElement(By.tagName("a")).getAttribute("href");

    }

}

import java.util.List;

import org.junit.Assert;

import org.openqa.selenium.WebElement;

import eu.etaxonomy.dataportal.elements.ClassificationTreeBlock;

    /**

     * @param driver

     * @param context

     * @param pagePathSuffix

     * @throws MalformedURLException

     */

    public GenericPortalPage(WebDriver driver, DataPortalContext context, String pagePathSuffix) throws MalformedURLException {

        super(driver, context, pagePathSuffix);

    }

    /**

     * @param driver

     * @param context

     * @throws Exception

     */

    public GenericPortalPage(WebDriver driver, DataPortalContext context) throws Exception {

        super(driver, context);

    }

    protected static String drupalPagePathBase = "cdm_dataportal";

    /* (non-Javadoc)

     * @see eu.etaxonomy.dataportal.pages.PortalPage#getDrupalPageBase()

     */

    @Override

    protected String getDrupalPageBase() {

        return drupalPagePathBase;

    }

    public TaxonSearchResultPage submitQuery(String query) throws Exception{

        searchBlockElement.findElement(By.id("edit-query")).clear();

        searchBlockElement.findElement(By.id("edit-query")).sendKeys(query);

        searchBlockElement.findElement(By.id("edit-submit")).submit();//Search results

        wait.until(new AllTrue(new PageTitleValidated(context.prepareTitle("Search results")), new VisibilityOfElementLocated(By.id("container"))));

        return new TaxonSearchResultPage(driver, context);

    }

import eu.etaxonomy.dataportal.elements.ClassificationTreeBlock;

    /**

     *

     */

    public static final int WAIT_SECONDS = 25;

    public static final Logger logger = Logger.getLogger(PortalPage.class);

    protected final static String DRUPAL_PAGE_QUERY_BASE = "?q=";

    protected WebDriver driver;

    protected DataPortalContext context;

    protected final JUnitWebDriverWait wait;

    public WebDriverWait getWait() {

        return wait;

    }

    /**

     * Implementations of this method will supply the relative

     * path to the Drupal page. This path will usally have the form

     * <code>cdm_dataportal/{nodetype}</code>. For example the taxon pages all

     * have the page base <code>cdm_dataportal/taxon</code>

     * @return

     */

    protected abstract String getDrupalPageBase();

    private String drupalPagePath;

    protected URL pageUrl;

    // ==== WebElements === //

    @FindBy(id="cdm_dataportal.node")

    protected WebElement portalContent;

    @FindBy(tagName="title")

    @CacheLookup

    protected WebElement title;

    @FindBy(className="node")

    protected WebElement node;

    @FindBys({@FindBy(id="tabs-wrapper"), @FindBy(className="primary")})

    @CacheLookup

    protected WebElement primaryTabs;

    @FindBy(id="block-cdm_dataportal-2")

    @CacheLookup

    protected WebElement searchBlockElement;

    @FindBy(id="block-cdm_taxontree-cdm_tree")

    @CacheLookup

    protected WebElement classificationBrowserBlock;

    /**

     * Creates a new PortaPage. Implementations of this class will provide the base path of the page by

     * implementing the method {@link #getDrupalPageBase()}. The constructor argument <code>pagePathSuffix</code>

     * specifies the specific page to navigate to. For example:

     * <ol>

     * <li>{@link #getDrupalPageBase()} returns <code>/cdm_dataportal/taxon</code></li>

     * <li><code>pagePathSuffix</code> gives <code>7fe8a8b6-b0ba-4869-90b3-177b76c1753f</code></li>

     * </ol>

     * Both are combined to form the URL pathelement <code>/cdm_dataportal/taxon/7fe8a8b6-b0ba-4869-90b3-177b76c1753f</code>

     *

     *

     * @param driver

     * @param context

     * @param pagePathSuffix

     * @throws MalformedURLException

     */

    public PortalPage(WebDriver driver, DataPortalContext context, String pagePathSuffix) throws MalformedURLException {

        this.driver = driver;

        this.context = context;

        this.wait = new JUnitWebDriverWait(driver, WAIT_SECONDS);

        this.drupalPagePath = getDrupalPageBase() + (pagePathSuffix != null ? "/" + pagePathSuffix: "");

        this.pageUrl = new URL(context.getBaseUri().toString() + DRUPAL_PAGE_QUERY_BASE + drupalPagePath);

        // tell browser to navigate to the page

        driver.get(pageUrl.toString());

        // This call sets the WebElement fields.

        PageFactory.initElements(driver, this);

        logger.info("loading " + pageUrl);

    }

    /**

     * Creates a new PortaPage at given URL location. An Exception is thrown if

     * this URL is not matching the expected URL for the specific page type.

     *

     * @param driver

     * @param context

     * @param url

     * @throws Exception

     */

    public PortalPage(WebDriver driver, DataPortalContext context, URL url) throws Exception {

        this.driver = driver;

        this.context = context;

        this.wait = new JUnitWebDriverWait(driver, 25);

        this.pageUrl = new URL(context.getBaseUri().toString());

        // tell browser to navigate to the given URL

        driver.get(url.toString());

        if(!isOnPage()){

            throw new Exception("Not on the expected portal page ( current: " + driver.getCurrentUrl() + ", expected: " +  pageUrl + " )");

        }

        this.pageUrl = url;

        logger.info("loading " + pageUrl);

        // This call sets the WebElement fields.

        PageFactory.initElements(driver, this);

    }

    /**

     * Creates a new PortaPage at the WebDrivers current URL location. An Exception is thrown if

     * driver.getCurrentUrl() is not matching the expected URL for the specific page type.

     *

     * @param driver

     * @param context

     * @throws Exception

     */

    public PortalPage(WebDriver driver, DataPortalContext context) throws Exception {

        this.driver = driver;

        this.context = context;

        this.wait = new JUnitWebDriverWait(driver, 25);

        // preliminary set the pageUrl to the base path of this page, this is used in the next setp to check if the

        // driver.getCurrentUrl() is a sub path of the base path

        this.pageUrl = new URL(context.getBaseUri().toString());

        if(!isOnPage()){

            throw new Exception("Not on the expected portal page ( current: " + driver.getCurrentUrl() + ", expected: " +  pageUrl + " )");

        }

        // now set the real URL

        this.pageUrl = new URL(driver.getCurrentUrl());

        logger.info("loading " + pageUrl);

        // This call sets the WebElement fields.

        PageFactory.initElements(driver, this);

    }

    /**

     * @return

     */

    protected boolean isOnPage() {

        return driver.getCurrentUrl().startsWith(pageUrl.toString());

    }

    /**

     * navigate and reload the page if not jet there

     */

    public void get() {

        if(!driver.getCurrentUrl().equals(pageUrl.toString())){

            driver.get(pageUrl.toString());

            wait.until(new UrlLoaded(pageUrl.toString()));

            PageFactory.initElements(driver, this);

        }

    }

    /**

     * go back in history

     */

    public void back() {

        driver.navigate().back();

    }

    public String getDrupalPagePath() {

        return drupalPagePath;

    }

    /**

     * returns the string from the <code>title</code> tag.

     * @return

     */

    public String getTitle() {

        return title.getText();

    }

    /**

     * returns the warning messages from the Drupal message box

     * @return

     */

    public String getWarnings() {

        return null; //TODO unimplemented

    }

    /**

     * returns the error messages from the Drupal message box

     * @return

     */

    public String getErrors() {

        return null; //TODO unimplemented

    }

    public String getAuthorInformationText() {

        WebElement authorInformation = null;

        try {

            authorInformation  = node.findElement(By.className("submitted"));

        } catch (NoSuchElementException e) {

            // IGNORE //

        }

        if(authorInformation != null){

            return authorInformation.getText();

        } else {

            return null;

        }

    }

    public List<LinkElement> getPrimaryTabs(){

        List<LinkElement> tabs = new ArrayList<LinkElement>();

        List<WebElement> links = primaryTabs.findElements(By.tagName("a"));

        for(WebElement a : links) {

            WebElement renderedLink = a;

            if(renderedLink.isDisplayed()){

                tabs.add(new LinkElement(renderedLink));

            }

        }

        return tabs;

    }

    public ClassificationTreeBlock getClassificationTree() {

        return new ClassificationTreeBlock(classificationBrowserBlock);

    }

    public void hover(WebElement element) {

        Actions actions = new Actions(driver);

        actions.moveToElement(element, 1, 1).perform();

        logger.debug("hovering");

    }

    /**

     * Returns the current URL string from the {@link WebDriver}

     * @return

     */

    public URL getPageURL() {

        return pageUrl;

    }

    /**

     * return the <code>scheme://domain:port</code> part of the initial url of this page.

     * @return

     */

    public String getInitialUrlBase() {

        return pageUrl.getProtocol() + "://" + pageUrl.getHost() + pageUrl.getPort();

    }

    public boolean equals(Object obj) {

        if (PortalPage.class.isAssignableFrom(obj.getClass())) {

            PortalPage page = (PortalPage) obj;

            return this.getPageURL().toString().equals(page.getPageURL().toString());

        } else {

            return false;

        }

    }

    /**

     * @param <T>

     * @param link the link to click

     * @param isTrue see {@link org.openqa.selenium.support.ui.FluentWait#until(Function)}

     * @param type the return type

     * @param duration may be null, if this in null <code>waitUnit</code> will be ignored.

     * @param waitUnit may be null, is ignored if <code>duration</code> is null defaults to {@link TimeUnit.SECONDS}

     * @return

     * @throws SecurityException

     */

    public <T extends PortalPage> T clickLink(BaseElement element, Function<? super WebDriver, Boolean> isTrue, Class<T> type, Long duration, TimeUnit waitUnit) {

        String targetWindow = null;

        if(targetWindow == null){

            if(element instanceof LinkElement){

                targetWindow = element.getElement().getAttribute("target");

            } else {

                try {

                    targetWindow = element.getElement().findElement(By.xpath("./a[@target]")).getAttribute("target");

                } catch (NoSuchElementException e) {

                    logger.debug("No target window found");

                    /* IGNORE */

                }

            }

        }

        logger.info("clicking on " + element + (targetWindow == null? "" : " with target window: '" + targetWindow + "'"));

        element.getElement().click();

        if(targetWindow != null){

            driver.switchTo().window(targetWindow);

        }

        try {

            if(duration != null){

                if(waitUnit == null){

                    waitUnit = TimeUnit.SECONDS;

                }

                wait.withTimeout(duration, waitUnit).until(isTrue);

            } else {

                wait.until(isTrue);

            }

        } catch (AssertionError timeout){

            logger.info("current WindowHandles:" + driver.getWindowHandles());

            throw timeout;

        }

        Constructor<T> constructor;

        T pageInstance;

        try {

            constructor = type.getConstructor(WebDriver.class, DataPortalContext.class);

            pageInstance = constructor.newInstance(driver, context);

        } catch (Exception e) {

            throw new RuntimeException(e);

        }

        return pageInstance;

    }

    /**

     * @param <T>

     * @param link the link to click

     * @param isTrue see {@link org.openqa.selenium.support.ui.FluentWait#until(Function)}

     * @param type the return type

     * @return

     */

    public <T extends PortalPage> T clickLink(BaseElement element, Function<? super WebDriver, Boolean> isTrue, Class<T> type) {

        return clickLink(element, isTrue, type, null, null);

    }

    public static final Logger logger = Logger.getLogger(Lactuca_triquetra_TaxonProfileTest.class);

    static UUID taxonUuid = UUID.fromString("ecb7a76e-694a-4706-b1ab-a2eb334173ff");

    TaxonProfilePage p = null;

    @Before

    public void setUp() throws MalformedURLException {

        if(p != null && driver != null ){

            logger.debug("TaxonProfilePage p:" + p.getPageURL() + ", driver is at " + driver.getCurrentUrl());

        }

        p = new TaxonProfilePage(driver, getContext(), taxonUuid);

    }

    @Test

    public void testTitleAndTabs() {

        assertEquals(getContext().prepareTitle("Lactuca triquetra"), p.getTitle());

        assertNull("Authorship information should be hidden", p.getAuthorInformationText());

        List<LinkElement> primaryTabs = p.getPrimaryTabs();

        int tabId = 0;

        assertEquals("General", primaryTabs.get(tabId++).getText());

        assertEquals("Synonymy", primaryTabs.get(tabId++).getText());

        assertEquals("Images", primaryTabs.get(tabId++).getText());

        assertEquals("Specimens", primaryTabs.get(tabId++).getText());

        assertEquals("Expecting " + tabId + " tabs", tabId, primaryTabs.size());

    }

    @Test

    public void testProfileImage() {

        ImgElement profileImage = p.getProfileImage();

        assertNotNull("Expecting profile images to be switched on", profileImage);

        assertTrue("Expecting image Lactuca_triquetra_Bc_01.JPG", profileImage.getSrcUrl().toString().endsWith("/Lactuca_triquetra_Bc_01.JPG"));

    }

    @Test

    public void testFeatures() {

        assertEquals("Content", p.getTableOfContentHeader());

        List<LinkElement> links = p.getTableOfContentLinks();

        assertNotNull("Expecting a list of TOC links in the profile page.", links);

        FeatureBlock featureBlock;

        int featureId = 0;

        int descriptionElementFontSize = 12;

        String expectedCssDisplay = "inline";

        String expectedListStyleType = "none";

        String expectedListStylePosition = "outside";

        String expectedListStyleImage = "none";

        int indent = 0;

        /* Description */

        String featureClass = "description";

        String featureLabel = "Description";

        String blockTextFull = null;

        String blockTextBegin = featureLabel + "\nHerb, perennial, scoparious, 40-80 cm high. Flowering stems erect, triangular, medullary, glaucous-green, soon leafless, strongly branched; branches erect, slender. Cauline leaves few, glabrous.";

        String blockTextEnd = "Pappus white, 6.0-7.0 mm long, persistent, fragile, shortly barbellate or scabridulous.\n\nbased on: Meikle, R.D. 1985: Flora auf Cyprus 2. - Kew (as Prenanthes triquetra).";

        expectedListStyleType = "none";

        p.testTableOfContentEntry(featureId++,featureLabel, featureClass);

        featureBlock = p.getFeatureBlockAt(featureId, featureClass, "div", "span");

        assertTrue(featureBlock.getText().startsWith(blockTextBegin));

        assertTrue(featureBlock.getText().endsWith(blockTextEnd));

        featureBlock.testDescriptionElementLayout(0, indent, descriptionElementFontSize, expectedCssDisplay, expectedListStyleType, expectedListStylePosition, expectedListStyleImage);

        assertEquals(0, featureBlock.getOriginalSourcesSections().size());

        /* Distribution */

        expectedCssDisplay = "block";

        featureClass = "distribution";

        featureLabel = "Distribution";

        blockTextFull = featureLabel + "\n\n\n\nAsia-Temperate:\nCyprus 1,2; Lebanon-Syria (Lebanon 3,4,5); Palestine (Israel 5,6).\n1. Meikle, R. D., Flora of Cyprus 2. 1985, 2. Osorio-Tafall, B. H. & Serafim, G. M., List of the vascular plants of Cyprus. 1973, 3. Mouterde, P., Nouvelle flore du Liban et de la Syrie. Texte 3. 1978-1984, 4. Boissier, E., Flora Orientalis 3. 1875, 5. Post, G. E. , Flora of Syria, Palestine, and Sinai 2. 19336. (N)";

        p.testTableOfContentEntry(featureId++, featureLabel, featureClass);

        featureBlock = p.getFeatureBlockAt(featureId, featureClass, "div", "dt", "dd");

        assertEquals(blockTextFull, featureBlock.getText());

        MultipartDescriptionElementRepresentation descriptionElement = (MultipartDescriptionElementRepresentation) featureBlock.getDescriptionElements().get(0);

        logger.info(descriptionElement.getText());

        featureBlock.testDescriptionElementLayout(0, indent, descriptionElementFontSize, expectedCssDisplay, expectedListStyleType, expectedListStylePosition, expectedListStyleImage);

        assertEquals(0, featureBlock.getOriginalSourcesSections().size());

        assertEquals("Expecting 7 FootnoteKeys", 7, featureBlock.getFootNoteKeys().size());

        assertEquals("Expecting 6 Footnotes", 6, featureBlock.getFootNotes().size());

        assertNotNull("Expecting an OpenLayers map", featureBlock.getElement().findElement(By.id("openlayers_map")));

        WebElement mapCaptionElement = null;

        try {

            mapCaptionElement = featureBlock.getElement().findElement(By.className("distribution_map_caption"));

        } catch (NoSuchElementException e){

            /* IGNORE */

        }

        assertNull(mapCaptionElement);

        /* Uses */

        featureClass = "ecology";

        featureLabel = "Ecology";

        blockTextFull = featureLabel + "\n500 m. On chalky cliffs or in flushes on serpentine.\n\nfrom: Meikle, R. D. 1985: Flora of Cyprus 2. – Kew. (as Prenanthes triquetra)";

        expectedCssDisplay = "inline";

        p.testTableOfContentEntry(featureId++, featureLabel, featureClass);

        featureBlock = p.getFeatureBlockAt(featureId, featureClass, "div", "span");

        assertEquals(blockTextFull, featureBlock.getText());

        featureBlock.testDescriptionElementLayout(0, indent, descriptionElementFontSize, expectedCssDisplay, expectedListStyleType, expectedListStylePosition, expectedListStyleImage);

        assertEquals(0, featureBlock.getOriginalSourcesSections().size());

        assertEquals("Expecting no FootnoteKeys", 0, featureBlock.getFootNoteKeys().size());

        assertEquals("Expecting no Footnotes", 0, featureBlock.getFootNotes().size());

        /* Common names */

        featureClass = "common_names";

        featureLabel = "Common names";

        expectedCssDisplay = "block";

        blockTextFull = featureLabel + "\nArabic (Lebanon): سْكَرْيولَة ثُلاثِيَّة الأَرْكان7\n7. Nehmé, M., Dictionnaire Etymologique de la Flore du Liban. 2000";

        p.testTableOfContentEntry(featureId++, featureLabel, featureClass);

        featureBlock = p.getFeatureBlockAt(featureId, featureClass, "div", "li");

        assertEquals(blockTextFull, featureBlock.getText());

        /* Uses */

        featureClass = "credits";

        featureLabel = "Credits";

        blockTextFull = featureLabel + "\nChristodoulou C. S. 2009: Images (1 added).\nMakris C. 2009: Images (1 added).";

        expectedCssDisplay = "block";

        p.testTableOfContentEntry(featureId++, featureLabel, featureClass);

        featureBlock = p.getFeatureBlockAt(featureId, featureClass, "div", "span");

        assertEquals(blockTextFull, featureBlock.getText());

        featureBlock.testDescriptionElementLayout(0, indent, descriptionElementFontSize, expectedCssDisplay, expectedListStyleType, expectedListStylePosition, expectedListStyleImage);

        assertEquals(0, featureBlock.getOriginalSourcesSections().size());

        assertEquals("Expecting no FootnoteKeys", 0, featureBlock.getFootNoteKeys().size());

        assertEquals("Expecting no Footnotes", 0, featureBlock.getFootNotes().size());

    }

import static org.junit.Assert.assertTrue;

import eu.etaxonomy.dataportal.elements.ClassificationTreeBlock;

import eu.etaxonomy.dataportal.elements.ClassificationTreeElement;

import eu.etaxonomy.dataportal.pages.TaxonProfilePage;

    static UUID orchiserapias_Uuid = UUID.fromString("0aee7eea-84e7-4b61-8cb6-d17313cc9b80");

    static UUID epilobium_aschersonianum_Uuid = UUID.fromString("e13ea422-5d45-477b-ade3-8dc84dbc9dbc");

    //

    static UUID aegilops_biuncialis_x_geniculata_Uuid = UUID.fromString("88ff0fbb-c0df-46c1-9969-cf318ea97dbb");

    @Test

    public void orchiserapias() throws MalformedURLException {

        TaxonSynonymyPage p = new TaxonSynonymyPage(driver, getContext(), orchiserapias_Uuid);

        String expectedName = "×Orchiserapias";

        assertEquals(getContext().prepareTitle(expectedName), p.getTitle());

        assertEquals(expectedName, p.getAcceptedName());

        assertEquals("≡ Orchis × Serapias", p.getHomotypicalGroupSynonymName(1));

    }

    @Test

    public void epilobium_aschersonianum() throws MalformedURLException {

        TaxonSynonymyPage p = new TaxonSynonymyPage(driver, getContext(), epilobium_aschersonianum_Uuid);

        assertEquals(getContext().prepareTitle("Epilobium ×aschersonianum"), p.getTitle());

        assertEquals("Epilobium ×aschersonianum Hausskn.", p.getAcceptedName());

        assertEquals("≡ Epilobium lanceolatum × parviflorum", p.getHomotypicalGroupSynonymName(1));

    }

    @Test

    public void aegilops_biuncialis_x_geniculata() throws MalformedURLException {

        TaxonProfilePage p = new TaxonProfilePage(driver, getContext(), aegilops_biuncialis_x_geniculata_Uuid);

        assertEquals(getContext().prepareTitle("Aegilops biuncialis × geniculata"), p.getTitle());

        ClassificationTreeBlock classificationTree = p.getClassificationTree();

        ClassificationTreeElement focusedElement = classificationTree.getFocusedElement();

        assertTrue(classificationTree.isVisibleInViewPort(focusedElement));

        assertEquals("Abbreviated form of name should be used", "A. biuncialis × geniculata", focusedElement.getTaxonName());

    }