Unit Testing Eclipse Plugin

This tutorial provides a brief introduction to the AppPerfect Java Unit Test using a set of hands-on practice exercises. This tutorial assumes you have successfully downloaded and installed AppPerfect Unit Test on your machine with the default options. Apart from this pre-requisite, this tutorial is self contained. Instructions given below are Windows-specific; if you are using a non-Windows machine, please use equivalent commands/instructions.

This document is divided into following sections

  1. Creating Project
  2. AppPerfect Java Unit Test

In this tutorial, we will discuss generating Test Cases for Eclipse plugin projects. Unit testing of Eclipse plugins is supported only when product is integrated in Eclipse IDE. Eclipse plugin project is like a local project but runs only in Eclipse platform.

Within each section, multiple exercises are listed. Each exercise forms a logical unit which is expected to take no more than a few minutes to perform.

All exercises assume you have installed the product in C:\AppPerfect\UnitTest folder and will be referred as UnitTest_HOME henceforth in tutorial. If you have installed the product in some other folder, modify the instructions below appropriately.

This tutorial is not intended as a comprehensive training guide. Please refer to the product documentation for detailed information. However, this tutorial will give you a very good overview of the products and substantially improve your productivity with the product.

Creating Project

Exercise 1: Launch AppPerfect Java Unit Test

  1. Eclipse Plugin unit testing is supported only when product is integrated with Eclipse IDE. Hence to launch product, select a plugin project in package explorer in Eclipse and launch Unit Test. You can launch Unit Test either from context menu or from main menu AppPerfect > Unit Test

Exercise 2: Creating a Project

Unit Test will create a new project named .apUnitTest (if the action is invoked for the first time, later on there is no need to create project as its already present). Settings of the newly created project will be picked from the selected Eclipse project and will be displayed in the Project dialog. Unit Test project properties dialog will be displayed on finishing the common dialog.

  1. On launching product, Unit Test will bring up Project dialog with pre-filled values.
  2. Go through the instruction provided on top of the General tab.
  3. Unit Test will pick the required settings from the Eclipse plugin, go through all tabs to verify the settings picked and change them if needed. In the last target tab, click on the Finish button.
  4. A confirmation message saying that the project is saved will be displayed. Click on the OK button.

Now using this Project we will create tests to demonstrate the functionalities of AppPerfect Unit Test product.

AppPerfect Java Unit Test

NB: Please follow the steps provided in the "Creating Project" section to first create a Project, then proceed further.

Exercise 1: Define a Unit Test project

  1. Once the Project is successfully created another dialog - Define Project Properties dialog - will be displayed.
  2. Read the instructions at top of each tab.
  3. First tab of this dialog is Launch configuration settings. Select the Product or Application to run and list of plugins to include.
  4. The Test Case Generation tab allows you to specify Test Class Generation settings, you can select the various Test Case options. Keep default values.
  5. In Test Case Execution tab you can specify Test Class Execution settings. Keep default values.
  6. Click on the OK button to close this dialog.

Exercise 2: Test case Generation

  1. Once a project is defined, the next step is to generate the necessary unit test cases. AppPerfect Unit Tester automates the generation of such unit test cases. For .java files, the JUnit framework is used. For .jsp files, the HtmlUnit framework is used. Launch Test Generation Dialog by clicking on Project -> Generate Test Cases... menu option.
  2. Click on Test Classes tab.
  3. In 'Generating test classes' section AppPerfect will generate test classes for source files provided (which were added in the source tab of Project Wizard) and add instances created to Object Repository. You can see the number Source files, Test classes generated, Test cases generated and Files ignored etc. Click on Start Generation button.
  4. A check mark will be displayed against the files for which test classes are generated. Click OK once generation is done.
  5. Select the Test Classes tab on the l.h.s. and expand the EJB node and Source Files node to view the test classes generated for the EJB and JAVA files.
  6. Select a Test class to view its details on the r.h.s panel.
  7. Right click on a test class and select "Open with Java Editor" to view/edit its source code.
  8. The source will be displayed in the editor on the r.h.s. For this exercise, we will not modify the test class.

Exercise 3: Execute the unit test and view/analyze results

  1. Start unit testing by clicking on Project -> Run.
  2. A new instance of target Eclipse will be launched for executing the test classes for unit testing Eclipse plugin
  3. Select the Execution Summary node in the Results tab to get an overview of the test result.
  4. Select the Test Class node. On the r.h.s select Execution Results and expand the Source Classes to view its test result.
  5. A list of all the exceptions / assertions will be displayed under the Exceptions view on the r.h.s. Select individual exception / assertion and click "View stack trace" to view the error details. Rectify the error and repeat the test as needed.