
| Current Path : /var/www/html/holz-machines/web/core/tests/Drupal/Tests/Core/Template/ |
Linux ift1.ift-informatik.de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 |
| Current File : /var/www/html/holz-machines/web/core/tests/Drupal/Tests/Core/Template/TwigSandboxTest.php |
<?php
/**
* @file
* Contains \Drupal\Tests\Core\Template\TwigSandboxTest.
*/
namespace Drupal\Tests\Core\Template;
use Drupal\Core\Template\Attribute;
use Drupal\Core\Template\TwigSandboxPolicy;
use Drupal\Core\Template\Loader\StringLoader;
use Drupal\Tests\UnitTestCase;
use Twig\Environment;
use Twig\Extension\SandboxExtension;
use Twig\Sandbox\SecurityError;
/**
* Tests the twig sandbox policy.
*
* @group Template
*
* @coversDefaultClass \Drupal\Core\Template\TwigSandboxPolicy
*/
class TwigSandboxTest extends UnitTestCase {
/**
* The Twig environment loaded with the sandbox extension.
*
* @var \Twig\Environment
*/
protected $twig;
/**
* {@inheritdoc}
*/
protected function setUp(): void {
parent::setUp();
$loader = new StringLoader();
$this->twig = new Environment($loader);
$policy = new TwigSandboxPolicy();
$sandbox = new SandboxExtension($policy, TRUE);
$this->twig->addExtension($sandbox);
}
/**
* Tests that dangerous methods cannot be called in entity objects.
*
* @dataProvider getTwigEntityDangerousMethods
*/
public function testEntityDangerousMethods($template) {
$entity = $this->createMock('Drupal\Core\Entity\EntityInterface');
$this->expectException(SecurityError::class);
$this->twig->render($template, ['entity' => $entity]);
}
/**
* Data provider for ::testEntityDangerousMethods.
*
* @return array
*/
public function getTwigEntityDangerousMethods() {
return [
['{{ entity.delete }}'],
['{{ entity.save }}'],
['{{ entity.create }}'],
];
}
/**
* Tests that white listed classes can be extended.
*/
public function testExtendedClass() {
$this->assertEquals(' class="kitten"', $this->twig->render('{{ attribute.addClass("kitten") }}', ['attribute' => new TestAttribute()]));
}
/**
* Tests that prefixed methods can be called from within Twig templates.
*
* Currently "get", "has", and "is" are the only allowed prefixes.
*/
public function testEntitySafePrefixes() {
$entity = $this->createMock('Drupal\Core\Entity\EntityInterface');
$entity->expects($this->atLeastOnce())
->method('hasLinkTemplate')
->with('test')
->willReturn(TRUE);
$result = $this->twig->render('{{ entity.hasLinkTemplate("test") }}', ['entity' => $entity]);
$this->assertTrue((bool) $result, 'Sandbox policy allows has* functions to be called.');
$entity = $this->createMock('Drupal\Core\Entity\EntityInterface');
$entity->expects($this->atLeastOnce())
->method('isNew')
->willReturn(TRUE);
$result = $this->twig->render('{{ entity.isNew }}', ['entity' => $entity]);
$this->assertTrue((bool) $result, 'Sandbox policy allows is* functions to be called.');
$entity = $this->createMock('Drupal\Core\Entity\EntityInterface');
$entity->expects($this->atLeastOnce())
->method('getEntityType')
->willReturn('test');
$result = $this->twig->render('{{ entity.getEntityType }}', ['entity' => $entity]);
$this->assertEquals('test', $result, 'Sandbox policy allows get* functions to be called.');
}
/**
* Tests that valid methods can be called from within Twig templates.
*
* Currently the following methods are whitelisted: id, label, bundle, and
* get.
*/
public function testEntitySafeMethods() {
$entity = $this->getMockBuilder('Drupal\Core\Entity\ContentEntityBase')
->disableOriginalConstructor()
->getMock();
$entity->expects($this->atLeastOnce())
->method('get')
->with('title')
->willReturn('test');
$result = $this->twig->render('{{ entity.get("title") }}', ['entity' => $entity]);
$this->assertEquals('test', $result, 'Sandbox policy allows get() to be called.');
$entity = $this->createMock('Drupal\Core\Entity\EntityInterface');
$entity->expects($this->atLeastOnce())
->method('id')
->willReturn('1234');
$result = $this->twig->render('{{ entity.id }}', ['entity' => $entity]);
$this->assertEquals('1234', $result, 'Sandbox policy allows get() to be called.');
$entity = $this->createMock('Drupal\Core\Entity\EntityInterface');
$entity->expects($this->atLeastOnce())
->method('label')
->willReturn('testing');
$result = $this->twig->render('{{ entity.label }}', ['entity' => $entity]);
$this->assertEquals('testing', $result, 'Sandbox policy allows get() to be called.');
$entity = $this->createMock('Drupal\Core\Entity\EntityInterface');
$entity->expects($this->atLeastOnce())
->method('bundle')
->willReturn('testing');
$result = $this->twig->render('{{ entity.bundle }}', ['entity' => $entity]);
$this->assertEquals('testing', $result, 'Sandbox policy allows get() to be called.');
}
/**
* Tests that safe methods inside Url objects can be called.
*/
public function testUrlSafeMethods() {
$url = $this->getMockBuilder('Drupal\Core\Url')
->disableOriginalConstructor()
->getMock();
$url->expects($this->once())
->method('toString')
->willReturn('http://kittens.cat/are/cute');
$result = $this->twig->render('{{ url.toString }}', ['url' => $url]);
$this->assertEquals('http://kittens.cat/are/cute', $result, 'Sandbox policy allows toString() to be called.');
}
}
class TestAttribute extends Attribute {}