added unit tests for command processor

Author: webpigeon

src/test/java/uk/co/unitycoders/pircbotx/commandprocessor/CommandProcessorTest.java

@@ -0,0 +1,105 @@
+/**
+ * Copyright © 2012 Bruce Cowan <[email protected]>
+ *
+ * This file is part of uc_PircBotX.
+ *
+ * uc_PircBotX is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * uc_PircBotX is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with uc_PircBotX.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package uk.co.unitycoders.pircbotx.commandprocessor;
+
+import java.util.Arrays;
+
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+/**
+ * @author webpigeon
+ * 
+ */
+public class CommandProcessorTest
+{
+	private CommandProcessor processor;
+
+	/**
+	 * @throws java.lang.Exception
+	 */
+	@Before
+	public void setUp() throws Exception
+	{
+		processor = new CommandProcessor('!');
+
+	}
+
+	/**
+	 * Check that if the module list is empty, the getModules method returns an
+	 * empty array.
+	 */
+	@Test
+	public void testEmptyModules()
+	{
+		String[] expected = new String[0];
+		String[] result = processor.getModules();
+		Assert.assertArrayEquals(expected, result);
+	}
+
+	/**
+	 * Check that if an invalid module is passed to the getCommands list, that
+	 * an empty array is returned.
+	 */
+	@Test
+	public void testInvalidModuleCommands()
+	{
+		String fakeModuleName = "fakemodule";
+		String[] expected = new String[0];
+		String[] result = processor.getCommands(fakeModuleName);
+		Assert.assertArrayEquals(expected, result);
+	}
+
+	/**
+	 * Check that if a module is registered then all module commands show up
+	 */
+	@Test
+	public void testModuleExists()
+	{
+		String name = "fake";
+		Object module = new FakeModule();
+		processor.register(name, module);
+
+		String[] expected = { "fake" };
+		String[] result = processor.getModules();
+		Assert.assertArrayEquals(expected, result);
+	}
+
+	/**
+	 * Check that if a module is registered then all module commands show up
+	 */
+	@Test
+	public void testCommandsExists()
+	{
+		String name = "fake";
+		Object module = new FakeModule();
+		processor.register(name, module);
+
+		String[] expected = { "default", "goodbye", "bye", "hello" };
+		String[] result = processor.getCommands(name);
+
+		// sort arrays to prevent ordering error
+		Arrays.sort(result);
+		Arrays.sort(expected);
+
+		Assert.assertArrayEquals(expected, result);
+	}
+
+}

src/test/java/uk/co/unitycoders/pircbotx/commandprocessor/FakeModule.java

@@ -0,0 +1,62 @@
+/**
+ * Copyright © 2012 Bruce Cowan <[email protected]>
+ *
+ * This file is part of uc_PircBotX.
+ *
+ * uc_PircBotX is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * uc_PircBotX is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with uc_PircBotX.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package uk.co.unitycoders.pircbotx.commandprocessor;
+
+import org.pircbotx.PircBotX;
+import org.pircbotx.hooks.events.MessageEvent;
+
+/**
+ * Fake module used for unit testing.
+ * 
+ * @author webpigeon
+ * 
+ */
+public class FakeModule
+{
+
+	/**
+	 * Default command
+	 * 
+	 * @param ex
+	 */
+	@Command
+	public void doStuff(MessageEvent<PircBotX> ex)
+	{
+	}
+
+	/**
+	 * Single command
+	 * 
+	 * @param ex
+	 */
+	@Command("hello")
+	public void doStuffOnce(MessageEvent<PircBotX> ex)
+	{
+	}
+
+	/**
+	 * Double command
+	 * 
+	 * @param ex
+	 */
+	@Command({ "goodbye", "bye" })
+	public void doStuffTwice(MessageEvent<PircBotX> ex)
+	{
+	}
+}

src/test/java/uk/co/unitycoders/pircbotx/commandprocessor/TriggerModule.java

@@ -0,0 +1,38 @@
+/**
+ * Copyright © 2012 Bruce Cowan <[email protected]>
+ *
+ * This file is part of uc_PircBotX.
+ *
+ * uc_PircBotX is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * uc_PircBotX is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with uc_PircBotX.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package uk.co.unitycoders.pircbotx.commandprocessor;
+
+import org.pircbotx.PircBotX;
+import org.pircbotx.hooks.events.MessageEvent;
+
+/**
+ * @author webpigeon
+ * 
+ */
+public class TriggerModule
+{
+	int called = 0;
+
+	@Command
+	public void onMessage(MessageEvent<PircBotX> pircbox)
+	{
+		called++;
+	}
+
+}