ExceptionCasterTest.php 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\VarDumper\Tests\Caster;
  11. use PHPUnit\Framework\TestCase;
  12. use Symfony\Component\VarDumper\Caster\Caster;
  13. use Symfony\Component\VarDumper\Caster\ExceptionCaster;
  14. use Symfony\Component\VarDumper\Caster\FrameStub;
  15. use Symfony\Component\VarDumper\Cloner\VarCloner;
  16. use Symfony\Component\VarDumper\Dumper\HtmlDumper;
  17. use Symfony\Component\VarDumper\Test\VarDumperTestTrait;
  18. class ExceptionCasterTest extends TestCase
  19. {
  20. use VarDumperTestTrait;
  21. private function getTestException($msg, &$ref = null)
  22. {
  23. return new \Exception(''.$msg);
  24. }
  25. protected function tearDown(): void
  26. {
  27. ExceptionCaster::$srcContext = 1;
  28. ExceptionCaster::$traceArgs = true;
  29. }
  30. public function testDefaultSettings()
  31. {
  32. $ref = ['foo'];
  33. $e = $this->getTestException('foo', $ref);
  34. $expectedDump = <<<'EODUMP'
  35. Exception {
  36. #message: "foo"
  37. #code: 0
  38. #file: "%sExceptionCasterTest.php"
  39. #line: 28
  40. trace: {
  41. %s%eTests%eCaster%eExceptionCasterTest.php:28 {
  42. › {
  43. › return new \Exception(''.$msg);
  44. › }
  45. }
  46. %s%eTests%eCaster%eExceptionCasterTest.php:40 { …}
  47. %A
  48. EODUMP;
  49. $this->assertDumpMatchesFormat($expectedDump, $e);
  50. $this->assertSame(['foo'], $ref);
  51. }
  52. public function testSeek()
  53. {
  54. $e = $this->getTestException(2);
  55. $expectedDump = <<<'EODUMP'
  56. {
  57. %s%eTests%eCaster%eExceptionCasterTest.php:28 {
  58. › {
  59. › return new \Exception(''.$msg);
  60. › }
  61. }
  62. %s%eTests%eCaster%eExceptionCasterTest.php:64 { …}
  63. %A
  64. EODUMP;
  65. $this->assertStringMatchesFormat($expectedDump, $this->getDump($e, 'trace'));
  66. }
  67. public function testNoArgs()
  68. {
  69. $e = $this->getTestException(1);
  70. ExceptionCaster::$traceArgs = false;
  71. $expectedDump = <<<'EODUMP'
  72. Exception {
  73. #message: "1"
  74. #code: 0
  75. #file: "%sExceptionCasterTest.php"
  76. #line: 28
  77. trace: {
  78. %sExceptionCasterTest.php:28 {
  79. › {
  80. › return new \Exception(''.$msg);
  81. › }
  82. }
  83. %s%eTests%eCaster%eExceptionCasterTest.php:82 { …}
  84. %A
  85. EODUMP;
  86. $this->assertDumpMatchesFormat($expectedDump, $e);
  87. }
  88. public function testNoSrcContext()
  89. {
  90. $e = $this->getTestException(1);
  91. ExceptionCaster::$srcContext = -1;
  92. $expectedDump = <<<'EODUMP'
  93. Exception {
  94. #message: "1"
  95. #code: 0
  96. #file: "%sExceptionCasterTest.php"
  97. #line: 28
  98. trace: {
  99. %s%eTests%eCaster%eExceptionCasterTest.php:28
  100. %s%eTests%eCaster%eExceptionCasterTest.php:%d
  101. %A
  102. EODUMP;
  103. $this->assertDumpMatchesFormat($expectedDump, $e);
  104. }
  105. public function testHtmlDump()
  106. {
  107. if (ini_get('xdebug.file_link_format') || get_cfg_var('xdebug.file_link_format')) {
  108. $this->markTestSkipped('A custom file_link_format is defined.');
  109. }
  110. $e = $this->getTestException(1);
  111. ExceptionCaster::$srcContext = -1;
  112. $cloner = new VarCloner();
  113. $cloner->setMaxItems(1);
  114. $dumper = new HtmlDumper();
  115. $dumper->setDumpHeader('<foo></foo>');
  116. $dumper->setDumpBoundaries('<bar>', '</bar>');
  117. $dump = $dumper->dump($cloner->cloneVar($e)->withRefHandles(false), true);
  118. $expectedDump = <<<'EODUMP'
  119. <foo></foo><bar><span class=sf-dump-note>Exception</span> {<samp>
  120. #<span class=sf-dump-protected title="Protected property">message</span>: "<span class=sf-dump-str>1</span>"
  121. #<span class=sf-dump-protected title="Protected property">code</span>: <span class=sf-dump-num>0</span>
  122. #<span class=sf-dump-protected title="Protected property">file</span>: "<span class=sf-dump-str title="%sExceptionCasterTest.php
  123. %d characters"><span class="sf-dump-ellipsis sf-dump-ellipsis-path">%s%eVarDumper</span><span class=sf-dump-ellipsis>%e</span>Tests%eCaster%eExceptionCasterTest.php</span>"
  124. #<span class=sf-dump-protected title="Protected property">line</span>: <span class=sf-dump-num>28</span>
  125. <span class=sf-dump-meta>trace</span>: {<samp>
  126. <span class=sf-dump-meta title="%sExceptionCasterTest.php
  127. Stack level %d."><span class="sf-dump-ellipsis sf-dump-ellipsis-path">%s%eVarDumper</span><span class=sf-dump-ellipsis>%e</span>Tests%eCaster%eExceptionCasterTest.php</span>:<span class=sf-dump-num>28</span>
  128. &hellip;%d
  129. </samp>}
  130. </samp>}
  131. </bar>
  132. EODUMP;
  133. $this->assertStringMatchesFormat($expectedDump, $dump);
  134. }
  135. /**
  136. * @requires function Twig\Template::getSourceContext
  137. */
  138. public function testFrameWithTwig()
  139. {
  140. require_once \dirname(__DIR__).'/Fixtures/Twig.php';
  141. $f = [
  142. new FrameStub([
  143. 'file' => \dirname(__DIR__).'/Fixtures/Twig.php',
  144. 'line' => 20,
  145. 'class' => '__TwigTemplate_VarDumperFixture_u75a09',
  146. ]),
  147. new FrameStub([
  148. 'file' => \dirname(__DIR__).'/Fixtures/Twig.php',
  149. 'line' => 21,
  150. 'class' => '__TwigTemplate_VarDumperFixture_u75a09',
  151. 'object' => new \__TwigTemplate_VarDumperFixture_u75a09(null, __FILE__),
  152. ]),
  153. ];
  154. $expectedDump = <<<'EODUMP'
  155. array:2 [
  156. 0 => {
  157. class: "__TwigTemplate_VarDumperFixture_u75a09"
  158. src: {
  159. %sTwig.php:1 {
  160. › foo bar
  161. › twig source
  162. }
  163. }
  164. }
  165. 1 => {
  166. class: "__TwigTemplate_VarDumperFixture_u75a09"
  167. object: __TwigTemplate_VarDumperFixture_u75a09 {
  168. %A
  169. }
  170. src: {
  171. %sExceptionCasterTest.php:2 {
  172. › foo bar
  173. › twig source
  174. }
  175. }
  176. }
  177. ]
  178. EODUMP;
  179. $this->assertDumpMatchesFormat($expectedDump, $f);
  180. }
  181. public function testExcludeVerbosity()
  182. {
  183. $e = $this->getTestException('foo');
  184. $expectedDump = <<<'EODUMP'
  185. Exception {
  186. #message: "foo"
  187. #code: 0
  188. #file: "%sExceptionCasterTest.php"
  189. #line: 28
  190. }
  191. EODUMP;
  192. $this->assertDumpMatchesFormat($expectedDump, $e, Caster::EXCLUDE_VERBOSE);
  193. }
  194. public function testAnonymous()
  195. {
  196. $e = new \Exception(sprintf('Boo "%s" ba.', \get_class(new class('Foo') extends \Exception {
  197. })));
  198. $expectedDump = <<<'EODUMP'
  199. Exception {
  200. #message: "Boo "Exception@anonymous" ba."
  201. #code: 0
  202. #file: "%sExceptionCasterTest.php"
  203. #line: %d
  204. }
  205. EODUMP;
  206. $this->assertDumpMatchesFormat($expectedDump, $e, Caster::EXCLUDE_VERBOSE);
  207. }
  208. }