If you are experiencing testing problems such as build failures, the best way to remedy the problem is to create a zip archive containing the source file(s) that caused that failure (if applicable), as well as related test information, then send that zip file to Parasoft's support team (see Contacting Parasoft Technical Support).To facilitate this process, you can have the product automatically create an archive when testing problems occur. On average, these archives are about half a megabyte, and are created in about one minute.
By default, an archive is not created when testing problems occur. You can either manually prepare and send a support archive when needed, or you can modify Parasoft archive creation options so that the product automatically prepares and sends an archive when testing problems occur.
To configure the product to automatically prepare and send archives when testing problems occur:
- Open the Technical Support panel by choosing Parasoft> Preferences, then selecting the Parasoft> Technical Support category.
- Check Enable auto-creation of support archives.
Customize additional options as needed. Available options are:
Option Description Send archives by e-mail If this option is enabled, the archive is sent automatically. If you enable this option, be sure to set the e-mail options in Preferences> E-mail if you have not already done so. C++test configuration files All user and team Test Configurations available to C++test at the time the technical support archive is created. DTP engine configuration files Additional C++test data generated during analysis. Environmental data Environment variables, JVM system properties, platform details, additional properties (memory, other). Preprocessed source files If this option is enabled, you will be prompted to include preprocessed source files when the Create Archive button is clicked. If the Enable auto-creation of support archives option is enabled, pre-processed source files will be automatically added to any archives created. Project properties Properties from the project, platform, tool, and options extractor. If this is enabled, the archive will probably contain your preprocessed sources, Makefiles, and other files you have added to the project. Moreover, it might also contain data that can reveal your project’s structure. Test run data Checker-specific (standards, execution, generation) data that is automatically collected during test sessions. This option must be enabled in order to collect data during test runs. General application logs Various platform/application logs. Enable verbose logging
Includes verbose logs included in the archive. Note that this option cannot be enabled if the logging system has custom configurations.
- Verbose logs are stored in the
xtest.logfile within the user-home temporary location (on Windows, this is
<drive>:\Documents and Settings\<user>\Local Set-tings\Temp\parasoft\xtest).
- Verbose logging state is cross-ses-sionpersistent(restored on application startup).
- The log file is a rolling file: it won't grow over a certain size, and each time it achieves the maximum size, a backup will be created.
Enable source control output Includes output from source control commands in verbose logs. Note that the output could include fragments of your source code. Advanced options If the support team asked you to enter any advanced options, check this box, then enter the options here. Archives location
If you do not want to use the listed archive
location, specify a new one.
- Verbose logs are stored in the
- Click Apply, then OK.
To manually create a support archive:
- Choose Parasoft> Preferences, select the Technical Support category, select the desired archive options, then click Create Archive.
To open the Technical Support Archive Manager, which allows you to review, e-mail, or delete recent support archives:
- Choose Parasoft> Preferences, select the Technical Support category, then click Browse Recent Archives.
When creating a support archive it is best to ensure that it contains all the info which is relevant to the problem and does not contain any unrelated info.
Best Practice: Creating an Archive with the Most Relevant Data
When a technical support archive is created, the complete application logs are included. The logs may contain information from many test runs over a long period of time—but chances are that only a small part of that information is relevant to the problem you are experiencing. To help technical support isolate the cause of the problem, create a technical support archive containing application logs for only the testing session that produces problems. To do this:
- Clean application logs by turning on verbose logging. If verbose logging is already enabled, then disable it and re-enable it.
- Run the testing session that causes problems.
- Prepare a technical support archive.