vaadin-framework/uitest/src/com/vaadin/tests/components/grid/basicfeatures/server/GridDetailsServerTest.java

/*
 * Copyright 2000-2014 Vaadin Ltd.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.vaadin.tests.components.grid.basicfeatures.server;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;
import org.openqa.selenium.By;
import org.openqa.selenium.NoSuchElementException;

import com.vaadin.testbench.TestBenchElement;
import com.vaadin.testbench.elements.NotificationElement;
import com.vaadin.tests.components.grid.basicfeatures.GridBasicFeaturesTest;

public class GridDetailsServerTest extends GridBasicFeaturesTest {
    /**
     * The reason to why last item details wasn't selected is that since it will
     * exist only after the viewport has been scrolled into view, we wouldn't be
     * able to scroll that particular details row into view, making tests
     * awkward with two scroll commands back to back.
     */
    private static final int ALMOST_LAST_INDEX = 995;
    private static final String[] OPEN_ALMOST_LAST_ITEM_DETAILS = new String[] {
            "Component", "Details", "Open " + ALMOST_LAST_INDEX };
    private static final String[] OPEN_FIRST_ITEM_DETAILS = new String[] {
            "Component", "Details", "Open firstItemId" };
    private static final String[] TOGGLE_FIRST_ITEM_DETAILS = new String[] {
            "Component", "Details", "Toggle firstItemId" };
    private static final String[] DETAILS_GENERATOR_NULL = new String[] {
            "Component", "Details", "Generators", "NULL" };
    private static final String[] DETAILS_GENERATOR_WATCHING = new String[] {
            "Component", "Details", "Generators", "\"Watching\"" };
    private static final String[] DETAILS_GENERATOR_HIERARCHICAL = new String[] {
            "Component", "Details", "Generators", "Hierarchical" };
    private static final String[] CHANGE_HIERARCHY = new String[] {
            "Component", "Details", "Generators", "- Change Component" };

    @Before
    public void setUp() {
        openTestURL();
    }

    @Test
    public void openVisibleDetails() {
        try {
            getGridElement().getDetails(0);
            fail("Expected NoSuchElementException");
        } catch (NoSuchElementException ignore) {
            // expected
        }
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS);
        assertNotNull("details should've opened", getGridElement()
                .getDetails(0));
    }

    @Test(expected = NoSuchElementException.class)
    public void closeVisibleDetails() {
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS);
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS);

        getGridElement().getDetails(0);
    }

    @Test
    public void openDetailsOutsideOfActiveRange() throws InterruptedException {
        getGridElement().scroll(10000);
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS);
        getGridElement().scroll(0);
        Thread.sleep(50);
        assertNotNull("details should've been opened", getGridElement()
                .getDetails(0));
    }

    @Test(expected = NoSuchElementException.class)
    public void closeDetailsOutsideOfActiveRange() {
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS);
        getGridElement().scroll(10000);
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS);
        getGridElement().scroll(0);
        getGridElement().getDetails(0);
    }

    @Test
    public void componentIsVisibleClientSide() {
        selectMenuPath(DETAILS_GENERATOR_WATCHING);
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS);

        TestBenchElement details = getGridElement().getDetails(0);
        assertNotNull("No widget detected inside details",
                details.findElement(By.className("v-widget")));
    }

    @Test
    public void openingDetailsTwice() {
        selectMenuPath(DETAILS_GENERATOR_WATCHING);
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS); // open
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS); // close
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS); // open

        TestBenchElement details = getGridElement().getDetails(0);
        assertNotNull("No widget detected inside details",
                details.findElement(By.className("v-widget")));
    }

    @Test(expected = NoSuchElementException.class)
    public void scrollingDoesNotCreateAFloodOfDetailsRows() {
        selectMenuPath(DETAILS_GENERATOR_WATCHING);

        // scroll somewhere to hit uncached rows
        getGridElement().scrollToRow(101);

        // this should throw
        getGridElement().getDetails(100);
    }

    @Test
    public void openingDetailsOutOfView() {
        getGridElement().scrollToRow(500);

        selectMenuPath(DETAILS_GENERATOR_WATCHING);
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS);

        getGridElement().scrollToRow(0);

        // if this fails, it'll fail before the assertNotNull
        assertNotNull("unexpected null details row", getGridElement()
                .getDetails(0));
    }

    @Test
    public void togglingAVisibleDetailsRowWithOneRoundtrip() {
        selectMenuPath(DETAILS_GENERATOR_WATCHING);
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS); // open

        assertTrue("Unexpected generator content",
                getGridElement().getDetails(0).getText().endsWith("(0)"));
        selectMenuPath(TOGGLE_FIRST_ITEM_DETAILS);
        assertTrue("New component was not displayed in the client",
                getGridElement().getDetails(0).getText().endsWith("(1)"));
    }

    @Test
    public void almosLastItemIdIsRendered() {
        selectMenuPath(DETAILS_GENERATOR_WATCHING);
        selectMenuPath(OPEN_ALMOST_LAST_ITEM_DETAILS);
        scrollGridVerticallyTo(100000);

        TestBenchElement details = getGridElement().getDetails(
                ALMOST_LAST_INDEX);
        assertNotNull(details);
        assertTrue("Unexpected details content",
                details.getText().endsWith(ALMOST_LAST_INDEX + " (0)"));
    }

    @Test
    public void hierarchyChangesWorkInDetails() {
        selectMenuPath(DETAILS_GENERATOR_HIERARCHICAL);
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS);
        assertEquals("One", getGridElement().getDetails(0).getText());
        selectMenuPath(CHANGE_HIERARCHY);
        assertEquals("Two", getGridElement().getDetails(0).getText());
    }

    @Ignore("This use case is not currently supported by Grid. If the detail "
            + "is out of view, the component is detached from the UI and a "
            + "new instance is generated when scrolled back. Support will "
            + "maybe be incorporated at a later time")
    @Test
    public void hierarchyChangesWorkInDetailsWhileOutOfView() {
        selectMenuPath(DETAILS_GENERATOR_HIERARCHICAL);
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS);
        scrollGridVerticallyTo(10000);
        selectMenuPath(CHANGE_HIERARCHY);
        scrollGridVerticallyTo(0);
        assertEquals("Two", getGridElement().getDetails(0).getText());
    }

    @Test
    public void swappingDetailsGenerators_noDetailsShown() {
        selectMenuPath(DETAILS_GENERATOR_WATCHING);
        selectMenuPath(DETAILS_GENERATOR_NULL);
        assertFalse("Got some errors", $(NotificationElement.class).exists());
    }

    @Test
    public void swappingDetailsGenerators_shownDetails() {
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS);
        assertTrue("Details should be empty at the start", getGridElement()
                .getDetails(0).getText().isEmpty());

        selectMenuPath(DETAILS_GENERATOR_WATCHING);
        assertFalse("Details should not be empty after swapping generator",
                getGridElement().getDetails(0).getText().isEmpty());
    }

    @Test
    public void swappingDetailsGenerators_whileDetailsScrolledOut_showNever() {
        scrollGridVerticallyTo(1000);
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS);
        selectMenuPath(DETAILS_GENERATOR_WATCHING);
        assertFalse("Got some errors", $(NotificationElement.class).exists());
    }

    @Test
    public void swappingDetailsGenerators_whileDetailsScrolledOut_showAfter() {
        scrollGridVerticallyTo(1000);
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS);
        selectMenuPath(DETAILS_GENERATOR_WATCHING);
        scrollGridVerticallyTo(0);

        assertFalse("Got some errors", $(NotificationElement.class).exists());
        assertNotNull("Could not find a details", getGridElement()
                .getDetails(0));
    }

    @Test
    public void swappingDetailsGenerators_whileDetailsScrolledOut_showBefore() {
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS);
        selectMenuPath(DETAILS_GENERATOR_WATCHING);
        scrollGridVerticallyTo(1000);

        assertFalse("Got some errors", $(NotificationElement.class).exists());
        assertNotNull("Could not find a details", getGridElement()
                .getDetails(0));
    }

    @Test
    public void swappingDetailsGenerators_whileDetailsScrolledOut_showBeforeAndAfter() {
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS);
        selectMenuPath(DETAILS_GENERATOR_WATCHING);
        scrollGridVerticallyTo(1000);
        scrollGridVerticallyTo(0);

        assertFalse("Got some errors", $(NotificationElement.class).exists());
        assertNotNull("Could not find a details", getGridElement()
                .getDetails(0));
    }

    @Test
    public void nullDetailComponentToggling() {
        selectMenuPath(OPEN_FIRST_ITEM_DETAILS);
        selectMenuPath(DETAILS_GENERATOR_WATCHING);
        selectMenuPath(DETAILS_GENERATOR_NULL);
        assertTrue("Details should be empty with null component",
                getGridElement().getDetails(0).getText().isEmpty());
        selectMenuPath(DETAILS_GENERATOR_WATCHING);
        assertFalse("Details should be not empty with details component",
                getGridElement().getDetails(0).getText().isEmpty());
    }
}