-
Notifications
You must be signed in to change notification settings - Fork 238
/
Profiler.php
245 lines (217 loc) · 6.71 KB
/
Profiler.php
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
<?php
/**
* Lithium: the most rad php framework
*
* @copyright Copyright 2013, Union of RAD (http://union-of-rad.org)
* @license http://opensource.org/licenses/bsd-license.php The BSD License
*/
namespace lithium\test\filter;
/**
* The `Profiler` filter tracks timing and memory usage information for each test method, and
* presents aggregate reports across single test runs. Used for performance-tuning classes and
* methods.
*/
class Profiler extends \lithium\test\Filter {
/**
* Contains the list of profiler checks to run against each test. Values can be string
* function names, arrays containing function names as the first key and function parameters
* as subsequent keys, or closures.
*
* @var array
* @see lithium\test\Profiler::check()
*/
protected static $_metrics = array(
'Time' => array(
'function' => array('microtime', true),
'format' => 'seconds'
),
'Current Memory' => array(
'function' => 'memory_get_usage',
'format' => 'bytes'
),
'Peak Memory' => array(
'function' => 'memory_get_peak_usage',
'format' => 'bytes'
),
'Current Memory (Xdebug)' => array(
'function' => 'xdebug_memory_usage',
'format' => 'bytes'
),
'Peak Memory (Xdebug)' => array(
'function' => 'xdebug_peak_memory_usage',
'format' => 'bytes'
)
);
protected static $_formatters = array();
/**
* Verifies that the corresponding function exists for each built-in profiler check.
* Initializes display formatters.
*/
public static function reset() {
foreach (static::$_metrics as $name => $check) {
$function = current((array) $check['function']);
if (is_string($check['function']) && !function_exists($check['function'])) {
unset(static::$_metrics[$name]);
}
}
static::$_formatters = array(
'seconds' => function($value) { return number_format($value, 4) . 's'; },
'bytes' => function($value) { return number_format($value / 1024, 3) . 'k'; }
);
}
/**
* Takes an instance of an object (usually a Collection object) containing test
* instances. Allows for preparing tests before they are run.
*
* @param object $report Instance of Report which is calling apply.
* @param array $tests The test to apply this filter on
* @param array $options Options for how this filter should be applied. Available options are:
* - `'method'`
* - `'run'`
* - `'checks'`
* @return object Returns the instance of `$tests`.
*/
public static function apply($report, $tests, array $options = array()) {
$defaults = array('method' => 'run', 'checks' => static::$_metrics);
$options += $defaults;
$m = $options['method'];
$filter = function($self, $params, $chain) use ($report, $options) {
$start = $results = array();
$runCheck = function($check) {
switch (true) {
case (is_object($check) || is_string($check)):
return $check();
break;
case (is_array($check)):
$function = array_shift($check);
$result = !$check ? $check() : call_user_func_array($function, $check);
break;
}
return $result;
};
foreach ($options['checks'] as $name => $check) {
$start[$name] = $runCheck($check['function']);
}
$methodResult = $chain->next($self, $params, $chain);
foreach ($options['checks'] as $name => $check) {
$results[$name] = $runCheck($check['function']) - $start[$name];
}
$report->collect(
__CLASS__,
array(
$self->subject() => $results,
'options' => $options + array('test' => get_class($self)),
'method' => $params['method']
)
);
return $methodResult;
};
$tests->invoke('applyFilter', array($m, $filter));
return $tests;
}
/**
* Analyzes the results of a test run and returns the result of the analysis.
*
* @param object $report The report instance running this filter and aggregating results
* @param array $options Not used.
* @return array The results of the analysis.
*/
public static function analyze($report, array $options = array()) {
$results = $report->results['group'];
$collectedResults = static::collect($report->results['filters'][__CLASS__]);
extract($collectedResults, EXTR_OVERWRITE);
$metrics = array();
foreach ($results as $testCase) {
foreach ((array) $testCase as $assertion) {
if ($assertion['result'] !== 'pass' && $assertion['result'] !== 'fail') {
continue;
}
$class = $classMap[$assertion['class']];
if (!isset($metrics[$class])) {
$metrics[$class] = array('assertions' => 0);
}
$metrics[$class]['assertions']++;
}
}
foreach ($filterResults as $class => $methods) {
foreach ($methods as $methodName => $timers) {
foreach ($timers as $title => $value) {
if (!isset($metrics[$class][$title])) {
$metrics[$class][$title] = 0;
}
$metrics[$class][$title] += $value;
}
}
}
$totals = array();
foreach ($metrics as $class => $data) {
foreach ($data as $title => $value) {
if (isset(static::$_metrics[$title])) {
if (isset($totals[$title]['value'])) {
$totals[$title]['value'] += $value;
} else {
$totals[$title]['value'] = $value;
}
if (!isset($totals[$title]['format'])) {
$format = static::$_metrics[$title]['format'];
$totals[$title]['formatter'] = static::$_formatters[$format];
}
}
}
}
$metrics['totals'] = $totals;
return $metrics;
}
/**
* Add, remove, or modify a profiler check.
*
* @see lithium\test\Profiler::$_metrics
* @param mixed $name
* @param string $value
* @return mixed
*/
public function check($name, $value = null) {
if (is_null($value) && !is_array($name)) {
return isset(static::$_metrics[$name]) ? static::$_metrics[$name] : null;
}
if ($value === false) {
unset(static::$_metrics[$name]);
return;
}
if (!empty($value)) {
static::$_metrics[$name] = $value;
}
if (is_array($name)) {
static::$_metrics = $name + static::$_metrics;
}
}
/**
* Collects the raw filter results and packages them for analysis.
*
* @param array $filterResults The results of the filter on the test run.
* @return array The packaged filter results prepared for analysis.
*/
public static function collect($filterResults) {
$defaults = array('test' => null);
$classMap = array();
$packagedResults = array();
foreach ($filterResults as $results) {
$class = key($results);
$options = $results['options'];
$options += $defaults;
$method = $results['method'];
$classMap[$options['test']] = $class;
if (!isset($packagedResults[$class])) {
$packagedResults[$class] = array();
}
$packagedResults[$class][$method] = $results[$class];
}
$filterResults = $packagedResults;
return array(
'filterResults' => $filterResults,
'classMap' => $classMap
);
}
}
Profiler::reset();
?>