DMDirc-Client/src/test/java/com/dmdirc/ui/core/aliases/CoreAliasDialogModelTest.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.core.aliases;

import com.dmdirc.commandparser.CommandType;
import com.dmdirc.commandparser.aliases.Alias;
import com.dmdirc.commandparser.aliases.AliasFactory;
import com.dmdirc.commandparser.aliases.AliasManager;
import com.dmdirc.interfaces.CommandController;
import com.dmdirc.interfaces.ui.AliasDialogModelListener;

import java.util.HashSet;
import java.util.Optional;
import java.util.Set;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.runners.MockitoJUnitRunner;
import org.mockito.stubbing.Answer;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.anyInt;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

@RunWith(MockitoJUnitRunner.class)
public class CoreAliasDialogModelTest {

    @Mock private AliasManager aliasModel;
    @Mock private AliasFactory aliasFactory;
    @Mock private AliasDialogModelListener listener;
    @Mock private CommandController commandController;
    private final Alias alias1 = new Alias(CommandType.TYPE_GLOBAL, "alias1", 0, "");
    private final Alias alias1Edited = new Alias(CommandType.TYPE_GLOBAL, "alias2", 0, "");
    private final Alias alias2Edited = new Alias(CommandType.TYPE_GLOBAL, "alias1", 1, "");
    private final Alias alias2 = new Alias(CommandType.TYPE_GLOBAL, "alias2", 0, "");
    private Set<Alias> aliases;

    @Before
    public void setupAliases() {
        aliases = new HashSet<>();
    }

    @Before
    public void setUpFactory() {
        when(aliasFactory.createAlias(anyString(), anyInt(), anyString())).thenAnswer(
                new Answer<Alias>() {
                    @Override
                    public Alias answer(final InvocationOnMock invocation) throws Throwable {
                        return new Alias(
                                CommandType.TYPE_GLOBAL,
                                (String) invocation.getArguments()[0],
                                (Integer) invocation.getArguments()[1],
                                (String) invocation.getArguments()[2]
                        );
                    }
                });
    }

    @Test
    public void testgetAliases() {
        aliases.add(alias1);
        aliases.add(alias2);
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        assertEquals(2, model.getAliases().size());
    }

    @Test
    public void testGetAliasExists() {
        aliases.add(alias1);
        aliases.add(alias2);
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        assertEquals(model.getAlias(alias1.getName()).get(), alias1);
    }

    @Test
    public void testGetAliasNotExists() {
        aliases.add(alias1);
        aliases.add(alias2);
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        assertFalse(model.getAlias("test").isPresent());
    }

    @Test
    public void testAddAlias() {
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        assertEquals(0, model.getAliases().size());
        model.addAlias(alias1.getName(), alias1.getMinArguments(), alias1.getSubstitution());
        assertEquals(1, model.getAliases().size());
    }

    @Test
    public void testAddAliasListener() {
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        model.addListener(listener);
        model.addAlias(alias1.getName(), alias1.getMinArguments(), alias1.getSubstitution());
        verify(listener).aliasAdded(alias1);
    }

    @Test
    public void testEditAlias() {
        aliases.add(alias1);
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        assertEquals(1, model.getAliases().size());
        assertEquals(0, model.getAlias(alias2Edited.getName()).get().getMinArguments());
        model.editAlias(alias1.getName(), alias2Edited.getMinArguments(), alias2Edited.
                getSubstitution());
        assertEquals(1, model.getAlias(alias1.getName()).get().getMinArguments());
    }

    @Test
    public void testEditAliasListener() {
        aliases.add(alias1);
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        model.addListener(listener);
        model.editAlias(alias1.getName(), alias2Edited.getMinArguments(), alias2Edited.
                getSubstitution());
        verify(listener).aliasEdited(alias1, alias2Edited);
    }

    @Test
    public void testRenameAlias() {
        aliases.add(alias1);
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        assertEquals(1, model.getAliases().size());
        assertEquals(model.getAlias(alias1.getName()).get(), alias1);
        model.renameAlias(alias1.getName(), alias1Edited.getName());
        assertEquals(model.getAlias(alias1Edited.getName()).get(), alias2);
    }

    @Test
    public void testRenameAliasListener() {
        aliases.add(alias1);
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        model.addListener(listener);
        assertEquals(1, model.getAliases().size());
        assertEquals(model.getAlias(alias1.getName()).get(), alias1);
        model.renameAlias(alias1.getName(), alias1Edited.getName());
        verify(listener).aliasRenamed(alias1, alias1Edited);
    }

    @Test
    public void testRemoveAlias() {
        aliases.add(alias1);
        aliases.add(alias2);
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        assertEquals(2, model.getAliases().size());
        model.removeAlias(alias1.getName());
        assertEquals(1, model.getAliases().size());
        assertFalse(model.getAlias(alias1.getName()).isPresent());
    }

    @Test
    public void testRemoveAliasListener() {
        aliases.add(alias1);
        aliases.add(alias2);
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        model.addListener(listener);
        model.removeAlias(alias1.getName());
        verify(listener).aliasRemoved(alias1);
    }

    @Test
    public void testSelectedAliasInitiallyNotNull() {
        aliases.add(alias1);
        aliases.add(alias2);
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        assertEquals(2, model.getAliases().size());
        assertTrue(model.getSelectedAlias().isPresent());
    }

    @Test
    public void testSelectedAliasNotNull() {
        aliases.add(alias1);
        aliases.add(alias2);
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        assertEquals(2, model.getAliases().size());
        assertTrue(model.getSelectedAlias().isPresent());
        model.setSelectedAlias(Optional.ofNullable(alias2));
        assertEquals(model.getSelectedAlias().get(), alias2);
    }

    @Test
    public void testSelectedAliasToNull() {
        aliases.add(alias1);
        aliases.add(alias2);
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        assertEquals(2, model.getAliases().size());
        assertTrue(model.getSelectedAlias().isPresent());
        model.setSelectedAlias(Optional.ofNullable(alias2));
        assertEquals(model.getSelectedAlias().get(), alias2);
        model.setSelectedAlias(Optional.<Alias>empty());
        assertFalse(model.getSelectedAlias().isPresent());
    }

    @Test
    public void testRemoveListener() {
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        model.addListener(listener);
        model.addAlias(alias1.getName(), alias1.getMinArguments(), alias1.getSubstitution());
        model.removeListener(listener);
        model.addAlias(alias2.getName(), alias2.getMinArguments(), alias2.getSubstitution());
        verify(listener).aliasAdded(alias1);
        verify(listener, never()).aliasAdded(alias2);
    }

    @Test
    public void testRenameSelectedAlias() {
        aliases.add(alias1);
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        assertEquals(1, model.getAliases().size());
        assertEquals(model.getAlias(alias1.getName()).get(), alias1);
        model.setSelectedAlias(Optional.ofNullable(alias1));
        model.setSelectedAliasName(alias1Edited.getName());
        model.setSelectedAliasMinimumArguments(alias1Edited.getMinArguments());
        model.setSelectedAliasSubstitution(alias1Edited.getSubstitution());
        model.setSelectedAlias(Optional.<Alias>empty());
        assertEquals(model.getAlias(alias1Edited.getName()).get(), alias2);
    }

    @Test
    public void testEditSelectedAlias() {
        aliases.add(alias1);
        when(aliasModel.getAliases()).thenReturn(aliases);
        final CoreAliasDialogModel model = new CoreAliasDialogModel(aliasModel, aliasFactory,
                commandController);
        model.loadModel();
        assertEquals(1, model.getAliases().size());
        assertEquals(model.getAlias(alias1.getName()).get(), alias1);
        model.setSelectedAlias(Optional.ofNullable(alias1));
        model.setSelectedAliasMinimumArguments(alias2Edited.getMinArguments());
        model.setSelectedAliasSubstitution(alias2Edited.getSubstitution());
        model.setSelectedAlias(Optional.<Alias>empty());
        final Alias alias = model.getAlias(alias1.getName()).get();
        assertEquals(alias.getName(), alias2Edited.getName());
        assertEquals(alias.getMinArguments(), alias2Edited.getMinArguments());
        assertEquals(alias.getSubstitution(), alias2Edited.getSubstitution());
    }

}