Clean up. Bit of refactoring and new @testdox annotations

sebastianbergmann · Jan 11, 2019 · 5189727 · 5189727
1 parent 35dfa54
commit 5189727
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 30 deletions.
diff --git a/src/Framework/Assert.php b/src/Framework/Assert.php
@@ -3000,6 +3000,12 @@ public static function markTestIncomplete(string $message = ''): void
      */
     public static function markTestSkipped(string $message = ''): void
     {
+        if ($hint = self::detectLocationHint($message)) {
+            $trace = \debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS);
+
+            throw new SyntheticSkippedError($hint['message'], 0, $hint['file'], $hint['line'], $trace);
+        }
+
         throw new SkippedTestError($message);
     }
 
@@ -3019,6 +3025,30 @@ public static function resetCount(): void
         self::$count = 0;
     }
 
+    private static function detectLocationHint(string $message): ?array
+    {
+        $hint  = null;
+        $lines = \preg_split('/\r\n|\r|\n/', $message);
+
+        while (\strpos($lines[0], '__OFFSET') !== false) {
+            $offset = \explode('=', \array_shift($lines));
+
+            if ($offset[0] === '__OFFSET_FILE') {
+                $hint['file'] = $offset[1];
+            }
+
+            if ($offset[0] === '__OFFSET_LINE') {
+                $hint['line'] = $offset[1];
+            }
+        }
+
+        if ($hint) {
+            $hint['message'] = \implode(\PHP_EOL, $lines);
+        }
+
+        return $hint;
+    }
+
     private static function isValidAttributeName(string $attributeName): bool
     {
         return \preg_match('/[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*/', $attributeName);

diff --git a/src/Framework/TestCase.php b/src/Framework/TestCase.php
@@ -1644,35 +1644,10 @@ private function checkRequirements(): void
         );
 
         if (!empty($missingRequirements)) {
-            $this->markTestSkippedWithLocationHint($missingRequirements);
+            $this->markTestSkipped(\implode(\PHP_EOL, $missingRequirements));
         }
     }
 
-    private function markTestSkippedWithLocationHint(array $required): void
-    {
-        $file = null;
-        $line = null;
-
-        while (\strpos($required[0], '__OFFSET') !== false) {
-            $offset = \explode('=', \array_shift($required));
-
-            if ($offset[0] === '__OFFSET_FILE') {
-                $file = $offset[1];
-            }
-
-            if ($offset[0] === '__OFFSET_LINE') {
-                $line = $offset[1];
-            }
-        }
-
-        if ($file && $line) {
-            $trace = \debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS);
-
-            throw new SyntheticSkippedError(\implode(\PHP_EOL, $required), 0, $file, $line, $trace);
-        }
-        $this->markTestSkipped(\implode(\PHP_EOL, $required));
-    }
-
     private function verifyMockObjects(): void
     {
         foreach ($this->mockObjects as $mockObject) {

diff --git a/src/Runner/PhptTestCase.php b/src/Runner/PhptTestCase.php
@@ -647,8 +647,8 @@ private function getLocationHint(string $needle, array $sections, ?string $secti
                 $file = \trim($sections[$section . '_EXTERNAL']);
 
                 return [
-                    'file'     => \realpath(\dirname($this->filename) . \DIRECTORY_SEPARATOR . $file),
-                    'line'     => 1,
+                    'file' => \realpath(\dirname($this->filename) . \DIRECTORY_SEPARATOR . $file),
+                    'line' => 1,
                 ];
             }
 
@@ -660,8 +660,8 @@ private function getLocationHint(string $needle, array $sections, ?string $secti
             foreach ($lines as $line) {
                 if (\strpos($line, $needle) !== false) {
                     return [
-                        'file'     => \realpath($this->filename),
-                        'line'     => $offset,
+                        'file' => \realpath($this->filename),
+                        'line' => $offset,
                     ];
                 }
                 $offset++;

diff --git a/tests/unit/Runner/TestSuiteSorterTest.php b/tests/unit/Runner/TestSuiteSorterTest.php
@@ -56,6 +56,7 @@ public function testThrowsExceptionWhenUsingInvalidOrderDefectsOption(): void
     }
 
     /**
+     * @testdox Empty TestSuite not affected (order=$order, resolve=$resolveDependencies, defects=$orderDefects)
      * @dataProvider suiteSorterOptionPermutationsProvider
      */
     public function testShouldNotAffectEmptyTestSuite(int $order, bool $resolveDependencies, int $orderDefects): void