DMDirc-Client/src/test/java/com/dmdirc/ui/WindowManagerTest.java

/*
 * Copyright (c) 2006-2015 DMDirc Developers
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.dmdirc.ui;

import com.dmdirc.CustomWindow;
import com.dmdirc.interfaces.EventBus;
import com.dmdirc.interfaces.WindowModel;
import com.dmdirc.interfaces.ui.FrameListener;

import java.util.Arrays;
import java.util.Collection;
import java.util.Optional;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
import org.mockito.Mock;
import org.mockito.runners.MockitoJUnitRunner;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyBoolean;
import static org.mockito.ArgumentMatchers.anyObject;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.ArgumentMatchers.same;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

@RunWith(MockitoJUnitRunner.class)
public class WindowManagerTest {

    @Mock private FrameListener frameListener;
    @Mock private WindowModel container;
    @Mock private WindowModel child;
    @Mock private WindowModel grandchild;
    @Mock private EventBus eventBus;
    @Captor private ArgumentCaptor<String> idCaptor;
    private WindowManager manager;

    @Before
    public void setup() {
        manager = new WindowManager(eventBus);
    }

    @Test
    public void testAddRoot() {
        manager.addListener(frameListener);

        verify(frameListener, never()).addWindow(anyObject(), anyBoolean());
        verify(frameListener, never()).addWindow(anyObject(), anyObject(), anyBoolean());

        manager.addWindow(container);

        verify(frameListener).addWindow(same(container), eq(true));
        verify(frameListener, never()).addWindow(anyObject(), anyObject(), anyBoolean());
    }

    @Test
    public void testAddChild() {
        manager.addWindow(container);
        manager.addListener(frameListener);
        manager.addWindow(container, child);

        verify(frameListener, never()).addWindow(anyObject(), anyBoolean());
        verify(frameListener).addWindow(same(container), same(child), eq(true));
    }

    @Test
    public void testGetParent() {
        manager.addWindow(container);
        manager.addListener(frameListener);
        manager.addWindow(container, child);

        assertEquals(Optional.of(container), manager.getParent(child));
        assertEquals(Optional.empty(), manager.getParent(container));
    }

    @Test
    public void testGetChildren() {
        manager.addWindow(container);
        manager.addListener(frameListener);
        manager.addWindow(container, child);
        manager.addWindow(container, grandchild);

        assertEquals(2, manager.getChildren(container).size());
        assertTrue(manager.getChildren(container).contains(child));
        assertTrue(manager.getChildren(container).contains(grandchild));
        assertEquals(0, manager.getChildren(child).size());
        assertEquals(0, manager.getChildren(grandchild).size());
    }

    @Test
    public void testRemoveRoot() {
        manager.addWindow(container);
        manager.addListener(frameListener);

        manager.removeWindow(container);

        verify(frameListener).delWindow(same(container));
    }

    @Test
    public void testRemoveChild() {
        manager.addWindow(container);
        manager.addWindow(container, child);
        manager.addListener(frameListener);

        manager.removeWindow(child);

        verify(frameListener, never()).addWindow(any(), anyBoolean());
        verify(frameListener, never()).addWindow(any(), any(), anyBoolean());
        verify(frameListener, never()).delWindow(any());
        verify(frameListener).delWindow(same(container), same(child));
    }

    @Test
    public void testRemoveFrameManager() {
        manager.addWindow(container);
        manager.addListener(frameListener);
        manager.removeListener(frameListener);
        manager.addWindow(container, child);

        verify(frameListener, never()).addWindow(any(), anyBoolean());
        verify(frameListener, never()).addWindow(any(), any(), anyBoolean());
        verify(frameListener, never()).delWindow(any());
        verify(frameListener, never()).delWindow(any(), any());
    }

    @Test
    public void testAddListener() {
        manager.addListener(frameListener);
        manager.addWindow(container);
        verify(frameListener).addWindow(container, true);
    }

    @Test
    public void testAddListenerAndSync() {
        manager.addWindow(container);
        manager.addWindow(container, child);
        manager.addWindow(child, grandchild);
        manager.addListenerAndSync(frameListener);

        verify(frameListener).addWindow(container, true);
        verify(frameListener).addWindow(container, child, true);
        verify(frameListener).addWindow(child, grandchild, true);
    }

    @Test
    public void testRemoveWindowRootWindowNoChildren() {
        manager.addListener(frameListener);
        manager.addWindow(container);
        manager.removeWindow(container);

        verify(frameListener).delWindow(container);
    }

    @Test
    public void testRemoveWindowRootWindowWithChildren() {
        manager.addListener(frameListener);
        manager.addWindow(container);
        manager.addWindow(container, child);
        manager.removeWindow(container);

        verify(frameListener).delWindow(container);
        verify(child).close();
    }

    @Test
    public void testRemoveChildWindowNoChildren() {
        manager.addListener(frameListener);
        manager.addWindow(container);
        manager.addWindow(container, child);
        manager.removeWindow(child);

        verify(frameListener).delWindow(container, child);
    }

    @Test
    public void testRemoveChildWindowWithChildren() {
        manager.addListener(frameListener);
        manager.addWindow(container);
        manager.addWindow(container, child);
        manager.addWindow(child, grandchild);
        manager.removeWindow(child);

        verify(frameListener).delWindow(container, child);
        verify(grandchild).close();
    }

    @Test
    public void testGetRootWindows() {
        final WindowModel root1 = mock(WindowModel.class);
        final WindowModel root2 = mock(WindowModel.class);
        final Collection<WindowModel> rootWindows = Arrays.asList(root1, root2);

        manager.addWindow(root1);
        manager.addWindow(root2);

        assertTrue(manager.getRootWindows().containsAll(rootWindows));
    }

    @Test
    public void testFindCustomWindow() {
        final CustomWindow custom = mock(CustomWindow.class);

        when(custom.getName()).thenReturn("test");

        manager.addWindow(custom);

        assertEquals(custom, manager.findCustomWindow("test"));
    }

    @Test
    public void testFindCustomWindowNotFound() {
        final CustomWindow custom = mock(CustomWindow.class);

        when(custom.getName()).thenReturn("test");

        manager.addWindow(custom);

        assertNull(manager.findCustomWindow("test1"));
    }

    @Test
    public void testFindCustomWindowWithParent() {
        final CustomWindow customContainer = mock(CustomWindow.class);
        final CustomWindow customChild = mock(CustomWindow.class);

        when(customChild.getName()).thenReturn("test1");

        manager.addWindow(customContainer);
        manager.addWindow(customContainer, customChild);

        assertEquals(customChild, manager.findCustomWindow(customContainer, "test1"));
    }

    @Test
    public void testFindCustomWindowWithParentNotFound() {
        final CustomWindow customContainer = mock(CustomWindow.class);
        final CustomWindow customChild = mock(CustomWindow.class);

        when(customChild.getName()).thenReturn("test1");

        manager.addWindow(customContainer);
        manager.addWindow(customContainer, customChild);

        assertNull(manager.findCustomWindow(customContainer, "test"));
    }

    @Test
    public void testAssignId() {
        manager.addWindow(container);
        manager.addWindow(container, child);

        verify(container).setId(idCaptor.capture());
        final String parentId = idCaptor.getValue();

        verify(child).setId(idCaptor.capture());
        final String childId = idCaptor.getValue();

        assertNotEquals(parentId, childId);
    }

    @Test
    public void testGetById() {
        manager.addWindow(container);
        manager.addWindow(container, child);

        verify(container).setId(idCaptor.capture());
        final String parentId = idCaptor.getValue();

        verify(child).setId(idCaptor.capture());
        final String childId = idCaptor.getValue();

        assertSame(container, manager.getWindowById(parentId).get());
        assertSame(child, manager.getWindowById(childId).get());
        assertEquals(Optional.empty(), manager.getWindowById("invalid"));
    }

}