class YamlSymfonyTest

Same name and namespace in other branches
  1. 8.9.x core/tests/Drupal/Tests/Component/Serialization/YamlSymfonyTest.php \Drupal\Tests\Component\Serialization\YamlSymfonyTest
  2. 10 core/tests/Drupal/Tests/Component/Serialization/YamlSymfonyTest.php \Drupal\Tests\Component\Serialization\YamlSymfonyTest
  3. 11.x core/tests/Drupal/Tests/Component/Serialization/YamlSymfonyTest.php \Drupal\Tests\Component\Serialization\YamlSymfonyTest

Tests the YamlSymfony serialization implementation.

@group Drupal @group Serialization @coversDefaultClass \Drupal\Component\Serialization\YamlSymfony

Hierarchy

  • class \Drupal\Tests\Component\Serialization\YamlTestBase extends \PHPUnit\Framework\TestCase
    • class \Drupal\Tests\Component\Serialization\YamlSymfonyTest extends \Drupal\Tests\Component\Serialization\YamlTestBase

Expanded class hierarchy of YamlSymfonyTest

File

core/tests/Drupal/Tests/Component/Serialization/YamlSymfonyTest.php, line 15

Namespace

Drupal\Tests\Component\Serialization
View source 
class YamlSymfonyTest extends YamlTestBase {
    
    /**
     * Tests encoding and decoding basic data structures.
     *
     * @covers ::encode
     * @covers ::decode
     * @dataProvider providerEncodeDecodeTests
     */
    public function testEncodeDecode($data) {
        $this->assertEquals($data, YamlSymfony::decode(YamlSymfony::encode($data)));
    }
    
    /**
     * Tests decoding YAML node anchors.
     *
     * @covers ::decode
     * @dataProvider providerDecodeTests
     */
    public function testDecode($string, $data) {
        $this->assertEquals($data, YamlSymfony::decode($string));
    }
    
    /**
     * Tests our encode settings.
     *
     * @covers ::encode
     */
    public function testEncode() {
        // cSpell:disable
        $this->assertEquals('foo:
  bar: \'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus sapien ex, venenatis vitae nisi eu, posuere luctus dolor. Nullam convallis\'
', YamlSymfony::encode([
            'foo' => [
                'bar' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus sapien ex, venenatis vitae nisi eu, posuere luctus dolor. Nullam convallis',
            ],
        ]));
        // cSpell:enable
    }
    
    /**
     * @covers ::getFileExtension
     */
    public function testGetFileExtension() {
        $this->assertEquals('yml', YamlSymfony::getFileExtension());
    }
    
    /**
     * Tests that invalid YAML throws an exception.
     *
     * @covers ::decode
     */
    public function testError() {
        $this->expectException(InvalidDataTypeException::class);
        YamlSymfony::decode('foo: [ads');
    }
    
    /**
     * Ensures that php object support is disabled.
     *
     * @covers ::encode
     */
    public function testObjectSupportDisabled() {
        $this->expectException(InvalidDataTypeException::class);
        $this->expectExceptionMessage('Object support when dumping a YAML file has been disabled.');
        $object = new \stdClass();
        $object->foo = 'bar';
        YamlSymfony::encode([
            $object,
        ]);
    }

}

Members

Title Modifiers Object type Summary
YamlSymfonyTest::testDecode public function Tests decoding YAML node anchors.
YamlSymfonyTest::testEncode public function Tests our encode settings.
YamlSymfonyTest::testEncodeDecode public function Tests encoding and decoding basic data structures.
YamlSymfonyTest::testError public function Tests that invalid YAML throws an exception.
YamlSymfonyTest::testGetFileExtension public function @covers ::getFileExtension
YamlSymfonyTest::testObjectSupportDisabled public function Ensures that php object support is disabled.
YamlTestBase::providerBoolTest public function Tests different boolean serialization and de-serialization.
YamlTestBase::providerDecodeTests public function Some data that should be able to be de-serialized.
YamlTestBase::providerEncodeDecodeTests public function Some data that should be able to be serialized.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.