feature #1775 add support for lit renderers to grid tester

vaadin-testbench-unit-junit5/src/test/java/com/vaadin/flow/component/grid/BasicGridTesterTest.java

@@ -8,22 +8,21 @@
  */
 package com.vaadin.flow.component.grid;
 
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
-import java.util.concurrent.atomic.AtomicInteger;
-
-import org.junit.jupiter.api.Assertions;
-import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Test;
-
 import com.vaadin.flow.component.Component;
 import com.vaadin.flow.router.RouteConfiguration;
 import com.vaadin.testbench.unit.UIUnitTest;
 import com.vaadin.testbench.unit.ViewPackages;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.concurrent.atomic.AtomicInteger;
 
 @ViewPackages
-public class BasicGridTesterTest extends UIUnitTest {
+class BasicGridTesterTest extends UIUnitTest {
 
     BasicGridView view;
 
@@ -41,113 +40,112 @@ void basicGrid_verifyColumnContent() {
 
         Assertions.assertTrue(test(view.basicGrid).getSelected().isEmpty());
 
-        Assertions.assertEquals("Jorma",
-                test(view.basicGrid).getCellText(0, 0));
+        Assertions.assertEquals("Jorma", test(view.basicGrid).getCellText(0, 0));
+        // second column is hidden
         Assertions.assertEquals("46", test(view.basicGrid).getCellText(0, 1));
+
         Assertions.assertEquals("Maya", test(view.basicGrid).getCellText(1, 0));
+        // second column is hidden
         Assertions.assertEquals("18", test(view.basicGrid).getCellText(1, 1));
     }
 
     @Test
     void basicGrid_selectionOnClick() {
-
         Assertions.assertTrue(test(view.basicGrid).getSelected().isEmpty());
 
         test(view.basicGrid).clickRow(0);
-
         Assertions.assertEquals(1, test(view.basicGrid).getSelected().size());
-        Assertions.assertSame(view.first,
+        Assertions.assertSame(view.person1,
                 test(view.basicGrid).getSelected().iterator().next());
 
         test(view.basicGrid).clickRow(1);
-
         Assertions.assertEquals(1, test(view.basicGrid).getSelected().size());
-        Assertions.assertSame(view.second,
+        Assertions.assertSame(view.person2,
                 test(view.basicGrid).getSelected().iterator().next());
     }
 
     @Test
     void basicGrid_deselectSelectedOnClick() {
-
         Assertions.assertTrue(test(view.basicGrid).getSelected().isEmpty());
 
         test(view.basicGrid).clickRow(0);
-
         Assertions.assertEquals(1, test(view.basicGrid).getSelected().size());
-        Assertions.assertSame(view.first,
+        Assertions.assertSame(view.person1,
                 test(view.basicGrid).getSelected().iterator().next());
 
         test(view.basicGrid).clickRow(0);
-
         Assertions.assertTrue(test(view.basicGrid).getSelected().isEmpty(),
                 "Clicking selected row should deselect");
     }
 
     @Test
     void basicGrid_selectWillChangeSelection() {
         test(view.basicGrid).select(1);
-
         Assertions.assertEquals(1, test(view.basicGrid).getSelected().size());
-        Assertions.assertSame(view.second,
+        Assertions.assertSame(view.person2,
                 test(view.basicGrid).getSelected().iterator().next());
 
         test(view.basicGrid).select(0);
         Assertions.assertEquals(1, test(view.basicGrid).getSelected().size(),
                 "Single select should only change selection.");
-        Assertions.assertSame(view.first,
+        Assertions.assertSame(view.person1,
                 test(view.basicGrid).getSelected().iterator().next());
     }
 
     @Test
     void basicGrid_headerContent() {
-        Assertions.assertEquals(view.firstHeader,
-                test(view.basicGrid).getHeaderCell(0));
-        Assertions.assertEquals(view.secondHeader,
-                test(view.basicGrid).getHeaderCell(1));
+        Assertions.assertEquals("First Name",
+                test(view.basicGrid).getColumn(BasicGridView.FIRST_NAME_KEY).getHeaderText());
+        Assertions.assertEquals("Age",
+                test(view.basicGrid).getColumn(BasicGridView.AGE_KEY).getHeaderText());
+        Assertions.assertEquals("Subscriber",
+                test(view.basicGrid).getColumn(BasicGridView.SUBSCRIBER_KEY).getHeaderText());
+        Assertions.assertEquals("Deceased",
+                test(view.basicGrid).getColumn(BasicGridView.DECEASED_KEY).getHeaderText());
     }
 
     @Test
     void basicGrid_multiselect() {
-        // This is not right for a test, but we are testing features.
+        // This is not normally appropriate for a test, but we are testing features.
         view.basicGrid.setSelectionMode(Grid.SelectionMode.MULTI);
 
         test(view.basicGrid).clickRow(0);
-
         Assertions.assertTrue(test(view.basicGrid).getSelected().isEmpty(),
                 "Multiselect doesn't select for row click!");
 
         test(view.basicGrid).select(0);
         test(view.basicGrid).select(1);
-
         Assertions.assertSame(2, test(view.basicGrid).getSelected().size());
     }
 
     @Test
     void basicGrid_multiselectAll() {
-        // This is not right for a test, but we are testing features.
+        // This is not normally appropriate for a test, but we are testing features.
         view.basicGrid.setSelectionMode(Grid.SelectionMode.MULTI);
 
         test(view.basicGrid).selectAll();
-
         Assertions.assertSame(2, test(view.basicGrid).getSelected().size());
     }
 
     @Test
     void basicGrid_singleSelectThrowsForSelectAll() {
+        GridTester<Grid<Person>, Person> grid_ = test(view.basicGrid);
         Assertions.assertThrows(IllegalStateException.class,
-                () -> test(view.basicGrid).selectAll(),
+                grid_::selectAll,
                 "Select all should throw for single select");
     }
 
     @Test
     void basicGrid_Hidden_getTextThrows() {
         view.basicGrid.setVisible(false);
 
+        GridTester<Grid<Person>, Person> grid_ = test(view.basicGrid);
+
         Assertions.assertThrows(IllegalStateException.class,
-                () -> test(view.basicGrid).getHeaderCell(0),
+                () -> grid_.getHeaderCell(0),
                 "Header cell shouldn't be available for hidden grid");
         Assertions.assertThrows(IllegalStateException.class,
-                () -> test(view.basicGrid).getCellText(0, 0),
+                () -> grid_.getCellText(0, 0),
                 "Cell content shouldn't be available for hidden grid");
     }
 
@@ -158,12 +156,10 @@ void basicGrid_doubleClick() {
                 event -> doubleClicks.incrementAndGet());
 
         test(view.basicGrid).clickRow(0);
-
         Assertions.assertEquals(0, doubleClicks.get(),
                 "Click should not generate a double click event");
 
         test(view.basicGrid).doubleClickRow(0);
-
         Assertions.assertEquals(1, doubleClicks.get(),
                 "Double click event should have fired");
 
@@ -172,29 +168,33 @@ void basicGrid_doubleClick() {
     @Test
     void getCellComponent_columnByKey_returnsInstantiatedComponent() {
         final Component cellComponent = test(view.basicGrid).getCellComponent(1,
-                view.subscriber);
-        Assertions.assertTrue(cellComponent instanceof CheckBox);
+                BasicGridView.SUBSCRIBER_KEY);
+        Assertions.assertInstanceOf(CheckBox.class, cellComponent);
         Assertions.assertFalse(((CheckBox) cellComponent).isChecked());
     }
 
     @Test
     void getCellComponentByFaultyKey_throwsException() {
+        GridTester<Grid<Person>, Person> grid_ = test(view.basicGrid);
+
         Assertions.assertThrows(IllegalArgumentException.class,
-                () -> test(view.basicGrid).getCellComponent(1, "property"));
+                () -> grid_.getCellComponent(1, "property"));
     }
 
     @Test
     void getCellComponent_columnByPosition_returnsInstantiatedComponent() {
         final Component cellComponent = test(view.basicGrid).getCellComponent(1,
                 2);
-        Assertions.assertTrue(cellComponent instanceof CheckBox);
+        Assertions.assertInstanceOf(CheckBox.class, cellComponent);
         Assertions.assertFalse(((CheckBox) cellComponent).isChecked());
     }
 
     @Test
     void getCellComponent_columnByPosition_stringColumnThrows() {
+        GridTester<Grid<Person>, Person> grid_ = test(view.basicGrid);
+
         Assertions.assertThrows(IllegalArgumentException.class,
-                () -> test(view.basicGrid).getCellComponent(1, 1));
+                () -> grid_.getCellComponent(1, 1));
     }
 
     @Test
@@ -204,11 +204,27 @@ void basicGrid_reorderColumns() {
         Collections.reverse(columns);
         view.basicGrid.setColumnOrder(columns);
 
+        // person 1
         Assertions.assertEquals("Jorma",
-                test(view.basicGrid).getCellText(0, 2));
-        Assertions.assertEquals("46", test(view.basicGrid).getCellText(0, 1));
-        Assertions.assertEquals("Maya", test(view.basicGrid).getCellText(1, 2));
-        Assertions.assertEquals("18", test(view.basicGrid).getCellText(1, 1));
+                test(view.basicGrid).getCellText(0, 3));
+        Assertions.assertEquals("46", test(view.basicGrid).getCellText(0, 2));
+
+        // person 2
+        Assertions.assertEquals("Maya", test(view.basicGrid).getCellText(1, 3));
+        Assertions.assertEquals("18", test(view.basicGrid).getCellText(1, 2));
+    }
+
+    @Test
+    void basicGrid_toggleLitRenderedColumn() {
+        boolean deceased = test(view.basicGrid).getRow(0).getDeceased();
+
+        Assertions.assertEquals(deceased,
+                test(view.basicGrid).getLitRendererPropertyValue(0, BasicGridView.DECEASED_KEY, "deceased", Boolean.class));
+
+        test(view.basicGrid).invokeLitRendererFunction(0, BasicGridView.DECEASED_KEY, "onClick");
+
+        Assertions.assertEquals(!deceased,
+                test(view.basicGrid).getLitRendererPropertyValue(0, BasicGridView.DECEASED_KEY, "deceased", Boolean.class));
     }
 
 }

vaadin-testbench-unit-junit5/src/test/java/com/vaadin/flow/component/grid/BasicGridView.java

@@ -12,33 +12,60 @@
 import com.vaadin.flow.component.HasComponents;
 import com.vaadin.flow.component.Tag;
 import com.vaadin.flow.data.renderer.ComponentRenderer;
+import com.vaadin.flow.data.renderer.LitRenderer;
 import com.vaadin.flow.router.Route;
 
 @Tag("div")
 @Route(value = "basic-grid", registerAtStartup = false)
 public class BasicGridView extends Component implements HasComponents {
 
-    Grid<Person> basicGrid = new Grid<>();
-    Person first = Person.createTestPerson1();
-    Person second = Person.createTestPerson2();
+    static final String FIRST_NAME_KEY = "First Name";
+    static final String LAST_NAME_KEY = "Last Name";
+    static final String AGE_KEY = "Age";
+    static final String SUBSCRIBER_KEY = "Subscriber";
+    static final String DECEASED_KEY = "Deceased";
 
-    final String firstHeader = "Name";
-    final String secondHeader = "Age";
-    final String subscriber = "Subscriber";
+    final Grid<Person> basicGrid;
+    final Person person1;
+    final Person person2;
 
     public BasicGridView() {
+        basicGrid = new Grid<>();
 
-        basicGrid.setItems(first, second);
-
-        basicGrid.addColumn(Person::getFirstName).setHeader(firstHeader);
-        basicGrid.addColumn(Person::getLastName).setHeader(firstHeader)
+        basicGrid.addColumn(Person::getFirstName)
+                .setKey(FIRST_NAME_KEY)
+                .setHeader("First Name");
+        basicGrid.addColumn(Person::getLastName)
+                .setKey(LAST_NAME_KEY)
+                .setHeader("Last Name")
                 .setVisible(false);
-        basicGrid.addColumn(Person::getAge).setHeader(secondHeader);
-        basicGrid
-                .addColumn(new ComponentRenderer<>(
-                        person -> new CheckBox(person.isSubscriber())))
-                .setHeader(subscriber).setKey(subscriber);
+        basicGrid.addColumn(Person::getAge)
+                .setKey(AGE_KEY)
+                .setHeader("Age");
+        basicGrid.addColumn(new ComponentRenderer<>(person -> new CheckBox(person.isSubscriber())))
+                .setKey(SUBSCRIBER_KEY)
+                .setHeader("Subscriber");
+        basicGrid.addColumn(deceasedRenderer())
+                .setKey(DECEASED_KEY)
+                .setHeader("Deceased");
+
         add(basicGrid);
+
+        person1 = Person.createTestPerson1();
+        person1.setDeceased(true);
+        person2 = Person.createTestPerson2();
+
+        basicGrid.setItems(person1, person2);
+    }
+
+    private LitRenderer<Person> deceasedRenderer() {
+        return LitRenderer.<Person>of(
+                        "<button @click=${onClick}>${item.deceased ? 'Yes' : 'No'}</button>")
+                .withProperty("deceased", Person::getDeceased)
+                .withFunction("onClick", person -> {
+                    person.setDeceased(!person.getDeceased());
+                    basicGrid.getListDataView().refreshItem(person);
+                });
     }
 
 }

vaadin-testbench-unit-junit5/src/test/java/com/vaadin/flow/component/grid/GetTextCellRendererTest.java

@@ -8,13 +8,12 @@
  */
 package com.vaadin.flow.component.grid;
 
-import org.junit.jupiter.api.Assertions;
-import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Test;
-
 import com.vaadin.flow.router.RouteConfiguration;
 import com.vaadin.testbench.unit.UIUnitTest;
 import com.vaadin.testbench.unit.ViewPackages;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 
 @ViewPackages
 class GetTextCellRendererTest extends UIUnitTest {

vaadin-testbench-unit-junit5/src/test/java/com/vaadin/flow/component/grid/RendererGridView.java

@@ -34,7 +34,6 @@ public RendererGridView() {
         grid.addColumn(new ComponentRenderer<>(p -> null))
                 .setKey("nullRendered");
         grid.addColumn(new ComponentRenderer<>(p -> new Icon("USER")));
-
         add(grid);
     }