CliDumperTest.php 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575
  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: "{$var['file']}"
  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 provideDumpWithCommaFlagTests()
  119. {
  120. $expected = <<<'EOTXT'
  121. array:3 [
  122. "array" => array:2 [
  123. 0 => "a",
  124. 1 => "b"
  125. ],
  126. "string" => "hello",
  127. "multiline string" => """
  128. this\n
  129. is\n
  130. a\multiline\n
  131. string
  132. """
  133. ]
  134. EOTXT;
  135. yield array($expected, CliDumper::DUMP_COMMA_SEPARATOR);
  136. $expected = <<<'EOTXT'
  137. array:3 [
  138. "array" => array:2 [
  139. 0 => "a",
  140. 1 => "b",
  141. ],
  142. "string" => "hello",
  143. "multiline string" => """
  144. this\n
  145. is\n
  146. a\multiline\n
  147. string
  148. """,
  149. ]
  150. EOTXT;
  151. yield array($expected, CliDumper::DUMP_TRAILING_COMMA);
  152. }
  153. /**
  154. * @requires extension xml
  155. */
  156. public function testXmlResource()
  157. {
  158. $var = xml_parser_create();
  159. $this->assertDumpMatchesFormat(
  160. <<<'EOTXT'
  161. xml resource {
  162. current_byte_index: %i
  163. current_column_number: %i
  164. current_line_number: 1
  165. error_code: XML_ERROR_NONE
  166. }
  167. EOTXT
  168. ,
  169. $var
  170. );
  171. }
  172. public function testJsonCast()
  173. {
  174. $var = (array) json_decode('{"0":{},"1":null}');
  175. foreach ($var as &$v) {
  176. }
  177. $var[] = &$v;
  178. $var[''] = 2;
  179. if (\PHP_VERSION_ID >= 70200) {
  180. $this->assertDumpMatchesFormat(
  181. <<<'EOTXT'
  182. array:4 [
  183. 0 => {}
  184. 1 => &1 null
  185. 2 => &1 null
  186. "" => 2
  187. ]
  188. EOTXT
  189. ,
  190. $var
  191. );
  192. } else {
  193. $this->assertDumpMatchesFormat(
  194. <<<'EOTXT'
  195. array:4 [
  196. "0" => {}
  197. "1" => &1 null
  198. 0 => &1 null
  199. "" => 2
  200. ]
  201. EOTXT
  202. ,
  203. $var
  204. );
  205. }
  206. }
  207. public function testObjectCast()
  208. {
  209. $var = (object) array(1 => 1);
  210. $var->{1} = 2;
  211. if (\PHP_VERSION_ID >= 70200) {
  212. $this->assertDumpMatchesFormat(
  213. <<<'EOTXT'
  214. {
  215. +"1": 2
  216. }
  217. EOTXT
  218. ,
  219. $var
  220. );
  221. } else {
  222. $this->assertDumpMatchesFormat(
  223. <<<'EOTXT'
  224. {
  225. +1: 1
  226. +"1": 2
  227. }
  228. EOTXT
  229. ,
  230. $var
  231. );
  232. }
  233. }
  234. public function testClosedResource()
  235. {
  236. if (defined('HHVM_VERSION') && HHVM_VERSION_ID < 30600) {
  237. $this->markTestSkipped();
  238. }
  239. $var = fopen(__FILE__, 'r');
  240. fclose($var);
  241. $dumper = new CliDumper('php://output');
  242. $dumper->setColors(false);
  243. $cloner = new VarCloner();
  244. $data = $cloner->cloneVar($var);
  245. ob_start();
  246. $dumper->dump($data);
  247. $out = ob_get_clean();
  248. $res = (int) $var;
  249. $this->assertStringMatchesFormat(
  250. <<<EOTXT
  251. Closed resource @{$res}
  252. EOTXT
  253. ,
  254. $out
  255. );
  256. }
  257. public function testFlags()
  258. {
  259. putenv('DUMP_LIGHT_ARRAY=1');
  260. putenv('DUMP_STRING_LENGTH=1');
  261. $var = array(
  262. range(1, 3),
  263. array('foo', 2 => 'bar'),
  264. );
  265. $this->assertDumpEquals(
  266. <<<EOTXT
  267. [
  268. [
  269. 1
  270. 2
  271. 3
  272. ]
  273. [
  274. 0 => (3) "foo"
  275. 2 => (3) "bar"
  276. ]
  277. ]
  278. EOTXT
  279. ,
  280. $var
  281. );
  282. putenv('DUMP_LIGHT_ARRAY=');
  283. putenv('DUMP_STRING_LENGTH=');
  284. }
  285. /**
  286. * @requires function Twig\Template::getSourceContext
  287. */
  288. public function testThrowingCaster()
  289. {
  290. $out = fopen('php://memory', 'r+b');
  291. require_once __DIR__.'/../Fixtures/Twig.php';
  292. $twig = new \__TwigTemplate_VarDumperFixture_u75a09(new Environment(new FilesystemLoader()));
  293. $dumper = new CliDumper();
  294. $dumper->setColors(false);
  295. $cloner = new VarCloner();
  296. $cloner->addCasters(array(
  297. ':stream' => function ($res, $a) {
  298. unset($a['wrapper_data']);
  299. return $a;
  300. },
  301. ));
  302. $cloner->addCasters(array(
  303. ':stream' => eval('return function () use ($twig) {
  304. try {
  305. $twig->render(array());
  306. } catch (\Twig\Error\RuntimeError $e) {
  307. throw $e->getPrevious();
  308. }
  309. };'),
  310. ));
  311. $ref = (int) $out;
  312. $data = $cloner->cloneVar($out);
  313. $dumper->dump($data, $out);
  314. $out = stream_get_contents($out, -1, 0);
  315. $r = defined('HHVM_VERSION') ? '' : '#%d';
  316. $this->assertStringMatchesFormat(
  317. <<<EOTXT
  318. stream resource {@{$ref}
  319. ⚠: Symfony\Component\VarDumper\Exception\ThrowingCasterException {{$r}
  320. #message: "Unexpected Exception thrown from a caster: Foobar"
  321. trace: {
  322. %sTwig.php:2: {
  323. : foo bar
  324. : twig source
  325. :
  326. }
  327. %sTemplate.php:%d: {
  328. : try {
  329. : \$this->doDisplay(\$context, \$blocks);
  330. : } catch (Twig%sError \$e) {
  331. }
  332. %sTemplate.php:%d: {
  333. : {
  334. : \$this->displayWithErrorHandling(\$this->env->mergeGlobals(\$context), array_merge(\$this->blocks, \$blocks));
  335. : }
  336. }
  337. %sTemplate.php:%d: {
  338. : try {
  339. : \$this->display(\$context);
  340. : } catch (%s \$e) {
  341. }
  342. %sCliDumperTest.php:%d: {
  343. %A
  344. }
  345. }
  346. }
  347. %Awrapper_type: "PHP"
  348. stream_type: "MEMORY"
  349. mode: "%s+b"
  350. unread_bytes: 0
  351. seekable: true
  352. uri: "php://memory"
  353. %Aoptions: []
  354. }
  355. EOTXT
  356. ,
  357. $out
  358. );
  359. }
  360. public function testRefsInProperties()
  361. {
  362. $var = (object) array('foo' => 'foo');
  363. $var->bar = &$var->foo;
  364. $dumper = new CliDumper();
  365. $dumper->setColors(false);
  366. $cloner = new VarCloner();
  367. $data = $cloner->cloneVar($var);
  368. $out = $dumper->dump($data, true);
  369. $r = defined('HHVM_VERSION') ? '' : '#%d';
  370. $this->assertStringMatchesFormat(
  371. <<<EOTXT
  372. {{$r}
  373. +"foo": &1 "foo"
  374. +"bar": &1 "foo"
  375. }
  376. EOTXT
  377. ,
  378. $out
  379. );
  380. }
  381. /**
  382. * @runInSeparateProcess
  383. * @preserveGlobalState disabled
  384. * @requires PHP 5.6
  385. */
  386. public function testSpecialVars56()
  387. {
  388. $var = $this->getSpecialVars();
  389. $this->assertDumpEquals(
  390. <<<'EOTXT'
  391. array:3 [
  392. 0 => array:1 [
  393. 0 => &1 array:1 [
  394. 0 => &1 array:1 [&1]
  395. ]
  396. ]
  397. 1 => array:1 [
  398. "GLOBALS" => &2 array:1 [
  399. "GLOBALS" => &2 array:1 [&2]
  400. ]
  401. ]
  402. 2 => &2 array:1 [&2]
  403. ]
  404. EOTXT
  405. ,
  406. $var
  407. );
  408. }
  409. /**
  410. * @runInSeparateProcess
  411. * @preserveGlobalState disabled
  412. */
  413. public function testGlobalsNoExt()
  414. {
  415. $var = $this->getSpecialVars();
  416. unset($var[0]);
  417. $out = '';
  418. $dumper = new CliDumper(function ($line, $depth) use (&$out) {
  419. if ($depth >= 0) {
  420. $out .= str_repeat(' ', $depth).$line."\n";
  421. }
  422. });
  423. $dumper->setColors(false);
  424. $cloner = new VarCloner();
  425. $refl = new \ReflectionProperty($cloner, 'useExt');
  426. $refl->setAccessible(true);
  427. $refl->setValue($cloner, false);
  428. $data = $cloner->cloneVar($var);
  429. $dumper->dump($data);
  430. $this->assertSame(
  431. <<<'EOTXT'
  432. array:2 [
  433. 1 => array:1 [
  434. "GLOBALS" => &1 array:1 [
  435. "GLOBALS" => &1 array:1 [&1]
  436. ]
  437. ]
  438. 2 => &1 array:1 [&1]
  439. ]
  440. EOTXT
  441. ,
  442. $out
  443. );
  444. }
  445. /**
  446. * @runInSeparateProcess
  447. * @preserveGlobalState disabled
  448. */
  449. public function testBuggyRefs()
  450. {
  451. if (\PHP_VERSION_ID >= 50600) {
  452. $this->markTestSkipped('PHP 5.6 fixed refs counting');
  453. }
  454. $var = $this->getSpecialVars();
  455. $var = $var[0];
  456. $dumper = new CliDumper();
  457. $dumper->setColors(false);
  458. $cloner = new VarCloner();
  459. $data = $cloner->cloneVar($var)->withMaxDepth(3);
  460. $out = '';
  461. $dumper->dump($data, function ($line, $depth) use (&$out) {
  462. if ($depth >= 0) {
  463. $out .= str_repeat(' ', $depth).$line."\n";
  464. }
  465. });
  466. $this->assertSame(
  467. <<<'EOTXT'
  468. array:1 [
  469. 0 => array:1 [
  470. 0 => array:1 [
  471. 0 => array:1 [ …1]
  472. ]
  473. ]
  474. ]
  475. EOTXT
  476. ,
  477. $out
  478. );
  479. }
  480. public function testIncompleteClass()
  481. {
  482. $unserializeCallbackHandler = ini_set('unserialize_callback_func', null);
  483. $var = unserialize('O:8:"Foo\Buzz":0:{}');
  484. ini_set('unserialize_callback_func', $unserializeCallbackHandler);
  485. $this->assertDumpMatchesFormat(
  486. <<<EOTXT
  487. __PHP_Incomplete_Class(Foo\Buzz) {}
  488. EOTXT
  489. ,
  490. $var
  491. );
  492. }
  493. private function getSpecialVars()
  494. {
  495. foreach (array_keys($GLOBALS) as $var) {
  496. if ('GLOBALS' !== $var) {
  497. unset($GLOBALS[$var]);
  498. }
  499. }
  500. $var = function &() {
  501. $var = array();
  502. $var[] = &$var;
  503. return $var;
  504. };
  505. return array($var(), $GLOBALS, &$GLOBALS);
  506. }
  507. }