3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
24 * @copyright © 2014 Wikimedia Foundation and contributors
27 class XhprofDataTest
extends PHPUnit_Framework_TestCase
{
30 * @covers XhprofData::splitKey
31 * @dataProvider provideSplitKey
33 public function testSplitKey( $key, $expect ) {
34 $this->assertSame( $expect, XhprofData
::splitKey( $key ) );
37 public function provideSplitKey() {
39 [ 'main()', [ null, 'main()' ] ],
40 [ 'foo==>bar', [ 'foo', 'bar' ] ],
41 [ 'bar@1==>bar@2', [ 'bar@1', 'bar@2' ] ],
42 [ 'foo==>bar==>baz', [ 'foo', 'bar==>baz' ] ],
43 [ '==>bar', [ '', 'bar' ] ],
49 * @covers XhprofData::pruneData
51 public function testInclude() {
52 $xhprofData = $this->getXhprofDataFixture( [
53 'include' => [ 'main()' ],
55 $raw = $xhprofData->getRawData();
56 $this->assertArrayHasKey( 'main()', $raw );
57 $this->assertArrayHasKey( 'main()==>foo', $raw );
58 $this->assertArrayHasKey( 'main()==>xhprof_disable', $raw );
59 $this->assertSame( 3, count( $raw ) );
63 * Validate the structure of data returned by
64 * Xhprof::getInclusiveMetrics(). This acts as a guard against unexpected
65 * structural changes to the returned data in lieu of using a more heavy
66 * weight typed response object.
68 * @covers XhprofData::getInclusiveMetrics
70 public function testInclusiveMetricsStructure() {
83 'variance' => 'numeric',
84 'percent' => 'numeric',
87 $xhprofData = $this->getXhprofDataFixture();
88 $metrics = $xhprofData->getInclusiveMetrics();
90 foreach ( $metrics as $name => $metric ) {
91 $this->assertArrayStructure( $metricStruct, $metric );
93 foreach ( $metricStruct as $key => $type ) {
94 if ( $type === 'array' ) {
95 $this->assertArrayStructure( $statStruct, $metric[$key] );
96 if ( $name === 'main()' ) {
97 $this->assertEquals( 100, $metric[$key]['percent'] );
105 * Validate the structure of data returned by
106 * Xhprof::getCompleteMetrics(). This acts as a guard against unexpected
107 * structural changes to the returned data in lieu of using a more heavy
108 * weight typed response object.
110 * @covers XhprofData::getCompleteMetrics
112 public function testCompleteMetricsStructure() {
120 'subcalls' => 'array',
122 $statsMetrics = [ 'wt', 'cpu', 'mu', 'pmu' ];
124 'total' => 'numeric',
128 'variance' => 'numeric',
129 'percent' => 'numeric',
130 'exclusive' => 'numeric',
133 $xhprofData = $this->getXhprofDataFixture();
134 $metrics = $xhprofData->getCompleteMetrics();
136 foreach ( $metrics as $name => $metric ) {
137 $this->assertArrayStructure( $metricStruct, $metric, $name );
139 foreach ( $metricStruct as $key => $type ) {
140 if ( in_array( $key, $statsMetrics ) ) {
141 $this->assertArrayStructure(
142 $statStruct, $metric[$key], $key
144 $this->assertLessThanOrEqual(
145 $metric[$key]['total'], $metric[$key]['exclusive']
153 * @covers XhprofData::getCallers
154 * @covers XhprofData::getCallees
157 public function testEdges() {
158 $xhprofData = $this->getXhprofDataFixture();
159 $this->assertSame( [], $xhprofData->getCallers( 'main()' ) );
160 $this->assertSame( [ 'foo', 'xhprof_disable' ],
161 $xhprofData->getCallees( 'main()' )
163 $this->assertSame( [ 'main()' ],
164 $xhprofData->getCallers( 'foo' )
166 $this->assertSame( [], $xhprofData->getCallees( 'strlen' ) );
170 * @covers XhprofData::getCriticalPath
173 public function testCriticalPath() {
174 $xhprofData = $this->getXhprofDataFixture();
175 $path = $xhprofData->getCriticalPath();
178 foreach ( $path as $key => $value ) {
179 list( $func, $call ) = XhprofData
::splitKey( $key );
180 $this->assertSame( $last, $func );
183 $this->assertSame( $last, 'bar@1' );
187 * Get an Xhprof instance that has been primed with a set of known testing
188 * data. Tests for the Xhprof class should laregly be concerned with
189 * evaluating the manipulations of the data collected by xhprof rather
190 * than the data collection process itself.
192 * The returned Xhprof instance primed will be with a data set created by
193 * running this trivial program using the PECL xhprof implementation:
195 * function bar( $x ) {
201 * for ( $idx = 0; $idx < 2; $idx++ ) {
203 * $x = strlen( 'abc' );
206 * xhprof_enable( XHPROF_FLAGS_CPU | XHPROF_FLAGS_MEMORY );
208 * $x = xhprof_disable();
214 protected function getXhprofDataFixture( array $opts = [] ) {
215 return new XhprofData( [
244 'main()==>xhprof_disable' => [
262 * Assert that the given array has the described structure.
264 * @param array $struct Array of key => type mappings
265 * @param array $actual Array to check
266 * @param string $label
268 protected function assertArrayStructure( $struct, $actual, $label = null ) {
269 $this->assertInternalType( 'array', $actual, $label );
270 $this->assertCount( count( $struct ), $actual, $label );
271 foreach ( $struct as $key => $type ) {
272 $this->assertArrayHasKey( $key, $actual );
273 $this->assertInternalType( $type, $actual[$key] );