* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Symfony\Component\Console\Tests\Formatter; use PHPUnit\Framework\TestCase; use Symfony\Component\Console\Formatter\OutputFormatter; use Symfony\Component\Console\Formatter\OutputFormatterStyle; class OutputFormatterTest extends TestCase { public function testEmptyTag() { $formatter = new OutputFormatter(true); $this->assertEquals('foo<>bar', $formatter->format('foo<>bar')); } public function testLGCharEscaping() { $formatter = new OutputFormatter(true); $this->assertEquals('fooformat('foo\\assertEquals('foo << bar', $formatter->format('foo << bar')); $this->assertEquals('foo << bar \\', $formatter->format('foo << bar \\')); $this->assertEquals("foo << \033[32mbar \\ baz\033[39m \\", $formatter->format('foo << bar \\ baz \\')); $this->assertEquals('some info', $formatter->format('\\some info\\')); $this->assertEquals('\\some info\\', OutputFormatter::escape('some info')); $this->assertEquals( "\033[33mSymfony\\Component\\Console does work very well!\033[39m", $formatter->format('Symfony\Component\Console does work very well!') ); } public function testBundledStyles() { $formatter = new OutputFormatter(true); $this->assertTrue($formatter->hasStyle('error')); $this->assertTrue($formatter->hasStyle('info')); $this->assertTrue($formatter->hasStyle('comment')); $this->assertTrue($formatter->hasStyle('question')); $this->assertEquals( "\033[37;41msome error\033[39;49m", $formatter->format('some error') ); $this->assertEquals( "\033[32msome info\033[39m", $formatter->format('some info') ); $this->assertEquals( "\033[33msome comment\033[39m", $formatter->format('some comment') ); $this->assertEquals( "\033[30;46msome question\033[39;49m", $formatter->format('some question') ); } public function testNestedStyles() { $formatter = new OutputFormatter(true); $this->assertEquals( "\033[37;41msome \033[39;49m\033[32msome info\033[39m\033[37;41m error\033[39;49m", $formatter->format('some some info error') ); } public function testAdjacentStyles() { $formatter = new OutputFormatter(true); $this->assertEquals( "\033[37;41msome error\033[39;49m\033[32msome info\033[39m", $formatter->format('some errorsome info') ); } public function testStyleMatchingNotGreedy() { $formatter = new OutputFormatter(true); $this->assertEquals( "(\033[32m>=2.0,<2.3\033[39m)", $formatter->format('(>=2.0,<2.3)') ); } public function testStyleEscaping() { $formatter = new OutputFormatter(true); $this->assertEquals( "(\033[32mz>=2.0,<<format('('.$formatter->escape('z>=2.0,<\\<)') ); $this->assertEquals( "\033[32msome error\033[39m", $formatter->format(''.$formatter->escape('some error').'') ); } public function testDeepNestedStyles() { $formatter = new OutputFormatter(true); $this->assertEquals( "\033[37;41merror\033[39;49m\033[32minfo\033[39m\033[33mcomment\033[39m\033[37;41merror\033[39;49m", $formatter->format('errorinfocommenterror') ); } public function testNewStyle() { $formatter = new OutputFormatter(true); $style = new OutputFormatterStyle('blue', 'white'); $formatter->setStyle('test', $style); $this->assertEquals($style, $formatter->getStyle('test')); $this->assertNotEquals($style, $formatter->getStyle('info')); $style = new OutputFormatterStyle('blue', 'white'); $formatter->setStyle('b', $style); $this->assertEquals("\033[34;47msome \033[39;49m\033[34;47mcustom\033[39;49m\033[34;47m msg\033[39;49m", $formatter->format('some custom msg')); } public function testRedefineStyle() { $formatter = new OutputFormatter(true); $style = new OutputFormatterStyle('blue', 'white'); $formatter->setStyle('info', $style); $this->assertEquals("\033[34;47msome custom msg\033[39;49m", $formatter->format('some custom msg')); } public function testInlineStyle() { $formatter = new OutputFormatter(true); $this->assertEquals("\033[34;41msome text\033[39;49m", $formatter->format('some text')); $this->assertEquals("\033[34;41msome text\033[39;49m", $formatter->format('some text')); } /** * @param string $tag * @param string|null $expected * @param string|null $input * * @dataProvider provideInlineStyleOptionsCases */ public function testInlineStyleOptions($tag, $expected = null, $input = null) { $styleString = substr($tag, 1, -1); $formatter = new OutputFormatter(true); $method = new \ReflectionMethod($formatter, 'createStyleFromString'); $method->setAccessible(true); $result = $method->invoke($formatter, $styleString); if (null === $expected) { $this->assertFalse($result); $expected = $tag.$input.''; $this->assertSame($expected, $formatter->format($expected)); } else { /* @var OutputFormatterStyle $result */ $this->assertInstanceOf(OutputFormatterStyle::class, $result); $this->assertSame($expected, $formatter->format($tag.$input.'')); $this->assertSame($expected, $formatter->format($tag.$input.'')); } } public function provideInlineStyleOptionsCases() { return [ [''], [''], ['', "\033[32m[test]\033[39m", '[test]'], ['', "\033[32;44ma\033[39;49m", 'a'], ['', "\033[32;1mb\033[39;22m", 'b'], ['', "\033[32;7m\033[39;27m", ''], ['', "\033[32;1;4mz\033[39;22;24m", 'z'], ['', "\033[32;1;4;7md\033[39;22;24;27m", 'd'], ]; } public function provideInlineStyleTagsWithUnknownOptions() { return [ ['', 'abc'], ['', 'abc'], ['', 'xyz'], ['', 'efg'], ]; } public function testNonStyleTag() { $formatter = new OutputFormatter(true); $this->assertEquals("\033[32msome \033[39m\033[32m\033[39m\033[32m \033[39m\033[32m\033[39m\033[32m styled \033[39m\033[32m

\033[39m\033[32msingle-char tag\033[39m\033[32m

\033[39m", $formatter->format('some styled

single-char tag

')); } public function testFormatLongString() { $formatter = new OutputFormatter(true); $long = str_repeat('\\', 14000); $this->assertEquals("\033[37;41msome error\033[39;49m".$long, $formatter->format('some error'.$long)); } public function testFormatToStringObject() { $formatter = new OutputFormatter(false); $this->assertEquals( 'some info', $formatter->format(new TableCell()) ); } public function testNotDecoratedFormatter() { $formatter = new OutputFormatter(false); $this->assertTrue($formatter->hasStyle('error')); $this->assertTrue($formatter->hasStyle('info')); $this->assertTrue($formatter->hasStyle('comment')); $this->assertTrue($formatter->hasStyle('question')); $this->assertEquals( 'some error', $formatter->format('some error') ); $this->assertEquals( 'some info', $formatter->format('some info') ); $this->assertEquals( 'some comment', $formatter->format('some comment') ); $this->assertEquals( 'some question', $formatter->format('some question') ); $this->assertEquals( 'some text with inline style', $formatter->format('some text with inline style') ); $formatter->setDecorated(true); $this->assertEquals( "\033[37;41msome error\033[39;49m", $formatter->format('some error') ); $this->assertEquals( "\033[32msome info\033[39m", $formatter->format('some info') ); $this->assertEquals( "\033[33msome comment\033[39m", $formatter->format('some comment') ); $this->assertEquals( "\033[30;46msome question\033[39;49m", $formatter->format('some question') ); $this->assertEquals( "\033[31msome text with inline style\033[39m", $formatter->format('some text with inline style') ); } public function testContentWithLineBreaks() { $formatter = new OutputFormatter(true); $this->assertEquals(<<format(<<<'EOF' some text EOF )); $this->assertEquals(<<format(<<<'EOF' some text EOF )); $this->assertEquals(<<format(<<<'EOF' some text EOF )); $this->assertEquals(<<format(<<<'EOF' some text more text EOF )); } public function testFormatAndWrap() { $formatter = new OutputFormatter(true); $this->assertSame("fo\no\e[37;41mb\e[39;49m\n\e[37;41mar\e[39;49m\nba\nz", $formatter->formatAndWrap('foobar baz', 2)); $this->assertSame("pr\ne \e[37;41m\e[39;49m\n\e[37;41mfo\e[39;49m\n\e[37;41mo \e[39;49m\n\e[37;41mba\e[39;49m\n\e[37;41mr \e[39;49m\n\e[37;41mba\e[39;49m\n\e[37;41mz\e[39;49m \npo\nst", $formatter->formatAndWrap('pre foo bar baz post', 2)); $this->assertSame("pre\e[37;41m\e[39;49m\n\e[37;41mfoo\e[39;49m\n\e[37;41mbar\e[39;49m\n\e[37;41mbaz\e[39;49m\npos\nt", $formatter->formatAndWrap('pre foo bar baz post', 3)); $this->assertSame("pre \e[37;41m\e[39;49m\n\e[37;41mfoo \e[39;49m\n\e[37;41mbar \e[39;49m\n\e[37;41mbaz\e[39;49m \npost", $formatter->formatAndWrap('pre foo bar baz post', 4)); $this->assertSame("pre \e[37;41mf\e[39;49m\n\e[37;41moo ba\e[39;49m\n\e[37;41mr baz\e[39;49m\npost", $formatter->formatAndWrap('pre foo bar baz post', 5)); $formatter = new OutputFormatter(); $this->assertSame("fo\nob\nar\nba\nz", $formatter->formatAndWrap('foobar baz', 2)); $this->assertSame("pr\ne \nfo\no \nba\nr \nba\nz \npo\nst", $formatter->formatAndWrap('pre foo bar baz post', 2)); $this->assertSame("pre\nfoo\nbar\nbaz\npos\nt", $formatter->formatAndWrap('pre foo bar baz post', 3)); $this->assertSame("pre \nfoo \nbar \nbaz \npost", $formatter->formatAndWrap('pre foo bar baz post', 4)); $this->assertSame("pre f\noo ba\nr baz\npost", $formatter->formatAndWrap('pre foo bar baz post', 5)); } } class TableCell { public function __toString() { return 'some info'; } }