<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[35214] trunk: Unit Tests: add `SpeedTrapListener` to `phpunit/includes` and add the config node to `phpunit.xml.dist`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/35214">35214</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/35214","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-10-16 00:27:28 +0000 (Fri, 16 Oct 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Unit Tests: add `SpeedTrapListener` to `phpunit/includes` and add the config node to `phpunit.xml.dist`.
See <a href="https://core.trac.wordpress.org/ticket/30017">#30017</a>, <a href="https://core.trac.wordpress.org/ticket/33968">#33968</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkphpunitxmldist">trunk/phpunit.xml.dist</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunitincludesspeedtraplistenerphp">trunk/tests/phpunit/includes/speed-trap-listener.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkphpunitxmldist"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/phpunit.xml.dist</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/phpunit.xml.dist 2015-10-15 22:51:38 UTC (rev 35213)
+++ trunk/phpunit.xml.dist 2015-10-16 00:27:28 UTC (rev 35214)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -31,4 +31,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <php>
</span><span class="cx" style="display: block; padding: 0 10px"> <const name="WP_RUN_CORE_TESTS" value="1" />
</span><span class="cx" style="display: block; padding: 0 10px"> </php>
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <listeners>
+ <listener class="SpeedTrapListener" file="tests/phpunit/includes/speed-trap-listener.php">
+ <arguments>
+ <array>
+ <element key="slowThreshold">
+ <integer>150</integer>
+ </element>
+ </array>
+ </arguments>
+ </listener>
+ </listeners>
</ins><span class="cx" style="display: block; padding: 0 10px"> </phpunit>
</span></span></pre></div>
<a id="trunktestsphpunitincludesspeedtraplistenerphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/includes/speed-trap-listener.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/speed-trap-listener.php (rev 0)
+++ trunk/tests/phpunit/includes/speed-trap-listener.php 2015-10-16 00:27:28 UTC (rev 35214)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,314 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * A PHPUnit TestListener that exposes your slowest running tests by outputting
+ * results directly to the console.
+ */
+class SpeedTrapListener implements \PHPUnit_Framework_TestListener
+{
+ /**
+ * Internal tracking for test suites.
+ *
+ * Increments as more suites are run, then decremented as they finish. All
+ * suites have been run when returns to 0.
+ *
+ * @var integer
+ */
+ protected $suites = 0;
+
+ /**
+ * Time in milliseconds at which a test will be considered "slow" and be
+ * reported by this listener.
+ *
+ * @var int
+ */
+ protected $slowThreshold;
+
+ /**
+ * Number of tests to report on for slowness.
+ *
+ * @var int
+ */
+ protected $reportLength;
+
+ /**
+ * Collection of slow tests.
+ *
+ * @var array
+ */
+ protected $slow = array();
+
+ /**
+ * Construct a new instance.
+ *
+ * @param array $options
+ */
+ public function __construct(array $options = array())
+ {
+ $this->loadOptions($options);
+ }
+
+ /**
+ * An error occurred.
+ *
+ * @param \PHPUnit_Framework_Test $test
+ * @param \Exception $e
+ * @param float $time
+ */
+ public function addError(\PHPUnit_Framework_Test $test, \Exception $e, $time)
+ {
+ }
+
+ /**
+ * A failure occurred.
+ *
+ * @param \PHPUnit_Framework_Test $test
+ * @param \PHPUnit_Framework_AssertionFailedError $e
+ * @param float $time
+ */
+ public function addFailure(\PHPUnit_Framework_Test $test, \PHPUnit_Framework_AssertionFailedError $e, $time)
+ {
+ }
+
+ /**
+ * Incomplete test.
+ *
+ * @param \PHPUnit_Framework_Test $test
+ * @param \Exception $e
+ * @param float $time
+ */
+ public function addIncompleteTest(\PHPUnit_Framework_Test $test, \Exception $e, $time)
+ {
+ }
+
+ /**
+ * Risky test.
+ *
+ * @param \PHPUnit_Framework_Test $test
+ * @param \Exception $e
+ * @param float $time
+ * @since Method available since Release 4.0.0
+ */
+ public function addRiskyTest(\PHPUnit_Framework_Test $test, \Exception $e, $time)
+ {
+ }
+
+ /**
+ * Skipped test.
+ *
+ * @param \PHPUnit_Framework_Test $test
+ * @param \Exception $e
+ * @param float $time
+ */
+ public function addSkippedTest(\PHPUnit_Framework_Test $test, \Exception $e, $time)
+ {
+ }
+
+ /**
+ * A test started.
+ *
+ * @param \PHPUnit_Framework_Test $test
+ */
+ public function startTest(\PHPUnit_Framework_Test $test)
+ {
+ }
+
+ /**
+ * A test ended.
+ *
+ * @param \PHPUnit_Framework_Test $test
+ * @param float $time
+ */
+ public function endTest(\PHPUnit_Framework_Test $test, $time)
+ {
+ if (!$test instanceof \PHPUnit_Framework_TestCase) return;
+
+ $time = $this->toMilliseconds($time);
+ $threshold = $this->getSlowThreshold($test);
+
+ if ($this->isSlow($time, $threshold)) {
+ $this->addSlowTest($test, $time);
+ }
+ }
+
+ /**
+ * A test suite started.
+ *
+ * @param \PHPUnit_Framework_TestSuite $suite
+ */
+ public function startTestSuite(\PHPUnit_Framework_TestSuite $suite)
+ {
+ $this->suites++;
+ }
+
+ /**
+ * A test suite ended.
+ *
+ * @param \PHPUnit_Framework_TestSuite $suite
+ */
+ public function endTestSuite(\PHPUnit_Framework_TestSuite $suite)
+ {
+ $this->suites--;
+
+ if (0 === $this->suites && $this->hasSlowTests()) {
+ arsort($this->slow); // Sort longest running tests to the top
+
+ $this->renderHeader();
+ $this->renderBody();
+ $this->renderFooter();
+ }
+ }
+
+ /**
+ * Whether the given test execution time is considered slow.
+ *
+ * @param int $time Test execution time in milliseconds
+ * @param int $slowThreshold Test execution time at which a test should be considered slow (milliseconds)
+ * @return bool
+ */
+ protected function isSlow($time, $slowThreshold)
+ {
+ return $time >= $slowThreshold;
+ }
+
+ /**
+ * Stores a test as slow.
+ *
+ * @param \PHPUnit_Framework_TestCase $test
+ * @param int $time Test execution time in milliseconds
+ */
+ protected function addSlowTest(\PHPUnit_Framework_TestCase $test, $time)
+ {
+ $label = $this->makeLabel($test);
+
+ $this->slow[$label] = $time;
+ }
+
+ /**
+ * Whether at least one test has been considered slow.
+ *
+ * @return bool
+ */
+ protected function hasSlowTests()
+ {
+ return !empty($this->slow);
+ }
+
+ /**
+ * Convert PHPUnit's reported test time (microseconds) to milliseconds.
+ *
+ * @param float $time
+ * @return int
+ */
+ protected function toMilliseconds($time)
+ {
+ return (int) round($time * 1000);
+ }
+
+ /**
+ * Label for describing a test.
+ *
+ * @param \PHPUnit_Framework_TestCase $test
+ * @return string
+ */
+ protected function makeLabel(\PHPUnit_Framework_TestCase $test)
+ {
+ return sprintf('%s:%s', get_class($test), $test->getName());
+ }
+
+ /**
+ * Calculate number of slow tests to report about.
+ *
+ * @return int
+ */
+ protected function getReportLength()
+ {
+ return min(count($this->slow), $this->reportLength);
+ }
+
+ /**
+ * Find how many slow tests occurred that won't be shown due to list length.
+ *
+ * @return int Number of hidden slow tests
+ */
+ protected function getHiddenCount()
+ {
+ $total = count($this->slow);
+ $showing = $this->getReportLength($this->slow);
+
+ $hidden = 0;
+ if ($total > $showing) {
+ $hidden = $total - $showing;
+ }
+
+ return $hidden;
+ }
+
+ /**
+ * Renders slow test report header.
+ */
+ protected function renderHeader()
+ {
+ echo sprintf("\n\nYou should really fix these slow tests (>%sms)...\n", $this->slowThreshold);
+ }
+
+ /**
+ * Renders slow test report body.
+ */
+ protected function renderBody()
+ {
+ $slowTests = $this->slow;
+
+ $length = $this->getReportLength($slowTests);
+ for ($i = 1; $i <= $length; ++$i) {
+ $label = key($slowTests);
+ $time = array_shift($slowTests);
+
+ echo sprintf(" %s. %sms to run %s\n", $i, $time, $label);
+ }
+ }
+
+ /**
+ * Renders slow test report footer.
+ */
+ protected function renderFooter()
+ {
+ if ($hidden = $this->getHiddenCount($this->slow)) {
+ echo sprintf("...and there %s %s more above your threshold hidden from view", $hidden == 1 ? 'is' : 'are', $hidden);
+ }
+ }
+
+ /**
+ * Populate options into class internals.
+ *
+ * @param array $options
+ */
+ protected function loadOptions(array $options)
+ {
+ $this->slowThreshold = isset($options['slowThreshold']) ? $options['slowThreshold'] : 500;
+ $this->reportLength = isset($options['reportLength']) ? $options['reportLength'] : 10;
+ }
+
+ /**
+ * Get slow test threshold for given test. A TestCase can override the
+ * suite-wide slow threshold by using the annotation @slowThreshold with
+ * the threshold value in milliseconds.
+ *
+ * The following test will only be considered slow when its execution time
+ * reaches 5000ms (5 seconds):
+ *
+ * <code>
+ * \@slowThreshold 5000
+ * public function testLongRunningProcess() {}
+ * </code>
+ *
+ * @param \PHPUnit_Framework_TestCase $test
+ * @return int
+ */
+ protected function getSlowThreshold(\PHPUnit_Framework_TestCase $test)
+ {
+ $ann = $test->getAnnotations();
+
+ return isset($ann['method']['slowThreshold'][0]) ? $ann['method']['slowThreshold'][0] : $this->slowThreshold;
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>