File size: 5,677 Bytes
ae4627d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 | '''
:class:`.BenchMark` is a :class:`.TestPlugin` for benchmarking test functions.
To use the plugin follow these three steps:
* Flag a ``unittest.TestCase`` class with the ``__benchmark__ = True``
class attribute::
class MyBenchmark(unittest.TestCase):
__benchmark__ = True
def test_mybenchmark_function1(self):
...
def test_mybenchmark_function2(self):
...
* Run the test suite with the ``--benchmark`` command line option.
Alternatively, you can use the ``bench`` command from your ``setup.py`` file.
Simply add the ``bench`` entry in the ``setup.cfg``.
[bench]
test_modules = tests/bench
The test class can implement additional methods to fine-tune how the
benchmark plugin evaluate the performance and display results:
* When implemented, the ``startUp`` method is invoked before each run
of a test function.
* The time taken to run a test once can be modified by implementing
the ``getTime`` method which receives as only argument the time interval
taken.
By default it returns the same time interval.
.. autoclass:: BenchMark
'''
import time
import math
from inspect import isawaitable
from unittest import TestSuite
from pulsar.api import Setting
from pulsar.utils.config import validate_pos_int
from .base import WrapTest, TestPlugin
BENCHMARK_TEMPLATE = ('{0[name]}: repeated {0[repeat]}(x{0[times]}) times, '
'average {0[mean]} secs, stdev {0[std]}')
def simple(info, *args):
return info
class BenchTest(WrapTest):
def __init__(self, test, number, repeat):
super().__init__(test)
self.number = number
self.repeat = repeat
def update_summary(self, info, repeat, total_time, total_time2):
mean = total_time/repeat
std = math.sqrt((total_time2 - total_time*mean)/repeat)
std = round(100*std/mean, 2)
info.update({'repeat': repeat,
'times': self.number,
'mean': '%.5f' % mean,
'std': '{0} %'.format(std)})
async def _call(self):
testMethod = self.testMethod
testStartUp = getattr(self.test, 'startUp', lambda: None)
testGetTime = getattr(self.test, 'getTime', simple)
testGetInfo = getattr(self.test, 'getInfo', simple)
testGetSummary = getattr(self.test, 'getSummary', simple)
t = 0
t2 = 0
info = {'name': '%s.%s' % (self.test.__class__.__name__,
testMethod.__name__)}
for r in range(self.repeat):
DT = 0
for r in range(self.number):
testStartUp()
start = time.monotonic()
result = testMethod()
delta = time.monotonic() - start
if isawaitable(result):
start = time.monotonic()
await result
delta += time.monotonic() - start
dt = testGetTime(delta)
testGetInfo(info, delta, dt)
DT += dt
t += DT
t2 += DT*DT
self.update_summary(info, self.repeat, t, t2)
self.set_test_attribute('bench_info',
testGetSummary(info, self.repeat, t, t2))
class BenchMark(TestPlugin):
'''Benchmarking addon for pulsar test suite.'''
desc = '''Run benchmarks function flagged with __benchmark__ attribute'''
repeat = Setting(
flags=['--repeat'],
type=int,
default=10,
validator=validate_pos_int,
desc='Default number of repetition when benchmarking.'
)
def loadTestsFromTestCase(self, test_cls):
bench = getattr(test_cls, '__benchmark__', False)
if self.config.benchmark != bench: # skip the loading
return TestSuite()
def before_test_function_run(self, test, local):
if self.config.benchmark:
method_name = getattr(test, '_testMethodName', None)
if method_name:
method = getattr(test, method_name, None)
bench = getattr(test, '__benchmark__', False)
if not bench and method:
bench = getattr(method, '__benchmark__', False)
if bench:
number = getattr(test, '__number__', 1)
return BenchTest(test, number, self.config.repeat)
def addSuccess(self, test):
if self.config.benchmark and self.stream:
result = getattr(test, 'bench_info', None)
# if result and self.stream.showAll:
if result:
stream = self.stream.handler('benchmark')
template = getattr(test, 'benchmark_template',
BENCHMARK_TEMPLATE)
stream.writeln(template.format(result))
stream.flush()
self.result.addSuccess(test)
return True
def addError(self, test, err):
msg = self._msg(test, 'ERROR')
if msg:
self.result.addError(test, err)
return msg
def addFailure(self, test, err):
msg = self._msg(test, 'FAILURE')
if msg:
self.result.addFailure(test, err)
return msg
def addSkip(self, test, reason):
msg = self._msg(test, 'SKIPPED')
if msg:
self.result.addSkip(test, reason)
return msg
def _msg(self, test, msg):
if self.config.benchmark and self.stream:
stream = self.stream.handler('benchmark')
stream.writeln('%s: %s' % (test, msg))
stream.flush()
return True
|