View source
<?php
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 {
protected $parser;
protected function setUp() {
$this->parser = new Parser();
}
protected function tearDown() {
$this->parser = null;
chmod(__DIR__ . '/Fixtures/not_readable.yml', 0644);
}
public function testSpecifications($expected, $yaml, $comment, $deprecated) {
$deprecations = [];
if ($deprecated) {
set_error_handler(function ($type, $msg) use (&$deprecations) {
if (E_USER_DEPRECATED !== $type) {
restore_error_handler();
if (class_exists('PHPUnit_Util_ErrorHandler')) {
return \call_user_func_array('PHPUnit_Util_ErrorHandler::handleError', \func_get_args());
}
return \call_user_func_array('PHPUnit\\Util\\ErrorHandler::handleError', \func_get_args());
}
$deprecations[] = $msg;
});
}
$this
->assertEquals($expected, var_export($this->parser
->parse($yaml), true), $comment);
if ($deprecated) {
restore_error_handler();
$this
->assertCount(1, $deprecations);
$this
->assertContains(true !== $deprecated ? $deprecated : 'Using the comma as a group separator for floats is deprecated since Symfony 3.2 and will be removed in 4.0 on line 1.', $deprecations[0]);
}
}
public function getDataFormSpecifications() {
return $this
->loadTestsFromFixtureFiles('index.yml');
}
public function testNonStringMappingKeys($expected, $yaml, $comment) {
$this
->assertSame($expected, var_export($this->parser
->parse($yaml, Yaml::PARSE_KEYS_AS_STRINGS), true), $comment);
}
public function getNonStringMappingKeysData() {
return $this
->loadTestsFromFixtureFiles('nonStringKeys.yml');
}
public function testLegacyNonStringMappingKeys($expected, $yaml, $comment) {
$this
->assertSame($expected, var_export($this->parser
->parse($yaml), true), $comment);
}
public function getLegacyNonStringMappingKeysData() {
return $this
->loadTestsFromFixtureFiles('legacyNonStringKeys.yml');
}
public function testTabsInYaml() {
$yamls = [
"foo:\n\tbar",
"foo:\n \tbar",
"foo:\n\t bar",
"foo:\n \t bar",
];
foreach ($yamls as $yaml) {
try {
$content = $this->parser
->parse($yaml);
$this
->fail('YAML files must not contain tabs');
} catch (\Exception $e) {
$this
->assertInstanceOf('\\Exception', $e, 'YAML files must not contain tabs');
$this
->assertEquals('A YAML file cannot contain tabs as indentation at line 2 (near "' . strpbrk($yaml, "\t") . '").', $e
->getMessage(), 'YAML files must not contain tabs');
}
}
}
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;
}
public function testBlockChomping($expected, $yaml) {
$this
->assertSame($expected, $this->parser
->parse($yaml));
}
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
->assertEquals([
'foo' => new B(),
'bar' => 1,
], $this->parser
->parse($input, Yaml::PARSE_OBJECT), '->parse() is able to parse objects');
}
public function testObjectSupportEnabledPassingTrue() {
$input = <<<'EOF'
foo: !php/object:O:30:"Symfony\Component\Yaml\Tests\B":1:{s:1:"b";s:3:"foo";}
bar: 1
EOF;
$this
->assertEquals([
'foo' => new B(),
'bar' => 1,
], $this->parser
->parse($input, false, true), '->parse() is able to parse objects');
}
public function testObjectSupportEnabledWithDeprecatedTag($yaml) {
$this
->assertEquals([
'foo' => new B(),
'bar' => 1,
], $this->parser
->parse($yaml, Yaml::PARSE_OBJECT), '->parse() is able to parse objects');
}
public function deprecatedObjectValueProvider() {
return [
[
<<<YAML
foo: !!php/object:O:30:"Symfony\\Component\\Yaml\\Tests\\B":1:{s:1:"b";s:3:"foo";}
bar: 1
YAML
,
],
[
<<<YAML
foo: !php/object:O:30:"Symfony\\Component\\Yaml\\Tests\\B":1:{s:1:"b";s:3:"foo";}
bar: 1
YAML
,
],
];
}
public function testObjectSupportDisabledButNoExceptions($input) {
$this
->assertEquals([
'foo' => null,
'bar' => 1,
], $this->parser
->parse($input), '->parse() does not parse objects');
}
public function testObjectForMap($yaml, $expected) {
$flags = Yaml::PARSE_OBJECT_FOR_MAP;
$this
->assertEquals($expected, $this->parser
->parse($yaml, $flags));
}
public function testObjectForMapEnabledWithMappingUsingBooleanToggles($yaml, $expected) {
$this
->assertEquals($expected, $this->parser
->parse($yaml, false, false, true));
}
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($yaml) {
$this->parser
->parse($yaml, Yaml::PARSE_EXCEPTION_ON_INVALID_TYPE);
}
public function testCanParseContentWithTrailingSpaces() {
$yaml = "items: \n foo: bar";
$expected = [
'items' => [
'foo' => 'bar',
],
];
$this
->assertSame($expected, $this->parser
->parse($yaml));
}
public function testObjectsSupportDisabledWithExceptionsUsingBooleanToggles($yaml) {
$this->parser
->parse($yaml, true);
}
public function invalidDumpedObjectProvider() {
$yamlTag = <<<'EOF'
foo: !!php/object:O:30:"Symfony\Tests\Component\Yaml\B":1:{s:1:"b";s:3:"foo";}
bar: 1
EOF;
$localTag = <<<'EOF'
foo: !php/object:O:30:"Symfony\Tests\Component\Yaml\B":1:{s:1:"b";s:3:"foo";}
bar: 1
EOF;
return [
'yaml-tag' => [
$yamlTag,
],
'local-tag' => [
$localTag,
],
];
}
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('Symfony\\Component\\Yaml\\Exception\\ParseException', $e, 'charsets other than UTF-8 are rejected.');
}
}
}
public function testUnindentedCollectionException() {
$yaml = <<<'EOF'
collection:
-item1
-item2
-item3
EOF;
$this->parser
->parse($yaml);
}
public function testShortcutKeyUnindentedCollectionException() {
$yaml = <<<'EOF'
collection:
- key: foo
foo: bar
EOF;
$this->parser
->parse($yaml);
}
public function testMultipleDocumentsNotSupportedException() {
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() {
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;
}
public function testParseExceptionNotAffectedByMultiLineStringLastResortParsing($yaml) {
$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() {
Yaml::parse(<<<'EOF'
yaml:
- array stuff
hash: me
EOF
);
}
public function testScalarInSequence() {
Yaml::parse(<<<'EOF'
foo:
- bar
"missing colon"
foo: bar
EOF
);
}
public function testMappingDuplicateKeyBlock() {
$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() {
$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 testParseExceptionOnDuplicate($input, $duplicateKey, $lineNumber) {
Yaml::parse($input);
}
public function getParseExceptionOnDuplicateData() {
$tests = [];
$yaml = <<<EOD
parent: { child: first, child: duplicate }
EOD;
$tests[] = [
$yaml,
'child',
1,
];
$yaml = <<<EOD
parent:
child: first,
child: duplicate
EOD;
$tests[] = [
$yaml,
'child',
3,
];
$yaml = <<<EOD
parent: { child: foo }
parent: { child: bar }
EOD;
$tests[] = [
$yaml,
'parent',
2,
];
$yaml = <<<EOD
parent: { child_mapping: { value: bar}, child_mapping: { value: bar} }
EOD;
$tests[] = [
$yaml,
'child_mapping',
1,
];
$yaml = <<<EOD
parent:
child_mapping:
value: bar
child_mapping:
value: bar
EOD;
$tests[] = [
$yaml,
'child_mapping',
4,
];
$yaml = <<<EOD
parent: { child_sequence: ['key1', 'key2', 'key3'], child_sequence: ['key1', 'key2', 'key3'] }
EOD;
$tests[] = [
$yaml,
'child_sequence',
1,
];
$yaml = <<<EOD
parent:
child_sequence:
- key1
- key2
- key3
child_sequence:
- key1
- key2
- key3
EOD;
$tests[] = [
$yaml,
'child_sequence',
6,
];
return $tests;
}
public function testEmptyValue() {
$input = <<<'EOF'
hash:
EOF;
$this
->assertEquals([
'hash' => null,
], Yaml::parse($input));
}
public function testCommentAtTheRootIndent() {
$this
->assertEquals([
'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
->assertEquals([
'content' => <<<'EOT'
# comment 1
header
# comment 2
<body>
<h1>title</h1>
</body>
footer # comment3
EOT
,
], Yaml::parse(<<<'EOF'
content: |
# comment 1
header
# comment 2
<body>
<h1>title</h1>
</body>
footer # comment3
EOF
));
}
public function testFoldedStringBlockWithComments() {
$this
->assertEquals([
[
'content' => <<<'EOT'
# comment 1
header
# comment 2
<body>
<h1>title</h1>
</body>
footer # comment3
EOT
,
],
], Yaml::parse(<<<'EOF'
-
content: |
# comment 1
header
# comment 2
<body>
<h1>title</h1>
</body>
footer # comment3
EOF
));
}
public function testNestedFoldedStringBlockWithComments() {
$this
->assertEquals([
[
'title' => 'some title',
'content' => <<<'EOT'
# comment 1
header
# comment 2
<body>
<h1>title</h1>
</body>
footer # comment3
EOT
,
],
], Yaml::parse(<<<'EOF'
-
title: some title
content: |
# comment 1
header
# comment 2
<body>
<h1>title</h1>
</body>
footer # comment3
EOF
));
}
public function testReferenceResolvingInInlineStrings() {
$this
->assertEquals([
'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',
],
],
], 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 } }
EOF
));
}
public function testYamlDirective() {
$yaml = <<<'EOF'
%YAML 1.2
---
foo: 1
bar: 2
EOF;
$this
->assertEquals([
'foo' => 1,
'bar' => 2,
], $this->parser
->parse($yaml));
}
public function testFloatKeys() {
$yaml = <<<'EOF'
foo:
1.2: "bar"
1.3: "baz"
EOF;
$expected = [
'foo' => [
'1.2' => 'bar',
'1.3' => 'baz',
],
];
$this
->assertEquals($expected, $this->parser
->parse($yaml));
}
public function testBooleanKeys() {
$yaml = <<<'EOF'
true: foo
false: bar
EOF;
$expected = [
1 => 'foo',
0 => 'bar',
];
$this
->assertEquals($expected, $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
->assertEquals($expected, $this->parser
->parse($yaml));
}
public function testColonInMappingValueException() {
$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));
}
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
<body>
<h1>title</h1>
</body>
footer # comment3
EOT;
$expected = [
'pages' => [
[
'title' => 'some title',
'content' => <<<'EOT'
# comment 1
header
# comment 2
<body>
<h1>title</h1>
</body>
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: >
<h2>A heading</h2>
<ul>
<li>a list</li>
<li>may be a good example</li>
</ul>
EOT;
$this
->assertSame([
'test' => <<<'EOT'
<h2>A heading</h2>
<ul> <li>a list</li> <li>may be a good example</li> </ul>
EOT
,
], $this->parser
->parse($yaml));
}
public function testAdditionallyIndentedLinesAreParsedAsNewLinesInFoldedBlocks() {
$yaml = <<<'EOT'
test: >
<h2>A heading</h2>
<ul>
<li>a list</li>
<li>may be a good example</li>
</ul>
EOT;
$this
->assertSame([
'test' => <<<'EOT'
<h2>A heading</h2>
<ul>
<li>a list</li>
<li>may be a good example</li>
</ul>
EOT
,
], $this->parser
->parse($yaml));
}
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
,
],
];
}
public function testParseInvalidBinaryData($data, $expectedMessage) {
if (method_exists($this, 'expectException')) {
$this
->expectExceptionMessageRegExp($expectedMessage);
}
else {
$this
->setExpectedExceptionRegExp(ParseException::class, $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
->assertEquals([
'date' => $expectedDate,
], $this->parser
->parse($yaml, Yaml::PARSE_DATETIME));
}
public function testParserThrowsExceptionWithCorrectLineNumber($lineNumber, $yaml) {
if (method_exists($this, 'expectException')) {
$this
->expectException('\\Symfony\\Component\\Yaml\\Exception\\ParseException');
$this
->expectExceptionMessage(sprintf('Unexpected characters near "," at line %d (near "bar: "123",").', $lineNumber));
}
else {
$this
->setExpectedException('\\Symfony\\Component\\Yaml\\Exception\\ParseException', 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 = <<<EOT
foo: "bar
baz
foobar
foo"
bar: baz
EOT;
$this
->assertSame([
'foo' => 'bar baz foobar foo',
'bar' => 'baz',
], $this->parser
->parse($yaml));
}
public function testMultiLineQuotedStringWithTrailingBackslash() {
$yaml = <<<YAML
foobar:
"foo\\
bar"
YAML;
$this
->assertSame([
'foobar' => 'foobar',
], $this->parser
->parse($yaml));
}
public function testCommentCharactersInMultiLineQuotedStrings() {
$yaml = <<<YAML
foo:
foobar: 'foo
#bar'
bar: baz
YAML;
$expected = [
'foo' => [
'foobar' => 'foo #bar',
'bar' => 'baz',
],
];
$this
->assertSame($expected, $this->parser
->parse($yaml));
}
public function testBlankLinesInQuotedMultiLineString() {
$yaml = <<<YAML
foobar: 'foo
bar'
YAML;
$expected = [
'foobar' => "foo\nbar",
];
$this
->assertSame($expected, $this->parser
->parse($yaml));
}
public function testParseMultiLineUnquotedString() {
$yaml = <<<EOT
foo: bar
baz
foobar
foo
bar: baz
EOT;
$this
->assertSame([
'foo' => 'bar baz foobar foo',
'bar' => 'baz',
], $this->parser
->parse($yaml));
}
public function testParseMultiLineString() {
$this
->assertEquals("foo bar\nbaz", $this->parser
->parse("foo\nbar\n\nbaz"));
}
public function testParseMultiLineMappingValue($yaml, $expected, $parseError) {
$this
->assertEquals($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;
}
public function testTaggedInlineMapping() {
$this
->assertEquals(new TaggedValue('foo', [
'foo' => 'bar',
]), $this->parser
->parse('!foo {foo: bar}', Yaml::PARSE_CUSTOM_TAGS));
}
public function testCustomTagSupport($expected, $yaml) {
$this
->assertEquals($expected, $this->parser
->parse($yaml, Yaml::PARSE_CUSTOM_TAGS));
}
public function taggedValuesProvider() {
return [
'sequences' => [
[
new TaggedValue('foo', [
'yaml',
]),
new TaggedValue('quz', [
'bar',
]),
],
<<<YAML
- !foo
- yaml
- !quz [bar]
YAML
,
],
'mappings' => [
new TaggedValue('foo', [
'foo' => new TaggedValue('quz', [
'bar',
]),
'quz' => new TaggedValue('foo', [
'quz' => 'bar',
]),
]),
<<<YAML
!foo
foo: !quz [bar]
quz: !foo
quz: bar
YAML
,
],
'inline' => [
[
new TaggedValue('foo', [
'foo',
'bar',
]),
new TaggedValue('quz', [
'foo' => 'bar',
'quz' => new TaggedValue('bar', [
'one' => 'bar',
]),
]),
],
<<<YAML
- !foo [foo, bar]
- !quz {foo: bar, quz: !bar {one: bar}}
YAML
,
],
];
}
public function testCustomTagsDisabled() {
$this->parser
->parse('!iterator [foo]');
}
public function testUnsupportedTagWithScalar() {
$this
->assertEquals('!iterator foo', $this->parser
->parse('!iterator foo'));
}
public function testExceptionWhenUsingUnsuportedBuiltInTags() {
$this->parser
->parse('!!foo');
}
public function testComplexMappingThrowsParseException() {
$yaml = <<<YAML
? "1"
:
name: végétalien
YAML;
$this->parser
->parse($yaml);
}
public function testComplexMappingNestedInMappingThrowsParseException() {
$yaml = <<<YAML
diet:
? "1"
:
name: végétalien
YAML;
$this->parser
->parse($yaml);
}
public function testComplexMappingNestedInSequenceThrowsParseException() {
$yaml = <<<YAML
- ? "1"
:
name: végétalien
YAML;
$this->parser
->parse($yaml);
}
public function testParsingIniThrowsException() {
$ini = <<<INI
[parameters]
foo = bar
bar = %foo%
INI;
$this->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');
foreach (preg_split('/^---( %YAML\\:1\\.0)?/m', $yamls) as $yaml) {
if (!$yaml) {
continue;
}
$test = $parser
->parse($yaml);
if (isset($test['todo']) && $test['todo']) {
}
else {
eval('$expected = ' . trim($test['php']) . ';');
$tests[] = [
var_export($expected, true),
$test['yaml'],
$test['test'],
isset($test['deprecated']) ? $test['deprecated'] : false,
];
}
}
}
return $tests;
}
public function testCanParseVeryLongValue() {
$longStringWithSpaces = str_repeat('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ', 20000);
$trickyVal = [
'x' => $longStringWithSpaces,
];
$yamlString = Yaml::dump($trickyVal);
$arrayFromYaml = $this->parser
->parse($yamlString);
$this
->assertEquals($trickyVal, $arrayFromYaml);
}
public function testParserCleansUpReferencesBetweenRuns() {
$yaml = <<<YAML
foo: &foo
baz: foobar
bar:
<<: *foo
YAML;
$this->parser
->parse($yaml);
$yaml = <<<YAML
bar:
<<: *foo
YAML;
$this->parser
->parse($yaml);
}
public function testPhpConstantTagMappingKey() {
$yaml = <<<YAML
transitions:
!php/const 'Symfony\\Component\\Yaml\\Tests\\B::FOO':
from:
- !php/const 'Symfony\\Component\\Yaml\\Tests\\B::BAR'
to: !php/const 'Symfony\\Component\\Yaml\\Tests\\B::BAZ'
YAML;
$expected = [
'transitions' => [
'foo' => [
'from' => [
'bar',
],
'to' => 'baz',
],
],
];
$this
->assertSame($expected, $this->parser
->parse($yaml, Yaml::PARSE_CONSTANT));
}
public function testDeprecatedPhpConstantTagMappingKey() {
$yaml = <<<YAML
transitions:
!php/const:Symfony\\Component\\Yaml\\Tests\\B::FOO:
from:
- !php/const:Symfony\\Component\\Yaml\\Tests\\B::BAR
to: !php/const:Symfony\\Component\\Yaml\\Tests\\B::BAZ
YAML;
$expected = [
'transitions' => [
'foo' => [
'from' => [
'bar',
],
'to' => 'baz',
],
],
];
$this
->assertSame($expected, $this->parser
->parse($yaml, Yaml::PARSE_CONSTANT));
}
public function testPhpConstantTagMappingKeyWithKeysCastToStrings() {
$yaml = <<<YAML
transitions:
!php/const 'Symfony\\Component\\Yaml\\Tests\\B::FOO':
from:
- !php/const 'Symfony\\Component\\Yaml\\Tests\\B::BAR'
to: !php/const 'Symfony\\Component\\Yaml\\Tests\\B::BAZ'
YAML;
$expected = [
'transitions' => [
'foo' => [
'from' => [
'bar',
],
'to' => 'baz',
],
],
];
$this
->assertSame($expected, $this->parser
->parse($yaml, Yaml::PARSE_CONSTANT | Yaml::PARSE_KEYS_AS_STRINGS));
}
public function testMergeKeysWhenMappingsAreParsedAsObjects() {
$yaml = <<<YAML
foo: &FOO
bar: 1
bar: &BAR
baz: 2
<<: *FOO
baz:
baz_foo: 3
<<:
baz_bar: 4
foobar:
bar: ~
<<: [*FOO, *BAR]
YAML;
$expected = (object) [
'foo' => (object) [
'bar' => 1,
],
'bar' => (object) [
'baz' => 2,
'bar' => 1,
],
'baz' => (object) [
'baz_foo' => 3,
'baz_bar' => 4,
],
'foobar' => (object) [
'bar' => null,
'baz' => 2,
],
];
$this
->assertEquals($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
->assertInternalType('array', $this->parser
->parseFile(__DIR__ . '/Fixtures/index.yml'));
}
public function testParsingNonExistentFilesThrowsException() {
$this->parser
->parseFile(__DIR__ . '/Fixtures/nonexistent.yml');
}
public function testParsingNotReadableFilesThrowsException() {
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 = <<<YAML
mergekeyrefdef:
a: foo
<<: &quux
b: bar
c: baz
mergekeyderef:
d: quux
<<: *quux
YAML;
$expected = [
'mergekeyrefdef' => [
'a' => 'foo',
'b' => 'bar',
'c' => 'baz',
],
'mergekeyderef' => [
'd' => 'quux',
'b' => 'bar',
'c' => 'baz',
],
];
$this
->assertSame($expected, $this->parser
->parse($yaml));
}
public function testParseReferencesOnMergeKeysWithMappingsParsedAsObjects() {
$yaml = <<<YAML
mergekeyrefdef:
a: foo
<<: &quux
b: bar
c: baz
mergekeyderef:
d: quux
<<: *quux
YAML;
$expected = (object) [
'mergekeyrefdef' => (object) [
'a' => 'foo',
'b' => 'bar',
'c' => 'baz',
],
'mergekeyderef' => (object) [
'd' => 'quux',
'b' => 'bar',
'c' => 'baz',
],
];
$this
->assertEquals($expected, $this->parser
->parse($yaml, Yaml::PARSE_OBJECT_FOR_MAP));
}
public function testEvalRefException() {
$yaml = <<<EOE
foo: { &foo { a: Steve, <<: *foo} }
EOE;
$this->parser
->parse($yaml);
}
public function testDetectCircularReferences($yaml) {
$this->parser
->parse($yaml, Yaml::PARSE_CUSTOM_TAGS);
}
public function circularReferenceProvider() {
$tests = [];
$yaml = <<<YAML
foo:
- &foo
- &bar
bar: foobar
baz: *foo
YAML;
$tests['sequence'] = [
$yaml,
];
$yaml = <<<YAML
foo: &foo
bar: &bar
foobar: baz
baz: *foo
YAML;
$tests['mapping'] = [
$yaml,
];
$yaml = <<<YAML
foo: &foo
bar: &bar
foobar: baz
<<: *foo
YAML;
$tests['mapping with merge key'] = [
$yaml,
];
return $tests;
}
public function testParseIndentedMappings($yaml, $expected) {
$this
->assertSame($expected, $this->parser
->parse($yaml));
}
public function indentedMappingData() {
$tests = [];
$yaml = <<<YAML
foo:
- bar: "foobar"
# A comment
baz: "foobaz"
YAML;
$expected = [
'foo' => [
[
'bar' => 'foobar',
'baz' => 'foobaz',
],
],
];
$tests['comment line is first line in indented block'] = [
$yaml,
$expected,
];
$yaml = <<<YAML
foo:
- bar:
# comment
baz: [1, 2, 3]
YAML;
$expected = [
'foo' => [
[
'bar' => [
'baz' => [
1,
2,
3,
],
],
],
],
];
$tests['mapping value on new line starting with a comment line'] = [
$yaml,
$expected,
];
$yaml = <<<YAML
foo:
-
bar: foobar
YAML;
$expected = [
'foo' => [
[
'bar' => 'foobar',
],
],
];
$tests['mapping in sequence starting on a new line'] = [
$yaml,
$expected,
];
$yaml = <<<YAML
foo:
bar: baz
YAML;
$expected = [
'foo' => [
'bar' => 'baz',
],
];
$tests['blank line at the beginning of an indented mapping value'] = [
$yaml,
$expected,
];
return $tests;
}
}
class B {
public $b = 'foo';
const FOO = 'foo';
const BAR = 'bar';
const BAZ = 'baz';
}