diff options
Diffstat (limited to 'android/sdl_android/src/androidTest/java/com/smartdevicelink/managers/screen/menu/MenuReplaceUtilitiesTests.java')
| -rw-r--r-- | android/sdl_android/src/androidTest/java/com/smartdevicelink/managers/screen/menu/MenuReplaceUtilitiesTests.java | 343 |
1 files changed, 343 insertions, 0 deletions
diff --git a/android/sdl_android/src/androidTest/java/com/smartdevicelink/managers/screen/menu/MenuReplaceUtilitiesTests.java b/android/sdl_android/src/androidTest/java/com/smartdevicelink/managers/screen/menu/MenuReplaceUtilitiesTests.java new file mode 100644 index 000000000..61587dbdc --- /dev/null +++ b/android/sdl_android/src/androidTest/java/com/smartdevicelink/managers/screen/menu/MenuReplaceUtilitiesTests.java @@ -0,0 +1,343 @@ +/* + * Copyright (c) 2021 Livio, Inc. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * + * Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following + * disclaimer in the documentation and/or other materials provided with the + * distribution. + * + * Neither the name of the Livio Inc. nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +package com.smartdevicelink.managers.screen.menu; + +import androidx.test.ext.junit.runners.AndroidJUnit4; + +import com.smartdevicelink.managers.file.FileManager; +import com.smartdevicelink.managers.file.filetypes.SdlArtwork; +import com.smartdevicelink.proxy.rpc.ImageField; +import com.smartdevicelink.proxy.rpc.WindowCapability; +import com.smartdevicelink.proxy.rpc.enums.ImageFieldName; +import com.smartdevicelink.proxy.rpc.enums.MenuLayout; +import com.smartdevicelink.test.TestValues; + +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import static com.smartdevicelink.managers.screen.menu.BaseMenuManager.parentIdNotFound; +import static com.smartdevicelink.managers.screen.menu.MenuReplaceUtilities.addIdsToMenuCells; +import static junit.framework.TestCase.assertEquals; +import static junit.framework.TestCase.assertFalse; +import static junit.framework.TestCase.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +/** + * Created by Bilal Alsharifi on 2/4/21. + */ +@RunWith(AndroidJUnit4.class) +public class MenuReplaceUtilitiesTests { + @Before + public void setUp() throws Exception { + } + + @Test + public void testRemoveMenuCellFromList() { + MenuCell menuCellToDelete; + boolean cellRemoved; + List<MenuCell> actualMenuCellList = createMenuCellList(); + List<MenuCell> expectedMenuCellList = createMenuCellList(); + + // Delete cell c4 + menuCellToDelete = actualMenuCellList.get(3); + cellRemoved = MenuReplaceUtilities.removeCellFromList(actualMenuCellList, menuCellToDelete.getCellId()); + assertTrue(cellRemoved); + expectedMenuCellList.remove(3); + assertEquals(expectedMenuCellList, actualMenuCellList); + assertEquals(3, actualMenuCellList.size()); + + // Delete cell c4 again - removal should fail and list should not change + cellRemoved = MenuReplaceUtilities.removeCellFromList(actualMenuCellList, menuCellToDelete.getCellId()); + assertFalse(cellRemoved); + assertEquals(expectedMenuCellList, actualMenuCellList); + assertEquals(3, actualMenuCellList.size()); + + // Delete cell c3 + menuCellToDelete = actualMenuCellList.get(2); + cellRemoved = MenuReplaceUtilities.removeCellFromList(actualMenuCellList, menuCellToDelete.getCellId()); + assertTrue(cellRemoved); + expectedMenuCellList.remove(2); + assertEquals(expectedMenuCellList, actualMenuCellList); + assertEquals(2, actualMenuCellList.size()); + + // Delete cell c2-2-2 + menuCellToDelete = actualMenuCellList.get(1).getSubCells().get(1).getSubCells().get(1); + cellRemoved = MenuReplaceUtilities.removeCellFromList(actualMenuCellList, menuCellToDelete.getCellId()); + assertTrue(cellRemoved); + expectedMenuCellList.get(1).getSubCells().get(1).getSubCells().remove(1); + assertEquals(expectedMenuCellList, actualMenuCellList); + assertEquals(2, actualMenuCellList.size()); + assertEquals(1, actualMenuCellList.get(1).getSubCells().get(1).getSubCells().size()); + + // Delete cell c2-2-1 + menuCellToDelete = actualMenuCellList.get(1).getSubCells().get(1).getSubCells().get(0); + cellRemoved = MenuReplaceUtilities.removeCellFromList(actualMenuCellList, menuCellToDelete.getCellId()); + assertTrue(cellRemoved); + expectedMenuCellList.get(1).getSubCells().get(1).getSubCells().remove(0); + assertEquals(expectedMenuCellList, actualMenuCellList); + assertEquals(2, actualMenuCellList.size()); + assertEquals(0, actualMenuCellList.get(1).getSubCells().get(1).getSubCells().size()); + + // Delete cell c2-2 + menuCellToDelete = actualMenuCellList.get(1).getSubCells().get(1); + cellRemoved = MenuReplaceUtilities.removeCellFromList(actualMenuCellList, menuCellToDelete.getCellId()); + assertTrue(cellRemoved); + expectedMenuCellList.get(1).getSubCells().remove(1); + assertEquals(expectedMenuCellList, actualMenuCellList); + assertEquals(2, actualMenuCellList.size()); + assertEquals(1, actualMenuCellList.get(1).getSubCells().size()); + + // Delete cell c2-1 + menuCellToDelete = actualMenuCellList.get(1).getSubCells().get(0); + cellRemoved = MenuReplaceUtilities.removeCellFromList(actualMenuCellList, menuCellToDelete.getCellId()); + assertTrue(cellRemoved); + expectedMenuCellList.get(1).getSubCells().remove(0); + assertEquals(expectedMenuCellList, actualMenuCellList); + assertEquals(2, actualMenuCellList.size()); + assertEquals(0, actualMenuCellList.get(1).getSubCells().size()); + + // Delete cell c2 + menuCellToDelete = actualMenuCellList.get(1); + cellRemoved = MenuReplaceUtilities.removeCellFromList(actualMenuCellList, menuCellToDelete.getCellId()); + assertTrue(cellRemoved); + expectedMenuCellList.remove(1); + assertEquals(expectedMenuCellList, actualMenuCellList); + assertEquals(1, actualMenuCellList.size()); + + // Delete cell c1 + menuCellToDelete = actualMenuCellList.get(0); + cellRemoved = MenuReplaceUtilities.removeCellFromList(actualMenuCellList, menuCellToDelete.getCellId()); + assertTrue(cellRemoved); + expectedMenuCellList.remove(0); + assertEquals(expectedMenuCellList, actualMenuCellList); + assertEquals(0, actualMenuCellList.size()); + } + + @Test + public void testAddMenuRequestWithCommandId() { + MenuCell menuCellToAdd; + boolean cellAdded; + List<MenuCell> actualMenuCellList = createMenuCellList(); + List<MenuCell> expectedMenuCellList = createMenuCellList(); + List<MenuCell> newMenuList = createNewMenuList(); + + // Add cell c5 + menuCellToAdd = newMenuList.get(0); + cellAdded = MenuReplaceUtilities.addCellWithCellId(menuCellToAdd.getCellId(), 4, newMenuList, actualMenuCellList); + assertTrue(cellAdded); + expectedMenuCellList.add(4, cloneMenuCellAndRemoveSubCells(menuCellToAdd)); + assertEquals(expectedMenuCellList, actualMenuCellList); + assertEquals(5, actualMenuCellList.size()); + assertEquals(0, actualMenuCellList.get(4).getSubCells().size()); + + // Add cell c5-1 + menuCellToAdd = newMenuList.get(0).getSubCells().get(0); + cellAdded = MenuReplaceUtilities.addCellWithCellId(menuCellToAdd.getCellId(), 0, newMenuList, actualMenuCellList); + assertTrue(cellAdded); + expectedMenuCellList.get(4).getSubCells().add(0, cloneMenuCellAndRemoveSubCells(menuCellToAdd)); + assertEquals(expectedMenuCellList, actualMenuCellList); + assertEquals(5, actualMenuCellList.size()); + assertEquals(1, actualMenuCellList.get(4).getSubCells().size()); + + // Add cell c5-1-1 + menuCellToAdd = newMenuList.get(0).getSubCells().get(0).getSubCells().get(0); + cellAdded = MenuReplaceUtilities.addCellWithCellId(menuCellToAdd.getCellId(), 0, newMenuList, actualMenuCellList); + assertTrue(cellAdded); + expectedMenuCellList.get(4).getSubCells().get(0).getSubCells().add(0, cloneMenuCellAndRemoveSubCells(menuCellToAdd)); + assertEquals(expectedMenuCellList, actualMenuCellList); + assertEquals(5, actualMenuCellList.size()); + assertEquals(1, actualMenuCellList.get(4).getSubCells().size()); + assertEquals(1, actualMenuCellList.get(4).getSubCells().get(0).getSubCells().size()); + + // Add cell c5-2 + menuCellToAdd = newMenuList.get(0).getSubCells().get(1); + cellAdded = MenuReplaceUtilities.addCellWithCellId(menuCellToAdd.getCellId(), 1, newMenuList, actualMenuCellList); + assertTrue(cellAdded); + expectedMenuCellList.get(4).getSubCells().add(1, cloneMenuCellAndRemoveSubCells(menuCellToAdd)); + assertEquals(expectedMenuCellList, actualMenuCellList); + assertEquals(5, actualMenuCellList.size()); + assertEquals(2, actualMenuCellList.get(4).getSubCells().size()); + assertEquals(1, actualMenuCellList.get(4).getSubCells().get(0).getSubCells().size()); + assertEquals(0, actualMenuCellList.get(4).getSubCells().get(1).getSubCells().size()); + + // Add cell c5-2-1 + menuCellToAdd = newMenuList.get(0).getSubCells().get(1).getSubCells().get(0); + cellAdded = MenuReplaceUtilities.addCellWithCellId(menuCellToAdd.getCellId(), 0, newMenuList, actualMenuCellList); + assertTrue(cellAdded); + expectedMenuCellList.get(4).getSubCells().get(1).getSubCells().add(0, cloneMenuCellAndRemoveSubCells(menuCellToAdd)); + assertEquals(expectedMenuCellList, actualMenuCellList); + assertEquals(5, actualMenuCellList.size()); + assertEquals(2, actualMenuCellList.get(4).getSubCells().size()); + assertEquals(1, actualMenuCellList.get(4).getSubCells().get(0).getSubCells().size()); + assertEquals(1, actualMenuCellList.get(4).getSubCells().get(1).getSubCells().size()); + } + + @Test + public void testShouldCellIncludeImage() { + MenuCell menuCell; + WindowCapability windowCapability; + FileManager fileManager; + List<String> voiceCommands = null; + + // Case 1 + menuCell = new MenuCell(TestValues.GENERAL_STRING, TestValues.GENERAL_ARTWORK, voiceCommands, null); + windowCapability = createWindowCapability(true, true); + fileManager = createMockFileManager(true); + assertTrue(MenuReplaceUtilities.shouldCellIncludePrimaryImageFromCell(menuCell, fileManager, windowCapability)); + + // Case 2 - Image are not supported + menuCell = new MenuCell(TestValues.GENERAL_STRING, TestValues.GENERAL_ARTWORK, voiceCommands, null); + windowCapability = createWindowCapability(false, false); + fileManager = createMockFileManager(true); + assertFalse(MenuReplaceUtilities.shouldCellIncludePrimaryImageFromCell(menuCell, fileManager, windowCapability)); + + // Case 3 - Artwork is null + menuCell = new MenuCell(TestValues.GENERAL_STRING, null, voiceCommands, null); + windowCapability = createWindowCapability(true, true); + fileManager = createMockFileManager(true); + assertFalse(MenuReplaceUtilities.shouldCellIncludePrimaryImageFromCell(menuCell, fileManager, windowCapability)); + + // Case 4 - Artwork has not been uploaded + menuCell = new MenuCell(TestValues.GENERAL_STRING, TestValues.GENERAL_ARTWORK, voiceCommands, null); + windowCapability = createWindowCapability(true, true); + fileManager = createMockFileManager(false); + assertFalse(MenuReplaceUtilities.shouldCellIncludePrimaryImageFromCell(menuCell, fileManager, windowCapability)); + + // Case 5 - Artwork is static icon + menuCell = new MenuCell(TestValues.GENERAL_STRING, TestValues.GENERAL_ARTWORK_STATIC, voiceCommands, null); + windowCapability = createWindowCapability(true, true); + fileManager = createMockFileManager(false); + assertTrue(MenuReplaceUtilities.shouldCellIncludePrimaryImageFromCell(menuCell, fileManager, windowCapability)); + } + + private WindowCapability createWindowCapability (boolean supportsCmdIcon, boolean supportsSubMenuIcon) { + WindowCapability windowCapability = new WindowCapability(); + windowCapability.setImageFields(new ArrayList<ImageField>()); + if (supportsCmdIcon) { + windowCapability.getImageFields().add(new ImageField(ImageFieldName.cmdIcon, null)); + } + if (supportsSubMenuIcon) { + windowCapability.getImageFields().add(new ImageField(ImageFieldName.subMenuIcon, null)); + } + return windowCapability; + } + + private FileManager createMockFileManager (boolean hasUploadedFile) { + FileManager fileManager = mock(FileManager.class); + when(fileManager.hasUploadedFile(any(SdlArtwork.class))).thenReturn(hasUploadedFile); + return fileManager; + } + + private MenuCell cloneMenuCellAndRemoveSubCells(MenuCell menuCell) { + MenuCell clonedCell = menuCell.clone(); + if (clonedCell.getSubCells() != null) { + clonedCell.getSubCells().clear(); + } + return clonedCell; + } + + private List<MenuCell> createMenuCellList() { + /* + + c1 c2 c3 c4 + / \ / \ + / \ / \ + c2-1 c2-2 c4-1 c4-2 + / \ + / \ + c2-2-1 c2-2-2 + + */ + + SdlArtwork sdlArtwork = null; + List<String> voiceCommands = null; + MenuSelectionListener listener = null; + MenuLayout subMenuLayout = null; + + MenuCell menuCell1 = new MenuCell("c1", sdlArtwork, voiceCommands, listener); + + MenuCell menuCell2_1 = new MenuCell("c2_1", sdlArtwork, voiceCommands, listener); + MenuCell menuCell2_2_1 = new MenuCell("c2_2_1", sdlArtwork, voiceCommands, listener); + MenuCell menuCell2_2_2 = new MenuCell("c2_2_2", sdlArtwork, voiceCommands, listener); + MenuCell menuCell2_2 = new MenuCell("c2_2", subMenuLayout, sdlArtwork, new ArrayList<>(Arrays.asList(menuCell2_2_1, menuCell2_2_2))); + MenuCell menuCell2 = new MenuCell("c2", subMenuLayout, sdlArtwork, new ArrayList<>(Arrays.asList(menuCell2_1, menuCell2_2))); + + MenuCell menuCell3 = new MenuCell("c3", sdlArtwork, voiceCommands, listener); + + MenuCell menuCell4_1 = new MenuCell("c4_1", sdlArtwork, voiceCommands, listener); + MenuCell menuCell4_2 = new MenuCell("c4_2", sdlArtwork, voiceCommands, listener); + MenuCell menuCell4 = new MenuCell("c4", subMenuLayout, sdlArtwork, new ArrayList<>(Arrays.asList(menuCell4_1, menuCell4_2))); + + List<MenuCell> menuCellList = new ArrayList<>(Arrays.asList(menuCell1, menuCell2, menuCell3, menuCell4)); + addIdsToMenuCells(menuCellList, parentIdNotFound); + + return menuCellList ; + } + + private List<MenuCell> createNewMenuList() { + /* + + c5 + / \ + / \ + c5-1 c5-2 + / / + / / + c5-1-1 c5-2-1 + + */ + + SdlArtwork sdlArtwork = null; + List<String> voiceCommands = null; + MenuSelectionListener listener = null; + MenuLayout subMenuLayout = null; + + MenuCell menuCell5_1_1 = new MenuCell("c5_1_1", sdlArtwork, voiceCommands, listener); + MenuCell menuCell5_1 = new MenuCell("c5_1", subMenuLayout, sdlArtwork, new ArrayList<>(Arrays.asList(menuCell5_1_1))); + MenuCell menuCell5_2_1 = new MenuCell("c5_2_1", sdlArtwork, voiceCommands, listener); + MenuCell menuCell5_2 = new MenuCell("c5_2", subMenuLayout, sdlArtwork, new ArrayList<>(Arrays.asList(menuCell5_2_1))); + MenuCell menuCell5 = new MenuCell("c5", subMenuLayout, sdlArtwork, new ArrayList<>(Arrays.asList(menuCell5_1, menuCell5_2))); + + List<MenuCell> newMenuList = new ArrayList<>(Arrays.asList(menuCell5)); + addIdsToMenuCells(newMenuList, parentIdNotFound); + + return newMenuList ; + } +} |