#436 more UI automated testing

Author: davetcc

.idea/runConfigurations/TcMenuDesigner_Single_Test.xml

@@ -26,6 +26,7 @@
 import java.util.List;
 import java.util.Optional;
 import java.util.function.BiConsumer;
+import java.util.stream.Collectors;
 
 import static com.thecoderscorner.menu.domain.RuntimeListMenuItem.ListCreationMode;
 
@@ -60,6 +61,15 @@ protected Optional<RuntimeListMenuItem> getChangedMenuItem() {
             errors.add(new FieldError(bundle.getString("menu.editor.enum.fmt.error"), "Choices"));
         }
 
+        if(creationModeCombo.getValue() != ListCreationMode.CUSTOM_RTCALL && localHandler.isLocalSupportEnabled()) {
+            var itemsNotInResources = listView.getItems().stream()
+                    .filter(item -> item.startsWith("%") && !item.startsWith("%%") && item.length() > 1)
+                    .filter(item -> localHandler.getLocalSpecificEntry(item.substring(1)) == null)
+                    .collect(Collectors.joining(", "));
+            errors.add(new FieldError(bundle.getString("menu.editor.core.locale.missing") + " " +  itemsNotInResources,
+                    "List values", false));
+        }
+
         builder.withInitialRows(initialRowsSpinner.getValue());
         builder.withCreationMode(creationModeCombo.getValue());
         var item = builder.menuItem();
@@ -70,6 +80,7 @@ protected Optional<RuntimeListMenuItem> getChangedMenuItem() {
     protected int internalInitPanel(GridPane pane, int idx) {
         idx++;
         initialRowsSpinner = new Spinner<>(0, 255, getMenuItem().getInitialRows());
+        initialRowsSpinner.setId("initialRowsSpinner");
         initialRowsSpinner.valueProperty().addListener((observable, oldValue, newValue) -> callChangeConsumer());
         pane.add(new Label(bundle.getString("menu.editor.initial.rows")), 0, idx);
         pane.add(initialRowsSpinner, 1, idx);
@@ -110,8 +121,4 @@ private void listTypeHasChanged() {
             buttonsToAddRemove.removeButton().setDisable(listView.getSelectionModel().getSelectedIndex() == -1);
         } else buttonsToAddRemove.removeButton().setDisable(true);
     }
-
-    protected String getEnumEntryKey(int i) {
-        return String.format("menu.%d.list.%d", getMenuItem().getId(), i);
-    }
 }

tcMenuGenerator/src/main/java/com/thecoderscorner/menu/editorui/uimodel/UIRuntimeListMenuItem.java

@@ -1,36 +1,112 @@
 package com.thecoderscorner.menu.editorint.uitests.uimenuitem;
 
+import com.thecoderscorner.menu.domain.RuntimeListMenuItem;
+import com.thecoderscorner.menu.domain.RuntimeListMenuItemBuilder;
+import com.thecoderscorner.menu.domain.util.MenuItemHelper;
 import com.thecoderscorner.menu.editorui.generator.core.VariableNameGenerator;
+import com.thecoderscorner.menu.persist.LocaleMappingHandler;
+import com.thecoderscorner.menu.persist.PropertiesLocaleEnabledHandler;
+import com.thecoderscorner.menu.persist.SafeBundleLoader;
 import javafx.application.Platform;
+import javafx.scene.Node;
+import javafx.scene.control.Label;
+import javafx.scene.control.Spinner;
 import javafx.stage.Stage;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
+import org.testfx.api.FxAssert;
+import org.testfx.api.FxRobot;
 import org.testfx.framework.junit5.ApplicationExtension;
 import org.testfx.framework.junit5.Start;
+import org.testfx.matcher.control.ListViewMatchers;
 
-import static org.junit.jupiter.api.Assertions.fail;
-import static org.mockito.ArgumentMatchers.any;
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Comparator;
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.testfx.api.FxAssert.verifyThat;
 
 @ExtendWith(ApplicationExtension.class)
 public class UIRuntimeListMenuItemTest extends UIMenuItemTestBase {
+    private Path tempPath;
+
     @Start
-    public void setup(Stage stage) {
+    public void setup(Stage stage) throws IOException {
+        tempPath = Files.createTempDirectory("i18ntest");
         init(stage);
     }
 
     @AfterEach
-    protected void closeWindow() {
+    protected void closeWindow() throws IOException {
         Platform.runLater(() -> stage.close());
+        Files.walk(tempPath)
+                .sorted(Comparator.reverseOrder())
+                .map(Path::toFile)
+                .forEach(File::delete);
+    }
+
+    @Test
+    public void testListInCustomMode(FxRobot robot) throws Exception {
+        VariableNameGenerator vng = new VariableNameGenerator(menuTree, false);
+        var uiList = editorUI.createPanelForMenuItem(new RuntimeListMenuItemBuilder()
+                .withExisting((RuntimeListMenuItem) menuTree.getMenuById(10).orElseThrow())
+                .withInitialRows(10).withCreationMode(RuntimeListMenuItem.ListCreationMode.CUSTOM_RTCALL)
+                .menuItem(), menuTree, vng, mockedConsumer);
+        if(uiList.isEmpty()) throw new IllegalArgumentException("No menu item found");
+        createMainPanel(uiList);
+
+        performAllCommonChecks(uiList.get().getMenuItem(), false, false);
+
+        verifyThat("#initialRowsSpinner", (Spinner<Integer> spinner) -> spinner.getValue() == 10);
     }
 
     @Test
-    public void testListCanConstruct() throws Exception {
+    public void testListInArrayMode(FxRobot robot) throws Exception {
         VariableNameGenerator vng = new VariableNameGenerator(menuTree, false);
-        var uiList = editorUI.createPanelForMenuItem(menuTree.getMenuById(10).get(), menuTree, vng, mockedConsumer);
+        RuntimeListMenuItem menuItem = new RuntimeListMenuItemBuilder()
+                .withExisting((RuntimeListMenuItem) menuTree.getMenuById(10).orElseThrow())
+                .withInitialRows(10).withCreationMode(RuntimeListMenuItem.ListCreationMode.FLASH_ARRAY)
+                .menuItem();
+        MenuItemHelper.setMenuState(menuItem, List.of("%list1", "%list2"), menuTree);
+
+        var uiList = editorUI.createPanelForMenuItem(menuItem, menuTree, vng, mockedConsumer);
         if(uiList.isEmpty()) throw new IllegalArgumentException("No menu item found");
         createMainPanel(uiList);
 
         performAllCommonChecks(uiList.get().getMenuItem(), false, false);
+        verifyThat("#initialRowsSpinner", Node::isDisable);
+        FxAssert.verifyThat("#enumList", ListViewMatchers.hasListCell("%list1"));
+        FxAssert.verifyThat("#enumList", ListViewMatchers.hasListCell("%list2"));
+
+        robot.clickOn("#addEnumEntry");
+        FxAssert.verifyThat("#enumList", ListViewMatchers.hasItems(3));
+        FxAssert.verifyThat("#enumList", ListViewMatchers.hasListCell("ChangeMe"));
+
+        var item = menuTree.getMenuById(10).orElseThrow();
+        assertThat((List<String>)MenuItemHelper.getValueFor(item, menuTree)).containsExactly("%list1", "%list2", "ChangeMe");
+
+        var errorText = "WARNING List values: no locale entry in bundle";
+        verifyThat("#uiItemErrors", (Label l)-> l.getText().contains(errorText) && l.isVisible());
+        verifyThat("#initialRowsSpinner", (Spinner<Integer> s)-> s.getValue() == 3);
+
+    }
+
+    @Override
+    protected LocaleMappingHandler getTestLocaleHandler() {
+        try {
+            var coreFile = tempPath.resolve("temp.properties");
+            Files.writeString(coreFile, """
+                    menu.item.name=hello world
+                    list1=abc
+                    """);
+            return new PropertiesLocaleEnabledHandler(new SafeBundleLoader(tempPath, "temp"));
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
     }
 }

tcMenuGenerator/src/test/java/com/thecoderscorner/menu/editorint/uitests/uimenuitem/UIRuntimeListMenuItemTest.java

@@ -6,10 +6,17 @@
 
 package com.thecoderscorner.menu.domain;
 
+import com.thecoderscorner.menu.domain.state.MenuTree;
+import com.thecoderscorner.menu.domain.util.MenuItemHelper;
 import com.thecoderscorner.menu.domain.util.MenuItemVisitor;
 
+import java.util.List;
 import java.util.Objects;
 
+/**
+ * This class represents a runtime list menu item, which is a type of menu item that can contain a list of values.
+ * It extends the MenuItem class and inherits its properties and methods.
+ */
 public class RuntimeListMenuItem extends MenuItem {
     public enum ListCreationMode {CUSTOM_RTCALL, RAM_ARRAY, FLASH_ARRAY }
     private final int initialRows;
@@ -58,8 +65,27 @@ public int hashCode() {
         return Objects.hash(getInitialRows(), getName(), getId(), getEepromAddress(), getFunctionName(), isReadOnly(), getVariableName(), getListCreationMode());
     }
 
+    /**
+     * Used with MenuItemHelper's visit method, accepts a MenuItemVisitor and calls the appropriate visit method for a RuntimeListMenuItem.
+     *
+     * @param visitor The MenuItemVisitor to accept
+     */
     @Override
     public void accept(MenuItemVisitor visitor) {
         visitor.visit(this);
     }
+
+
+    /**
+     * Retrieves the list of items from a menu tree for a specific RuntimeListMenuItem. This is a helper to
+     * get back the list of items stored in the tree state.
+     *
+     * @param menuTree the menu tree from which to retrieve the items
+     * @return a list of items as strings
+     */
+    @SuppressWarnings("unchecked")
+    public List<String> getItemsFromTree(MenuTree menuTree) {
+        return (List<String>) MenuItemHelper.getValueFor(this, menuTree);
+    }
+
 }