Test suite reports API

The report APIs allow you create reports for different types of elements in the Hyades Test perspective. The report APIs are not final, and may change at any time.

A class used for reporting knows how to handle one or more "types" of elements such as folders, test suite definitions and execution results. It analyzes a set of objects and returns the result of the analysis as a java.io.InputStream, along with the extension of the file that will store the results.

At any time a Hyades Test user can select one or more objects in the Definition or Execution pane and try to create a report for them. If the report option in the popup menu is available, it means that there is at least one report that supports the current selection of objects. When the user clicks on Report in the pop-up menu, the Report wizard opens.

The first page of the Report wizard shows the list of all the valid reports for the current selection allowing the user to select one of them. There is also a check box that can be used to request the Workbench to open the file that will be created using its default editor.

The Hyades Test API provides a default implementation for this interface: org.eclipse.hyades.ui.IReportGeneratorl. A report developer can create a class that extends this one, redefining only the methods that are relevant for the analysis that will be performed. 

Arguments and return types

For the methods below (other than the first one), the reportFile argument is a handle to the file that will be created after the method returns. This method doesn't need to check if the file exists and should not create a file in its location. The returned InputStream is the content of the report that will be serialized into the file.

public String getReportFileExtension (String objectType, boolean isSingleSelection)

Returns the extension of the report file that will be created for a specific object type, also based on whether there is only one, or are many, objects of the selected type.

• org.eclipse.core.resources.IProject - Workbench project
• org.eclipse.core.resources.IFolder - Workbech folder
• org.eclipse.hyades.test.java -  JUnit test
• org.eclipse.hyades.test.ui - Has the common pieces of the Hyades Test framework
• org.eclipse.hyades.ui - Has the common pieces of the Hyades framework

public InputStream generate (IFile reportFile, IContainer container)
throws Exception

This method is executed if:

• This report is registered to handle a selection of one project or one folder
• The user selected a valid project or folder

public InputStream generate (IFile reportFile, IContainer[] containers)
throws Exception

This method is executed if:

• This report is registered to handle a selection of more than one project or more than one folder
• The user selected a valid set of projects or folders

public InputStream generate (IFile reportFile, TestcaseDefinition testcaseDefinition)
throws Exception

This method is executed if:

• This report is registered to handle a selection of one testcase definition
• The user selected a valid testcase definition

public InputStream generate (IFile reportFile, TestcaseDefinition[] testcaseDefinitions)
throws Exception

This method is executed if:

• This report is registered to handle a selection of more than one testcase definitions
• The user selected a valid set of testcase definitions

public InputStream generate (IFile reportFile, TestcaseInstance testcaseInstance)
throws Exception

This method is executed if:

• This report is registered to handle a selection of one test case instance
• The user selected a valid test case instance

public InputStream generate (IFile reportFile, TestcaseInstance[] testcaseInstances)
throws Exception

This method is executed if:

• This report is registered to handle a selection of more than one testcase instances
• The user selected a valid set of testcase instances

public InputStream generate (IFile reportFile, ExecutionContainer executionContainer)
throws Exception

This method is executed if:

• This report is registered to handle a selection of one execution
• The user selected a valid execution

public InputStream generate (IFile reportFile, ExecutionContainer[] executionContainers)
throws Exception

This method is executed if:

• This report is registered to handle a selection of more than one executions
• The user selected a valid set of executions

Related tasks
Defining new report generators
Creating report classes
Registering report classes through plug-ins
Registering report classes in preferences

(C) Copyright IBM Corporation 2000, 2003. All Rights Reserved.