Package schrodinger :: Package test :: Package performance :: Module reporter :: Class Test

Class Test

object --+
         |
        Test

A performance test. name and product must uniquely specify a test. product is required to match an existing product name in the database. New tests require descriptions when uploaded. The descriptions of existing tests are not changed by result upload.

Invididual results are added with addResult(). All results are uploaded to the database when report() is called.

Typical pattern:

   test = performance.Test("distribution_size", "shared components",
           ("Determine the size of the SCHRODINGER distribution and "
            "report it to the performance database."))
   # Result with a metric name and value
   test.addResult('file count', 200000)
   # Result with a metric name, value, and units
   test.addResult('size', 20000, 'MB')
   test.report()

Instance Methods

[hide private]

__init__(self, name, product, description=None)
x.__init__(...) initializes x; see help(type(x)) for signature

addResult(self, name, value, units=None)
Add a result to the current test.

report(self, build_id=None, buildtype=None)
Once all results have been added to the test, report them to the database.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, name, product, description=None)
(Constructor)

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

addResult(self, name, value, units=None)

Add a result to the current test. Results are not uploaded until report() is called.

Parameters:

name - Name of the metric being reported
value - Current value of the metric
units - (optional) units of the value.

Class Test

__init__(self, name, product, description=None) (Constructor)

addResult(self, name, value, units=None)

init(self, name, product, description=None)
(Constructor)