summaryrefslogtreecommitdiff
path: root/tags/2.3/src/test/java/org/mockftpserver/core/command/_AbstractTrackingCommandHandlerTest.java
blob: 008988dc05427b78a435dea36e12bf83139267cc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
/*
 * Copyright 2007 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.mockftpserver.core.command;

import org.apache.log4j.Logger;
import org.easymock.MockControl;
import org.mockftpserver.core.session.Session;
import org.mockftpserver.core.util.AssertFailedException;
import org.mockftpserver.test.AbstractTestCase;

import java.util.ListResourceBundle;
import java.util.ResourceBundle;

/**
 * Tests for the AbstractTrackingCommandHandler class. The class name is prefixed with an
 * underscore so that it is not filtered out by Maven's Surefire test plugin.
 *
 * @author Chris Mair
 * @version $Revision$ - $Date$
 */
public final class _AbstractTrackingCommandHandlerTest extends AbstractTestCase {

    private static final Logger LOG = Logger.getLogger(_AbstractTrackingCommandHandlerTest.class);
    private static final String COMMAND_NAME = "abc";
    private static final Object ARG = "123";
    private static final Object[] ARGS = {ARG};
    private static final Command COMMAND = new Command(COMMAND_NAME, EMPTY);
    private static final Command COMMAND_WITH_ARGS = new Command(COMMAND_NAME, EMPTY);
    private static final int REPLY_CODE1 = 777;
    private static final int REPLY_CODE2 = 888;
    private static final int REPLY_CODE3 = 999;
    private static final String REPLY_TEXT1 = "reply1 ... abcdef";
    private static final String REPLY_TEXT2 = "abc {0} def";
    private static final String REPLY_TEXT2_FORMATTED = "abc 123 def";
    private static final String OVERRIDE_REPLY_TEXT = "overridden reply ... abcdef";
    private static final String MESSAGE_KEY = "key.123";
    private static final String MESSAGE_TEXT = "message.123";

    private AbstractTrackingCommandHandler commandHandler;
    private Session session;

    /**
     * Test the handleCommand(Command,Session) method
     */
    public void testHandleCommand() throws Exception {
        assertEquals("before", 0, commandHandler.numberOfInvocations());
        commandHandler.handleCommand(COMMAND, session);
        assertEquals("after", 1, commandHandler.numberOfInvocations());
        assertTrue("locked", commandHandler.getInvocation(0).isLocked());
    }

    /**
     * Test the handleCommand(Command,Session) method, passing in a null Command
     */
    public void testHandleCommand_NullCommand() throws Exception {
        try {
            commandHandler.handleCommand(null, session);
            fail("Expected AssertFailedException");
        }
        catch (AssertFailedException expected) {
            LOG.info("Expected: " + expected);
        }
    }

    /**
     * Test the handleCommand(Command,Session) method, passing in a null Session
     */
    public void testHandleCommand_NullSession() throws Exception {
        try {
            commandHandler.handleCommand(COMMAND, null);
            fail("Expected AssertFailedException");
        }
        catch (AssertFailedException expected) {
            LOG.info("Expected: " + expected);
        }
    }

    /**
     * Test the numberOfInvocations(), addInvocationRecord() and clearInvocationRecord() methods
     */
    public void testInvocationHistory() throws Exception {
        control(session).expectAndDefaultReturn(session.getClientHost(), DEFAULT_HOST);
        replay(session);

        assertEquals("none", 0, commandHandler.numberOfInvocations());
        commandHandler.handleCommand(COMMAND, session);
        assertEquals("1", 1, commandHandler.numberOfInvocations());
        commandHandler.handleCommand(COMMAND, session);
        assertEquals("2", 2, commandHandler.numberOfInvocations());
        commandHandler.clearInvocations();
        assertEquals("cleared", 0, commandHandler.numberOfInvocations());
    }

    /**
     * Test the getInvocation() method
     *
     * @throws Exception
     */
    public void testGetInvocation() throws Exception {
        control(session).expectAndDefaultReturn(session.getClientHost(), DEFAULT_HOST);
        replay(session);

        commandHandler.handleCommand(COMMAND, session);
        commandHandler.handleCommand(COMMAND_WITH_ARGS, session);
        assertSame("1", COMMAND, commandHandler.getInvocation(0).getCommand());
        assertSame("2", COMMAND_WITH_ARGS, commandHandler.getInvocation(1).getCommand());
    }

    /**
     * Test the getInvocation() method, passing in an invalid index
     */
    public void testGetInvocation_IndexOutOfBounds() throws Exception {
        commandHandler.handleCommand(COMMAND, session);
        try {
            commandHandler.getInvocation(2);
            fail("Expected IndexOutOfBoundsException");
        }
        catch (IndexOutOfBoundsException expected) {
            LOG.info("Expected: " + expected);
        }
    }

    /**
     * Test the sendReply() method, when no message arguments are specified
     */
    public void testSendReply() {
        session.sendReply(REPLY_CODE1, REPLY_TEXT1);
        session.sendReply(REPLY_CODE1, MESSAGE_TEXT);
        session.sendReply(REPLY_CODE1, OVERRIDE_REPLY_TEXT);
        session.sendReply(REPLY_CODE3, null);
        replay(session);

        commandHandler.sendReply(session, REPLY_CODE1, null, null, null);
        commandHandler.sendReply(session, REPLY_CODE1, MESSAGE_KEY, null, null);
        commandHandler.sendReply(session, REPLY_CODE1, MESSAGE_KEY, OVERRIDE_REPLY_TEXT, null);
        commandHandler.sendReply(session, REPLY_CODE3, null, null, null);

        verify(session);
    }

    /**
     * Test the sendReply() method, passing in message arguments
     */
    public void testSendReply_WithMessageArguments() {
        session.sendReply(REPLY_CODE1, REPLY_TEXT2_FORMATTED);
        replay(session);

        commandHandler.sendReply(session, REPLY_CODE1, null, REPLY_TEXT2, ARGS);

        verify(session);
    }

    /**
     * Test the sendReply() method, passing in a null Session
     */
    public void testSendReply_NullSession() {
        try {
            commandHandler.sendReply(null, REPLY_CODE1, REPLY_TEXT1, null, null);
            fail("Expected AssertFailedException");
        }
        catch (AssertFailedException expected) {
            LOG.info("Expected: " + expected);
        }
    }

    /**
     * Test the sendReply() method, passing in an invalid replyCode
     */
    public void testSendReply_InvalidReplyCode() {
        try {
            commandHandler.sendReply(session, 0, REPLY_TEXT1, null, null);
            fail("Expected AssertFailedException");
        }
        catch (AssertFailedException expected) {
            LOG.info("Expected: " + expected);
        }
    }

    //-------------------------------------------------------------------------
    // Test setup
    //-------------------------------------------------------------------------

    /**
     * Perform initialization before each test
     *
     * @see org.mockftpserver.test.AbstractTestCase#setUp()
     */
    protected void setUp() throws Exception {
        super.setUp();
        session = (Session) createMock(Session.class);
        control(session).setDefaultMatcher(MockControl.ARRAY_MATCHER);
        commandHandler = new AbstractTrackingCommandHandler() {
            public void handleCommand(Command command, Session session, InvocationRecord invocationRecord) throws Exception {
            }
        };
        ResourceBundle replyTextBundle = new ListResourceBundle() {
            protected Object[][] getContents() {
                return new Object[][]{
                        {Integer.toString(REPLY_CODE1), REPLY_TEXT1},
                        {Integer.toString(REPLY_CODE2), REPLY_TEXT2},
                        {MESSAGE_KEY, MESSAGE_TEXT}
                };
            }
        };
        commandHandler.setReplyTextBundle(replyTextBundle);
    }

}