README

Last updated: October 26, 2005

Introduction

This readme describes how to create performance charts and tables similar to those available on the eclipse platform download pages using the stand-alone java program org.eclipse.test.performance.ui.Main stored in this project. Although the program is currently geared to generating results for the Eclipse Platform builds, the program may work for you given the following conditions:


For purposes of this document, the term "fingerprint" will be used to refer to a bar graph which represents the performance summary at a global or component level for each test configuration.

The term "scenario status table" will be used to refer to a table of scenarios with green checks and red x indicators below a component fingerprint. This table gives an overall view of the status for all scenarios for a component for all configurations.

The term "scenario results" will be used to refer to a web page comparing current performance measurements to the baseline measurements for one scenario on one configuration. The web page displays the raw data for the current and baseline measurements and also displays line graphs showing the measured values over the course of builds between the current and baseline.


Requirements

Running the program

From a terminal or dos prompt,

  1. cd to org.eclipse.releng.basebuilder\plugins\org.eclipse.test.performance.ui\scripts
  2. If running on Linux, execute "chmod 755 genresults"
  3. Execute the following command:

    genresults -baseline <baseline build id> -current <current build id> -config <comma-separated list of configs> -jvm <jvm name> -output <output dir> [-config.properties <properties>] [highlight <buildid patterns>] [scenario.pattern <scenario prefix patterns>] [-fingerprints][-scenarioresults][-current.prefix <comma-separated list of build id prefixes>][-baseline.prefix <comma-separated list of build id prefixes>]


Parameter descriptions:


Optional arguments: