CliDumperTest.php 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591
  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\Dumper;
  11. use PHPUnit\Framework\TestCase;
  12. use Symfony\Component\VarDumper\Cloner\VarCloner;
  13. use Symfony\Component\VarDumper\Dumper\CliDumper;
  14. use Symfony\Component\VarDumper\Test\VarDumperTestTrait;
  15. use Twig\Environment;
  16. use Twig\Loader\FilesystemLoader;
  17. /**
  18. * @author Nicolas Grekas <p@tchwork.com>
  19. */
  20. class CliDumperTest extends TestCase
  21. {
  22. use VarDumperTestTrait;
  23. public function testGet()
  24. {
  25. require __DIR__.'/../Fixtures/dumb-var.php';
  26. $dumper = new CliDumper('php://output');
  27. $dumper->setColors(false);
  28. $cloner = new VarCloner();
  29. $cloner->addCasters(array(
  30. ':stream' => function ($res, $a) {
  31. unset($a['uri'], $a['wrapper_data']);
  32. return $a;
  33. },
  34. ));
  35. $data = $cloner->cloneVar($var);
  36. ob_start();
  37. $dumper->dump($data);
  38. $out = ob_get_clean();
  39. $out = preg_replace('/[ \t]+$/m', '', $out);
  40. $intMax = PHP_INT_MAX;
  41. $res = (int) $var['res'];
  42. $r = \defined('HHVM_VERSION') ? '' : '#%d';
  43. $this->assertStringMatchesFormat(
  44. <<<EOTXT
  45. array:24 [
  46. "number" => 1
  47. 0 => &1 null
  48. "const" => 1.1
  49. 1 => true
  50. 2 => false
  51. 3 => NAN
  52. 4 => INF
  53. 5 => -INF
  54. 6 => {$intMax}
  55. "str" => "déjà\\n"
  56. 7 => b"é\\x00"
  57. "[]" => []
  58. "res" => stream resource {@{$res}
  59. %A wrapper_type: "plainfile"
  60. stream_type: "STDIO"
  61. mode: "r"
  62. unread_bytes: 0
  63. seekable: true
  64. %A options: []
  65. }
  66. "obj" => Symfony\Component\VarDumper\Tests\Fixture\DumbFoo {#%d
  67. +foo: "foo"
  68. +"bar": "bar"
  69. }
  70. "closure" => Closure {{$r}
  71. class: "Symfony\Component\VarDumper\Tests\Dumper\CliDumperTest"
  72. this: Symfony\Component\VarDumper\Tests\Dumper\CliDumperTest {{$r} …}
  73. parameters: {
  74. \$a: {}
  75. &\$b: {
  76. typeHint: "PDO"
  77. default: null
  78. }
  79. }
  80. file: "%s%eTests%eFixtures%edumb-var.php"
  81. line: "{$var['line']} to {$var['line']}"
  82. }
  83. "line" => {$var['line']}
  84. "nobj" => array:1 [
  85. 0 => &3 {#%d}
  86. ]
  87. "recurs" => &4 array:1 [
  88. 0 => &4 array:1 [&4]
  89. ]
  90. 8 => &1 null
  91. "sobj" => Symfony\Component\VarDumper\Tests\Fixture\DumbFoo {#%d}
  92. "snobj" => &3 {#%d}
  93. "snobj2" => {#%d}
  94. "file" => "{$var['file']}"
  95. b"bin-key-é" => ""
  96. ]
  97. EOTXT
  98. ,
  99. $out
  100. );
  101. }
  102. /**
  103. * @dataProvider provideDumpWithCommaFlagTests
  104. */
  105. public function testDumpWithCommaFlag($expected, $flags)
  106. {
  107. $dumper = new CliDumper(null, null, $flags);
  108. $dumper->setColors(false);
  109. $cloner = new VarCloner();
  110. $var = array(
  111. 'array' => array('a', 'b'),
  112. 'string' => 'hello',
  113. 'multiline string' => "this\nis\na\multiline\nstring",
  114. );
  115. $dump = $dumper->dump($cloner->cloneVar($var), true);
  116. $this->assertSame($expected, $dump);
  117. }
  118. public function testDumpWithCommaFlagsAndExceptionCodeExcerpt()
  119. {
  120. $dumper = new CliDumper(null, null, CliDumper::DUMP_TRAILING_COMMA);
  121. $dumper->setColors(false);
  122. $cloner = new VarCloner();
  123. $ex = new \RuntimeException('foo');
  124. $dump = $dumper->dump($cloner->cloneVar($ex)->withRefHandles(false), true);
  125. $this->assertStringMatchesFormat(<<<'EOTXT'
  126. RuntimeException {
  127. #message: "foo"
  128. #code: 0
  129. #file: "%ACliDumperTest.php"
  130. #line: %d
  131. trace: {
  132. %ACliDumperTest.php:%d {
  133. › $ex = new \RuntimeException('foo');
  134. }
  135. %A
  136. }
  137. }
  138. EOTXT
  139. , $dump);
  140. }
  141. public function provideDumpWithCommaFlagTests()
  142. {
  143. $expected = <<<'EOTXT'
  144. array:3 [
  145. "array" => array:2 [
  146. 0 => "a",
  147. 1 => "b"
  148. ],
  149. "string" => "hello",
  150. "multiline string" => """
  151. this\n
  152. is\n
  153. a\multiline\n
  154. string
  155. """
  156. ]
  157. EOTXT;
  158. yield array($expected, CliDumper::DUMP_COMMA_SEPARATOR);
  159. $expected = <<<'EOTXT'
  160. array:3 [
  161. "array" => array:2 [
  162. 0 => "a",
  163. 1 => "b",
  164. ],
  165. "string" => "hello",
  166. "multiline string" => """
  167. this\n
  168. is\n
  169. a\multiline\n
  170. string
  171. """,
  172. ]
  173. EOTXT;
  174. yield array($expected, CliDumper::DUMP_TRAILING_COMMA);
  175. }
  176. /**
  177. * @requires extension xml
  178. */
  179. public function testXmlResource()
  180. {
  181. $var = xml_parser_create();
  182. $this->assertDumpMatchesFormat(
  183. <<<'EOTXT'
  184. xml resource {
  185. current_byte_index: %i
  186. current_column_number: %i
  187. current_line_number: 1
  188. error_code: XML_ERROR_NONE
  189. }
  190. EOTXT
  191. ,
  192. $var
  193. );
  194. }
  195. public function testJsonCast()
  196. {
  197. $var = (array) json_decode('{"0":{},"1":null}');
  198. foreach ($var as &$v) {
  199. }
  200. $var[] = &$v;
  201. $var[''] = 2;
  202. if (\PHP_VERSION_ID >= 70200) {
  203. $this->assertDumpMatchesFormat(
  204. <<<'EOTXT'
  205. array:4 [
  206. 0 => {}
  207. 1 => &1 null
  208. 2 => &1 null
  209. "" => 2
  210. ]
  211. EOTXT
  212. ,
  213. $var
  214. );
  215. } else {
  216. $this->assertDumpMatchesFormat(
  217. <<<'EOTXT'
  218. array:4 [
  219. "0" => {}
  220. "1" => &1 null
  221. 0 => &1 null
  222. "" => 2
  223. ]
  224. EOTXT
  225. ,
  226. $var
  227. );
  228. }
  229. }
  230. public function testObjectCast()
  231. {
  232. $var = (object) array(1 => 1);
  233. $var->{1} = 2;
  234. if (\PHP_VERSION_ID >= 70200) {
  235. $this->assertDumpMatchesFormat(
  236. <<<'EOTXT'
  237. {
  238. +"1": 2
  239. }
  240. EOTXT
  241. ,
  242. $var
  243. );
  244. } else {
  245. $this->assertDumpMatchesFormat(
  246. <<<'EOTXT'
  247. {
  248. +1: 1
  249. +"1": 2
  250. }
  251. EOTXT
  252. ,
  253. $var
  254. );
  255. }
  256. }
  257. public function testClosedResource()
  258. {
  259. if (\defined('HHVM_VERSION') && HHVM_VERSION_ID < 30600) {
  260. $this->markTestSkipped();
  261. }
  262. $var = fopen(__FILE__, 'r');
  263. fclose($var);
  264. $dumper = new CliDumper('php://output');
  265. $dumper->setColors(false);
  266. $cloner = new VarCloner();
  267. $data = $cloner->cloneVar($var);
  268. ob_start();
  269. $dumper->dump($data);
  270. $out = ob_get_clean();
  271. $res = (int) $var;
  272. $this->assertStringMatchesFormat(
  273. <<<EOTXT
  274. Closed resource @{$res}
  275. EOTXT
  276. ,
  277. $out
  278. );
  279. }
  280. public function testFlags()
  281. {
  282. putenv('DUMP_LIGHT_ARRAY=1');
  283. putenv('DUMP_STRING_LENGTH=1');
  284. $var = array(
  285. range(1, 3),
  286. array('foo', 2 => 'bar'),
  287. );
  288. $this->assertDumpEquals(
  289. <<<EOTXT
  290. [
  291. [
  292. 1
  293. 2
  294. 3
  295. ]
  296. [
  297. 0 => (3) "foo"
  298. 2 => (3) "bar"
  299. ]
  300. ]
  301. EOTXT
  302. ,
  303. $var
  304. );
  305. putenv('DUMP_LIGHT_ARRAY=');
  306. putenv('DUMP_STRING_LENGTH=');
  307. }
  308. /**
  309. * @requires function Twig\Template::getSourceContext
  310. */
  311. public function testThrowingCaster()
  312. {
  313. $out = fopen('php://memory', 'r+b');
  314. require_once __DIR__.'/../Fixtures/Twig.php';
  315. $twig = new \__TwigTemplate_VarDumperFixture_u75a09(new Environment(new FilesystemLoader()));
  316. $dumper = new CliDumper();
  317. $dumper->setColors(false);
  318. $cloner = new VarCloner();
  319. $cloner->addCasters(array(
  320. ':stream' => function ($res, $a) {
  321. unset($a['wrapper_data']);
  322. return $a;
  323. },
  324. ));
  325. $cloner->addCasters(array(
  326. ':stream' => eval('return function () use ($twig) {
  327. try {
  328. $twig->render(array());
  329. } catch (\Twig\Error\RuntimeError $e) {
  330. throw $e->getPrevious();
  331. }
  332. };'),
  333. ));
  334. $ref = (int) $out;
  335. $data = $cloner->cloneVar($out);
  336. $dumper->dump($data, $out);
  337. $out = stream_get_contents($out, -1, 0);
  338. $r = \defined('HHVM_VERSION') ? '' : '#%d';
  339. $this->assertStringMatchesFormat(
  340. <<<EOTXT
  341. stream resource {@{$ref}
  342. ⚠: Symfony\Component\VarDumper\Exception\ThrowingCasterException {{$r}
  343. #message: "Unexpected Exception thrown from a caster: Foobar"
  344. trace: {
  345. %sTwig.php:2 {
  346. › foo bar
  347. › twig source
  348. }
  349. %s%eTemplate.php:%d { …}
  350. %s%eTemplate.php:%d { …}
  351. %s%eTemplate.php:%d { …}
  352. %s%eTests%eDumper%eCliDumperTest.php:%d { …}
  353. %A }
  354. }
  355. %Awrapper_type: "PHP"
  356. stream_type: "MEMORY"
  357. mode: "%s+b"
  358. unread_bytes: 0
  359. seekable: true
  360. uri: "php://memory"
  361. %Aoptions: []
  362. }
  363. EOTXT
  364. ,
  365. $out
  366. );
  367. }
  368. public function testRefsInProperties()
  369. {
  370. $var = (object) array('foo' => 'foo');
  371. $var->bar = &$var->foo;
  372. $dumper = new CliDumper();
  373. $dumper->setColors(false);
  374. $cloner = new VarCloner();
  375. $data = $cloner->cloneVar($var);
  376. $out = $dumper->dump($data, true);
  377. $r = \defined('HHVM_VERSION') ? '' : '#%d';
  378. $this->assertStringMatchesFormat(
  379. <<<EOTXT
  380. {{$r}
  381. +"foo": &1 "foo"
  382. +"bar": &1 "foo"
  383. }
  384. EOTXT
  385. ,
  386. $out
  387. );
  388. }
  389. /**
  390. * @runInSeparateProcess
  391. * @preserveGlobalState disabled
  392. * @requires PHP 5.6
  393. */
  394. public function testSpecialVars56()
  395. {
  396. $var = $this->getSpecialVars();
  397. $this->assertDumpEquals(
  398. <<<'EOTXT'
  399. array:3 [
  400. 0 => array:1 [
  401. 0 => &1 array:1 [
  402. 0 => &1 array:1 [&1]
  403. ]
  404. ]
  405. 1 => array:1 [
  406. "GLOBALS" => &2 array:1 [
  407. "GLOBALS" => &2 array:1 [&2]
  408. ]
  409. ]
  410. 2 => &2 array:1 [&2]
  411. ]
  412. EOTXT
  413. ,
  414. $var
  415. );
  416. }
  417. /**
  418. * @runInSeparateProcess
  419. * @preserveGlobalState disabled
  420. */
  421. public function testGlobalsNoExt()
  422. {
  423. $var = $this->getSpecialVars();
  424. unset($var[0]);
  425. $out = '';
  426. $dumper = new CliDumper(function ($line, $depth) use (&$out) {
  427. if ($depth >= 0) {
  428. $out .= str_repeat(' ', $depth).$line."\n";
  429. }
  430. });
  431. $dumper->setColors(false);
  432. $cloner = new VarCloner();
  433. $refl = new \ReflectionProperty($cloner, 'useExt');
  434. $refl->setAccessible(true);
  435. $refl->setValue($cloner, false);
  436. $data = $cloner->cloneVar($var);
  437. $dumper->dump($data);
  438. $this->assertSame(
  439. <<<'EOTXT'
  440. array:2 [
  441. 1 => array:1 [
  442. "GLOBALS" => &1 array:1 [
  443. "GLOBALS" => &1 array:1 [&1]
  444. ]
  445. ]
  446. 2 => &1 array:1 [&1]
  447. ]
  448. EOTXT
  449. ,
  450. $out
  451. );
  452. }
  453. /**
  454. * @runInSeparateProcess
  455. * @preserveGlobalState disabled
  456. */
  457. public function testBuggyRefs()
  458. {
  459. if (\PHP_VERSION_ID >= 50600) {
  460. $this->markTestSkipped('PHP 5.6 fixed refs counting');
  461. }
  462. $var = $this->getSpecialVars();
  463. $var = $var[0];
  464. $dumper = new CliDumper();
  465. $dumper->setColors(false);
  466. $cloner = new VarCloner();
  467. $data = $cloner->cloneVar($var)->withMaxDepth(3);
  468. $out = '';
  469. $dumper->dump($data, function ($line, $depth) use (&$out) {
  470. if ($depth >= 0) {
  471. $out .= str_repeat(' ', $depth).$line."\n";
  472. }
  473. });
  474. $this->assertSame(
  475. <<<'EOTXT'
  476. array:1 [
  477. 0 => array:1 [
  478. 0 => array:1 [
  479. 0 => array:1 [ …1]
  480. ]
  481. ]
  482. ]
  483. EOTXT
  484. ,
  485. $out
  486. );
  487. }
  488. public function testIncompleteClass()
  489. {
  490. $unserializeCallbackHandler = ini_set('unserialize_callback_func', null);
  491. $var = unserialize('O:8:"Foo\Buzz":0:{}');
  492. ini_set('unserialize_callback_func', $unserializeCallbackHandler);
  493. $this->assertDumpMatchesFormat(
  494. <<<EOTXT
  495. __PHP_Incomplete_Class(Foo\Buzz) {}
  496. EOTXT
  497. ,
  498. $var
  499. );
  500. }
  501. private function getSpecialVars()
  502. {
  503. foreach (array_keys($GLOBALS) as $var) {
  504. if ('GLOBALS' !== $var) {
  505. unset($GLOBALS[$var]);
  506. }
  507. }
  508. $var = function &() {
  509. $var = array();
  510. $var[] = &$var;
  511. return $var;
  512. };
  513. return array($var(), $GLOBALS, &$GLOBALS);
  514. }
  515. }