DMDirc-Client/src/test/java/com/dmdirc/commandparser/aliases/AliasCommandHandlerTest.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.commandparser.aliases;

import com.dmdirc.commandparser.CommandArguments;
import com.dmdirc.commandparser.CommandInfo;
import com.dmdirc.commandparser.CommandType;
import com.dmdirc.commandparser.commands.context.CommandContext;
import com.dmdirc.commandparser.parsers.CommandParser;
import com.dmdirc.events.CommandErrorEvent;
import com.dmdirc.interfaces.CommandController;
import com.dmdirc.interfaces.EventBus;
import com.dmdirc.interfaces.InputModel;
import com.dmdirc.interfaces.WindowModel;

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.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

@RunWith(MockitoJUnitRunner.class)
public class AliasCommandHandlerTest {

    @Mock private WindowModel container;
    @Mock private InputModel inputModel;
    @Mock private CommandController commandController;
    @Mock private CommandParser commandParser;
    @Mock private CommandContext context;
    @Mock private CommandInfo commandInfo;
    @Mock private EventBus eventbus;
    @Captor private ArgumentCaptor<CommandErrorEvent> errorEventCaptor;

    @Before
    public void setup() {
        when(container.getInputModel()).thenReturn(Optional.of(inputModel));
        when(inputModel.getCommandParser()).thenReturn(commandParser);
        when(commandController.getCommandChar()).thenReturn('#');
        when(commandController.getSilenceChar()).thenReturn('/');
        when(context.getSource()).thenReturn(container);
        when(context.getCommandInfo()).thenReturn(commandInfo);
        when(container.getEventBus()).thenReturn(eventbus);
    }

    @Test
    public void testBasicAlias() {
        final Alias alias = new Alias(CommandType.TYPE_CHAT, "test", 0, "test2");
        final AliasCommandHandler handler = new AliasCommandHandler(commandController, alias);
        final CommandArguments arguments = new CommandArguments(commandController, "#test");
        handler.execute(container, arguments, context);
        verify(commandParser).parseCommand(container, "#test2");
    }

    @Test
    public void testSubstitutions() {
        final Alias alias = new Alias(CommandType.TYPE_CHAT, "test", 0, "test2 $1- $2 $1 $2- $2");
        final AliasCommandHandler handler = new AliasCommandHandler(commandController, alias);
        final CommandArguments arguments
                = new CommandArguments(commandController, "#test agadoo do");
        handler.execute(container, arguments, context);
        verify(commandParser).parseCommand(container, "#test2 agadoo do do agadoo do do");
    }

    @Test
    public void testInsufficientArgsSingular() {
        final Alias alias = new Alias(CommandType.TYPE_CHAT, "test", 1, "blah");
        final AliasCommandHandler handler = new AliasCommandHandler(commandController, alias);
        final CommandArguments arguments = new CommandArguments(commandController, "#test");
        handler.execute(container, arguments, context);
        verify(eventbus).publishAsync(errorEventCaptor.capture());
        assertEquals("test requires at least 1 argument.",
                errorEventCaptor.getValue().getMessage());
    }

    @Test
    public void testInsufficientArgsPlural() {
        final Alias alias = new Alias(CommandType.TYPE_CHAT, "test", 2, "blah");
        final AliasCommandHandler handler = new AliasCommandHandler(commandController, alias);
        final CommandArguments arguments = new CommandArguments(commandController, "#test agadoo");
        handler.execute(container, arguments, context);
        verify(eventbus).publishAsync(errorEventCaptor.capture());
        assertEquals("test requires at least 2 arguments.",
                errorEventCaptor.getValue().getMessage());
    }

    @Test
    public void testCarriesForwardSilence() {
        final Alias alias = new Alias(CommandType.TYPE_CHAT, "test", 0, "blah");
        final AliasCommandHandler handler = new AliasCommandHandler(commandController, alias);
        final CommandArguments arguments = new CommandArguments(commandController, "#/test agadoo");
        handler.execute(container, arguments, context);
        verify(commandParser).parseCommand(container, "#/blah");
    }

}