|
From: <man...@us...> - 2010-12-26 22:47:59
|
Revision: 6062
http://squirrel-sql.svn.sourceforge.net/squirrel-sql/?rev=6062&view=rev
Author: manningr
Date: 2010-12-26 22:47:52 +0000 (Sun, 26 Dec 2010)
Log Message:
-----------
New tests for the example plugin in the archetype. Synchronizing with the actual Example plugin project. Once an integration test has been setup for this archetype, it will no longer be necessary to have the Example plugin project.
Modified Paths:
--------------
trunk/sql12/plugins/squirrelsql-plugin-archetype/src/main/resources/archetype-resources/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExamplePlugin.java
trunk/sql12/plugins/squirrelsql-plugin-archetype/src/main/resources/archetype-resources/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExampleSqlExecutionListener.java
trunk/sql12/plugins/squirrelsql-plugin-archetype/src/main/resources/archetype-resources/src/test/java/net/sourceforge/squirrel_sql/plugins/example/ExamplePluginTest.java
Added Paths:
-----------
trunk/sql12/plugins/squirrelsql-plugin-archetype/src/main/resources/archetype-resources/src/test/java/net/sourceforge/squirrel_sql/plugins/example/ExampleSqlExecutionListenerTest.java
Modified: trunk/sql12/plugins/squirrelsql-plugin-archetype/src/main/resources/archetype-resources/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExamplePlugin.java
===================================================================
--- trunk/sql12/plugins/squirrelsql-plugin-archetype/src/main/resources/archetype-resources/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExamplePlugin.java 2010-12-26 22:17:53 UTC (rev 6061)
+++ trunk/sql12/plugins/squirrelsql-plugin-archetype/src/main/resources/archetype-resources/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExamplePlugin.java 2010-12-26 22:47:52 UTC (rev 6062)
@@ -13,16 +13,19 @@
import net.sourceforge.squirrel_sql.fw.util.IMessageHandler;
/**
- * The Example plugin class. This plugin does the following: 1. If the database types is DB2, it registers a
- * menu action in the popup menu for view and procedure nodes in the ObjectTree. For detailed information and
- * usage of the Plugin API see the following:
+ * <pre>
+ * The Example plugin class. If the database session's type is DB2, this plugin registers a menu action in
+ * the popup menu for view and procedure nodes in the ObjectTree.
+ *
+ * For detailed information and usage of the Plugin API see the following:
+ *
* https://sourceforge.net/apps/trac/squirrel-sql/wiki/SQuirreLSQLClientPluginAPI
+ * </pre>
*/
public class ExamplePlugin extends DefaultSessionPlugin
{
private PluginResources _resources;
-
/**
* Return the internal name of this plugin.
*
@@ -127,20 +130,20 @@
*
* @param session
* The session that is starting.
- * @return An implementation of PluginSessionCallback or null to indicate the plugin does not work with this
- * session
+ * @return An implementation of PluginSessionCallback or null to indicate the plugin does not work with
+ * this session
*/
public PluginSessionCallback sessionStarted(ISession session)
{
// Adds the view and procedure script actions if the session is DB2.
addTreeNodeMenuActionsForDB2(session);
-
+
// Register a custom ISQLExecutionListener implementation that simply prints all SQL being executed to
// the message panel.
IMessageHandler messageHandler = session.getApplication().getMessageHandler();
ExampleSqlExecutionListener sqlExecutionListener = new ExampleSqlExecutionListener(messageHandler);
session.getSessionSheet().getSQLPaneAPI().addSQLExecutionListener(sqlExecutionListener);
-
+
return new PluginSessionCallbackAdaptor(this);
}
@@ -155,10 +158,10 @@
// Add context menu items to the object tree's view and procedure nodes.
IObjectTreeAPI otApi = session.getSessionInternalFrame().getObjectTreeAPI();
- otApi.addToPopup(DatabaseObjectType.VIEW, new ScriptDB2ViewAction(getApplication(), _resources,
- session));
- otApi.addToPopup(DatabaseObjectType.PROCEDURE, new ScriptDB2ProcedureAction(getApplication(),
+ otApi.addToPopup(DatabaseObjectType.VIEW, new ScriptDB2ViewAction(session.getApplication(),
_resources, session));
+ otApi.addToPopup(DatabaseObjectType.PROCEDURE, new ScriptDB2ProcedureAction(
+ session.getApplication(), _resources, session));
}
}
catch (Exception e)
Modified: trunk/sql12/plugins/squirrelsql-plugin-archetype/src/main/resources/archetype-resources/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExampleSqlExecutionListener.java
===================================================================
--- trunk/sql12/plugins/squirrelsql-plugin-archetype/src/main/resources/archetype-resources/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExampleSqlExecutionListener.java 2010-12-26 22:17:53 UTC (rev 6061)
+++ trunk/sql12/plugins/squirrelsql-plugin-archetype/src/main/resources/archetype-resources/src/main/java/net/sourceforge/squirrel_sql/plugins/example/ExampleSqlExecutionListener.java 2010-12-26 22:47:52 UTC (rev 6062)
@@ -28,6 +28,7 @@
*/
public class ExampleSqlExecutionListener implements ISQLExecutionListener
{
+ /** This is what gives the ability to print a message to the message panel */
private final IMessageHandler _messageHandler;
public ExampleSqlExecutionListener(IMessageHandler messageHandler) {
@@ -45,7 +46,8 @@
{
_messageHandler.showMessage("statementExecuting: "+sql);
- // We don't modify the SQL in this example. We could veto it's execution be returned null.
+ // We don't modify the SQL in this example. in addition to modifying it, we could veto it's execution
+ // by returning null.
return sql;
}
Modified: trunk/sql12/plugins/squirrelsql-plugin-archetype/src/main/resources/archetype-resources/src/test/java/net/sourceforge/squirrel_sql/plugins/example/ExamplePluginTest.java
===================================================================
--- trunk/sql12/plugins/squirrelsql-plugin-archetype/src/main/resources/archetype-resources/src/test/java/net/sourceforge/squirrel_sql/plugins/example/ExamplePluginTest.java 2010-12-26 22:17:53 UTC (rev 6061)
+++ trunk/sql12/plugins/squirrelsql-plugin-archetype/src/main/resources/archetype-resources/src/test/java/net/sourceforge/squirrel_sql/plugins/example/ExamplePluginTest.java 2010-12-26 22:47:52 UTC (rev 6062)
@@ -1,10 +1,13 @@
package net.sourceforge.squirrel_sql.plugins.example;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.fail;
+import static org.mockito.Mockito.when;
import net.sourceforge.squirrel_sql.client.plugin.AbstractSessionPluginTest;
import org.junit.Before;
+import org.junit.Test;
-
/*
* Copyright (C) 2010 Rob Manning
* man...@us...
@@ -24,24 +27,73 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/**
+ * This test extends AbstractSessionPluginTest which provides testing for many of the methods in the
+ * ISessionPlugin interface that are implemented by such a plugin. Run this test through a code coverage tool
+ * such as Emma and you will find that many of the simpler methods in the interface are covered.
+ */
public class ExamplePluginTest extends AbstractSessionPluginTest
{
+ /**
+ * getDatabaseProductName returns "DB2" because that is the product name for sessions that the example
+ * plugin is interested in. This value will be returned by the SQLDatabaseMetaData for the method called
+ * getDatabaseProductName() that is associated with Session that is used when testing methods that on the
+ * ISessionPlugin interface that require a Session.
+ *
+ * @see net.sourceforge.squirrel_sql.client.plugin.AbstractSessionPluginTest#getDatabaseProductName()
+ */
@Override
protected String getDatabaseProductName()
{
- return "DB2";
+ return "DB2";
}
+ /**
+ * No version is given here, because it is not required to distinguish dialects, since there is only one
+ * DB2 dialect at the current time.
+ *
+ * @see net.sourceforge.squirrel_sql.client.plugin.AbstractSessionPluginTest#getDatabaseProductVersion()
+ */
@Override
protected String getDatabaseProductVersion()
{
return null;
}
-
+
@Before
public void setUp() throws Exception
{
+ super.setUp();
classUnderTest = new ExamplePlugin();
}
+
+ @Test
+ public void testSessionStarted() throws Exception
+ {
+ classUnderTest.initialize();
+ ((ExamplePlugin) classUnderTest).sessionStarted(mockSession);
+ }
+
+ @Test
+ public void testSessionStartedNullApplication() throws Exception
+ {
+ try
+ {
+ when(mockSession.getApplication()).thenReturn(null);
+ classUnderTest.initialize();
+ ((ExamplePlugin) classUnderTest).sessionStarted(mockSession);
+ fail("Exception to get an exception for null IApplication returned from Session.getApplication");
+ }
+ catch (Exception e)
+ {
+ // This is expected.
+ }
+ }
+
+ @Test
+ public void testGetGlobalPreferencePanels() {
+ assertNotNull(classUnderTest.getGlobalPreferencePanels());
+ }
+
}
Added: trunk/sql12/plugins/squirrelsql-plugin-archetype/src/main/resources/archetype-resources/src/test/java/net/sourceforge/squirrel_sql/plugins/example/ExampleSqlExecutionListenerTest.java
===================================================================
--- trunk/sql12/plugins/squirrelsql-plugin-archetype/src/main/resources/archetype-resources/src/test/java/net/sourceforge/squirrel_sql/plugins/example/ExampleSqlExecutionListenerTest.java (rev 0)
+++ trunk/sql12/plugins/squirrelsql-plugin-archetype/src/main/resources/archetype-resources/src/test/java/net/sourceforge/squirrel_sql/plugins/example/ExampleSqlExecutionListenerTest.java 2010-12-26 22:47:52 UTC (rev 6062)
@@ -0,0 +1,78 @@
+package net.sourceforge.squirrel_sql.plugins.example;
+
+import static org.junit.Assert.*;
+
+import net.sourceforge.squirrel_sql.fw.util.IMessageHandler;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+
+/*
+ * Copyright (C) 2010 Rob Manning
+ * man...@us...
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+/**
+ * A simple test that uses Mockito to create a mock (IMessageHandler) that is required to construct the
+ * class that is being tested (ExampleSqlExecutionListener).
+ */
+@RunWith(org.mockito.runners.MockitoJUnitRunner.class)
+public class ExampleSqlExecutionListenerTest
+{
+
+ /**
+ * Class that is being tested. This should always be called classUnderTest to distinguish it as the
+ * thing being tested.
+ */
+ private ExampleSqlExecutionListener classUnderTest = null;
+
+ /**
+ * The @Mock annotation in conjunction with the MockitoJUnitRunner is pure magic. This creates the mock
+ * automatically and injects it into this test class. To the naked eye, mockMessageHandler appears to be
+ * uninitialized here. However, because it's annotated with @Mock, it actually is set to a Mockito
+ * mock implementation of IMessageHandler.
+ */
+ @Mock
+ private IMessageHandler mockMessageHandler;
+
+ @Before
+ public void setUp() {
+ classUnderTest = new ExampleSqlExecutionListener(mockMessageHandler);
+ }
+
+ @Test
+ public void testStatementExecuted()
+ {
+ final String sqlToTest = "select * from testtable";
+ classUnderTest.statementExecuted(sqlToTest);
+
+ // We just want to verify that the message handler's showMessage method was called.
+ Mockito.verify(mockMessageHandler).showMessage("statementExecuted: "+sqlToTest);
+ }
+
+ @Test
+ public void testStatementExecuting()
+ {
+ final String sqlToTest = "select * from testtable";
+ String result = classUnderTest.statementExecuting(sqlToTest);
+ assertEquals(sqlToTest, result);
+ }
+
+}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
