Versions Compared

Old Version 12

changes.mady.by.user Barrett Reed

Saved on

compared with

New Version Current

changes.mady.by.user Ted Kirby

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Table of Contents

Overview

The automatic testing for the GEP is performed during the Maven build. The tests are run as JUnit 3 plug-in tests and use Abbot and Abbot for SWT (an both open source projectprojects) to perform the GUI testing of finding objects, testing objects, and driving objects.

...

Importing the testsuite into Eclipse

Download the following Abbot for SWT jars from sourceforge.net and put them in the eclipse plugins directory:

  • abbot.swt.jar

...

  • abbot.swt.test.jar

...

  • abbot.swt.eclipse.jar

I have found these jars in abbot.swt-0.1.0.20080305_1254.zip, available at http://sourceforge.net/projects/abbot/files/, under abbot.swt, 0.1.0.20080305_1254.

Afterwards, you should be able to import the org.apache.geronimo.testsuite.v21 project.

...

  1. Create a new JUnit Plug-in Test
  2. Test page. Change Test Runner to be JUnit 3.
  3. Test page. Change Project to org.apache.geronimo.testsuite.v22.
  4. Test page. Change Test class to org.apache.geronimo.testsuite.v22.ui.EclipseUITest.
  5. Arguments page. Set the VM Arguments to -Xms256m -Xmx256m -XX:MaxPermSize=128m
  6. Main page. Set Run an application to either org.eclipse.ui.ide.workbench or Select Run a product and select org.eclipse.platform.ide
  7. Main page. Find where the build installed the launcher and point the workspace location to the eclipse/eclipse/plugins directory that was created during the mvn install process. Set the workspace (on the main tab) to something similar to C:\g\devtools\eclipse-plugin\trunk\testsuite\launcher\eclipse\eclipse\plugin
    Image Removedjdt_folder
    Image Added
    Image Added

Adding test cases

The following steps are required when adding new testcases test cases to the GEP testsuitetest suite. Note that each new Eclipse plugin is the equivalent of an new testsuite, with each testsuite comprised of a single or multiple testcasestest case uses the org.apache.geronimo.testsuite.v22.testCases extension point.

  1. Create a new testsuite plugin in the testsuite\plugins directory. In order to build and execute properly from maven this new plugin must contain both a META-INF\MANIFEST.MF and a plugin.xml.
  2. Similarly, this new plugin must contain a pom.xml file to build the plugin, plus a test.xml ant script to execute the testsuite testcases using ant. The best examples for all these files are the existing testsuite(s).
  3. The testsuite\plugins\pom.xml file should be updated to build the new plugin.
  4. class that extends org.apache.geronimo.testsuite.v22.ui.AbstractTestCase and implement the buildTestCase(), runTestCase(), cleanupTestCase() methods. Each test case should leave the server and the workspace in the same state as when it was started.
  5. AbstractTestCase has several fields that provide useful methods for test case implementation.
    workbenchShell - Simply the Eclipse frame and all its GUI components
    abbotHelper - a wrapper for Abbot. Use this to make the GUI perform actions.
    serverTasks - performs several generic actions that can be taken on the Geronimo server, including showing the server overview page and publishing projects.
    projectTasks - performs generic actions that can be taken on projects, including creating and deleting.
    workbenchTasks - performs generic actions that can be taken in Eclipse, including opening the internal browser and changing the perspective.
  6. Update plugin.xml to use the org.apache.geronimo.testsuite.v22.testCases extension point. The class for the extension point is the class created above.
    Code Block
    
<extension point="org.apache.geronimo.testsuite.v22.testCases">
    <testCase class="org.apache.geronimo.testsuite.v22.ui.Tutorial5MinuteTest">
    </testCase>
</extension>
    The testsuite\launcher\testsuite.xml and testsuite\launcher\testsuite.properties files must be updated to invoke and refer to the new testsuite plugin.

  7. There are actually two instances of Eclipse running while the testsuite is running. The first instance will use the testsuite\launcher\workspace as its workspace, and the second instance, used by the Junit testcasesJUnit test cases, will utilize the testsuite\eclipse\eclipse\jdt_folder directory as its workspace. Normally, each separate testsuite will delete this jdt_folder just prior to starting. However, if a testsuite requires some workspace artifacts from a previous testsuite (i.e., a defined Geronimo server), the test.xml for that testsuite should be modified to remove the delete ant task for the jdt_folder.If additional arguments need to be passed to the testsuite jvm, the extraVMargs property should be set in the test.xml ant script for that plugin. For example: 
     Code Block
    <property name="extraVMargs" value="-XX:MaxPermSize=128m" />

  8. JUnit will call the EclipseUITest class. This class is the main driver for the test suite. It will do a quick verification test to validate that Geronimo was installed and will start the server. Next it will loop through all the test case extensions, running each in turn. After it has finished all the test cases, it will uninstall the Geronimo server and close Eclipse.
  9. Finally, the new test case Finally, the new testsuite plugin must build and execute without errors from the maven build. And subsequent to the build, it must import into Eclipse and execute from within Eclipse without errors.
...
The 2 most common exceptions that Abbot throws are the ObjectNotFoundException and the MultiplesFoundException. ObjectNotFoundException is thrown when the code is looking for the wrong type of object or the String is not an exact match for an object. It is possible to use regular expressions in place of hard coded strings. For instance, if the title of a window is "Window (FFF)", where "FFF" represents a component and may change, you can change the title attribute of the component reference to "/Window .*/" so that the match string will always match the variable title.
Eclipse versions
There are actually three versions of eclipse in play on your workstation when working with GEP:
  1. M2_REPO/eclipse (constructed during GEP build via <gep-svn-root>/eclipse/build.xml. Used to build GEP plugins.)
  2. <gep-svn-root>/testsuite/launcher/eclipse (constructed during GEP build via <gep-svn-root>/testsuite/eclipse/build.xml. Used to run the testuite via "mvn -Ptestsuite" build in <gep-svn-root>. This one has Abbot and test framework plugins used to run the testsuite.)
  3. The one you actually use! One approach is to copy the one from M2_REPO/eclipse to another eclipse directory after a GEP mvn clean install build.
Debugging Abbot code
Sometimes it is helpful to step though the Abbot and Abbot for SWT code to figure out what it is expecting. In order to do this, you will need to get the source code and import it into Eclipse. Abbot for SWT has been split out to its own project. It looks like our code uses a specific level of abbot and abbot.swt code: 200800305_1254. The instructions did say trunk, but I upgraded them to reflect this level used.
  1. svn co -r669 https://abbotabbotforswt.svn.sourceforge.net/svnroot/abbotabbotforswt/abbot.swt/trunkImage Removed/ c:\abbot
  2. Create folder c:\abbot\abbot.plain (must be named abbot.plain)
  3. svn co -r2689 https://abbot.svn.sourceforge.net/svnroot/abbot/abbot/trunkImage Removed c:\abbot\abbot.plain
  4. In c:\abbot\abbot.plain, call "ant"
  5. In c:\abbot\abbot.swt, call "ant -f setup.xml" to create the c:\abbot\abbot.swt\lib\abbot.jar
  6. Copy from C:\abbot\abbot.plain\lib\ to C:\abbot\abbot.swt\lib\ the following jars: bsh-2.0b4.jar, gnu-regexp-1.1.0.jar, jdom-1.0.jar, xercesImpl-2.8.1.jar, xml-apis.jar
  7. Download MRJToolKitStubs.zip from http://developer.apple.com/samplecode/MRJToolkitStubs/index.htmlImage Removed into C:\abbot\abbot.swt\lib\. That link did not work. Try http://testng-abbot.googlecode.com/svn/trunk/testng-abbot/lib/main/MRJToolkitStubs.zip. (Use View raw file link in File info section at lower right if needed.) This jar is also contained in abbot.swt-0.1.0.20080305_1254.zip, available at http://sourceforge.net/projects/abbot/files/, under abbot.swt, 0.1.0.20080305_1254.
  8. To make sure that the source you debug with matches the source in the abbot.jar, copy the code from abbot.swt.0.1.0.200800305_1254 src.zip (can also be found in the downloadable version of abbot.swt from sourceforge.net in http://sourceforge.net/projects/abbot/files/, under abbot.swt.) into c:\abbot\abbot.swt\src directory. It looks like the abbot.swt "ant -f setup.xml" build puts abbotsrc.zip in abbot.swt\lib, so I extracted that one.
  9. Import abbot.swt project into eclipse
  10. Ensure that all the .jars and the .zip from above are on the LIbraries path and the Order and Export Page 
    1. Add C:\eclipse\abbot\abbot.plain\lib\ant4eclipse\ant4eclipse.jar
  11. In the MANIFEST.MF, add all available packages to the Exported Packages list. For the classpath, remove the "." library. Also add a new AbbotSWTplugin.jar and the jars and zip from above. 
     Warning
    I have not gotten this to work. When I import the Abbot code into Eclipse, I get compiler errors. I have not found the precise level of Abbot SWT used in the GEP testsuite code. Ultimately, we should upgrade our GEP testsuite code to the latest Abbot level, which of this writing was Jan 26 2009 for Abbot, and Apr 08 2009 for Abbot SWT.