optimizeit code coverage 1cca.yuntech.edu.tw/cca/ccawork/cca系統設備資料...borland software...

Optimizeit™ Code Coverage 1.5

for Java™

User’s Guide

Borland Software Corporation100 Enterprise WayScotts Valley, California 95066-3249www.borland.com

Borland Software Corporation may have patents and/or pending patent applications covering subjectmatter in this document. Please refer to the product CD or the About dialog box for the list ofapplicable patents. The furnishing of this document does not give you any license to these patents.

COPYRIGHT © 1997–2003 Borland Software Corporation. All rights reserved. All Borland brand andproduct names are trademarks or registered trademarks of Borland Software Corporation in theUnited States and other countries. All other marks are the property of their respective owners.

For third-party conditions and disclaimers, see the Release Notes on your Borland product CD.

Printed in the U.S.A.

oi60cc 4E3R10030304050607-9 8 7 6 5 4 3 2 1PDF

i

Chapter 1Getting Started 1When to use Code Coverage . . . . . . . . . . . 1Installing Code Coverage . . . . . . . . . . . . . 2

Using the virtual machine wizard. . . . . . . . 3Integrating Optimizeit with other tools . . . . . . . 3Running Code Coverage . . . . . . . . . . . . . 4

Chapter 2Defining your test program 5Using the Startup page . . . . . . . . . . . . . . 6

Choosing your program type . . . . . . . . . . 7Choosing your program location . . . . . . . . 7Choosing operation options . . . . . . . . . . 8Choosing extra Java or

program parameters . . . . . . . . . . . . . 8Choosing your class path and source path . . 8

Using the Filters tab . . . . . . . . . . . . . . . . 9Using the Virtual Machines tab . . . . . . . . . 12

Adding a virtual machine . . . . . . . . . . . 12Setting virtual machine properties . . . . . . 13

Chapter 3Running Optimizeit from the command line 15

Starting from the command line . . . . . . . . . 15Setting up the audit system . . . . . . . . . 16Launching your program . . . . . . . . . . . 16Windows audit system options . . . . . . . . 17UNIX audit system options . . . . . . . . . . 18Connecting the audit system . . . . . . . . . 21

Starting on a different machine . . . . . . . . . 22Using the Filter Editor . . . . . . . . . . . . . . 22Starting from the test program . . . . . . . . . 25

Adding API calls in your program . . . . . . 25Starting your test program . . . . . . . . . . 26

Chapter 4Using Class Coverage 27Controlling the test program. . . . . . . . . . . 29Mark and Inspector options . . . . . . . . . . . 29

Chapter 5Using Method Coverage 31Method Coverage window options . . . . . . . 32Controlling the test program . . . . . . . . . . 33Mark and Inspector options . . . . . . . . . . . 33

Chapter 6Reporting features 35Generating snapshots . . . . . . . . . . . . . 35Merging snapshots . . . . . . . . . . . . . . . 36Generating reports . . . . . . . . . . . . . . . 38

Generating a report from within Code Coverage . . . . . . . . . . . . . . 38

Generating a report from the command line . . . . . . . . . . . . . . . 39

Exporting data . . . . . . . . . . . . . . . . . 40Displaying console messages . . . . . . . . . 41

Chapter 7Setting your preferences 43Selecting default displays . . . . . . . . . . . . 43Setting launch parameters . . . . . . . . . . . 44Setting the source code location . . . . . . . . 45

Changing the default source path . . . . . . 45Changing the class path . . . . . . . . . . . . 46Selecting a virtual machine . . . . . . . . . . . 47Configuring servlet support . . . . . . . . . . . 48

Chapter 8Troubleshooting 49Starting your application . . . . . . . . . . . . 49Starting your application server . . . . . . . . . 53Problems during testing. . . . . . . . . . . . . 55Undoing an integration (Windows only) . . . . . 58

Index 59

Contents

Chapter 1: Get t ing Started 1

C h a p t e r

Chapter 1Getting StartedOptimizeit Code Coverage software is a Java performance tool that enables developers to find out precisely which part of their Java code is executed, right down to the exact line of source code.

The following sections introduce Code Coverage and describe how it is installed and run:■ “When to use Code Coverage”■ “Installing Code Coverage”■ “Integrating Optimizeit with other tools”■ “Running Code Coverage”

When to use Code CoverageWhen code is developed over time by several developers, portions of code and sometimes whole methods are no longer used, but remain dormant in the code. This type of dead code makes an application longer and more difficult to understand. Optimizeit Code Coverage makes locating dead code easy so that you can clean-up and simplify your application. Clarity of code makes it easier to read and more reusable.

Code Coverage also makes it easy for you to identify how much of your code has been tested by highlighting all tested code. Understanding exactly which classes, methods, and lines of code have not been used allows you to modify your test plan to cover all areas of the code.

2 Code Coverage User’s Guide

Instal l ing Code Coverage

Optimizeit Code Coverage lets you test applications, applets, servlets, JavaBeans, Enterprise JavaBeans (EJBs), JavaServer Pages (JSPs), and virtually any other Java code. Code Coverage is plug and play: there is no need to recompile your program with a custom compiler or to modify class files before execution. You can run your test from within Code Coverage, or you can run testing sessions from the command line.

When you invoke your program from Optimizeit Code Coverage, the user interface connects to the audit system running in the test application’s virtual machine and begins providing real-time test information. Code Coverage shows this information two ways: class coverage and method coverage. For a description of class coverage mode, see Chapter 4, “Using Class Coverage.” For a description of method coverage for a particular class of interest, see Chapter 5, “Using Method Coverage.”

Installing Code CoverageTo install Optimizeit, load your Optimizeit CD. Written installation instructions are located in the install.html file in the root directory of the CD. Optimizeit does not support directories with spaces in the name (for example, Program Files), so make sure there are no spaces in your installation directory name. Make sure your software and virtual machine are supported. Refer to the Release Notes for a complete listing of supported platforms and VMs.

Important Make sure you have installed the latest current release with all current patches for your OS and JDK version; for example, there are some problems using JDK version 1.3.1_02 that do not appear when JDK version 1.3.1_09 or JDK 1.4.2 are used.

If you are installing the Optimizeit Suite, you will be installing all three Optimizeit tools, Profiler, Code Coverage, and Thread Debugger, at once. All three tools share the same setting files and the same IDE and application server integrations:■ Because all three tools share the same settings, you can load any

Optimizeit setting file into any Optimizeit tool. For example, you can create some classpath, source path, and virtual machine settings in Profiler, save them, and then use these same settings with Thread Debugger.

■ If you integrate any Optimizeit tool with an IDE or an application server, all three tools will be immediately ready to use those environments, without any further configuration.

■ On Windows platforms, the Audit System Selector option places an icon on your toolbar that allows you to easily switch between the three tools.

The Optimizeit root directory also contains Release Notes. These Release Notes list added platforms and Java development environments, and describe a subset of known problems, workarounds, and tips for Optimizeit.

Chapter 1: Get t ing Started 3

Integrat ing Opt imizei t wi th other tools

Using the virtual machine wizard

By default, Optimizeit uses a Java 2 runtime. When Optimizeit is installed, a default JRE version 1.4.2 is also installed, but as shown in the table above, Optimizeit is compatible with many Java virtual machines.

The first time you run Optimizeit, a Java setup wizard starts automatically to help you select a virtual machine:

Note You can also access this wizard at any time from Tools|Java Setup.

1 If you want to use the default JRE, click Cancel, and the wizard returns you to Optimizeit.

2 If you want to configure Optimizeit to use a different virtual machine, click Next.

3 Select the directory where you want the wizard to search for available virtual machines. The wizard scans the selected directory or drive and lists all available virtual machines.

Tip After you see the message Found 1 virtual machine you can click Stop to end the scan.

4 Select the virtual machine you want to use.

5 Click Next, then click Finish.

6 After changing the default virtual machine, Optimizeit prompts you to confirm that the new default virtual machine should be used with the current settings. Click Yes to start using that virtual machine.

Integrating Optimizeit with other toolsAs described in Chapter 2, “Defining your test program,” you can specify and start test sessions from the Optimizeit user interface without integrating with a web server or application server. However, to run Optimizeit from the command line and take advantage of offline profiling you must integrate with the Java tool used to run the application you are testing. Integration wizards


Running Code Coverage

are provided for all supported web and application servers. However, since Optimizeit can be integrated with most application servers that use compatible virtual machines, integration instructions are provided for manually integrating Optimizeit with a variety of different servers.

Optimizeit also integrates with several integrated development environments (IDEs) to help speed application development and test cycles.

See the Release Notes for a list of supported web and application servers, and IDEs, and refer to the Optimizeit Integration Guide for integration instructions and additional information. If you have trouble integrating your tool, see Chapter 8, “Troubleshooting.”

Running Code CoverageOnce Optimizeit is installed, you must enter your test program information so that Optimizeit can locate the application, applet, or servlet to be tested, and can test the appropriate areas:■ If you have never used Optimizeit before, or have never created your own

Settings file, start with Chapter 2, “Defining your test program.”■ If you know about settings files but need to learn how to start a test from the

command line, go to Chapter 3, “Running Optimizeit from the command line.”

Note Each chapter builds on the information contained in the previous chapter. Review previous chapters before beginning a new chapter, and do not skip chapters unless you are familiar with the procedures.

To run Optimizeit Code Coverage:

1 By default, Code Coverage starts in class coverage mode, as described in Chapter 4, “Using Class Coverage.”

2 To analyze method coverage for a particular class of interest, switch to the method coverage, as described in Chapter 5, “Using Method Coverage.”

3 To store and analyze your coverage data, use the reporting functions described in Chapter 6, “Reporting features.”

4 Make changes to your source code and repeat these steps until you are satisfied with your program’s performance.

From within Code Coverage, use the menu items described in Chapter 7, “Setting your preferences,” to choose your startup window, your default source and class paths, and other defaults.

If you have trouble integrating or using Code Coverage, see Chapter 8, “Troubleshooting.”

Chapter 2: Def in ing your test program 5

C h a p t e r

Chapter2Defining your test programWhen you first start Optimizeit, it opens the Edit Settings dialog box:

Use the Settings dialog box to modify your source path, class path, filters (if any), and virtual machines. This dialog box is a centralized location for many configuration items, which is convenient if you are testing a program from within the Optimizeit user interface. You can also access the Settings dialog box with the following File menu commands:


Using the Startup page

■ File|New —opens a new settings dialog box, with only the Optimizeit defaults specified.

■ File|Open —allows you to browse for a settings file to use.■ File|Open Recent —displays a list of recently accessed settings files

(generated by any Optimizeit tool) for you to choose from.■ File|Settings—opens the current settings file, which you can either run

again or edit to run a new test.

The Settings dialog box contains the following pages:■ Startup—this page contains the required elements for your configuration,

such as the program type, location, Class path and Source path.■ Filters—if there are specific packages or classes you wish to test or ignore,

use the Filters page.■ Virtual Machines—by default, Optimizeit tests with a Java 2 runtime. If you

want to specify a virtual machine other than the default, use the Virtual Machines page.

Once you have configured the settings, you can save this configuration in a file when you exit Optimizeit. By default, information from the last-saved settings file is automatically loaded into Optimizeit when you open the program. The same settings file can be used in Optimizeit Profiler, Code Coverage, or Thread Debugger. Use the Save and Open commands on the File menu to save settings files and access existing ones.

Using the Startup pageThis section describes how to fill out the Startup page of the Settings dialog box in Optimizeit. The Startup page lets you specify the following settings for testing:■ Program type■ Program location and working directory■ Operation options■ Extra Java or program parameters■ Class path and source path

Once you have filled out the Startup tab, if you want to use the default virtual machine and filters, click Start Now to begin testing. Optimizeit starts the application and opens the default view.

See also■ Chapter 7, “Setting your preferences,” for more information about setting

defaults.



Choosing your program type

The first option on the Startup tab of the Settings dialog box is to choose your program type:■ Click Application to test a Java application. Continue by choosing your

program location.■ Click Applet to test an applet. Continue by choosing your program location.■ Click Servlet/JSP to test a servlet or JSP. If this is the first time you have

tested a servlet with Optimizeit, the servlet wizard will start. The wizard will guide you through the servlet configuration; see “Configuring servlet support” on page 48 for more information. Continue by choosing your program location.

■ Click Remote Application to test a Java application that is started from the command line or that is located on another machine.

See also■ “Connecting the audit system” on page 21 for remote testing instructions.

Choosing your program location

What you enter in the location field depends upon what you are testing:■ For an application, Optimizeit expects a Program Main Class Or JAR File:

■ If the application is packaged in a JAR file, click Browse to select the JAR file location.

Note To run an application from a JAR file, the .jar file of the JAR-packaged application must have a manifest file that includes a main-class attribute. See the Sun Microsystems Java web site for more information on JAR-packaged applications.

■ If the application is in a ZIP file, enter the fully qualified name of the class containing the Main method. For example:

com.reg.bar.Main

■ If the application is not in a JAR or ZIP file, click Browse to select the class file that contains the main method.

■ For an applet, Optimizeit expects an Applet HTML File or URL. If the applet is on your local disk, click Browse and select the HTML file. If the applet is a web page, enter the URL of that page.

■ For a servlet, click Browse to choose the class file that contains your servlet.

The Program working directory field is not required; you only use it if your test points to a specific working directory.



Choosing operation options

The Startup tab contains options to configure the behavior of your test program on startup:■ Generate snapshot on exit generates a snapshot when the System.exit()

method is called in the virtual machine.■ VM Cannot Exit disables the method System.exit() in the virtual machine.

Use this option to test a command line program such as a compiler that performs a task and then exits the running virtual machine. Use the Stop button to exit the program when your testing session is complete.

■ Open A Console opens a console window for the program when the testing session begins. Use this option if your program expects some input from System.in. When this option is off, anything printed using System.out and System.err is printed in the Optimizeit console.

Choosing extra Java or program parameters

The Extra Java Parameters and Extra Program Parameters fields are optional:■ Extra Java Parameters specifies a string passed directly to the virtual

machine running the test program. Use this field to add Java virtual machine arguments such as -Xms256m or -verbosegc.

■ Extra Program Parameters specifies a string passed directly to the tested application when launched. This option is not applicable for applets.

Choosing your class path and source path

If the application requires special classes not indicated in the default CLASSPATH, click Change under the Class Path window to choose and add the directories, JAR files, or ZIP files containing the extra classes. You can also enter a multi-entry class path, such as c:\classes;d:\project\xmlParser.jar in the empty field. These additions apply only for the current test program.

The Source path lists the directories where Optimizeit will search for source code. If you want Optimizeit to highlight relevant source code, you may need to add your source code directories, ZIP files, or JAR files to the source path.


Using the Fi l ters tab

To add or change the source code location, click the Change button to bring up the Source Path Chooser dialog box.

Use this dialog box to add, delete, and organize your source paths. Use the browser to search for a specific directory or file, or use the empty field under the browser if you have a multi-entry source path, such as c:\src;d:\project\src.jar. Enter your full path information into the field. Specific files can also be added later during the testing session. These additions apply only to the current test program.

See also■ By default, the Class Path dialog box contains the default class path as

defined by your CLASSPATH variable. This default can be changed using the Preferences menu; see “Changing the class path” on page 46 for more information.

■ By default, the Source Path dialog box is blank or contains the source path defined using the Preferences menu; see “Setting the source code location” on page 45 for more information.

Using the Filters tabFilters are sets of patterns that define the packages or classes either grouped or ignored by Optimizeit Code Coverage.

For Code Coverage, there are 2 types of filters: exclusive filters and inclusive filters:■ Exclusive filters specify which packages or classes should not be tested.

This allows you to test everything but specified packages or classes. For example, by default Optimizeit Code Coverage uses exclusive filters to filter out java base classes. The patterns for those classes are: java.*, javax.*, and sun.*. This means that every class name that begins with java. or javax. or sun. will not be tested.

10 Code Coverage User ’s Guide


■ Inclusive filters specify which packages or classes should be tested; everything else is filtered out. For example, an inclusive filter with the single pattern com.borland.* will cause Optimizeit to report only the test information for the classes with a name starting with com.borland.

Note Only one type of filter (inclusive or exclusive) can be used at a time.

Filters are very convenient for testing servlets, EJBs and JSPs. In that context, they can be used to remove or group in one call the resources used by the application server, allowing you to focus on your Java code.

Optimizeit provides several filters ready to use, including filters dedicated to many application servers. The filters provided by Optimizeit are read-only. You can only modify and delete the filters you have created.

Note Filters only remove information about resources used by code matching the filter pattern. Filters don’t remove information about methods invoked from filtered methods. If a filtered method calls an unfiltered method that allocates an instance, this instance won’t be filtered. If a filtered method invokes a method that consumes CPU time, this CPU time won’t be filtered. For example, you can set the filter for all Jakarta Tomcat objects, but when you read your test results you may still find Jakarta objects if these objects were created by other methods not affected by your filters. You should not see any filtered packages with a red star or clock next to them in a Hotspot or Allocation View.

This section describes how to set up filters for Optimizeit using the Filters tab on the Settings dialog box. Filters are only applicable for Profiler and Code Coverage.

1 Start Optimizeit to open the Edit Settings dialog box by default. If Optimizeit is already started, or opens with a different dialog box:■ Choose File|New Settings to start a new settings file,■ Choose File|Open Settings or File|Open Recent Settings to locate a

previous settings file to modify, or■ Choose File|Edit Settings to edit the current configuration.



2 Click the Filters tab on the Settings dialog box to open the Filter Editor:

3 To use inclusive filters, click Include Only. If you want to use exclusive filters, click Exclude.

4 To add a pattern, click New. The Pattern Editor dialog box opens:

5 Enter your pattern in the box and click OK. Both the asterisk wildcard character (*) and the not character (!) are supported. Your pattern can define packages, classes, or methods. When you are done with this pattern click OK.

6 Remove a pattern by highlighting it in the list and clicking Delete.

7 Edit a pattern by highlighting it in the list and clicking Edit Pattern. This opens the pattern editor.

8 When you are done with your filter selection, click on the Virtual Machines or Startup tabs, or click Start Now to begin your test. Click OK if you just want to save your information.

Note If you select more than one filter for a test run, Optimizeit always performs a logical OR of all the filters you have selected. Any top-level package, class, or method that meets any of the filter criteria is filtered.


Using the Vir tual Machines tab

See also■ “Using the Filter Editor” on page 22 for instructions on using the Filter Editor

executable when testing a remote application. This executable operates outside the Optimizeit user interface.

Custom filters are part of Optimizeit configuration files. They are saved and loaded when using Save and Open commands from the File menu.

Using the Virtual Machines tabAt any time, you can change the virtual machine or add a virtual machine using the Virtual Machines tab on the Settings dialog box:

The main panel lists all of the virtual machines Optimizeit recognizes on this computer.

Adding a virtual machine

To add virtual machines to the list of machines available for Optimizeit:

1 Click Add Virtual Machines. This starts the virtual machine wizard.

2 Click Next.

3 Select the directory where Optimizeit should begin the search for available virtual machines.

4 Click Search. Optimizeit displays the virtual machines found.

5 Click Finish to add these virtual machines to the list of available virtual machines.


Using the Vir tual Machines tab

Setting virtual machine properties

The Virtual Machine Properties are settings that may or may not be activated, depending upon what type of virtual machine you are using. When you select a virtual machine from the list, Optimizeit only enables the available options for that virtual machine. For example, JRE 1.2 does not have a Hotspot implementation, so the Hotspot option for Java runtime will not be available if you have that JRE selected.

The Java Runtime option sets the virtual machine runtime used. The following table shows which flag is added to the virtual machine invocation:

If you want to use a JIT (Just In Time compiler) when testing, check that option.

If you aren’t sure which options to use, or you want to return to your defaults, click Use Default Settings.

Once you have configured the Settings dialog box to start your application, you can save this configuration in a file when you exit Optimizeit. By default, information from the last-saved settings file is automatically loaded into Optimizeit when you open the program. The same settings file can be used in Optimizeit Profiler, Code Coverage, or Thread Debugger. Use the Save and Open commands on the File menu to save settings files and access existing ones.

Option Flag added Description

Default No flag added The virtual machine uses its default runtime.

Classic -classic Optimizeit forces the virtual machine to use its classic runtime.

Hotspot -hotspot Optimizeit forces the virtual machine to use its Hotspot runtime.

Chapter 3: Running Opt imizei t f rom the command l ine 15

C h a p t e r

Chapter3Running Optimizeit from thecommand line

This chapter describes how to start, run, and configure Optimizeit from outside the Optimizeit user interface. In addition to running your test program from within Optimizeit, you can also run it from a command prompt.

Invoking your application from outside the Optimizeit user interface allows you to do the following:■ Set custom variables■ Run the application as part of a script■ Run the program on a different machine

Starting from the command lineTo test your program from a command prompt:■ Set up the Optimizeit audit system.■ Launch the Optimizeit audit system, specifying your test program.■ Start your selected Optimizeit tool and connect the audit system to the

Optimizeit user interface.

These steps are described in the following sections.


Star t ing from the command l ine

Setting up the audit system

To use the Optimizeit audit system, you need to modify your environment variables to make certain Optimizeit files available on the CLASSPATH and the search path for libraries.

To do this on Windows,

1 Go to the directory where you have Optimizeit installed.

In this example, it is <OptItDir>.

2 Open a command prompt.

3 Set your PATH to include the Optimizeit lib directory:

set PATH=<OptItDir>\lib;%PATH%

4 Set your CLASSPATH to include the Optimizeit optit.jar file:

set CLASSPATH=<OptItDir>\lib\optit.jar;%CLASSPATH%

To do this on UNIX,

1 Enter the directory where you have Optimizeit installed.

In this example, it is <OptItDir>.

2 Open a command prompt.

3 Set your LD_LIBRARY_PATH to include the Optimizeit lib directory:

export LD_LIBRARY_PATH=<OptItDir>/lib:$LD_LIBRARY_PATH

4 Set your CLASSPATH to include the Optimizeit optit.jar file:

export CLASSPATH=<OptItDir>/lib/optit.jar:$CLASSPATH

Launching your program

The Optimizeit audit system is a set of Java classes and native code. There are two methods for launching the audit system: as a command or as a command option.■ To launch the audit system using the command option, use one of the

following arguments:

-Xruncci:startAudit=t

or

-Xruncci -Xbootclasspath/a:<OptItdir>\lib\oibcp.jar intuitive.audit.Audit

Either command structure is valid. The first option allows you to append Optimizeit start options directly to the -Xrun command using a colon. You can add more than one option, as long as they are separated by a comma. The second option includes -Xbootclasspath because -Xbootclasspath is a Virtual Machine start option. In an Optimizeit command, the Virtual Machine options must come before the Optimizeit options unless the Optimizeit options have been appended to the -Xrun command with a colon.


Start ing f rom the command l ine

■ To launch the audit system as a separate command, enter the following on the command line:

On Windows:

java intuitive.audit.Audit

On UNIX:

java intuitive.audit.Audit

Note Only use one of these options in a command. If a command contains both startAudit=t and intuitive.audit.Audit, the system returns an error message that the audit system or port is already in use.

If you launch the audit system as a separate command, Optimizeit returns a list of all the audit system start options. The output depends upon your platform and which JDK version you are using. The following tables list all available options.

Windows audit system options

The following tables list the audit system invocation options on Windows platforms. There are two types of start command options: Virtual Machine and Optimizeit. The VM options go before the intuitive.audit.Audit specification in a command, and the Optimizeit options follow the audit system invocation.

Note Some command options are only available on specific JDK versions.

Table 3.1 Windows audit system Virtual Machine start options

Option Description

-classic JDK 1.2 and 1.3 only. Forces Classic runtime.

-Xruncci Starts the Optimizeit Code Coverage JVMPI agent. You must also add a filter file specification as shown in the examples below.

-Xrunoii Starts the Optimizeit Suite JVMPI agent. This option is only available if you have Optimizeit Suite installed. All Optimizeit command options, including those that are tool-specific, can be used with -Xrunoii.

-Xbootclasspath/a:<OptItdir>\lib\oibcp.jar

JDK 1.2 and newer only. Appends Optimizeit classes to the boot classes. Replace <OptItdir> with the directory where you installed Optimizeit.

Table 3.2 Windows audit system Optimizeit start options

Option Description

[-startAudit] [-intuitive.audit.Audit]

Starts the Optimizeit audit system. startAudit=t or intuitive.audit.Audit is required in a command.

[-port portNumber] Specifies the port you want to use for the communication link between the Optimizeit audit system and the Optimizeit user interface.



UNIX audit system options

The following tables list all the audit system invocation options on UNIX platforms. There are two types of start command options: Virtual Machine and Optimizeit. The VM options go before the intuitive.audit.Audit specification in a command, and the Optimizeit options follow the audit system invocation.

Note Some command options are only available on specific versions of JDK.

[-snapshotonexit] Generates a snapshot when the virtual machine exits.

[-noexit] Disables the System.exit() method in the virtual machine. This prevents the tested application from exiting the virtual machine. The default is f.

[-filter] Specifies the filter file that Optimizeit will use for this test. The format of the filter specification is filter=<filter>, where <filter> is the name of (and path to) a filter (.oif) file. Filter specifications are required.

[-enableAPI] Enables the audit system API. When the API is enabled, the Optimizeit tools are disabled. The audit system waits for the test program to enable the Optimizeit tool from Java.

[-auditOption] Specifies audit system options that are listed in an ASCII file. The format of the file specification is auditOption=<filename>, where <filename> is the complete path to file containing the audit system options. This file can contain all the Optimizeit audit system options. Only one option is allowed per line. The same option file may be used for different tests.

Note: When this option is used, OISelector settings are overridden.

[ClassName] The main class for the test program. If the test program is an applet, use sun.applet.AppletViewer and then add the path of the applet HTML file or URL.

Note: With Code Coverage, you must use oldjava instead of java to run an applet.

Table 3.2 Windows audit system Optimizeit start options (continued)

Option Description

Table 3.3 UNIX audit system Virtual Machine start options

Option Description

-classic JDK 1.2 and 1.3 only. Forces Classic runtime.

-Xruncci Starts the Optimizeit Code Coverage JVMPI agent. You must also add a filter file specification as shown in the examples below.



-Xrunoii Starts the Optimizeit Suite JVMPI agent. This option is only available if you have Optimizeit Suite installed. All Optimizeit command options, including those that are tool-specific, can be used with -Xrunoii.

-Xbootclasspath/a:<OptItdir>/lib/oibcp.jar

JDK 1.2 and newer only. Appends Optimizeit classes to the boot classes. Replace <OptItdir> with the directory where you installed Optimizeit.

-native JDK 1.2 on Solaris platforms only. If your virtual machine uses green threads you should suppress the -native option and add -DOPTITTHR=green and -DOPTITDIR=<OptDir> (where <OptDir> is the directory where you installed Optimizeit). The invocation becomes:

java -native -Xnoclassgc -Djava.compiler=NONE -DOPTITTHR=green -DOPTITDIR=<OptItDir> intuitive.audit.Audit ...

Table 3.4 UNIX audit system Optimizeit start options

Option Description

[-startAudit] [-intuitive.audit.Audit]

Starts the Optimizeit audit system. startAudit=t or intuitive.audit.Audit is required in a command.

[-port portNumber] Specifies the port you want to use for the communication link between the Optimizeit audit system and the Optimizeit user interface.

[-snapshotonexit] Generates a snapshot when the virtual machine exits.

[-noexit] Disables the System.exit() method in the virtual machine. This prevents the tested application from exiting the virtual machine. The default is f.

[-filter] Specifies the filter file that Optimizeit will use for this test. The format of the filter specification is filter=<filter>, where <filter> is the name of (and path to) a filter (.oif) file. Filter specifications are required.

[-enableAPI] Enables the audit system API. When the API is enabled, the Optimizeit tools are disabled. The audit system waits for the test program to enable the Optimizeit tool from Java.

Table 3.3 UNIX audit system Virtual Machine start options (continued)

Option Description



ExamplesUse the following command to launch the applet contained in the file example.html, without testing JDK classes and applet viewer classes.

On Windows:

oldjava -Xruncci:filter=<OptItDir>\filters\DefaultAllOn.oif -Xbootclasspath/a:c:\Optimizeit\CCoverage\lib\oibcp.jar intuitive.audit.Cover sun.applet.AppletViewer example.html

On Solaris or Linux:

oldjava -Xruncci:filter=<OptItDir>/filters/DefaultAllOn.oif -Xbootclasspath/a:/opt/sfw/Optimizeit/CCoverage/lib/oibcp.jar intuitive.audit.Cover sun.applet.AppletViewer file:/usr/applet/example.html

Use the following command to test only the classes of the package com.busy of the application com.busy.BusyApp and generate a snapshot when the application ends.

On Windows:

java -Xruncci:filter=<OptItDir>\filters\DefaultAllOn.oif -Xbootclasspath/a:c:\Optimizeit\CCoverage\lib\oibcp.jar intuitive.audit.Cover -snapshotonexit com.busy.BusyApp

On UNIX:

java -Xruncci:filter=<OptItDir>/filters/DefaultAllOn.oif -Xbootclasspath/a:/opt/sfw/Optimizeit/CCoverage/lib/oibcp.jar intuitive.audit.Cover -snapshotonexit com.busy.BusyApp

The snapshotonexit option allows you to collect snapshot data. If you want to see real-time data you must attach to the Optimizeit user interface, but if you just want to collect snapshot data you do not need to attach the audit system to the Optimizeit user interface. For example, if you want to generate a Code

[-auditOption] Specifies audit system options that are listed in an ASCII file. The format of the file specification is auditOption=<Path to the file>. This file can contain all the Optimizeit audit system options. Only one option is allowed per line. The same option file may be used for different tests.

Note: When this option is used, OISelector settings are overridden.

ClassName The main class for the test program. If the test program is an applet, use sun.applet.AppletViewer and then add the path of the applet HTML file or URL.

Note: With Code Coverage, you must use oldjava instead of java to run an applet.

Table 3.4 UNIX audit system Optimizeit start options (continued)

Option Description



Coverage snapshot report during nightly builds, you can insert a command in your build script that will generate coverage data:

java -Xruncci:'filters={patternList=(!*tests.*,*Test*,*Proxy*)}' -Xbootclasspath/a:/$optit_inst/lib/oibcp.jar intuitive.audit.Cover -port 1472 -snapshotonexit mainClass ...

java intuitive.optit.coverage.ReportGenerator -verbose -methodInfo -showSource -sourcePath $PATH $snapshotfile $outputfile

The first command sets the snapshot conditions, while the second command saves the snapshot in the specified report format. You can access and view the report within Optimizeit whenever you wish.

Connecting the audit system

Once the test program is running, you need to direct the audit system results to the Optimizeit user interface. This procedure is called attaching Optimizeit to the test program.

To show the audit system results:

1 In Optimizeit, choose File|New.

2 In the Settings dialog box, click Remote Application in the Program Type section.

The Remote Application dialog box opens:

3 In the Host Name field, type either:■ localhost


Star t ing on a d i f ferent machine

■ The name of your local host■ The name of the machine where the audit system is running■ The IP address of the machine where the audit system is running

4 In the Port Number field, enter the port number you want to use for the communication link between Optimizeit and the audit system.

Change the default value only if you used the port option when launching the test program.

5 To show relevant source code not found in the default source path, click Change under the Source Path list to locate and add directories or JAR files containing the additional source files.

Specific files can be added later during the testing session.

6 Click Attach Now.

Once you configure your test program, you can attach to the audit system by choosing Program|Attach.

Starting on a different machineTesting a Java program running on a different machine is similar to testing a Java program started from the command line:

1 Set up the Optimizeit audit system, as described in “Setting up the audit system” on page 16.

2 Launch the Optimizeit audit system, specifying your test program, as described in “Launching your program” on page 16.

3 Start your selected Optimizeit tool and connect the audit system to the Optimizeit user interface using Remote Application as the Program type, as described in “Connecting the audit system” on page 21.

4 In the Host Name field, enter the name of the machine running the test program.

5 Click OK when you have finished entering your test information in the Settings dialog box.

6 Choose Program|Attach to attach Optimizeit to the test program.

Using the Filter EditorFilters must be specified before you run your test program, when you specify your virtual machine. For this reason, Optimizeit has command-line functions to create, modify, and specify filters from outside of Optimizeit. This is required when you are testing a remote application.

The Optimizeit Filter Editor creates and edits filter files for use in remote and offline (batch) testing. These filter files, which use a .oif extension, are specified in an Optimizeit command.


Using the Fi l ter Edi tor

Because it is used for both Profiler and Code Coverage, the Filter Editor dialog box has columns for both Profiler and Code Coverage filter operations. Only one column, Ignore Coverage, is applicable for Code Coverage testing. Ignore Coverage combines the two Code Coverage filter options, Include Class and Exclude Class, into one column.

To use this program:

1 Make sure you have integrated with an application server and chosen your virtual machine.

2 Start the Filter Editor:■ If you are on a UNIX machine, go to your root Optimizeit directory and

enter ./Editfilter.sh at the command prompt.■ If you are on a Windows machine, select the Optimizeit Filter Editor from

your Optimizeit program menu, or double-click on the Filter Editor executable icon in your Optimizeit root directory.

3 The Filter Editor opens:

Click New to create a filter, or double-click on one of your filters to edit that filter. You can also choose an existing filter from the Filter Editor File|Open command to use as a starting point.

4 Check the applicable column(s) for your filter:■ To filter methods, click in the Simplification Type column.

This column has two options:■ Group: select the Group option to condense methods of multiple

classes into one single line in your stack trace. To use this option, specify a set of classes to filter and give it a name as an identifier. When you access the stack trace, all calls to the filtered methods are condensed into one entry, labeled with the name you specified.


Using the Fi l ter Edi tor

For example, if your unfiltered back trace lists classes such as:

org.apache.catalina.core.x...org.apache.catalina.core.y...org.apache.catalina.core.z...javax.servlet.http...Myservlet...

you can group your Apache classes under the name Apache classes, and the filtered output for the same section shows:

Apache classesjavax.servlet.http...Myservlet...

This is especially useful for servlets.■ Eliminate: select Eliminate to filter these methods from your results.

The code matching this group is ignored, and will not show up in your backtraces. The time spent in this eliminated group will be associated with the caller.

Note The Eliminate simplification type is more efficient than Ignore CPU. Typically, you should select Eliminate for Simplification Type, and not enable Ignore CPU when enabling a filter.

■ To ignore CPU or time usage consumed by Java code matching the filter pattern, click the Ignore CPU column.

Any time spent in the filtered method will be unaccounted for in the backtrace. Ignore CPU is more precise than Eliminate, in that it assigns the correct amount of time spent to the methods in the backtrace, but Eliminate is useful in that all time is accounted for in the backtrace.

■ To enable a filter for the Memory Profiler, click the Ignore Memory column. Optimizeit Profiler ignores object allocations performed by Java code matching the filter pattern.

■ To enable a filter for a Code Coverage class, click the Ignore Coverage column. This filter excludes a class from testing.

If you want the reverse (the equivalent of the Include Coverage filter option in Code Coverage) use the not (!) character.

1 To see the patterns associated with a filter, double-click on the filter in the table or highlight the filter and click Details.

2 Make your selections and chose the Filter Editor’s File|Save option to save your filter file. This creates an .oif file that can be accessed by command-line test runs.

Custom filters are part of Optimizeit configuration files. They are saved and loaded when using Save and Open commands from the File menu.

Note If you select more than one filter for a test run, Optimizeit always performs a logical OR of all the filters you have selected. Any top-level package, class, or method that meets any of the filter criteria is filtered.


Start ing from the test program

You can also create and edit filters in the Filter Editor. For information on how to create and edit filters, see “Using the Filters tab” on page 9.

Starting from the test programIn some environments, the Java virtual machine is started automatically. The Optimizeit audit system can be invoked from the test program using the Profiler or Code Coverage application programming interface (API). To invoke Optimizeit from inside your test program:

1 Set up the Optimizeit audit system, as described in “Setting up the audit system” on page 16.

This is done in exactly the same way for all command-line or batch testing.

2 Add API calls in your program, as described in “Adding API calls in your program” on page 25.

3 Launch the Optimizeit audit system, specifying your test program, as described in “Starting your test program” on page 26.

4 Start your selected Optimizeit tool and connect the audit system to the Optimizeit user interface using Remote Application as the Program type, as described in “Connecting the audit system” on page 21.

5 In the Host Name field, enter the name of the machine running the test program.

6 Click OK when you have finished entering your test information in the Settings dialog box.

7 Choose Program|Attach to attach Optimizeit to the test program.

Adding API calls in your program

The following example shows how to start the Optimizeit Code Coverage audit system from Java code.

import intuitive.audit.Cover;void startAuditSystem() { /** Start the Optimizeit Code Coverage audit system with some default options **/ Audit.start(1472, Cover.DEFAULT_OPTIONS);}

Once the Code Coverage audit system has been started, Optimizeit Code Coverage starts retrieving the test information when the Java code is executed.

See also■ For more information about Optimizeit Code Coverage Audit API, read the

API reference documentation.


Star t ing from the test program

Starting your test program

Although the test program starts the audit system, extra parameters need to be added to the code or to the shell script that starts the virtual machine.■ Start the Code Coverage tool with the -Xruncci command option and specify

the filter file to be used.■ Set the bootclasspath so it includes the Optimizeit oibcp.jar file.

On Windows:

java -Xruncci:filter=<OptItDir>\filters\DefaultAllOn.oif -Xbootclasspath/a:C:\Optimizeit\CCoverage\lib\oibcp.jar TestProgram

On UNIX:

java -Xruncci:filter=<OptItDir>/filters/DefaultAllOn.oif TestProgram

Chapter 4: Using Class Coverage 27

C h a p t e r

Chapter 4Using Class CoverageOptimizeit Code Coverage has two ways to view results: Class Coverage and Method Coverage. By default, when you start Optimizeit Code Coverage, the Class Coverage view opens. To return to Class Coverage from Method Coverage, click the Class Coverage button on the main menu bar.

Class Coverage lists all classes and the real-time test results for each class. You can see how many lines have not been executed, and can apply filters to test only certain classes.


Using Class Coverage

The Class Coverage table contains these columns:

To sort the values in columns of the table, click on the column header.

The Filters box at the bottom allows you to select the classes that you want to view. The classes that you exclude will still be tested, but Optimizeit will not show them in the results.

Note This is different from the filters you set before the test is run, using the Filter Editor. Those filters, contained in .oif files, select which classes are tested.

For example, to see only the classes from the com.sun.estore.inventory package, enter the following in the filter box:

com.sun.estore.inventory.*

Both the asterisk wildcard character (*) and the not character (!) are supported. It is also possible to enumerate more than one pattern using a comma (,) separator. For example, to see all classes matching EJB except those ending with Impl:

*EJB*, !*Impl

To see all tested classes, either clear the filter completely or type an asterisk (*).

Column Description

Class Name All the classes that will be tested with the selected filters. If a class has not yet been loaded, Not Loaded appears on that row.

Coverage % The percentage of coverage for each class. When the classes have been compiled with line debug information (the default when you use javac) this percentage represents the number of lines of code that have been tested compared to the overall number of lines of code for that class.

If the line debug information is not available (because the classes were compiled with the -g:none option), this percentage represents the number of methods from that class that were executed compared to the total number of methods.

Tip: For more accurate test results, do not compile your application using the -g:none option.

Diff. Similar to the Coverage column, but only shows the coverage occurring since the last mark.

Chapter 4: Using Class Coverage 29

Control l ing the test program

Controlling the test programThe Optimizeit tool bar provides the following buttons to control the test program run:

Mark and Inspector optionsTwo of the tool bar icons, Mark and Inspector, have special functions in Class Coverage:

Starts or resumes the test program. This control is red when the test program is running.

Pauses or resumes the test program. Use this button to freeze the flow of execution to better study the interaction between different parts of the tested program.

Stops testing. If you are running your test program from within the Code Coverage user interface, the program will stop and the test will end. If you are connected to a remote server, and the test program is running on the remote machine, Stop will just disconnect your Code Coverage user interface. The test program itself will keep running on the remote server.

Click Mark to set a mark at any time. This resets the values in the Diff. column of the Class Coverage table. If you set the mark before a specific action in your application, you can see how this action affects the testing of your classes.

Click Inspector to view the options for the Class Coverage display.


Mark and Inspector opt ions

Table 4.1 Inspector options for Class Coverage

Option Description

Show Line Coverage Adds columns displaying the number of missed lines and number of missed lines since the mark (missed line diff). The information is displayed in the form:

missed lines / total number of lines

The Missed Lines Diff column shows the number of lines of code that have not been executed since the mark.

Note: These columns display N/A (Not Applicable) if the class has been compiled without the line information, or if the row describes coverage of an interface.

Show All Accessible Classes Displays all the classes accessible from the CLASSPATH and not filtered out by the specified filters. This includes the classes not loaded in the virtual machine.

Code Coverage reports the classes not loaded by looking through the CLASSPATH. Any class found in the CLASSPATH is reported if it is not filtered out by the specified filter file. Set the java property ccoverage.classpath if you want Code Coverage to use a different path. The following commands start the testing of an application and use different paths to search for classes that are not loaded.

On Windows:

c:\ java -Xruncci:filter=<OptItDir>\filters\DefaultAllOn.oif -Xbootclasspath/a:c:\Optimizeit\CCoverage\lib\oibcp.jar intuitive.audit.Cover MyApp

c:\ java -Xruncci:filter=<OptItDir>\filters\DefaultAllOn.oif -Xbootclasspath/a:c:\Optimizeit\CCoverage\lib\oibcp.jar -Dccoverage.classpath=d:\StoreEJBs.jar;d:\classes intuitive.audit.Cover MyApp


$ java -Xruncci:filter=<OptItDir>/filters/DefaultAllOn.oif -Xbootclasspath/a:/opt/sfw/Optimizeit/CCoverage/lib/oibcp.jar -Dccoverage.classpath=/home/StoreEJBs.jar:/home/classes intuitive.audit.Cover MyApp

Show Interfaces Displays the interfaces that have been loaded by the virtual machine.

Chapter 5: Using Method Coverage 31

C h a p t e r

Chapter 5Using Method Coverage Once you have identified a class you would like to investigate in the Class Coverage view, highlight this class in the table and either click the Method Coverage button on the tool bar or double-click on the line in the Class Coverage window. Optimizeit Code Coverage opens the Method Coverage view.


Method Coverage window opt ions

Method Coverage window optionsIn the top pane, the Method Coverage table lists all the methods of the selected class. All the methods appear in the same order as in the class file. The table contains these columns:

In the bottom pane, the source code table displays the source code for the class being reviewed. The lines that have been tested are highlighted in yellow. If you select any method in the method table, the source code table displays that particular method.

The table contains these columns:

Note If the class file for the selected class does not include the debug line information, the source code table displays a message explaining that the

Column Description

Method Name Name of the method

Note: This name includes the signature of the method if the Show Method Signatures option in the Inspector is selected.

Coverage % Percentage of code tested for the method, computed as:

tested lines / total number of lines

for that method.

Note: If the class file for the selected class does not include the debug line information, the method table only displays the method name and invocation count. To include the line information in your class files, use the -g option when compiling.

Invocation Count Number of times the method has been called.

Missed Lines Number of lines not tested.

Column Description

# Line numbers in the file, retrieved from the debug line information included in the class files. In the class file not all lines of code are significant, so the compiler does not generate bytecode for all the lines of code. The lines that do not correspond to bytecode will have no number of calls reported in the source code table and are disregarded when computing the coverage.

Source code Percentage of code tested for the method, computed as:

tested lines / total number of lines

for that method.

Note: If Optimizeit Code Coverage cannot find the source file for that class from the source path, it displays a message that the source file could not be found. Click the Browse button to search for the source file manually.

Calls Number of times each line of code has been called.

Chapter 5: Using Method Coverage 33

Control l ing the test program

class was compiled without the debug line information. To include the line information in your class files, use the -g option when compiling.

You can refresh the values in the tables by selecting File|Reload.

Controlling the test programThe Optimizeit tool bar provides the following buttons to control the test program run:

Mark and Inspector optionsTwo of the Optimizeit tool bar icons, mark and inspector, have special functions when the Method Coverage window is open.

Starts or resumes the test program. This control is red when the test program is running.

Pauses or resumes the test program. Use this button to freeze the flow of execution to better study the interaction between different parts of the tested program.

Stops testing. If you are running your test program from within the Code Coverage user interface, the program will stop and the test will end. If you are connected to a remote server, and the test program is running on the remote machine, stop will just disconnect your Code Coverage user interface; the test program itself will keep running on the remote server.

Click Mark on the tool bar to set a mark. This resets the Invocation Count and Missed Lines columns in the method table, and the Diff column in the source code table. The source code table only contains a Diff column if you choose the Show Difference option in the Inspector.

Click Inspector to view the options for Method Coverage display:

Table 5.1 Inspector options for Method Coverage

Option Description

Real Time Switches the coverage information to real time in the tables.

Show Method Signatures Includes the signatures of the methods in the Name column of the method table.


Mark and Inspector opt ions

Show Difference Adds the Invocation Count Difference and Missed Lines Difference columns to the method table. These columns show the information since the last mark.

Also adds the Diff column in the source code table. This column shows how many times each line of code has been executed since the last mark was set, if the line information is available for that class.

Highlight Since Mark Causes the source code table to highlight the lines of code that have been tested since the last mark.

Table 5.1 Inspector options for Method Coverage (continued)

Option Description

Chapter 6: Report ing features 35

C h a p t e r

Chapter 6Reporting featuresThis chapter describes the features available in Optimizeit Code Coverage to generate reports and other types of information from your test runs. These reporting features include the following:■ Snapshots, binary files that you can reopen in Optimizeit at a later date to

compare test results■ Test reports, HTML or ASCII files that contain all the test data for the

current test run, regardless of which view you are currently in■ Data exports, HTML or ASCII files that contain just the test information

from your current, open view

The following sections explain how to use Optimizeit’s reporting features:■ “Generating snapshots”■ “Merging snapshots”■ “Generating reports”■ “Exporting data”■ “Displaying console messages”

Generating snapshotsAt any time, Optimizeit Code Coverage allows you to save test information into a snapshot. You can then reload the snapshot later for further analysis. This is useful, for example, when you are testing several different classes in one test pass. Snapshots are generated from within the Optimizeit user interface or


Merging snapshots

with a specific command option when running Code Coverage from the command line.

To generate a snapshot

1 Choose File|Generate Snapshot.

2 In the Directory field, enter the directory where you would like the snapshot to be saved.

3 In the Name field, enter the name for the snapshot.

4 If you would like to have the time and date added to the end of the name you have chosen, check Append Time And Date When Saving.

5 Use the Notes area to add any comments.

6 Click Write Snapshot to create the snapshot.

To open a snapshot:

1 Choose File|Open snapshot or File|Open recent snapshots.

2 Double-click a recent snapshot, or highlight a snapshot and click Open, to view the snapshot’s test results. It may take a few moments to load, because a snapshot uses a VM to display data. The VM installed with Optimizeit is used to load the snapshot.

3 You can navigate through all available modes, but you cannot perform real-time actions such as starting or pausing the test run or setting a mark.

Snapshots are binary files that can only be opened from within Optimizeit user interface. If your snapshot takes a long time to load, and your connection times out before the load is completed, you can increase the connection time-out using the Launch option from Edit|Preferences.

Merging snapshotsCode Coverage includes a command-line executable, Snapmerge. Snapmerge creates merges of selected snapshots. This is useful, for example, if you have QA teams testing different areas of the product. The QA


Merging snapshots

teams can merge their test snapshots to give a complete view of the tested classes. To use:

1 Create a series of snapshots during a testing session. These snapshots could be of different time points in your test session, or of different functions in the same product.

2 Note the names of the snapshots you want to merge.

3 From a command prompt, access the root directory for your Optimizeit installation. For example, /home/OptimizeitSuite.

4 Enter the following command:

snapmerge mergefile.snp snap1.snp snap2.snp snap3.snp

where mergefile is the name of the file for all the merged snapshots and snapx are the filenames of the snapshots you want to merge. Include all file extensions, or the program will not be able to access your files.

Any warnings are displayed by default. If you do not want to see any error or warning messages, use -noWarnings in your command.■ A command example on Windows:

c:\Optimizeit\OptimizeitSuite\snapmerge.exe snapmerged.snp snapshot1.snp snapshot2.snp snapshot3.snp

This command merges the three snapshots c:\MyApp\snapshot1.snp, c:\MyApp\snapshot2.snp and c:\MyApp\snapshot3.snp into the new snapshot c:\MyApp\snapmerged.snp.

■ A command example on Solaris or Linux:

/user/local/OptimizeitSuite/snapmerge - noWarnings /home/MyApp/snapmerged.snp /home/MyAp/snapshot1.snp /home/MyApp/snapshot2.snp /home/MyApp/snapshot3.snp

This command merges the three snapshots /home/MyApp/snapshot1.snp, /home/MyApp/snapshot2.snp, and /home/MyApp/snapshot3.snp into the new snapshot /home/MyApp/snapmerged.snp and turns off Optimizeit snapmerge warning and error messages.

5 To view your merged snapshot, re-enter Code Coverage.

Note Make sure you have stopped any testing sessions, because Code Coverage cannot open snapshots when the virtual machine is running.

6 Choose one of the Open Snapshot commands from the File menu and browse for your merge file.

7 Double-click on the merge file to open it in Code Coverage. You will see a merge of test information from the snapshots you selected.

Any merged snapshot can be reopened in Optimizeit Code Coverage (see “Generating snapshots” on page 35), merged again with other snapshots, or used to generate a report.


Generat ing reports

Generating reportsCode Coverage supports both command line- and user interface-accessed report functions.

Generating a report from within Code Coverage

If you are testing an application, or if you have opened a snapshot, the Report option within Code Coverage allows you to save the test information in either ASCII or HTML.

To generate a report, choose File|Generate Report or click Generate Report:

Note Although this button looks the same as the Optimizeit Profiler Export button, in Code Coverage it is used for reports.

To export data, choose File|Export Data.

1 In the Directory field, enter the directory where the report will be created.

2 In the Name field, enter the filename of the report.

3 Check Append Time And Date When Saving to have the current time and date appended to the name of the report.

4 In the Generate Report As field, select which type of file is to be used for the report: HTML or ASCII.

5 In the Options section, check the options you want to use for this report:■ Check Include Method Coverage if the method coverage should be

included in the report. When this option is not selected, only coverage for the classes is included in the report.

■ Check Include Source Code if the source code should be included in the report.


Generat ing reports

■ Check Show Difference to include the Diff columns, showing the test information since the last mark. Both class coverage and method coverage marks are included.

■ Check Show Method Signature to include the signature in the name of the method.

6 Add any additional text, such as a description of the context of the test session, in the Notes field.

7 Click Write Report to generate your report.

After generating a report with the specified filename, Optimizeit Code Coverage opens the report file in your default editor or web browser.

Generating a report from the command line

At the command line, you can generate a report from a testing snapshot using the ReportGenerator class. A coverage report presents the test information for all covered classes. You can customize your report with ReportGenerator options.

To generate a report from a snapshot, modify your environment variables:■ On Windows:

■ add <OptItDir> to the PATH■ add <OptItDir>\lib\optit.jar to the CLASSPATH

■ On UNIX:■ add <OptItDir>/lib to the LD_LIBRARY_PATH■ add <OptItDir>/lib/optit.jar to the CLASSPATH

After you have modified you environment variables, invoke the Optimizeit Code Coverage ReportGenerator class:

java intuitive.optit.coverage.ReportGenerator [-methodInfo] [-showDiff] [-showSignatures] [-reportType FileType] [-verbose] [-showSource] [-sourcePath SourcePath] snapshot report

This table describes the ReportGenerator options:

Option Description

-methodInfo Includes the method test information. For each tested class, the report includes a table with the test results for each method of the class.

-showDiff Includes the diff information, which is the test information since the mark.

-showSignatures Displays the full name of methods, including their signatures.

-reportType Should be followed by a document type (either HTML or ASCII). Specifies the type of the report generated. The default value is HTML.


Export ing data

ExamplesThe following command generates the report stressTest.html from the snapshot stressTest.snp, including the method coverage information.

On Windows:

java intuitive.optit.coverage.ReportGenerator -methodInfo c:\Test\stressTest.snp c:\Test\stressTest.html


java intuitive.optit.coverage.ReportGenerator -methodInfo /home/jay/Test/stressTest.snp /home/jay/Test/stressTest.html

The following command generates the report EJBs_coverage.html from the snapshot test5.snp, including the method information. The methods display with their full signature. The source code with line coverage information is included. The source file for the tested classes is located under the directory c:\EJB_src.

On Windows:

java intuitive.optit.coverage.ReportGenerator -methodInfo -showSignatures -showSource -sourcePath c:\EJB_src test5.snp EJBs_coverage.html

On UNIX:

java intuitive.optit.coverage.ReportGenerator -methodInfo -showSignatures -showSource -sourcePath /home/jay/EJB_src test5.snp /home/jay/EJBs_coverage.html

Exporting dataOptimizeit can export test data as ASCII, HTML, or Importable ASCII. After the data is exported it can be printed, compared, and archived.

To export the contents of a screen:

-verbose Prints information about the status of the report generation.

-showSource Includes the source code (when available) and line coverage for the tested classes. (This option is only effective with the -methodInfo option.)

-sourcePath Should be followed by the path to the source files of the classes tested. This option should be used to specify the location of the source code when the -showSource option is used.

Option Description


Displaying console messages

1 Choose File|Export Data. The Export Data dialog box opens:

2 In Export, choose the coverage type you want in your report, such as Class Coverage or Method and Source Code Coverage. Your options will depend upon what view is active.

3 In Export As, choose the output of the file format. Select HTML to produce an HTML document that presents data in the same format as the Optimizeit views. Select ASCII for a more compact file. Select Importable ASCII if you expect to use the output as input to another tool.

4 In the Filename field, enter the full path name of the file.

5 If this file already exists, and you want to append the new data at the end of the file, check Append Data At The End Of The File.

6 Use Title to insert a description at the top of the exported document.

7 If you wish, use the Comments section for information such as additional text to distinguish this test from others.

8 Click OK to export the data.

After exporting the data into the specified file, Optimizeit opens the file with the default editor or web browser.

Displaying console messagesThe Console button prints audit system messages as well as the test program standard output and standard error messages. Use the console output to read messages from the test program or to see errors if the Java program does not start.

Note If you add Open A Console to your start options, the standard output and the standard error messages of the test program won’t be redirected to the Optimizeit Code Coverage console.

Chapter 7: Sett ing your preferences 43

C h a p t e r

Chapter 7Setting your preferencesThis chapter describes how to use the Edit|Preferences menu option to set defaults for Optimizeit Code Coverage. You can set these defaults:■ Selecting default displays■ Setting launch parameters■ Setting the source code location■ Changing the class path■ Selecting a virtual machine■ Configuring servlet support

Your choices will appear in the Settings dialog box, where they can be customized for each applet or application you are testing.

Selecting default displaysAlthough the Edit Settings dialog box opens by default when you enter Code Coverage, you can set a new default using the Startup option on the Preferences pull-down menu. You can also determine the mode that testing will begin in.


Sett ing launch parameters

The Preferences dialog box, Startup view determines the default mode once testing begins. Click Default display to choose your default workspace, such as Class Coverage or Console.

Click the After Startup, Open pull-down menu to choose which window opens in the default workspace:■ Settings Editor—choose Settings Editor if your settings change depending

upon which test case you are running.■ Attach Panel—choose Attach Panel if you usually test your programs from

outside of Optimizeit.■ Nothing—choose Nothing if you rarely change your default settings, and

want to go directly to the default view when you open Code Coverage.

Click OK to close the form. The next time you open Optimizeit, your new defaults are activated.

Setting launch parametersThe Launch menu option lets you set your connection time-out and default port:■ By default, the connection time-out is set at ten seconds. If your connection

is timing out before you can access all the required information (for example, when you are loading a large snapshot), then you can make this option larger.

■ The default port for Code Coverage is 1472.

Important Make sure to use the correct port when you attach.

When you integrate Optimizeit with an application server, you start the Optimizeit audit system inside the virtual machine of the application server. By attaching the Optimizeit GUI to the audit system, you test the virtual machine of your application server and get the test information for your servlets/JSPs/EJBs.


Sett ing the source code locat ion

Optimizeit uses a port to get the test information from the audit system running in your application server. This port is only used by Optimizeit and is not related to any port of your application server. The default value for that port is 1472. If you start your application with Optimizeit from a script, the port is specified in the script. If you use the Optimizeit servlet to start the audit system, the port is specified from the servlet.

Setting the source code locationWhen Optimizeit Code Coverage has access to the source code for an application, it highlights the relevant lines as they are run. If the source code is not accessible, Optimizeit Code Coverage can still provide testing results for Java classes.

Optimizeit Code Coverage maintains a source path, which is a list of directories containing source code. When it requires a source file, Optimizeit Code Coverage searches each directory in the source path in the order specified.

Changing the default source path

The Preferences panel can be used to change the default source path:

1 Choose Edit|Preferences.

2 Click on Default Source Path in the top selection box.

3 Click the Edit button. The Source Path Chooser opens.

4 In the top box, either:■ Use the browser to search for and select the directory, JAR file, or ZIP

file you want to add.

If you select a directory, choose the directory that contains the top-level package of your Java source code. If you aren’t sure, select any Java file in your application and Optimizeit Profiler adds the appropriate directory. If you select a JAR or ZIP file, Optimizeit looks for a source file from the root of the JAR or ZIP content or from the src directory in the package.

■ Use the empty field under the browser if you have a multi-entry source path, such as c:\src;d:\project\src.jar. Enter your full path information into the field.

5 Click the Down Arrow button to add your selection to the source path. If you entered a multi-entry source string, Optimizeit adds all the entries to the source path.

6 Repeat these steps for other directories you would like to add to the source path.

7 Click the OK button.

8 Click the OK button again to close the Preferences dialog box.


Changing the class path

Note When Optimizeit Code Coverage is testing an application, if a Java file is not available, you will be prompted to locate the file. After you locate the missing Java file, a dialog box prompts you to add the file’s directory to the default source path.

To set a different source path for an applet, servlet, or application that you are testing with Optimizeit Code Coverage, define the changes to the default source path in the Settings dialog box.

Changing the class pathWhen Optimizeit launches your applet or application, the Java virtual machine needs the location of all classes your application uses. By default, Optimizeit points to the classes that are defined in your CLASSPATH environment variable.

The CLASSPATH environment variable is a list of directories containing class files. Optimizeit searches each directory in the class path in the order they appear. If there are certain classes, ZIP files or JAR files that you would like to always be available for all test programs, add them to the default Optimizeit class path using the Settings dialog box or the Edit|Preferences menu option.

To customize the CLASSPATH using Edit|Preferences:

1 Choose Edit|Preferences.

2 Click on Default Class Path in the top selection box:

3 Uncheck the Use CLASSPATH Environment Variable option.

4 Click the Edit button.

The Class Path Chooser opens.

5 In the top box, either,■ Use the browser to search for and select the directory, JAR file, or ZIP

file you want to add to the class path. If you select a directory, choose the directory that contains the top-level package of the source tree.


Select ing a v i r tual machine

■ Use the empty field under the browser if you have a multi-entry class path, such as c:\classes;d:\project\xmlParser.jar. Enter your full path information into the field.

6 Click the Down Arrow button to add your selection to the class path. If you entered a class path string, Optimizeit adds all the entries to the class path.

7 Click the OK button.

8 Click the OK button again to close the Preferences dialog box.

Selecting a virtual machineYou can add and set your virtual machine using the Virtual Machines tab on the Settings dialog box, and you can also set your default virtual machine and add virtual machines from the Virtual machine option of the Preferences dialog box:

1 Choose Edit|Preferences from the main menu bar.

2 Click on Virtual Machine in the top selection box:

3 Click Setup.

This starts the virtual machine wizard.

4 Click Next.

5 Select a directory.

Optimizeit will begin the search for a virtual machine from this point.

6 Click Search.

Optimizeit Code Coverage displays the virtual machines found.

7 Click Finish to add these virtual machines to the list of available virtual machines.

8 Highlight the virtual machine you would like to be the default, and click OK to set the default.


Conf igur ing servlet support

Configuring servlet supportThe Servlet option on the Preferences menu allows you to configure servlet/JSP testing.

1 Choose Edit|Preferences from the top menu.

2 Click on Servlet in the top selection box:

3 The Path To The Tomcat 4 Server Used field contains the current path to your Tomcat installation, if any. You can enter a path or change the existing path to point to this application, which is required for direct servlet/JSP testing.

4 If you are unsure of the correct directory for your Tomcat application, click Servlet Setup to open the Setup wizard and browse for the correct location.

5 Edit the Directory Used For Temporary Files field if the default location is too small or is not easily accessible.

6 By default, Code Coverage filters out Tomcat classes so you can concentrate on the testing of your application. Uncheck this option if you need to see the interaction between your tested application and Tomcat classes.

7 In the Tomcat configuration section, you can choose to either automatically generate the server.xml file (the default option), or you can use an existing server.xml file if you already have one that you have used for other Tomcat operations. You can browse for the correct file and double-click to select it, or you can enter it in the file path field directly.

8 When you start the direct testing of a servlet or JSP, Code Coverage runs your servlet in a servlet runner. The default port used by the servlet runner is 8080. If you have another application that already uses that port, change the value of the port in the Port Used By Tomcat field.

9 Click OK to save your changes.

Chapter 8: Troubleshoot ing 49

C h a p t e r

Chapter8Troubleshooting

Starting your application1 My application starts correctly, but an alert explaining that Optimizeit failed

to attach is displayed.

2 My application ran successfully, but the Optimizeit tools are not working correctly. Most of the buttons are disabled, and the views do not contain information.

3 When starting my application, I get an alert reporting a Class not found.

4 When starting my application, the console reports that my JDK is not supported.

5 When starting my applet, the console returns java.util.MissingResourceException: Can’t find resource at java.util.ResourceBundle.getObject.

6 My application or applet cannot be started from the Optimizeit user interface. What should I do next?

7 When starting my application, the console reports a java.lang.UnsatisfiedLinkError.

8 When starting my application, the console returns an error message that it cannot find or could not locate an entry point or field.

9 (Windows only) When starting my application, the console appears but closes immediately, Optimizeit times-out and I get a warning that Optimizeit was not able to attach to my application.


Start ing your appl icat ion

10 (UNIX only) I cannot start Optimizeit. The Optimizeit script fails with the error Class not found: intuitive.optit....

11 (Solaris only) Does Optimizeit support JDK 1.2.x? When configuring Optimizeit to use JDK 1.2.x, an error box reports that JDK is incompatible with Optimizeit.

12 (Solaris only) Does Optimizeit support JDK 1.3? When configuring Optimizeit to use JDK 1.3, an error box reports that JDK is incompatible with Optimizeit.

1 My application starts correctly, but an alert explaining that Optimizeit failed to attach is displayed.

Optimizeit uses a default connection time-out of 60 seconds on Windows or 20 seconds on UNIX machines to attach to the virtual machine.

In some environments, the Optimizeit audit system may require more than the default time-out to initialize. If this happens, choose Edit|Preferences, select the Launch section and increase the connection time-out value.

2 My application ran successfully, but the Optimizeit tools are not working correctly. Most of the buttons are disabled, and the views do not contain information.

Optimizeit’s audit system runs inside the same virtual machine as the tested application. If the tested application ends, the virtual machine exits and Optimizeit loses contact with its audit system and cannot retrieve data (a Test program exited alert pops up in Optimizeit).

To resolve this problem, Optimizeit provides an option to disable the Java method System.exit(). This option can be enabled either by using the VM Cannot Exit or Disable Exit option in the Settings dialog box or by using the command line option -noexit (java ... intuitive.audit.Audit -noexit ...). That way the virtual machine will not exit when your application ends. Use the Stop button in Optimizeit to exit the program when your testing is complete.

If you are starting your test from the command line, or testing remotely, the -Xrunoii argument uses the configuration of the Audit System Selector. Make sure your Audit System Selector is not set to none. On Windows machines, your selected tool appears in the Windows icon tray. The Optimizeit icon is red for Profiler, green for Thread Debugger, and blue for Code Coverage.

If you have integrated Optimizeit with an application server, make sure that you are attaching the correct tool to the Audit process started with your application server. If, for example, the Audit System Selector has the Thread Debugger tool selected and you started your WebLogic tool with Thread Debugger, then you must attach with the Thread Debugger tool.

3 When starting my application, I get an alert reporting a Class not found.

This error is very likely related to a CLASSPATH setting problem. Open the Settings dialog box, and make sure that the Class Path window includes the paths to the packages and classes required by your application.



4 When starting my application, the console reports that my JDK is not supported.

The virtual machine you are using is not supported by Optimizeit. See the Release Notes for a complete list of supported JDKs. Make sure to select a supported virtual machine in the Virtual Machines tab of the Settings dialog box.

5 When starting my applet, the console returns java.util.MissingResourceException: Can’t find resource at java.util.ResourceBundle.getObject.

Optimizeit starts your applet in the Sun applet viewer in order to test it. The applet viewer throws that error when the HTML file of your applet specifies the size of your applet in percent. Make sure that the HTML file you are using to start your applet uses hard values for the width and height.

6 My application or applet cannot be started from the Optimizeit user interface. What should I do next?

The best way to investigate the cause of the problem is to start your application from the command line. This may give more information. For complete instructions on how to start Optimizeit from the command line and all available start options, please see Chapter 3, “Running Optimizeit from the command line.”

If that still does not help, contact Borland Technical Support. Remember to include the version of the operating system you are running, the version of Optimizeit and the version of the JDK you are using, and give as much information as possible about the problem. The more information you provide the quicker and more effective the response from the support team!

7 When starting my application, the console reports a java.lang.UnsatisfiedLinkError.

This error may happen if for some reason Optimizeit loads a library of an older version of Optimizeit. If you have a previous version of Optimizeit installed, make sure that your LD_LIBRARY_PATH does not point to this older version.

On Windows machines, this problem can also happen if you have integrated a previous version of Optimizeit with an IDE or an application server. When you integrate Optimizeit with an IDE or an application server, the wizard that performs the integration may copy the Optimizeit library oii.dll in the Windows directory or in the IDE directory. The PATH may still reference the IDE directory causing the old oii.dll to be used, even if you have uninstalled the previous version of Optimizeit. To make sure the correct oii.dll is used, perform a find on your hard drives for the oii.dll library. Remove any oii.dll that is not located under the Optimizeit directory.

8 When starting my application, the console returns an error message that it cannot find or could not locate an entry point or field.

This error may happen if you have two versions of the dynamic link library oii.dll on your system. This can also occur if you have an older oibcp.jar



or optit.jar in the CLASSPATH or bootclasspath and/or you are loading the older oii.dll, pri.dll, or auditjni.dll instead of the newer ones. When you upgrade to a new version of Optimizeit, make sure all older versions of these files are deleted.

9 (Windows only) When starting my application, the console appears but closes immediately, Optimizeit times-out and I get a warning that Optimizeit was not able to attach to my application.

The console may flash when you are using a JDK or JRE located in a path with spaces in the path name. In the Virtual Machines tab of the Settings dialog box, make sure to select a virtual machine located in a path without spaces.

10 (UNIX only) I cannot start Optimizeit. The Optimizeit script fails with the error Class not found: intuitive.optit....

If your DISPLAY environment variable is set to a display that does not exist, the Optimizeit script fails with the message Class not found: intuitive.optit.toolclassname. This message is sent by the virtual machine that Optimizeit uses and is not accurate. Make sure to set your DISPLAY to a correct value.

For example on a machine named asterix, the DISPLAY is set with the command:

export DISPLAY=asterix:0

11 (Solaris only) Does Optimizeit support JDK 1.2.x? When configuring Optimizeit to use JDK 1.2.x, an error box reports that JDK is incompatible with Optimizeit.

You may be running the JDK 1.2.x production release. Optimizeit for Solaris does not support this JDK. The JDK 1.2.x production release does not implement JVMPI well. JVMPI is the low-level API from Sun used to retrieve information from the virtual machine. Optimizeit fully supports the JDK 1.2.x reference implementation.

12 (Solaris only) Does Optimizeit support JDK 1.3? When configuring Optimizeit to use JDK 1.3, an error box reports that JDK is incompatible with Optimizeit.

JDK 1.3 is not supported by Optimizeit for Solaris. JDK 1.3 only comes with a Hotspot runtime on Solaris, and the Hotspot runtime has several bugs in its JVMPI implementation. JVMPI is a low-level API from Sun used to retrieve information from the virtual machine. Because of these bugs, Optimizeit cannot test reliably with the JDK 1.3.

These problems have been fixed in JDK 1.3.1 (j2se 1.3.1). Make sure to either configure Optimizeit with JDK 1.3.1, or to use the JDK 1.2.2 reference implementation.

JDK 1.3.1 can be downloaded from http://java.sun.com/j2se/1.3/download.html.

JDK 1.2.2 can be downloaded from http://java.sun.com/products/jdk/1.2/download-solaris.html.

Start ing your appl icat ion server

Starting your application server1 (Windows only) Starting the testing in the VisualAge WebSphere Test

environment does not work. The browser reports an error message Error 503: Application is currently unavailable for service.

2 (Solaris only) When starting my application server with the parameters required by Optimizeit, it fails to start and displays the error Cannot find JVMPI(-3).

3 (UNIX only) My application server no longer starts since I configured it with Optimizeit.

4 My application server starts, but when I try to attach from Optimizeit I get a crash or an error dump.

5 Why can’t I attach from the Optimizeit GUI? Which port should I use to attach? Why is no test information displayed when I attach?

6 (Windows only) Starting an applet from JBuilder does not work. Optimizeit displays virtual machine not found error messages.

1 (Windows only) Starting the testing in the VisualAge WebSphere Test environment does not work. The browser reports an error message Error 503: Application is currently unavailable for service.

This problem happens if the JSPs are enabled in the web application you are trying to test with Optimizeit. Unfortunately testing JSPs is only possible inside VisualAge. So when you want to run the WebSphere Test Environment with Optimizeit, you need to disable the JSPs. To do that, edit the file <VisualAge_Dir>\ide\project_resources\IBM WebSphere Test Environment\hosts\default_host\default_app\servlets\default_app.webapp.

In this file, comment out the deployment information for the JSP servlet. To do that, add  after the section:

<autostart>true</autostart> <servlet-path>*.jsp</servlet-path> </servlet>

2 (Solaris only) When starting my application server with the parameters required by Optimizeit, it fails to start and displays the error Cannot find JVMPI(-3).

This problem happens because you are using the JDK 1.2.x production release. Optimizeit for Solaris does not support this JDK. The JDK 1.2.x production release does not implement JVMPI well. JVMPI is the low-level API from Sun used to retrieve information from the virtual machine. Optimizeit fully supports the JDK 1.2.x reference implementation.


Start ing your appl icat ion server

Note: To know if a JDK 1.2.x is a reference implementation or a production release, type with this JDK:

java -version

If this command returns a line starting with “Solaris VM” you are running the production release (not supported by Optimizeit), if it starts with “Classic VM” you are running the reference implementation (fully supported by Optimizeit).

3 (UNIX only) My application server no longer starts since I configured it with Optimizeit.

First, make sure to check the outputs and/or log files of your application server for any error message. Here are the most common issues:■ On Solaris machines, you may be using the JDK 1.2.x or JDK 1.3

production release rather then the JDK 1.2.x reference implementation or another supported virtual machine. Make sure to read the JDK 1.2 section for more information.

■ In your application server configuration, the LD_LIBRARY_PATH (or native library path) does not include the Optimizeit lib directory. When you configure an application server with Optimizeit, you add the parameter -Xrunoii. When the virtual machine is started with this parameter, it loads the Optimizeit library liboii.so. If it cannot find it in the LD_LIBRARY_PATH, the virtual machine fails to start. Make sure that the LD_LIBRARY_PATH, or the library path of your application server points to the Optimizeit lib directory.

4 My application server starts, but when I try to attach from Optimizeit I get a crash or an error dump.

This could be caused by one of the following issues:■ You are using an unsupported JVM. Check the Optimizeit list of

supported virtual machines in the Release Notes and make sure that Optimizeit has access to a supported JVM. If you have integrated with an application server, make sure that the application server is also using a supported JVM.

■ Your bootclasspath does not contain oibcp.jar.■ Your classpath does not contain optit.jar.■ There is an older version of the oii.dll on the machine.■ You have a Solaris machine and have not included the -Xboundthreads

option in your command.

5 Why can’t I attach from the Optimizeit GUI? Which port should I use to attach? Why is no test information displayed when I attach?

When you integrate Optimizeit with an application server, you start the Optimizeit audit system inside the virtual machine of the application server. By attaching the Optimizeit GUI to the audit system, you test the virtual machine of your application server and get the testing information for your servlets/JSPs/EJBs. Optimizeit uses a port to get the testing information from the audit system running in your application server. This port is only


Problems dur ing test ing

used by Optimizeit and is not related to any port of your application server. The default value for that port is 1470. If you start your application with Optimizeit from a script, the port is specified in the script. If you use the Optimizeit servlet to start the audit system, the port is specified from the servlet. Make sure to use the correct port when you attach.

Make sure that the process running on the remote machine is running on the port that you are attaching to. Also make sure that no other Optimizeit user interface is trying to attach to that same audit system. Only one Optimizeit user interface can attach to an audit system.

If you have other versions of Optimizeit, make sure that you have the same versions of Optimizeit installed and running on both the host and remote machine. For example, you cannot attach the Optimizeit Profiler 6.0 user interface to an Optimizeit audit system from version 4.1.

If you change test parameters (for example, you check the Disable Memory Profiler option), you must re-start your application server before beginning a new test. You must also re-start your application server to connect with another tool. For example, if you have been testing an application with Profiler and want to run a test against the same application with Thread Debugger, you must

a Shut down your Profiler test.

b Shut down your application server.

c Use the oiselector (Audit System Selector) to select Thread Debugger.

d Restart your application server.

e Start Optimizeit and attach to your test program.

For a test script, make sure that you use the correct -Xrun version for your chosen tool: -Xrunpri for Profiler, -Xruncci for Code Coverage, and -Xruntdi for Thread Debugger.

6 (Windows only) Starting an applet from JBuilder does not work. Optimizeit displays virtual machine not found error messages.

When you define a new virtual machine within JBuilder, make sure to select the executable java.exe in the bin directory, not in jre/bin.

Optimizeit uses oldjava.exe to start applets; this executable does not exist inside the jre/bin directory.

Problems during testing1 While testing my application, my application stops or crashes unexpectedly.

2 While testing my application, the application stops, the console shows a java.lang.OutOfMemoryError.

3 Why can’t I test applets with my JRE?

4 (Windows only) During a testing session, the Optimizeit user interface becomes unresponsive, and the Optimizeit window is all white.



5 The Optimizeit GUI looks wrong. The text is clipped, the windows are the wrong size.

6 Optimizeit seems to run slowly. Are there some strategies to improve performance?

1 While testing my application, my application stops or crashes unexpectedly.

Take a look at the external console. It may give more information on what went wrong. If you do not have an external console, it means you have not selected the Open A Console option in the Settings dialog box. Make sure to select the option, and start the testing again.

Also, try running the same test using the default JDK installed with Optimizeit. Sometimes, errors are related to the JVM used.

2 While testing my application, the application stops, the console shows a java.lang.OutOfMemoryError.

The virtual machine ran out of memory. You can increase the size of the java heap by using the extra java parameters -Xms and -Xmx. For example, -Xms128m -Xmx128m sets the size of the java heap to 128 Mb.

If you are starting the testing from Optimizeit, add those parameters in the Extra Java Parameters field on the Settings dialog box.

If you are starting your application from the command line, add those parameters to your command. For example, the following command starts the testing of BusyApp with the JDK 1.3, setting the size of the java heap to 256 Mb:

java -classic -Xrunoii:filter=<OptIt_Dir>/filters/DefaultAllOn.oif -Xbootclasspath/a:<OptItDir>/lib/oibcp.jar -Xms256m -Xmx256mintuitive.audit.Audit BusyApp

3 Why can’t I test applets with my JRE?

When you test applets with JDK 1.2 or 1.3, Optimizeit runs your applet in the applet viewer using oldjava rather than java, to avoid security exceptions. The JRE 1.2 and 1.3 do not include oldjava. This is why Optimizeit requires a JDK to test applets.

However, you can still test applets with a JRE from Optimizeit by following these steps:

a Edit the java.policy file of your JRE located under the lib\security directory of your JRE.

b At the end of the file include the following lines:

grant codeBase "file:<OptItDir>/lib/optit.jar" { permission java.security.AllPermission; };

c Replace <OptItDir> with the directory where you installed Optimizeit, using / instead of \ (for example: c:/Optimizeit/OptimizeitSuite).

d Set the environment variable OI_APPLET_JRE to true.

4 (Windows only) During a testing session, the Optimizeit user interface becomes unresponsive, and the Optimizeit window is all white.



This problem can occur if the Optimizeit user interface runs out of memory. Optimizeit is a Java program. By default the virtual machine is created with a minimum heap set to 8 Mb and a maximum heap set to 64 Mb.

You can override these default values by using the following environment variables:■ OIMINHEAP

■ OIMAXHEAP

These variables should be set to a new memory size. The notation should be compatible with the virtual machine options -ms and -mx. For example, 12000 means 12000 bytes, 64K means 64 Kb and 64M means 64 Mb.

To increase the max heap to 128 Mb on Windows NT:

a From the Start menu, select the Settings menu and then Control Panel.

b Double-click on the System icon.

c Select the Environment tab.

d In the Variable field, enter OIMAXHEAP.

e In the Value field, enter 128M.

f Click on Set, and then Apply.

If increasing the heap size does not help, use the following procedure to troubleshoot the issue:

g Open Windows Explorer.

h Browse and select the directory containing Optimizeit.

i Select the jre directory.

j Double click on startOptimizeit.bat to start Optimizeit with a console window.

k Recreate the issue. Please send any error message / exception to Borland Technical Support.

You may need to increase the console window buffer size to capture the whole error message:

l Choose Properties from the console window.

m Select the Layout tab.

n Enter a larger value in the Screen buffer size height field.

5 The Optimizeit GUI looks wrong. The text is clipped, the windows are the wrong size.

Some X-servers, including Exceed, have problems with Swing applications, such as over-large fonts or wrong-sized windows. The best way to test remotely is to run the Optimizeit GUI locally. If you test remotely from your Windows platform on your UNIX machine, make sure to use Optimizeit for Windows on the Windows platform.

To configure Exceed 7 to display the right fonts with Optimizeit:


Undoing an integrat ion (Windows only)

■ Open the Exceed Xconfig window from the Windows Start menu, Hummingbird.../Exceed/Xconfig.

■ Double click the Font icon to open the Font Settings dialog box.■ Click the Font Database button.■ Unselect the Automatic Font Substitution option then click OK.■ Restart Exceed.

6 Optimizeit seems to run slowly. Are there some strategies to improve performance?

To improve Optimizeit performance:■ Check the command line argument (shown in the console if you are

running from the user interface) and make sure there are no debugging arguments passed into the JVM. The JVMPI and the debugging interface cannot work simultaneously, so this will slow down performance.

■ Are you using a Hotspot runtime? This can sometimes degrade performance.

■ For Profiler, make sure you do not set the minimum heap size to a high value. This causes the heap to be resized less often. For better performance, use approximately a 4:1 ratio for RAM:Heap size. You can use a 2:1 ratio as long as you also add RAM to cover non-heap VM use and Optimizeit user interface overhead. disabling the garbage collector will slow down the backtrace view in both Tree and Graph modes because the instance count keeps increasing. This affects the time it takes to compute the backtrace views.

■ For Profiler, you can improve performance by disabling the Memory Profiler when you are testing CPU, or disabling the CPU Profiler when you are testing memory use.

Undoing an integration (Windows only)1 How do I undo the integration with VisualCafe?

2 How do I undo the integration with IBM VisualAge?

1 How do I undo the integration with VisualCafe?

Delete the file <CafeDir>\Bin\Components\oivcplugin.jar.

Also, VisualCafe stores some classes and other archives in a repository. This repository can sometimes hold a reference to plug-ins. Rename the file <CafeDir>\local.rps to <CafeDir>\local.rps.old and then start Cafe.

When a dialog appears, click yes. Cafe rebuilds the repository and the problem goes away.

2 How do I undo the integration with IBM VisualAge?

Remove the directory <VisualAge>\ivjtools\tooldata\OptimizeitPlugin and the directory <VisualAge>\ide\tools\OptimizeitPlugin.

Index 59

Symbols! not character 11# column 32* wildcard character 11

Aadding a virtual machine 12adding API calls in your program 25appending date and time

report names 38snapshot names 35

applettesting 7

applicationtesting 7

application programming interface (API) 25Attach panel 44attaching the audit system 21audit API 25audit system

attaching 21configuring 44description 16

audit system start optionsnative 18

CCalls column 32changing the default class path 46changing the default source path 45choosing

class path and source path 8extra Java or program parameters 8operation options 8program location 7program type 7

class coveragebutton 27mode 4options 28

class name column 28class path 46class path window 8classic runtime 13CLASSPATH environment variable 16, 30, 39, 46

Code Coverageinstalling 2integrating 3running 4using 1

command line, testing from 15command-line reports 39configuration file 6, 13, 24configuring servlet support 48connection timeout 44console button 41console options 8controlling the test program

pause 29, 33start 29, 33stop 29, 33

coverage % columnclass 28method 32

Ddata export 40debug line information 32default

class path 8port 44source path 45

default displayclass path 46setting 43virtual machine 47

diff column 28displaying console messages 41

EEdit Settings dialog box 5, 43, 46environment variables 16, 39examples

command line with JDK 1.2 20reports 40

exclude Filter option 11, 23exclusive filters 9exporting data 40extra Java parameters 8extra program parameters 8

Index


FFile Export options 38filter box 28Filter Editor 22Filter Editor columns 23filters

creating 9editing 11

Gg

none option 28generate snapshot on exit 8generating reports

from the command line 39within Code Coverage 38

generating snapshots 35

Hhighlight since mark option 33host name 22Hotspot runtime 13

Iignore coverage column 23include only Filter option 11, 23inclusive filters 10Inspector button 29, 33inspector options

highlight since mark 33real time 33show diff 33show method signature 33

installing Code Coverage 2integrating Optimizeit 3Integration Guide 3intuitive.audit 25invocation count column 32

JJAR files 46Java 2 runtime 3Java runtime option 13Java setup wizard 3JIT compiler 13

Llaunch parameters 44location field 7

MMark button 29, 33merging snapshots 36method coverage

button 31mode 4window options 32

method name column 32methodInfo report option 39missed lines column 32

Nnative start option 18not character 11

Ooibcp.jar 26Open A Console 8Optimizeit

Integration Guide 3

PPattern Editor 11pause button 29, 33port 44

used between the audit system and UI 17, 19port number 22preferences 4

default class path 46default source code 45launch 44servlet 48startup 43virtual machine 47

preferences menu 8, 43program

location 7options 8types 7working directory 7

Rreadme file 2real time option 33Release Notes 2remote application

connecting the audit system 21testing 7, 21, 22

Report button 38

Index 61

ReportGenerator optionsmethodInfo 39reportType 39showDiff 39showSignatures 39showSource 39sourcePath 39verbose 39

reporting functions 4reportType report option 39running Code Coverage 4

Sselecting a virtual machine 47selecting default displays 43selecting test options 6servlet

testing 7servlet testing 48setting the source code location 45setting up the audit system 16setting virtual machine properties 13Settings dialog box 5, 46Settings Editor option 44Settings file 4settings file 6, 13show diff option 33show method signature option 33showDiff report option 39showSignatures report option 39showSource report option 39snapmerge executable 36snapshots

generating 35merging 36

source codedirectories 9location 9, 45table 32

Source Code column 32source path 22

chooser 9, 45sourcePath report option 39start button 29, 33starting from the test program 25starting Optimizeit and connecting the audit

system 21

starting your test program 26startup option 43startup tab 6stop button 29, 33System.err 8System.in 8System.out 8

Ttesting

a program running on another machine 22applets 7applications 7remote applications 7, 21servlets 7

testing a program from the command line 15

Uusing

Class Coverage view 27Filter Editor 22Method Coverage 31virtual machine wizard 3

Vverbose report option 39virtual machine

adding 12classpath 46runtime 13selecting 47setting properties 13starting automatically 25wizard 3

Virtual Machines tab 12vm cannot exit 8vm options 8

Wwhen to use Code Coverage 1wildcard character 11working directory 7

optimizeit code coverage 1cca.yuntech.edu.tw/cca/ccawork/cca系統設備資料...borland software...

Documents