path: root/uitest/src/test/java/com/vaadin/tests/components/grid/basics/GridHeaderFooterTest.java

package com.vaadin.tests.components.grid.basics;

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

import java.util.List;
import java.util.Locale;
import java.util.stream.IntStream;

import org.junit.Test;

import com.vaadin.testbench.By;
import com.vaadin.testbench.elements.GridElement.GridCellElement;
import com.vaadin.testbench.elements.NotificationElement;

public class GridHeaderFooterTest extends GridBasicsTest {

    protected static final String[] HEADER_TEXTS = IntStream
            .range(0, GridBasics.COLUMN_CAPTIONS.length)
            .mapToObj(i -> "Header cell " + i).toArray(String[]::new);

    protected static final String[] FOOTER_TEXTS = IntStream
            .range(0, GridBasics.COLUMN_CAPTIONS.length)
            .mapToObj(i -> "Footer cell " + i).toArray(String[]::new);

    @Override
    public void setUp() {
        super.setUp();

        selectMenuPath("Component", "Footer", "Add default footer row");
    }

    @Test
    public void initialState_defaultHeaderPresent() {
        assertEquals(1, getGridElement().getHeaderCount());
        assertHeaderTexts(0, GridBasics.COLUMN_CAPTIONS);
    }

    @Test
    public void appendHeaderRow_addedToBottom() {
        selectMenuPath("Component", "Header", "Append header row");

        assertEquals(2, getGridElement().getHeaderCount());
        assertHeaderTexts(0, GridBasics.COLUMN_CAPTIONS);
        assertHeaderTexts(1, HEADER_TEXTS);
    }

    @Test
    public void prependHeaderRow_addedToTop() {
        selectMenuPath("Component", "Header", "Prepend header row");

        assertEquals(2, getGridElement().getHeaderCount());
        assertHeaderTexts(0, HEADER_TEXTS);
        assertHeaderTexts(1, GridBasics.COLUMN_CAPTIONS);
    }

    @Test
    public void removeDefaultHeaderRow_noHeaderRows() {
        selectMenuPath("Component", "Header", "Remove first header row");

        assertEquals(0, getGridElement().getHeaderCount());
    }

    @Test
    public void setDefaultRow_headerCaptionsUpdated() {
        selectMenuPath("Component", "Header", "Prepend header row");
        selectMenuPath("Component", "Header", "Set first row as default");

        assertHeaderTexts(0, HEADER_TEXTS);
    }

    @Test
    public void clickDefaultHeaderCell_sortIndicatorPresent() {
        GridCellElement headerCell = getGridElement().getHeaderCell(0, 2);
        headerCell.click();

        assertSortIndicator(headerCell, "sort-asc");

        headerCell.click();
        assertNoSortIndicator(headerCell, "sort-asc");
        assertSortIndicator(headerCell, "sort-desc");

        GridCellElement anotherCell = getGridElement().getHeaderCell(0, 3);
        anotherCell.click();

        assertNoSortIndicator(headerCell, "sort-asc");
        assertNoSortIndicator(headerCell, "sort-desc");
        assertSortIndicator(anotherCell, "sort-asc");
    }

    @Test
    public void noDefaultRow_clickHeaderCell_sortIndicatorsNotPresent() {
        selectMenuPath("Component", "Header", "Set no default row");

        GridCellElement headerCell = getGridElement().getHeaderCell(0, 2);
        headerCell.click();

        assertNoSortIndicator(headerCell, "sort-asc");
        assertNoSortIndicator(headerCell, "sort-desc");
    }

    @Test
    public void initialState_defaultFooterPresent() {
        assertEquals(1, getGridElement().getFooterCount());
        assertFooterTexts(0, GridBasics.COLUMN_CAPTIONS);
    }

    @Test
    public void appendFooterRow_addedToBottom() {
        selectMenuPath("Component", "Footer", "Append footer row");

        assertEquals(2, getGridElement().getFooterCount());
        assertFooterTexts(0, GridBasics.COLUMN_CAPTIONS);
        assertFooterTexts(1, FOOTER_TEXTS);
    }

    @Test
    public void prependFooterRow_addedToTop() {
        selectMenuPath("Component", "Footer", "Prepend footer row");

        assertEquals(2, getGridElement().getFooterCount());
        assertFooterTexts(0, FOOTER_TEXTS);
        assertFooterTexts(1, GridBasics.COLUMN_CAPTIONS);
    }

    @Test
    public void testDynamicallyChangingHeaderCellType() throws Exception {
        selectMenuPath("Component", "Columns", "Column 0", "Header Type",
                "Widget Header");
        GridCellElement widgetCell = getGridElement().getHeaderCell(0, 0);
        assertTrue(widgetCell.isElementPresent(By.className("v-button")));

        selectMenuPath("Component", "Columns", "Column 1", "Header Type",
                "HTML Header");
        GridCellElement htmlCell = getGridElement().getHeaderCell(0, 1);
        assertEquals("<b>HTML Header</b>",
                htmlCell.findElement(
                        By.className("v-grid-column-header-content"))
                        .getAttribute("innerHTML"));

        selectMenuPath("Component", "Columns", "Column 2", "Header Type",
                "Text Header");
        GridCellElement textCell = getGridElement().getHeaderCell(0, 2);

        assertEquals("text header",
                textCell.getText().toLowerCase(Locale.ROOT));
    }

    @Test
    public void testButtonInHeader() throws Exception {
        selectMenuPath("Component", "Columns", "Column 1", "Header Type",
                "Widget Header");

        getGridElement().findElements(By.className("v-button")).get(0).click();

        assertTrue("Button click should be logged",
                logContainsText("Button clicked!"));
    }

    @Test
    public void testRemoveComponentFromHeader() throws Exception {
        selectMenuPath("Component", "Columns", "Column 1", "Header Type",
                "Widget Header");
        selectMenuPath("Component", "Columns", "Column 1", "Header Type",
                "Text Header");
        assertTrue("No notifications should've been shown",
                !$(NotificationElement.class).exists());
        assertEquals("Header should've been reverted back to text header",
                "text header", getGridElement().getHeaderCell(0, 1).getText()
                        .toLowerCase(Locale.ROOT));
    }

    @Test
    public void testColumnHidingToggleCaption_settingWidgetToHeader_toggleCaptionStays() {
        toggleColumnHidable(1);
        getSidebarOpenButton().click();
        assertEquals("column 1", getGridElement().getHeaderCell(0, 1).getText()
                .toLowerCase(Locale.ROOT));
        assertEquals("Column 1", getColumnHidingToggle(1).getText());

        selectMenuPath("Component", "Columns", "Column 1", "Header Type",
                "Widget Header");

        getSidebarOpenButton().click();
        assertEquals("Column 1", getColumnHidingToggle(1).getText());
    }

    @Test
    public void testDynamicallyChangingFooterCellType() throws Exception {
        selectMenuPath("Component", "Columns", "Column 0", "Footer Type",
                "Widget Footer");
        GridCellElement widgetCell = getGridElement().getFooterCell(0, 0);
        assertTrue(widgetCell.isElementPresent(By.className("v-button")));

        selectMenuPath("Component", "Columns", "Column 1", "Footer Type",
                "HTML Footer");
        GridCellElement htmlCell = getGridElement().getFooterCell(0, 1);
        assertEquals("<b>HTML Footer</b>",
                htmlCell.findElement(
                        By.className("v-grid-column-footer-content"))
                        .getAttribute("innerHTML"));

        selectMenuPath("Component", "Columns", "Column 2", "Footer Type",
                "Text Footer");
        GridCellElement textCell = getGridElement().getFooterCell(0, 2);

        assertEquals("text footer",
                textCell.getText().toLowerCase(Locale.ROOT));
    }

    @Test
    public void testButtonInFooter() throws Exception {
        selectMenuPath("Component", "Columns", "Column 1", "Footer Type",
                "Widget Footer");

        getGridElement().findElements(By.className("v-button")).get(0).click();

        assertTrue("Button click should be logged",
                logContainsText("Button clicked!"));
    }

    @Test
    public void testRemoveComponentFromFooter() throws Exception {
        selectMenuPath("Component", "Columns", "Column 1", "Footer Type",
                "Widget Footer");
        selectMenuPath("Component", "Columns", "Column 1", "Footer Type",
                "Text Footer");
        assertTrue("No notifications should've been shown",
                !$(NotificationElement.class).exists());
        assertEquals("Footer should've been reverted back to text footer",
                "text footer", getGridElement().getFooterCell(0, 1).getText()
                        .toLowerCase(Locale.ROOT));
    }

    @Test
    public void testColumnHidingToggleCaption_settingWidgetToFooter_toggleCaptionStays() {
        toggleColumnHidable(1);
        getSidebarOpenButton().click();
        assertEquals("column 1", getGridElement().getHeaderCell(0, 1).getText()
                .toLowerCase(Locale.ROOT));
        assertEquals("Column 1", getColumnHidingToggle(1).getText());

        selectMenuPath("Component", "Columns", "Column 1", "Footer Type",
                "Widget Footer");

        getSidebarOpenButton().click();
        assertEquals("Column 1", getColumnHidingToggle(1).getText());
    }

    @Test
    public void testHeaderMergedRemoveColumn() {
        selectMenuPath("Component", "Header", "Append header row");
        selectMenuPath("Component", "Header", "Merge Header Cells [0,0..1]");

        selectMenuPath("Component", "Footer", "Append footer row");
        selectMenuPath("Component", "Footer", "Merge Footer Cells [0,0..1]");

        checkMergedHeaderFooter();

        selectMenuPath("Component", "Columns", "Column 1", "Remove");
        selectMenuPath("Component", "Header", "Append header row");
        selectMenuPath("Component", "Footer", "Append footer row");

        checkHeaderAfterDelete();
        checkFooterAfterDelete();

    }

    private void checkHeaderAfterDelete() {
        GridCellElement c00;
        c00 = getGridElement().getHeaderCell(0, 0);
        assertEquals("Column 0", c00.getText());
        assertEquals("Colspan of header cell [0,0]", "1",
                c00.getAttribute("colspan"));

        GridCellElement c01 = getGridElement().getHeaderCell(0, 1);
        assertEquals("Column 2", c01.getText());

        GridCellElement c10 = getGridElement().getHeaderCell(1, 0);
        assertEquals("Header cell 0", c10.getText());

        GridCellElement c11 = getGridElement().getHeaderCell(1, 1);
        assertEquals("Header cell 2", c11.getText());

        GridCellElement c20 = getGridElement().getHeaderCell(2, 0);
        assertEquals("Header cell 0", c20.getText());

        GridCellElement c21 = getGridElement().getHeaderCell(2, 1);
        assertEquals("Header cell 1", c21.getText());
    }

    private void checkFooterAfterDelete() {
        GridCellElement c10;
        // footer has an invisible first row
        c10 = getGridElement().getFooterCell(1, 0);
        assertEquals("Footer cell 0", c10.getText());
        assertEquals("Colspan of footer cell [0,0]", "1",
                c10.getAttribute("colspan"));

        GridCellElement c11 = getGridElement().getFooterCell(1, 1);
        assertEquals("Footer cell 2", c11.getText());

        GridCellElement c20 = getGridElement().getFooterCell(2, 0);
        assertEquals("Footer cell 0", c20.getText());

        GridCellElement c21 = getGridElement().getFooterCell(2, 1);
        assertEquals("Footer cell 1", c21.getText());
    }

    private void checkMergedHeaderFooter() {
        GridCellElement c00 = getGridElement().getHeaderCell(0, 0);
        assertEquals("0+1", c00.getText());
        assertEquals("Colspan of header cell [0,0]", "2",
                c00.getAttribute("colspan"));

        c00 = getGridElement().getFooterCell(0, 0);
        assertEquals("0+1", c00.getText());
        assertEquals("Colspan of footer cell [0,0]", "2",
                c00.getAttribute("colspan"));
    }

    @Test
    public void testHeaderMerge() {
        selectMenuPath("Component", "Header", "Append header row");
        selectMenuPath("Component", "Header", "Merge Header Cells [0,0..1]");
        selectMenuPath("Component", "Header", "Merge Header Cells [1,1..3]");
        selectMenuPath("Component", "Header", "Merge Header Cells [0,6..7]");

        GridCellElement mergedCell1 = getGridElement().getHeaderCell(0, 0);
        assertEquals("0+1", mergedCell1.getText());
        assertEquals("Colspan, cell [0,0]", "2",
                mergedCell1.getAttribute("colspan"));

        GridCellElement mergedCell2 = getGridElement().getHeaderCell(1, 1);
        assertEquals("1+2+3", mergedCell2.getText());
        assertEquals("Colspan of cell [1,1]", "3",
                mergedCell2.getAttribute("colspan"));

        GridCellElement mergedCell3 = getGridElement().getHeaderCell(0, 6);
        assertEquals("6+7", mergedCell3.getText());
        assertEquals("Colspan of cell [0,6]", "2",
                mergedCell3.getAttribute("colspan"));

    }

    @Test
    public void testFooterMerge() {
        selectMenuPath("Component", "Footer", "Append footer row");
        selectMenuPath("Component", "Footer", "Merge Footer Cells [0,0..1]");
        selectMenuPath("Component", "Footer", "Merge Footer Cells [1,1..3]");
        selectMenuPath("Component", "Footer", "Merge Footer Cells [0,6..7]");

        GridCellElement mergedCell1 = getGridElement().getFooterCell(0, 0);
        assertEquals("0+1", mergedCell1.getText());
        assertEquals("Colspan, cell [0,0]", "2",
                mergedCell1.getAttribute("colspan"));

        GridCellElement mergedCell2 = getGridElement().getFooterCell(1, 1);
        assertEquals("1+2+3", mergedCell2.getText());
        assertEquals("Colspan of cell [1,1]", "3",
                mergedCell2.getAttribute("colspan"));

        GridCellElement mergedCell3 = getGridElement().getFooterCell(0, 6);
        assertEquals("6+7", mergedCell3.getText());
        assertEquals("Colspan of cell [0,6]", "2",
                mergedCell3.getAttribute("colspan"));

    }

    @Test
    public void testHideAndShowHeader() {
        assertEquals("There should be one header row", 1,
                getGridElement().getHeaderCount());
        selectMenuPath("Component", "Header", "Toggle header visibility");
        assertEquals("There should be no header rows", 0,
                getGridElement().getHeaderCount());
        selectMenuPath("Component", "Header", "Toggle header visibility");
        assertEquals("There should be one header row again", 1,
                getGridElement().getHeaderCount());
    }

    @Test
    public void testHideAndShowFooter() {
        assertEquals("There should be one footer row", 1,
                getGridElement().getFooterCount());
        selectMenuPath("Component", "Footer", "Toggle footer visibility");
        assertEquals("There should be no footer rows", 0,
                getGridElement().getFooterCount());
        selectMenuPath("Component", "Footer", "Toggle footer visibility");
        assertEquals("There should be one footer row again", 1,
                getGridElement().getFooterCount());
    }

    private void toggleColumnHidable(int index) {
        selectMenuPath("Component", "Columns", "Column " + index, "Hidable");
    }

    protected static void assertText(String expected, GridCellElement e) {
        // TBE.getText returns "" if the element is scrolled out of view
        String actual = e.findElement(By.tagName("div"))
                .getAttribute("innerHTML");
        assertEquals(expected, actual);
    }

    protected void assertHeaderTexts(int rowIndex, String[] texts) {
        List<GridCellElement> headerCells = getGridElement()
                .getHeaderCells(rowIndex);

        assertEquals(texts.length, headerCells.size());
        for (int i = 0; i < headerCells.size(); i++) {
            assertText(texts[i], headerCells.get(i));
        }
    }

    protected void assertFooterTexts(int rowIndex, String[] texts) {
        List<GridCellElement> footerCells = getGridElement()
                .getFooterCells(rowIndex);

        assertEquals(texts.length, footerCells.size());
        for (int i = 0; i < footerCells.size(); i++) {
            assertText(texts[i], footerCells.get(i));
        }
    }

    protected void assertSortIndicator(GridCellElement cell, String classname) {
        assertTrue("Header cell should have sort indicator " + classname,
                cell.getAttribute("class").contains(classname));
    }

    protected void assertNoSortIndicator(GridCellElement cell,
            String classname) {
        assertFalse("Header cell should not have sort indicator " + classname,
                cell.getAttribute("class").contains(classname));
    }
}