* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Symfony\Component\Yaml\Tests; use PHPUnit\Framework\TestCase; use Symfony\Component\Yaml\Exception\ParseException; use Symfony\Component\Yaml\Parser; use Symfony\Component\Yaml\Tag\TaggedValue; use Symfony\Component\Yaml\Yaml; class ParserTest extends TestCase { /** @var Parser */ protected $parser; protected function setUp(): void { $this->parser = new Parser(); } protected function tearDown(): void { $this->parser = null; chmod(__DIR__.'/Fixtures/not_readable.yml', 0644); } public function testTopLevelNumber() { $yml = '5'; $data = $this->parser->parse($yml); $expected = 5; $this->assertSameData($expected, $data); } public function testTopLevelNull() { $yml = 'null'; $data = $this->parser->parse($yml); $expected = null; $this->assertSameData($expected, $data); } public function testTaggedValueTopLevelNumber() { $yml = '!number 5'; $data = $this->parser->parse($yml, Yaml::PARSE_CUSTOM_TAGS); // @todo Preserve the number, don't turn into string. $expected = new TaggedValue('number', '5'); $this->assertSameData($expected, $data); } public function testTaggedValueTopLevelNull() { $yml = '!tag null'; $data = $this->parser->parse($yml, Yaml::PARSE_CUSTOM_TAGS); // @todo Preserve literal null, don't turn into string. $expected = new TaggedValue('tag', 'null'); $this->assertSameData($expected, $data); } public function testTaggedValueTopLevelString() { $yml = '!user barbara'; $data = $this->parser->parse($yml, Yaml::PARSE_CUSTOM_TAGS); $expected = new TaggedValue('user', 'barbara'); $this->assertSameData($expected, $data); } public function testTaggedValueTopLevelAssocInline() { $yml = '!user { name: barbara }'; $data = $this->parser->parse($yml, Yaml::PARSE_CUSTOM_TAGS); $expected = new TaggedValue('user', ['name' => 'barbara']); $this->assertSameData($expected, $data); } public function testTaggedValueTopLevelAssoc() { $yml = <<<'YAML' !user name: barbara YAML; $data = $this->parser->parse($yml, Yaml::PARSE_CUSTOM_TAGS); $expected = new TaggedValue('user', ['name' => 'barbara']); $this->assertSameData($expected, $data); } public function testTaggedValueTopLevelList() { $yml = <<<'YAML' !users - barbara YAML; $data = $this->parser->parse($yml, Yaml::PARSE_CUSTOM_TAGS); $expected = new TaggedValue('users', ['barbara']); $this->assertSameData($expected, $data); } public function testTaggedTextAsListItem() { $yml = <<<'YAML' - !text | first line YAML; // @todo Fix the parser, eliminate this exception. $this->expectException(ParseException::class); $this->expectExceptionMessage('Unable to parse at line 2 (near "!text |").'); $this->parser->parse($yml, Yaml::PARSE_CUSTOM_TAGS); } /** * @dataProvider getDataFormSpecifications */ public function testSpecifications($expected, $yaml, $comment) { $this->assertEquals($expected, var_export($this->parser->parse($yaml), true), $comment); } public function getDataFormSpecifications() { return $this->loadTestsFromFixtureFiles('index.yml'); } public function getNonStringMappingKeysData() { return $this->loadTestsFromFixtureFiles('nonStringKeys.yml'); } /** * @dataProvider invalidIndentation */ public function testTabsAsIndentationInYaml(string $given, string $expectedMessage) { $this->expectException(ParseException::class); $this->expectExceptionMessage($expectedMessage); $this->parser->parse($given); } public function invalidIndentation(): array { return [ [ "foo:\n\tbar", "A YAML file cannot contain tabs as indentation at line 2 (near \"\tbar\").", ], [ "foo:\n \tbar", "A YAML file cannot contain tabs as indentation at line 2 (near \"\tbar\").", ], [ "foo:\n\t bar", "A YAML file cannot contain tabs as indentation at line 2 (near \"\t bar\").", ], [ "foo:\n \t bar", "A YAML file cannot contain tabs as indentation at line 2 (near \"\t bar\").", ], ]; } public function testParserIsStateless() { $yamlString = '# translations/messages.en.yaml '; $this->parser->parse($yamlString); $this->parser->parse($yamlString); $this->expectException(ParseException::class); $this->expectExceptionMessage("A YAML file cannot contain tabs as indentation at line 2 (near \"\tabc\")"); $this->parser->parse("abc:\n\tabc"); } /** * @dataProvider validTokenSeparators */ public function testValidTokenSeparation(string $given, array $expected) { $actual = $this->parser->parse($given); $this->assertSameData($expected, $actual); } public function validTokenSeparators(): array { return [ [ 'foo: bar', ['foo' => 'bar'], ], [ "foo:\tbar", ['foo' => 'bar'], ], [ "foo: \tbar", ['foo' => 'bar'], ], [ "foo:\t bar", ['foo' => 'bar'], ], ]; } public function testEndOfTheDocumentMarker() { $yaml = <<<'EOF' --- %YAML:1.0 foo ... EOF; $this->assertEquals('foo', $this->parser->parse($yaml)); } public function getBlockChompingTests() { $tests = []; $yaml = <<<'EOF' foo: |- one two bar: |- one two EOF; $expected = [ 'foo' => "one\ntwo", 'bar' => "one\ntwo", ]; $tests['Literal block chomping strip with single trailing newline'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: |- one two bar: |- one two EOF; $expected = [ 'foo' => "one\ntwo", 'bar' => "one\ntwo", ]; $tests['Literal block chomping strip with multiple trailing newlines'] = [$expected, $yaml]; $yaml = <<<'EOF' {} EOF; $expected = []; $tests['Literal block chomping strip with multiple trailing newlines after a 1-liner'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: |- one two bar: |- one two EOF; $expected = [ 'foo' => "one\ntwo", 'bar' => "one\ntwo", ]; $tests['Literal block chomping strip without trailing newline'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: | one two bar: | one two EOF; $expected = [ 'foo' => "one\ntwo\n", 'bar' => "one\ntwo\n", ]; $tests['Literal block chomping clip with single trailing newline'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: | one two bar: | one two EOF; $expected = [ 'foo' => "one\ntwo\n", 'bar' => "one\ntwo\n", ]; $tests['Literal block chomping clip with multiple trailing newlines'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: - bar: | one two EOF; $expected = [ 'foo' => [ [ 'bar' => "one\n\ntwo", ], ], ]; $tests['Literal block chomping clip with embedded blank line inside unindented collection'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: | one two bar: | one two EOF; $expected = [ 'foo' => "one\ntwo\n", 'bar' => "one\ntwo", ]; $tests['Literal block chomping clip without trailing newline'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: |+ one two bar: |+ one two EOF; $expected = [ 'foo' => "one\ntwo\n", 'bar' => "one\ntwo\n", ]; $tests['Literal block chomping keep with single trailing newline'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: |+ one two bar: |+ one two EOF; $expected = [ 'foo' => "one\ntwo\n\n", 'bar' => "one\ntwo\n\n", ]; $tests['Literal block chomping keep with multiple trailing newlines'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: |+ one two bar: |+ one two EOF; $expected = [ 'foo' => "one\ntwo\n", 'bar' => "one\ntwo", ]; $tests['Literal block chomping keep without trailing newline'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: >- one two bar: >- one two EOF; $expected = [ 'foo' => 'one two', 'bar' => 'one two', ]; $tests['Folded block chomping strip with single trailing newline'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: >- one two bar: >- one two EOF; $expected = [ 'foo' => 'one two', 'bar' => 'one two', ]; $tests['Folded block chomping strip with multiple trailing newlines'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: >- one two bar: >- one two EOF; $expected = [ 'foo' => 'one two', 'bar' => 'one two', ]; $tests['Folded block chomping strip without trailing newline'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: > one two bar: > one two EOF; $expected = [ 'foo' => "one two\n", 'bar' => "one two\n", ]; $tests['Folded block chomping clip with single trailing newline'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: > one two bar: > one two EOF; $expected = [ 'foo' => "one two\n", 'bar' => "one two\n", ]; $tests['Folded block chomping clip with multiple trailing newlines'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: > one two bar: > one two EOF; $expected = [ 'foo' => "one two\n", 'bar' => 'one two', ]; $tests['Folded block chomping clip without trailing newline'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: >+ one two bar: >+ one two EOF; $expected = [ 'foo' => "one two\n", 'bar' => "one two\n", ]; $tests['Folded block chomping keep with single trailing newline'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: >+ one two bar: >+ one two EOF; $expected = [ 'foo' => "one two\n\n", 'bar' => "one two\n\n", ]; $tests['Folded block chomping keep with multiple trailing newlines'] = [$expected, $yaml]; $yaml = <<<'EOF' foo: >+ one two bar: >+ one two EOF; $expected = [ 'foo' => "one two\n", 'bar' => 'one two', ]; $tests['Folded block chomping keep without trailing newline'] = [$expected, $yaml]; return $tests; } /** * @dataProvider getBlockChompingTests */ public function testBlockChomping($expected, $yaml) { $this->assertSame($expected, $this->parser->parse($yaml)); } /** * Regression test for issue #7989. * * @see https://github.com/symfony/symfony/issues/7989 */ public function testBlockLiteralWithLeadingNewlines() { $yaml = <<<'EOF' foo: |- bar EOF; $expected = [ 'foo' => "\n\nbar", ]; $this->assertSame($expected, $this->parser->parse($yaml)); } public function testObjectSupportEnabled() { $input = <<<'EOF' foo: !php/object O:30:"Symfony\Component\Yaml\Tests\B":1:{s:1:"b";s:3:"foo";} bar: 1 EOF; $this->assertSameData(['foo' => new B(), 'bar' => 1], $this->parser->parse($input, Yaml::PARSE_OBJECT), '->parse() is able to parse objects'); } public function testObjectSupportDisabledButNoExceptions() { $input = <<<'EOF' foo: !php/object O:30:"Symfony\Tests\Component\Yaml\B":1:{s:1:"b";s:3:"foo";} bar: 1 EOF; $this->assertSameData(['foo' => null, 'bar' => 1], $this->parser->parse($input), '->parse() does not parse objects'); } /** * @dataProvider getObjectForMapTests */ public function testObjectForMap($yaml, $expected) { $flags = Yaml::PARSE_OBJECT_FOR_MAP; $this->assertSameData($expected, $this->parser->parse($yaml, $flags)); } public function getObjectForMapTests() { $tests = []; $yaml = <<<'EOF' foo: fiz: [cat] EOF; $expected = new \stdClass(); $expected->foo = new \stdClass(); $expected->foo->fiz = ['cat']; $tests['mapping'] = [$yaml, $expected]; $yaml = '{ "foo": "bar", "fiz": "cat" }'; $expected = new \stdClass(); $expected->foo = 'bar'; $expected->fiz = 'cat'; $tests['inline-mapping'] = [$yaml, $expected]; $yaml = "foo: bar\nbaz: foobar"; $expected = new \stdClass(); $expected->foo = 'bar'; $expected->baz = 'foobar'; $tests['object-for-map-is-applied-after-parsing'] = [$yaml, $expected]; $yaml = <<<'EOT' array: - key: one - key: two EOT; $expected = new \stdClass(); $expected->array = []; $expected->array[0] = new \stdClass(); $expected->array[0]->key = 'one'; $expected->array[1] = new \stdClass(); $expected->array[1]->key = 'two'; $tests['nest-map-and-sequence'] = [$yaml, $expected]; $yaml = <<<'YAML' map: 1: one 2: two YAML; $expected = new \stdClass(); $expected->map = new \stdClass(); $expected->map->{1} = 'one'; $expected->map->{2} = 'two'; $tests['numeric-keys'] = [$yaml, $expected]; $yaml = <<<'YAML' map: '0': one '1': two YAML; $expected = new \stdClass(); $expected->map = new \stdClass(); $expected->map->{0} = 'one'; $expected->map->{1} = 'two'; $tests['zero-indexed-numeric-keys'] = [$yaml, $expected]; return $tests; } public function testObjectsSupportDisabledWithExceptions() { $this->expectException(ParseException::class); $yaml = <<<'EOF' foo: !php/object:O:30:"Symfony\Tests\Component\Yaml\B":1:{s:1:"b";s:3:"foo";} bar: 1 EOF; $this->parser->parse($yaml, Yaml::PARSE_EXCEPTION_ON_INVALID_TYPE); } /** * @group legacy * @expectedDeprecation Support for mapping keys in multi-line blocks is deprecated since Symfony 4.3 and will throw a ParseException in 5.0. */ public function testMappingKeyInMultiLineStringTriggersDeprecationNotice() { $yaml = <<<'EOF' data: dbal:wrong default_connection: monolith EOF; $this->parser->parse($yaml); } public function testCanParseContentWithTrailingSpaces() { $yaml = "items: \n foo: bar"; $expected = [ 'items' => ['foo' => 'bar'], ]; $this->assertSame($expected, $this->parser->parse($yaml)); } /** * @requires extension iconv */ public function testNonUtf8Exception() { $yamls = [ iconv('UTF-8', 'ISO-8859-1', "foo: 'äöüß'"), iconv('UTF-8', 'ISO-8859-15', "euro: '€'"), iconv('UTF-8', 'CP1252', "cp1252: '©ÉÇáñ'"), ]; foreach ($yamls as $yaml) { try { $this->parser->parse($yaml); $this->fail('charsets other than UTF-8 are rejected.'); } catch (\Exception $e) { $this->assertInstanceOf(ParseException::class, $e, 'charsets other than UTF-8 are rejected.'); } } } public function testUnindentedCollectionException() { $this->expectException(ParseException::class); $yaml = <<<'EOF' collection: -item1 -item2 -item3 EOF; $this->parser->parse($yaml); } public function testShortcutKeyUnindentedCollectionException() { $this->expectException(ParseException::class); $yaml = <<<'EOF' collection: - key: foo foo: bar EOF; $this->parser->parse($yaml); } public function testMultipleDocumentsNotSupportedException() { $this->expectException(ParseException::class); $this->expectExceptionMessageMatches('/^Multiple documents are not supported.+/'); Yaml::parse(<<<'EOL' # Ranking of 1998 home runs --- - Mark McGwire - Sammy Sosa - Ken Griffey # Team ranking --- - Chicago Cubs - St Louis Cardinals EOL ); } public function testSequenceInAMapping() { $this->expectException(ParseException::class); Yaml::parse(<<<'EOF' yaml: hash: me - array stuff EOF ); } public function testSequenceInMappingStartedBySingleDashLine() { $yaml = <<<'EOT' a: - b: - bar: baz - foo d: e EOT; $expected = [ 'a' => [ [ 'b' => [ [ 'bar' => 'baz', ], ], ], 'foo', ], 'd' => 'e', ]; $this->assertSame($expected, $this->parser->parse($yaml)); } public function testSequenceFollowedByCommentEmbeddedInMapping() { $yaml = <<<'EOT' a: b: - c # comment d: e EOT; $expected = [ 'a' => [ 'b' => ['c'], 'd' => 'e', ], ]; $this->assertSame($expected, $this->parser->parse($yaml)); } public function testNonStringFollowedByCommentEmbeddedInMapping() { $yaml = <<<'EOT' a: b: {} # comment d: 1.1 # another comment EOT; $expected = [ 'a' => [ 'b' => [], 'd' => 1.1, ], ]; $this->assertSame($expected, $this->parser->parse($yaml)); } public function getParseExceptionNotAffectedMultiLineStringLastResortParsing() { $tests = []; $yaml = <<<'EOT' a b: EOT; $tests['parse error on first line'] = [$yaml]; $yaml = <<<'EOT' a b c: EOT; $tests['parse error due to inconsistent indentation'] = [$yaml]; $yaml = <<<'EOT' & * ! | > ' " % @ ` #, { asd a;sdasd }-@^qw3 EOT; $tests['symfony/symfony/issues/22967#issuecomment-322067742'] = [$yaml]; return $tests; } /** * @dataProvider getParseExceptionNotAffectedMultiLineStringLastResortParsing */ public function testParseExceptionNotAffectedByMultiLineStringLastResortParsing($yaml) { $this->expectException(ParseException::class); $this->parser->parse($yaml); } public function testMultiLineStringLastResortParsing() { $yaml = <<<'EOT' test: You can have things that don't look like strings here true yes you can EOT; $expected = [ 'test' => 'You can have things that don\'t look like strings here true yes you can', ]; $this->assertSame($expected, $this->parser->parse($yaml)); $yaml = <<<'EOT' a: b c EOT; $expected = [ 'a' => 'b c', ]; $this->assertSame($expected, $this->parser->parse($yaml)); } public function testMappingInASequence() { $this->expectException(ParseException::class); Yaml::parse(<<<'EOF' yaml: - array stuff hash: me EOF ); } public function testScalarInSequence() { $this->expectException(ParseException::class); $this->expectExceptionMessage('missing colon'); Yaml::parse(<<<'EOF' foo: - bar "missing colon" foo: bar EOF ); } /** * > It is an error for two equal keys to appear in the same mapping node. * > In such a case the YAML processor may continue, ignoring the second * > "key: value" pair and issuing an appropriate warning. This strategy * > preserves a consistent information model for one-pass and random access * > applications. * * @see http://yaml.org/spec/1.2/spec.html#id2759572 * @see http://yaml.org/spec/1.1/#id932806 */ public function testMappingDuplicateKeyBlock() { $this->expectException(ParseException::class); $this->expectExceptionMessage('Duplicate key "child" detected'); $input = <<<'EOD' parent: child: first child: duplicate parent: child: duplicate child: duplicate EOD; $expected = [ 'parent' => [ 'child' => 'first', ], ]; $this->assertSame($expected, Yaml::parse($input)); } public function testMappingDuplicateKeyFlow() { $this->expectException(ParseException::class); $this->expectExceptionMessage('Duplicate key "child" detected'); $input = <<<'EOD' parent: { child: first, child: duplicate } parent: { child: duplicate, child: duplicate } EOD; $expected = [ 'parent' => [ 'child' => 'first', ], ]; $this->assertSame($expected, Yaml::parse($input)); } /** * @dataProvider getParseExceptionOnDuplicateData */ public function testParseExceptionOnDuplicate($input, $duplicateKey, $lineNumber) { $this->expectException(ParseException::class); $this->expectExceptionMessage(sprintf('Duplicate key "%s" detected at line %d', $duplicateKey, $lineNumber)); Yaml::parse($input); } public function getParseExceptionOnDuplicateData() { $tests = []; $yaml = <<assertSame(['hash' => null], Yaml::parse($input)); } public function testCommentAtTheRootIndent() { $this->assertSame([ 'services' => [ 'app.foo_service' => [ 'class' => 'Foo', ], 'app/bar_service' => [ 'class' => 'Bar', ], ], ], Yaml::parse(<<<'EOF' # comment 1 services: # comment 2 # comment 3 app.foo_service: class: Foo # comment 4 # comment 5 app/bar_service: class: Bar EOF )); } public function testStringBlockWithComments() { $this->assertSame(['content' => <<<'EOT' # comment 1 header # comment 2

title

footer # comment3 EOT ], Yaml::parse(<<<'EOF' content: | # comment 1 header # comment 2

title

footer # comment3 EOF )); } public function testFoldedStringBlockWithComments() { $this->assertSame([['content' => <<<'EOT' # comment 1 header # comment 2

title

footer # comment3 EOT ]], Yaml::parse(<<<'EOF' - content: | # comment 1 header # comment 2

title

footer # comment3 EOF )); } public function testNestedFoldedStringBlockWithComments() { $this->assertSame([[ 'title' => 'some title', 'content' => <<<'EOT' # comment 1 header # comment 2

title

footer # comment3 EOT ]], Yaml::parse(<<<'EOF' - title: some title content: | # comment 1 header # comment 2

title

footer # comment3 EOF )); } public function testReferenceResolvingInInlineStrings() { $this->assertSame([ 'var' => 'var-value', 'scalar' => 'var-value', 'list' => ['var-value'], 'list_in_list' => [['var-value']], 'map_in_list' => [['key' => 'var-value']], 'embedded_mapping' => [['key' => 'var-value']], 'map' => ['key' => 'var-value'], 'list_in_map' => ['key' => ['var-value']], 'map_in_map' => ['foo' => ['bar' => 'var-value']], 'foo' => ['bar' => 'baz'], 'bar' => ['foo' => 'baz'], 'baz' => ['foo'], 'foobar' => ['foo'], ], Yaml::parse(<<<'EOF' var: &var var-value scalar: *var list: [ *var ] list_in_list: [[ *var ]] map_in_list: [ { key: *var } ] embedded_mapping: [ key: *var ] map: { key: *var } list_in_map: { key: [*var] } map_in_map: { foo: { bar: *var } } foo: { bar: &baz baz } bar: { foo: *baz } baz: [ &foo foo ] foobar: [ *foo ] EOF )); } public function testYamlDirective() { $yaml = <<<'EOF' %YAML 1.2 --- foo: 1 bar: 2 EOF; $this->assertSame(['foo' => 1, 'bar' => 2], $this->parser->parse($yaml)); } public function testFloatKeys() { $this->expectException(ParseException::class); $this->expectExceptionMessage('Numeric keys are not supported. Quote your evaluable mapping keys instead'); $yaml = <<<'EOF' foo: 1.2: "bar" 1.3: "baz" EOF; $this->parser->parse($yaml); } public function testBooleanKeys() { $this->expectException(ParseException::class); $this->expectExceptionMessage('Non-string keys are not supported. Quote your evaluable mapping keys instead'); $yaml = <<<'EOF' true: foo false: bar EOF; $this->parser->parse($yaml); } public function testExplicitStringCasting() { $yaml = <<<'EOF' '1.2': "bar" !!str 1.3: "baz" 'true': foo !!str false: bar !!str null: 'null' '~': 'null' EOF; $expected = [ '1.2' => 'bar', '1.3' => 'baz', 'true' => 'foo', 'false' => 'bar', 'null' => 'null', '~' => 'null', ]; $this->assertSame($expected, $this->parser->parse($yaml)); } public function testColonInMappingValueException() { $this->expectException(ParseException::class); $this->expectExceptionMessage('A colon cannot be used in an unquoted mapping value'); $yaml = <<<'EOF' foo: bar: baz EOF; $this->parser->parse($yaml); } public function testColonInMappingValueExceptionNotTriggeredByColonInComment() { $yaml = <<<'EOT' foo: bar: foobar # Note: a comment after a colon EOT; $this->assertSame(['foo' => ['bar' => 'foobar']], $this->parser->parse($yaml)); } /** * @dataProvider getCommentLikeStringInScalarBlockData */ public function testCommentLikeStringsAreNotStrippedInBlockScalars($yaml, $expectedParserResult) { $this->assertSame($expectedParserResult, $this->parser->parse($yaml)); } public function getCommentLikeStringInScalarBlockData() { $tests = []; $yaml = <<<'EOT' pages: - title: some title content: | # comment 1 header # comment 2

title

footer # comment3 EOT; $expected = [ 'pages' => [ [ 'title' => 'some title', 'content' => <<<'EOT' # comment 1 header # comment 2

title

footer # comment3 EOT , ], ], ]; $tests[] = [$yaml, $expected]; $yaml = <<<'EOT' test: | foo # bar baz collection: - one: | foo # bar baz - two: | foo # bar baz EOT; $expected = [ 'test' => <<<'EOT' foo # bar baz EOT , 'collection' => [ [ 'one' => <<<'EOT' foo # bar baz EOT , ], [ 'two' => <<<'EOT' foo # bar baz EOT , ], ], ]; $tests[] = [$yaml, $expected]; $yaml = <<<'EOT' foo: bar: scalar-block: > line1 line2> baz: # comment foobar: ~ EOT; $expected = [ 'foo' => [ 'bar' => [ 'scalar-block' => "line1 line2>\n", ], 'baz' => [ 'foobar' => null, ], ], ]; $tests[] = [$yaml, $expected]; $yaml = <<<'EOT' a: b: hello # c: | # first row # second row d: hello EOT; $expected = [ 'a' => [ 'b' => 'hello', 'd' => 'hello', ], ]; $tests[] = [$yaml, $expected]; return $tests; } public function testBlankLinesAreParsedAsNewLinesInFoldedBlocks() { $yaml = <<<'EOT' test: >

A heading

EOT; $this->assertSame( [ 'test' => <<<'EOT'

A heading

EOT , ], $this->parser->parse($yaml) ); } public function testAdditionallyIndentedLinesAreParsedAsNewLinesInFoldedBlocks() { $yaml = <<<'EOT' test: >

A heading

EOT; $this->assertSame( [ 'test' => <<<'EOT'

A heading

EOT , ], $this->parser->parse($yaml) ); } /** * @dataProvider getBinaryData */ public function testParseBinaryData($data) { $this->assertSame(['data' => 'Hello world'], $this->parser->parse($data)); } public function getBinaryData() { return [ 'enclosed with double quotes' => ['data: !!binary "SGVsbG8gd29ybGQ="'], 'enclosed with single quotes' => ["data: !!binary 'SGVsbG8gd29ybGQ='"], 'containing spaces' => ['data: !!binary "SGVs bG8gd 29ybGQ="'], 'in block scalar' => [ <<<'EOT' data: !!binary | SGVsbG8gd29ybGQ= EOT ], 'containing spaces in block scalar' => [ <<<'EOT' data: !!binary | SGVs bG8gd 29ybGQ= EOT ], ]; } /** * @dataProvider getInvalidBinaryData */ public function testParseInvalidBinaryData($data, $expectedMessage) { $this->expectException(ParseException::class); $this->expectExceptionMessageMatches($expectedMessage); $this->parser->parse($data); } public function getInvalidBinaryData() { return [ 'length not a multiple of four' => ['data: !!binary "SGVsbG8d29ybGQ="', '/The normalized base64 encoded data \(data without whitespace characters\) length must be a multiple of four \(\d+ bytes given\)/'], 'invalid characters' => ['!!binary "SGVsbG8#d29ybGQ="', '/The base64 encoded data \(.*\) contains invalid characters/'], 'too many equals characters' => ['data: !!binary "SGVsbG8gd29yb==="', '/The base64 encoded data \(.*\) contains invalid characters/'], 'misplaced equals character' => ['data: !!binary "SGVsbG8gd29ybG=Q"', '/The base64 encoded data \(.*\) contains invalid characters/'], 'length not a multiple of four in block scalar' => [ <<<'EOT' data: !!binary | SGVsbG8d29ybGQ= EOT , '/The normalized base64 encoded data \(data without whitespace characters\) length must be a multiple of four \(\d+ bytes given\)/', ], 'invalid characters in block scalar' => [ <<<'EOT' data: !!binary | SGVsbG8#d29ybGQ= EOT , '/The base64 encoded data \(.*\) contains invalid characters/', ], 'too many equals characters in block scalar' => [ <<<'EOT' data: !!binary | SGVsbG8gd29yb=== EOT , '/The base64 encoded data \(.*\) contains invalid characters/', ], 'misplaced equals character in block scalar' => [ <<<'EOT' data: !!binary | SGVsbG8gd29ybG=Q EOT , '/The base64 encoded data \(.*\) contains invalid characters/', ], ]; } public function testParseDateAsMappingValue() { $yaml = <<<'EOT' date: 2002-12-14 EOT; $expectedDate = new \DateTime(); $expectedDate->setTimeZone(new \DateTimeZone('UTC')); $expectedDate->setDate(2002, 12, 14); $expectedDate->setTime(0, 0, 0); $this->assertSameData(['date' => $expectedDate], $this->parser->parse($yaml, Yaml::PARSE_DATETIME)); } /** * @param $lineNumber * @param $yaml * @dataProvider parserThrowsExceptionWithCorrectLineNumberProvider */ public function testParserThrowsExceptionWithCorrectLineNumber($lineNumber, $yaml) { $this->expectException(ParseException::class); $this->expectExceptionMessage(sprintf('Unexpected characters near "," at line %d (near "bar: "123",").', $lineNumber)); $this->parser->parse($yaml); } public function parserThrowsExceptionWithCorrectLineNumberProvider() { return [ [ 4, <<<'YAML' foo: - # bar bar: "123", YAML ], [ 5, <<<'YAML' foo: - # bar # bar bar: "123", YAML ], [ 8, <<<'YAML' foo: - # foobar baz: 123 bar: - # bar bar: "123", YAML ], [ 10, <<<'YAML' foo: - # foobar # foobar baz: 123 bar: - # bar # bar bar: "123", YAML ], ]; } public function testParseMultiLineQuotedString() { $yaml = <<assertSame(['foo' => 'bar baz foobar foo', 'bar' => 'baz'], $this->parser->parse($yaml)); } public function testMultiLineQuotedStringWithTrailingBackslash() { $yaml = <<assertSame(['foobar' => 'foobar'], $this->parser->parse($yaml)); } public function testCommentCharactersInMultiLineQuotedStrings() { $yaml = << [ 'foobar' => 'foo #bar', 'bar' => 'baz', ], ]; $this->assertSame($expected, $this->parser->parse($yaml)); } public function testBlankLinesInQuotedMultiLineString() { $yaml = << "foo\nbar", ]; $this->assertSame($expected, $this->parser->parse($yaml)); } public function testEscapedQuoteInQuotedMultiLineString() { $yaml = << 'foo "bar" baz', ]; $this->assertSame($expected, $this->parser->parse($yaml)); } public function testBackslashInQuotedMultiLineString() { $yaml = << 'foo bar\\', ]; $this->assertSame($expected, $this->parser->parse($yaml)); } public function testParseMultiLineUnquotedString() { $yaml = <<assertSame(['foo' => 'bar baz foobar foo', 'bar' => 'baz'], $this->parser->parse($yaml)); } /** * @dataProvider escapedQuotationCharactersInQuotedStrings */ public function testParseQuotedStringContainingEscapedQuotationCharacters(string $yaml, array $expected) { $this->assertSame($expected, $this->parser->parse($yaml)); } public function escapedQuotationCharactersInQuotedStrings() { return [ 'single quoted string' => [ << [ [ 'message' => 'No emails received before timeout - Address: \'test@testemail.company.com\' Keyword: \'Your Order confirmation\' ttl: 50', 'outcome' => 'failed', ], ], ], ], 'double quoted string' => [ << [ [ 'message' => 'No emails received before timeout - Address: "test@testemail.company.com" Keyword: "Your Order confirmation" ttl: 50', 'outcome' => 'failed', ], ], ], ], ]; } public function testBackslashInSingleQuotedString() { $this->assertSame(['foo' => 'bar\\'], $this->parser->parse("foo: 'bar\'")); } public function testParseMultiLineString() { $this->assertSame("foo bar\nbaz", $this->parser->parse("foo\nbar\n\nbaz")); } /** * @dataProvider multiLineDataProvider */ public function testParseMultiLineMappingValue($yaml, $expected, $parseError) { $this->assertSame($expected, $this->parser->parse($yaml)); } public function multiLineDataProvider() { $tests = []; $yaml = <<<'EOF' foo: - bar: one two three EOF; $expected = [ 'foo' => [ [ 'bar' => "one\ntwo three", ], ], ]; $tests[] = [$yaml, $expected, false]; $yaml = <<<'EOF' bar "foo" EOF; $expected = 'bar "foo"'; $tests[] = [$yaml, $expected, false]; $yaml = <<<'EOF' bar "foo EOF; $expected = 'bar "foo'; $tests[] = [$yaml, $expected, false]; $yaml = <<<'EOF' bar 'foo' EOF; $expected = "bar\n'foo'"; $tests[] = [$yaml, $expected, false]; $yaml = <<<'EOF' bar foo' EOF; $expected = "bar\nfoo'"; $tests[] = [$yaml, $expected, false]; return $tests; } /** * @dataProvider inlineNotationSpanningMultipleLinesProvider */ public function testInlineNotationSpanningMultipleLines($expected, string $yaml) { $this->assertSame($expected, $this->parser->parse($yaml)); } public function inlineNotationSpanningMultipleLinesProvider(): array { return [ 'mapping' => [ ['foo' => 'bar', 'bar' => 'baz'], << [ ['foo' => 'bar', 'bar' => 'baz'], << [ ['foo', 'bar'], << [ ['foo', 'bar'], << [ [ 'foo' => [ 'bar' => 'foobar', ], ], << [ [ 'foo', [ 'bar', 'baz', ], ], << [ [ ['entry1', []], ['entry2'], ], << [ ['foo' => ['bar', 'foobar'], 'bar' => ['baz']], << [ [ 'foobar' => [ 'foo', 'bar', 'baz', ], ], << [ [ 'foobar' => [ 'foo', 'bar', ], 'bar' => 'baz', ], << [ [ 'foo' => [ 'foobar', [ 'bar', 'baz', ], ], ], << [ [ 'foo' => [ 'foobar', [ 'bar', 'baz', ], ], ], << [ ['foo', ['bar' => 'baz']], << [ [ [ 'foo' => 'bar', 'bar' => 'baz', ], ], << [ [ [ 'foo' => [ 'bar' => 'foobar', ], 'bar' => 'baz', ], ], << [ [ [ 'foo' => [ 'bar' => 'foobar', ], 'bar' => 'baz', ], ], << [ "foo\nbar", << [ "foo\nbar", << [ ['foo' => "bar\nbaz"], << [ [ 'map' => [ 'key' => 'value', 'a' => 'b', ], 'param' => 'some', ], << [ [ 'map' => [ 'key' => 'value', 'a' => 'b', ], 'param' => 'some', ], << [ [ 'map' => [ 'key' => 'value', 'a' => 'b', ], 'param' => 'some', ], << [ [ [']'], ['}'], ['ba[r'], ['[ba]r'], ['bar]'], ['foo' => 'bar{'], ['foo' => 'b{ar}'], ['foo' => 'bar}'], ], << [ [ ['te"st'], ['test'], ["te'st"], ['te"st]'], ['te"st'], ['test'], ["te'st"], ['te"st]'], ], <<expectException(ParseException::class); $this->expectExceptionMessage('Unable to parse at line 2 (near "foobar").'); $yaml = <<parser->parse($yaml); } public function testTaggedInlineMapping() { $this->assertSameData(new TaggedValue('foo', ['foo' => 'bar']), $this->parser->parse('!foo {foo: bar}', Yaml::PARSE_CUSTOM_TAGS)); } public function testInvalidInlineSequenceContainingStringWithEscapedQuotationCharacter() { $this->expectException(ParseException::class); $this->parser->parse('["\\"]'); } /** * @dataProvider taggedValuesProvider */ public function testCustomTagSupport($expected, $yaml) { $this->assertSameData($expected, $this->parser->parse($yaml, Yaml::PARSE_CUSTOM_TAGS)); } public function taggedValuesProvider() { return [ 'scalars' => [ [ 'foo' => new TaggedValue('inline', 'bar'), 'quz' => new TaggedValue('long', 'this is a long text'), ], << this is a long text YAML ], 'sequences' => [ [new TaggedValue('foo', ['yaml']), new TaggedValue('quz', ['bar'])], << [ new TaggedValue('foo', ['foo' => new TaggedValue('quz', ['bar']), 'quz' => new TaggedValue('foo', ['quz' => 'bar'])]), << [ [new TaggedValue('foo', ['foo', 'bar']), new TaggedValue('quz', ['foo' => 'bar', 'quz' => new TaggedValue('bar', ['one' => 'bar'])])], << [ [new TaggedValue('foo', 'bar')], '[ !foo bar ]', ], 'with-comments' => [ [ [new TaggedValue('foo', ['foo', 'baz'])], ], << [ [ [new TaggedValue('foo', ['foo', 'baz'])], ], <<assertSame('12', $this->parser->parse('! 12')); } public function testCustomTagsDisabled() { $this->expectException(ParseException::class); $this->expectExceptionMessage('Tags support is not enabled. Enable the "Yaml::PARSE_CUSTOM_TAGS" flag to use "!iterator" at line 1 (near "!iterator [foo]").'); $this->parser->parse('!iterator [foo]'); } public function testUnsupportedTagWithScalar() { $this->expectException(ParseException::class); $this->expectExceptionMessage('Tags support is not enabled. Enable the "Yaml::PARSE_CUSTOM_TAGS" flag to use "!iterator" at line 1 (near "!iterator foo").'); $this->parser->parse('!iterator foo'); } public function testUnsupportedBuiltInTagWithScalar() { $this->expectException(ParseException::class); $this->expectExceptionMessage('The string "!!iterator foo" could not be parsed as it uses an unsupported built-in tag at line 1 (near "!!iterator foo").'); $this->parser->parse('!!iterator foo'); } public function testExceptionWhenUsingUnsupportedBuiltInTags() { $this->expectException(ParseException::class); $this->expectExceptionMessage('The built-in tag "!!foo" is not implemented at line 1 (near "!!foo").'); $this->parser->parse('!!foo'); } public function testComplexMappingThrowsParseException() { $this->expectException(ParseException::class); $this->expectExceptionMessage('Complex mappings are not supported at line 1 (near "? "1"").'); $yaml = <<parser->parse($yaml); } public function testComplexMappingNestedInMappingThrowsParseException() { $this->expectException(ParseException::class); $this->expectExceptionMessage('Complex mappings are not supported at line 2 (near "? "1"").'); $yaml = <<parser->parse($yaml); } public function testComplexMappingNestedInSequenceThrowsParseException() { $this->expectException(ParseException::class); $this->expectExceptionMessage('Complex mappings are not supported at line 1 (near "- ? "1"").'); $yaml = <<parser->parse($yaml); } public function testParsingIniThrowsException() { $this->expectException(ParseException::class); $this->expectExceptionMessage('Unable to parse at line 2 (near " foo = bar").'); $ini = <<parser->parse($ini); } private function loadTestsFromFixtureFiles($testsFile) { $parser = new Parser(); $tests = []; $files = $parser->parseFile(__DIR__.'/Fixtures/'.$testsFile); foreach ($files as $file) { $yamls = file_get_contents(__DIR__.'/Fixtures/'.$file.'.yml'); // split YAMLs documents foreach (preg_split('/^---( %YAML\:1\.0)?/m', $yamls) as $yaml) { if (!$yaml) { continue; } $test = $parser->parse($yaml); if (isset($test['todo']) && $test['todo']) { // TODO } else { eval('$expected = '.trim($test['php']).';'); $tests[] = [var_export($expected, true), $test['yaml'], $test['test']]; } } } return $tests; } public function testCanParseVeryLongValue() { $longStringWithSpaces = str_repeat('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ', 20000); $trickyVal = ['x' => $longStringWithSpaces]; $yamlString = Yaml::dump($trickyVal); $arrayFromYaml = $this->parser->parse($yamlString); $this->assertSame($trickyVal, $arrayFromYaml); } public function testParserCleansUpReferencesBetweenRuns() { $this->expectException(ParseException::class); $this->expectExceptionMessage('Reference "foo" does not exist at line 2'); $yaml = <<parser->parse($yaml); $yaml = <<parser->parse($yaml); } public function testPhpConstantTagMappingKey() { $yaml = << [ 'foo' => [ 'from' => [ 'bar', ], 'to' => 'baz', ], ], ]; $this->assertSame($expected, $this->parser->parse($yaml, Yaml::PARSE_CONSTANT)); } public function testDeprecatedPhpConstantSyntax() { $this->expectException(ParseException::class); $this->expectExceptionMessage('Missing value for tag "php/const:App\Kernel::SEMART_VERSION" at line 1 (near "!php/const:App\Kernel::SEMART_VERSION").'); $this->parser->parse('!php/const:App\Kernel::SEMART_VERSION', Yaml::PARSE_CUSTOM_TAGS | Yaml::PARSE_CONSTANT); } public function testPhpConstantTagMappingAsScalarKey() { $yaml = <<assertSame([ 'map1' => [['foo' => 'value_0', 'bar' => 'value_1']], 'map2' => [['foo' => 'value_0', 'bar' => 'value_1']], ], $this->parser->parse($yaml, Yaml::PARSE_CONSTANT)); } public function testTagMappingAsScalarKey() { $yaml = <<assertSame([ 'map1' => [['0' => 'value_0', '1' => 'value_1']], ], $this->parser->parse($yaml)); } public function testMergeKeysWhenMappingsAreParsedAsObjects() { $yaml = << (object) [ 'bar' => 1, ], 'bar' => (object) [ 'baz' => 2, 'bar' => 1, ], 'baz' => (object) [ 'baz_foo' => 3, 'baz_bar' => 4, ], 'foobar' => (object) [ 'bar' => null, 'baz' => 2, ], ]; $this->assertSameData($expected, $this->parser->parse($yaml, Yaml::PARSE_OBJECT_FOR_MAP)); } public function testFilenamesAreParsedAsStringsWithoutFlag() { $file = __DIR__.'/Fixtures/index.yml'; $this->assertSame($file, $this->parser->parse($file)); } public function testParseFile() { $this->assertIsArray($this->parser->parseFile(__DIR__.'/Fixtures/index.yml')); } public function testParsingNonExistentFilesThrowsException() { $this->expectException(ParseException::class); $this->expectExceptionMessageMatches('#^File ".+/Fixtures/nonexistent.yml" does not exist\.$#'); $this->parser->parseFile(__DIR__.'/Fixtures/nonexistent.yml'); } public function testParsingNotReadableFilesThrowsException() { $this->expectException(ParseException::class); $this->expectExceptionMessageMatches('#^File ".+/Fixtures/not_readable.yml" cannot be read\.$#'); if ('\\' === \DIRECTORY_SEPARATOR) { $this->markTestSkipped('chmod is not supported on Windows'); } if (!getenv('USER') || 'root' === getenv('USER')) { $this->markTestSkipped('This test will fail if run under superuser'); } $file = __DIR__.'/Fixtures/not_readable.yml'; chmod($file, 0200); $this->parser->parseFile($file); } public function testParseReferencesOnMergeKeys() { $yaml = << [ 'a' => 'foo', 'b' => 'bar', 'c' => 'baz', ], 'mergekeyderef' => [ 'd' => 'quux', 'b' => 'bar', 'c' => 'baz', ], ]; $this->assertSame($expected, $this->parser->parse($yaml)); } public function testParseReferencesOnMergeKeysWithMappingsParsedAsObjects() { $yaml = << (object) [ 'a' => 'foo', 'b' => 'bar', 'c' => 'baz', ], 'mergekeyderef' => (object) [ 'd' => 'quux', 'b' => 'bar', 'c' => 'baz', ], ]; $this->assertSameData($expected, $this->parser->parse($yaml, Yaml::PARSE_OBJECT_FOR_MAP)); } public function testEvalRefException() { $this->expectException(ParseException::class); $this->expectExceptionMessage('Reference "foo" does not exist'); $yaml = <<parser->parse($yaml); } /** * @dataProvider circularReferenceProvider */ public function testDetectCircularReferences($yaml) { $this->expectException(ParseException::class); $this->expectExceptionMessage('Circular reference [foo, bar, foo] detected'); $this->parser->parse($yaml, Yaml::PARSE_CUSTOM_TAGS); } public function circularReferenceProvider() { $tests = []; $yaml = <<assertSame($expected, $this->parser->parse($yaml)); } public function indentedMappingData() { $tests = []; $yaml = << [ [ 'bar' => 'foobar', 'baz' => 'foobaz', ], ], ]; $tests['comment line is first line in indented block'] = [$yaml, $expected]; $yaml = << [ [ 'bar' => [ 'baz' => [1, 2, 3], ], ], ], ]; $tests['mapping value on new line starting with a comment line'] = [$yaml, $expected]; $yaml = << [ [ 'bar' => 'foobar', ], ], ]; $tests['mapping in sequence starting on a new line'] = [$yaml, $expected]; $yaml = << [ 'bar' => 'baz', ], ]; $tests['blank line at the beginning of an indented mapping value'] = [$yaml, $expected]; return $tests; } public function testMultiLineComment() { $yaml = <<assertSame(['parameters' => 'abc'], $this->parser->parse($yaml)); } public function testParseValueWithModifiers() { $yaml = <<assertSame( [ 'parameters' => [ 'abc' => implode("\n", ['one', 'two', 'three', 'four', 'five']), ], ], $this->parser->parse($yaml) ); } public function testParseValueWithNegativeModifiers() { $yaml = <<assertSame( [ 'parameters' => [ 'abc' => implode("\n", ['one', 'two', 'three', 'four', 'five']), ], ], $this->parser->parse($yaml) ); } public function testThrowExceptionIfInvalidAdditionalClosingTagOccurs() { $yaml = '{ "object": { "array": [ "a", "b", "c" ] ], } }'; $this->expectException(ParseException::class); $this->expectExceptionMessage('Malformed unquoted YAML string at line 8 (near " ],").'); $this->parser->parse($yaml); } public function testWhitespaceAtEndOfLine() { $yaml = "\nfoo:\n arguments: [ '@bar' ] \n"; $this->assertSame( [ 'foo' => [ 'arguments' => ['@bar'], ], ], $this->parser->parse($yaml) ); $yaml = "\nfoo:\n bar: {} \n"; $this->assertSame( [ 'foo' => [ 'bar' => [], ], ], $this->parser->parse($yaml) ); $this->assertSame( [ 'foo' => 'bar', 'foobar' => 'baz', ], $this->parser->parse("foo: 'bar' \nfoobar: baz") ); } /** * This is a regression test for a bug where a YAML block with a nested multiline string using | was parsed without * a trailing \n when a shorter YAML document was parsed before. * * When a shorter document was parsed before, the nested string did not have a \n at the end of the string, because * the Parser thought it was the end of the file, even though it is not. */ public function testParsingMultipleDocuments() { $shortDocument = 'foo: bar'; $longDocument = <<parser->parse($shortDocument); // After the total number of lines has been reset the result will be the same as if a new parser was used // (before, there was no \n after row2) $this->assertSame(['a' => ['b' => "row\nrow2\n"], 'c' => 'd'], $this->parser->parse($longDocument)); } public function testParseIdeographicSpaces() { $expected = <<assertSame([ 'unquoted' => ' ', 'quoted' => ' ', 'within_string' => 'a b', 'regular_space' => 'a b', ], $this->parser->parse($expected)); } private function assertSameData($expected, $actual) { $this->assertEquals($expected, $actual); $this->assertSame( var_export($expected, true), var_export($actual, true) ); } } class B { public $b = 'foo'; public const FOO = 'foo'; public const BAR = 'bar'; public const BAZ = 'baz'; }