Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
| 1 | <?php |
||
| 14 | class LogPrinter extends \PHPUnit_Util_Printer implements \PHPUnit_Framework_TestListener |
||
| 15 | { |
||
| 16 | /** @var string */ |
||
| 17 | private $logDirectory; |
||
| 18 | |||
| 19 | /** @var int */ |
||
| 20 | private $testSuiteLevel; |
||
| 21 | |||
| 22 | /** @var string */ |
||
| 23 | private $currentTestSuiteName; |
||
| 24 | |||
| 25 | /** @var string */ |
||
| 26 | private $currentTestName; |
||
| 27 | |||
| 28 | /** @var bool */ |
||
| 29 | private $currentTestPass; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * LogPrinter constructor. |
||
| 33 | */ |
||
| 34 | 10 | public function __construct() |
|
| 39 | |||
| 40 | /** |
||
| 41 | * An error occurred. |
||
| 42 | * |
||
| 43 | * @param \PHPUnit_Framework_Test $test |
||
| 44 | * @param \Exception $e |
||
| 45 | * @param float $time |
||
| 46 | */ |
||
| 47 | 1 | public function addError(\PHPUnit_Framework_Test $test, \Exception $e, $time) |
|
| 48 | { |
||
| 49 | 1 | $this->writeCase( |
|
| 50 | 1 | 'error', |
|
| 51 | $time, |
||
| 52 | 1 | \PHPUnit_Util_Filter::getFilteredStacktrace($e, false), |
|
|
|
|||
| 53 | 1 | \PHPUnit_Framework_TestFailure::exceptionToString($e), |
|
| 54 | $test |
||
| 55 | ); |
||
| 56 | |||
| 57 | 1 | $this->currentTestPass = false; |
|
| 58 | 1 | } |
|
| 59 | |||
| 60 | /** |
||
| 61 | * A warning occurred. |
||
| 62 | * |
||
| 63 | * @param \PHPUnit_Framework_Test $test |
||
| 64 | * @param \PHPUnit_Framework_Warning $e |
||
| 65 | * @param float $time |
||
| 66 | */ |
||
| 67 | 1 | View Code Duplication | public function addWarning(\PHPUnit_Framework_Test $test, \PHPUnit_Framework_Warning $e, $time) |
| 79 | |||
| 80 | /** |
||
| 81 | * A failure occurred. |
||
| 82 | * |
||
| 83 | * @param \PHPUnit_Framework_Test $test |
||
| 84 | * @param \PHPUnit_Framework_AssertionFailedError $e |
||
| 85 | * @param float $time |
||
| 86 | */ |
||
| 87 | 1 | View Code Duplication | public function addFailure(\PHPUnit_Framework_Test $test, \PHPUnit_Framework_AssertionFailedError $e, $time) |
| 99 | |||
| 100 | /** |
||
| 101 | * Incomplete test. |
||
| 102 | * |
||
| 103 | * @param \PHPUnit_Framework_Test $test |
||
| 104 | * @param \Exception $e |
||
| 105 | * @param float $time |
||
| 106 | */ |
||
| 107 | 1 | View Code Duplication | public function addIncompleteTest(\PHPUnit_Framework_Test $test, \Exception $e, $time) |
| 119 | |||
| 120 | /** |
||
| 121 | * Risky test. |
||
| 122 | * |
||
| 123 | * @param \PHPUnit_Framework_Test $test |
||
| 124 | * @param \Exception $e |
||
| 125 | * @param float $time |
||
| 126 | */ |
||
| 127 | 1 | View Code Duplication | public function addRiskyTest(\PHPUnit_Framework_Test $test, \Exception $e, $time) |
| 139 | |||
| 140 | /** |
||
| 141 | * Skipped test. |
||
| 142 | * |
||
| 143 | * @param \PHPUnit_Framework_Test $test |
||
| 144 | * @param \Exception $e |
||
| 145 | * @param float $time |
||
| 146 | */ |
||
| 147 | 1 | View Code Duplication | public function addSkippedTest(\PHPUnit_Framework_Test $test, \Exception $e, $time) |
| 159 | |||
| 160 | /** |
||
| 161 | * A testsuite started. |
||
| 162 | * |
||
| 163 | * @param \PHPUnit_Framework_TestSuite $suite |
||
| 164 | * @throws \RuntimeException |
||
| 165 | */ |
||
| 166 | 9 | public function startTestSuite(\PHPUnit_Framework_TestSuite $suite) |
|
| 191 | |||
| 192 | /** |
||
| 193 | * A testsuite ended. |
||
| 194 | * |
||
| 195 | * @param \PHPUnit_Framework_TestSuite $suite |
||
| 196 | */ |
||
| 197 | 1 | public function endTestSuite(\PHPUnit_Framework_TestSuite $suite) |
|
| 203 | |||
| 204 | /** |
||
| 205 | * A test started. |
||
| 206 | * |
||
| 207 | * @param \PHPUnit_Framework_Test $test |
||
| 208 | */ |
||
| 209 | 7 | public function startTest(\PHPUnit_Framework_Test $test) |
|
| 222 | |||
| 223 | /** |
||
| 224 | * A test ended. |
||
| 225 | * |
||
| 226 | * @param \PHPUnit_Framework_Test $test |
||
| 227 | * @param float $time |
||
| 228 | */ |
||
| 229 | 1 | public function endTest(\PHPUnit_Framework_Test $test, $time) |
|
| 235 | |||
| 236 | /** |
||
| 237 | * @param string $status |
||
| 238 | * @param float $time |
||
| 239 | * @param array $trace |
||
| 240 | * @param string $message |
||
| 241 | * @param \PHPUnit_Framework_TestCase|null $test |
||
| 242 | */ |
||
| 243 | 7 | protected function writeCase($status, $time, array $trace = array(), $message = '', $test = null) |
|
| 263 | |||
| 264 | /** |
||
| 265 | * @param array $buffer |
||
| 266 | */ |
||
| 267 | public function writeArray($buffer) |
||
| 268 | { |
||
| 269 | 9 | array_walk_recursive($buffer, function (&$input) { |
|
| 270 | 9 | if (is_string($input)) { |
|
| 271 | 9 | $input = \PHPUnit_Util_String::convertToUtf8($input); |
|
| 272 | } |
||
| 273 | 9 | }); |
|
| 274 | |||
| 275 | 9 | $flags = 0; |
|
| 276 | |||
| 277 | 9 | if (defined('JSON_PRETTY_PRINT')) { |
|
| 278 | 9 | $flags |= JSON_PRETTY_PRINT; |
|
| 279 | } |
||
| 280 | |||
| 281 | 9 | $this->write(json_encode($buffer, $flags)); |
|
| 282 | 9 | } |
|
| 283 | |||
| 284 | /** |
||
| 285 | * @param \PHPUnit_Framework_TestSuite $suite |
||
| 286 | * @return string |
||
| 287 | */ |
||
| 288 | 10 | private function getLogFilename(\PHPUnit_Framework_TestSuite $suite) |
|
| 294 | |||
| 295 | /** |
||
| 296 | * @param \PHPUnit_Framework_TestSuite $suite |
||
| 297 | * @return string |
||
| 298 | */ |
||
| 299 | 10 | private function getTestFilename(\PHPUnit_Framework_TestSuite $suite) |
|
| 305 | |||
| 306 | /** |
||
| 307 | * @return string |
||
| 308 | */ |
||
| 309 | 10 | private function getLogDirectory() |
|
| 318 | } |
||
| 319 |
This check looks at variables that are passed out again to other methods.
If the outgoing method call has stricter type requirements than the method itself, an issue is raised.
An additional type check may prevent trouble.