FileItemValidationTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\file\Kernel;

use Drupal\entity_test\Entity\EntityTest;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\file\Entity\File;
use Drupal\KernelTests\KernelTestBase;
use Drupal\user\Entity\User;
use org\bovigo\vfs\vfsStream;

/**
 * Tests that files referenced in file and image fields are always validated.
 *
 * @group file
 */
class FileItemValidationTest extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'file',
        'image',
        'entity_test',
        'field',
        'user',
        'system',
    ];
    
    /**
     * A user.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $user;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('entity_test');
        $this->installEntitySchema('user');
        $this->installEntitySchema('file');
        $this->installSchema('file', 'file_usage');
        $this->user = User::create([
            'name' => 'username',
            'status' => 1,
        ]);
        $this->user
            ->save();
        $this->container
            ->get('current_user')
            ->setAccount($this->user);
    }
    
    /**
     * @covers \Drupal\file\Plugin\Validation\Constraint\FileValidationConstraint
     * @covers \Drupal\file\Plugin\Validation\Constraint\FileValidationConstraintValidator
     * @dataProvider getFileTypes
     */
    public function testFileValidationConstraint($file_type) : void {
        $field_storage = FieldStorageConfig::create([
            'field_name' => 'field_test_file',
            'entity_type' => 'entity_test',
            'type' => $file_type,
        ]);
        $field_storage->save();
        $field = FieldConfig::create([
            'field_name' => 'field_test_file',
            'entity_type' => 'entity_test',
            'bundle' => 'entity_test',
            'settings' => [
                'max_filesize' => '2k',
                'file_extensions' => 'jpg|png',
            ],
        ]);
        $field->save();
        vfsStream::setup('drupal_root');
        vfsStream::create([
            'sites' => [
                'default' => [
                    'files' => [
                        'test.txt' => str_repeat('a', 3000),
                    ],
                ],
            ],
        ]);
        // Test for max filesize.
        $file = File::create([
            'uri' => 'vfs://drupal_root/sites/default/files/test.txt',
            'uid' => $this->user
                ->id(),
        ]);
        $file->setPermanent();
        $file->save();
        $entity_test = EntityTest::create([
            'uid' => $this->user
                ->id(),
            'field_test_file' => [
                'target_id' => $file->id(),
            ],
        ]);
        $result = $entity_test->validate();
        $this->assertCount(2, $result);
        $this->assertEquals('field_test_file.0', $result->get(0)
            ->getPropertyPath());
        $this->assertEquals('The file is <em class="placeholder">2.93 KB</em> exceeding the maximum file size of <em class="placeholder">2 KB</em>.', (string) $result->get(0)
            ->getMessage());
        $this->assertEquals('field_test_file.0', $result->get(1)
            ->getPropertyPath());
        $this->assertEquals('Only files with the following extensions are allowed: <em class="placeholder">jpg|png</em>.', (string) $result->get(1)
            ->getMessage());
        // Refer to a file that does not exist.
        $entity_test = EntityTest::create([
            'uid' => $this->user
                ->id(),
            'field_test_file' => [
                'target_id' => 2,
            ],
        ]);
        $result = $entity_test->validate();
        $this->assertCount(1, $result);
        $this->assertEquals('field_test_file.0.target_id', $result->get(0)
            ->getPropertyPath());
        $this->assertEquals('The referenced entity (<em class="placeholder">file</em>: <em class="placeholder">2</em>) does not exist.', (string) $result->get(0)
            ->getMessage());
    }
    
    /**
     * Provides a list of file types to test.
     */
    public static function getFileTypes() {
        return [
            [
                'file',
            ],
            [
                'image',
            ],
        ];
    }

}