Improved stack trace output. (#203)

ezzatron · web-flow · commit a73acdb8e8e0 · 2017-01-06T21:48:58.000+10:00
diff --git a/fixtures/exception-trimming.spec.php b/fixtures/exception-trimming.spec.php
@@ -0,0 +1,33 @@
+<?php
+namespace Some\Really\Long\Name\That\Looks\Dumb;
+
+describe('Exception trimming', function () {
+    it('should not display irrelevent stack frames', function () {
+        new SomeClass();
+    });
+
+    it('should render assertion exceptions', function () {
+        assert('true === false', 'should implode the universe');
+    });
+});
+
+class SomeClass
+{
+    public function __construct()
+    {
+        someFunction();
+    }
+}
+
+function someFunction()
+{
+    new SomeOtherClass();
+}
+
+class SomeOtherClass
+{
+    public function __construct()
+    {
+        throw new \Exception('You done goofed.');
+    }
+}
diff --git a/specs/assert-exception.spec.php b/specs/assert-exception.spec.php
@@ -0,0 +1,31 @@
+<?php
+
+use Peridot\AssertException;
+
+describe('AssertException', function () {
+    context('::handle()', function () {
+        it('should throw an exception', function () {
+            $exception = null;
+            try {
+                AssertException::handle('/path/to/file', 111, '', 'You done goofed.');
+            } catch (AssertException $e) {
+                $exception = $e;
+            }
+            assert(!is_null($exception), 'exception should have been thrown');
+            assert($exception->getFile() === '/path/to/file', 'exception should have the correct filename');
+            assert($exception->getLine() === 111, 'exception should have the correct line number');
+            assert($exception->getMessage() === 'You done goofed.', 'exception should have the correct message');
+            assert($exception->getTrace() === [], 'exception should have an empty trace');
+        });
+
+        it('should support assertions with an expression', function () {
+            $exception = null;
+            try {
+                AssertException::handle('/path/to/file', 111, 'expression', 'You done goofed.');
+            } catch (AssertException $e) {
+                $exception = $e;
+            }
+            assert($exception->getMessage() === 'expression You done goofed.', 'exception should have the correct message');
+        });
+    });
+});
diff --git a/specs/spec-reporter.spec.php b/specs/spec-reporter.spec.php
@@ -48,11 +48,13 @@
 
             $exception = null;
             try {
-                throw new Exception("ooops" . PHP_EOL . "nextline");
+                $expectedTrace = preg_quote(sprintf('%s:%d', __FILE__, __LINE__ + 1), '~') . '.*';
+                new ExceptionThrower($expectedTrace);
             } catch (Exception $e) {
                 $exception = $e;
             }
             $this->exception = $exception;
+            $this->expectedTrace = '~' . $expectedTrace . '~s';
 
             $this->emitter->emit('test.passed', [new Test('passing test', function() {})]);
             $this->emitter->emit('test.failed', [new Test('failing test', function() {}), $this->exception]);
@@ -81,9 +83,33 @@
         it('should display exception stacks and messages', function() {
             $expectedExceptionMessage = "     ooops" . PHP_EOL . "     nextline";
             assert(strstr($this->contents, $expectedExceptionMessage) !== false, "should include exception message");
-            $trace = preg_replace('/^#/m', "      #", $this->exception->getTraceAsString());
-            assert(strstr($this->contents, $trace) !== false, "should include exception stack");
+            assert(preg_match($this->expectedTrace, $this->contents), 'should include exception stack');
         });
     });
 
 });
+
+function throwException(&$pattern)
+{
+    $pattern = preg_quote(sprintf('%s:%d', __FILE__, __LINE__ + 1), '~') . '.*noFilename.*' . $pattern;
+    $exception = new Exception('ooops' . PHP_EOL . 'nextline');
+
+    $reflector = new ReflectionClass('Exception');
+    $traceProperty = $reflector->getProperty('trace');
+    $traceProperty->setAccessible(true);
+
+    $trace = $traceProperty->getValue($exception);
+    array_unshift($trace, ['function' => 'noFilename']);
+    $traceProperty->setValue($exception, $trace);
+
+    throw $exception;
+}
+
+class ExceptionThrower
+{
+    public function __construct(&$pattern)
+    {
+        $pattern = preg_quote(sprintf('%s:%d', __FILE__, __LINE__ + 1), '~') . '.*' . $pattern;
+        throwException($pattern);
+    }
+}
diff --git a/specs/suiteloader.spec.php b/specs/suiteloader.spec.php
@@ -18,7 +18,7 @@
     describe('->getTests()', function() {
         it("should return file paths matching *.spec.php recursively", function() {
             $tests = $this->loader->getTests($this->fixtures);
-            assert(count($tests) == 5, "suite loader should have loaded 5 specs");
+            assert(count($tests) == 6, "suite loader should have loaded 6 specs");
         });
 
         it("should return single file if it exists", function() {
diff --git a/src/AssertException.php b/src/AssertException.php
@@ -0,0 +1,55 @@
+<?php
+namespace Peridot;
+
+use Exception;
+use ReflectionClass;
+
+/**
+ * Represents a failed assert() call.
+ *
+ * @package Peridot
+ */
+class AssertException extends Exception
+{
+    /**
+     * Handle a failed assert() call.
+     *
+     * @param string $file
+     * @param int $line
+     * @param string $expression
+     * @param string $description
+     *
+     * @return self
+     */
+    public static function handle($file, $line, $expression, $description)
+    {
+        throw new self($file, $line, $expression, $description);
+    }
+
+    /**
+     * Construct a new assert exception.
+     *
+     * @param string $file
+     * @param int $line
+     * @param string $expression
+     * @param string $description
+     */
+    public function __construct($file, $line, $expression, $description)
+    {
+        if ($expression) {
+            $message = sprintf('%s %s', $expression, $description);
+        } else {
+            $message = $description;
+        }
+
+        parent::__construct($message);
+
+        $this->file = $file;
+        $this->line = $line;
+
+        $reflector = new ReflectionClass('Exception');
+        $traceProperty = $reflector->getProperty('trace');
+        $traceProperty->setAccessible(true);
+        $traceProperty->setValue($this, array());
+    }
+}
diff --git a/src/Dsl.php b/src/Dsl.php
@@ -126,6 +126,4 @@ function afterEach(callable $fn)
  * Change default assert behavior to throw exceptions
  */
 assert_options(ASSERT_WARNING, false);
-assert_options(ASSERT_CALLBACK, function ($script, $line, $message, $description) {
-    throw new Exception($description);
-});
+assert_options(ASSERT_CALLBACK, ['Peridot\AssertException', 'handle']);
diff --git a/src/Reporter/AbstractBaseReporter.php b/src/Reporter/AbstractBaseReporter.php
@@ -183,6 +183,7 @@ public function footer()
         for ($i = 0; $i < $errorCount; $i++) {
             list($test, $error) = $this->errors[$i];
             $this->outputError($i + 1, $test, $error);
+            $this->output->writeln('');
         }
     }
 
@@ -191,7 +192,7 @@ public function footer()
      *
      * @param int $errorNumber
      * @param TestInterface $test
-     * @param $exception - an exception like interface with ->getMessage(), ->getTraceAsString()
+     * @param $exception - an exception like interface with ->getMessage(), ->getTrace()
      */
     protected function outputError($errorNumber, TestInterface $test, $exception)
     {
@@ -200,8 +201,32 @@ protected function outputError($errorNumber, TestInterface $test, $exception)
         $message = sprintf("     %s", str_replace(PHP_EOL, PHP_EOL . "     ", $exception->getMessage()));
         $this->output->writeln($this->color('error', $message));
 
-        $trace = preg_replace('/^#/m', "      #", $exception->getTraceAsString());
-        $this->output->writeln($this->color('muted', $trace));
+        $location = sprintf('     at %s:%d', $exception->getFile(), $exception->getLine());
+        $this->output->writeln($location);
+
+        $this->outputTrace($exception->getTrace());
+    }
+
+    /**
+     * Output a stack trace.
+     *
+     * @param array $trace
+     */
+    protected function outputTrace(array $trace)
+    {
+        foreach ($trace as $index => $entry) {
+            if (isset($entry['class'])) {
+                $function = $entry['class'] . $entry['type'] . $entry['function'];
+            } else {
+                $function = $entry['function'];
+            }
+
+            if (strncmp($function, 'Peridot\\', 8) === 0) {
+                break;
+            }
+
+            $this->output->writeln($this->color('muted', $this->renderTraceEntry($index, $entry, $function)));
+        }
     }
 
     /**
@@ -309,4 +334,15 @@ private function isTtyTerminal(StreamOutput $output)
      * @return void
      */
     abstract public function init();
+
+    private function renderTraceEntry($index, array $entry, $function)
+    {
+        if (isset($entry['file'])) {
+            $location = sprintf(' (%s:%d)', $entry['file'], $entry['line']);
+        } else {
+            $location = '';
+        }
+
+        return sprintf('       #%d %s%s', $index, $function, $location);
+    }
 }
