ImageFieldValidateTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\image\Functional;

use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\Tests\TestFileCreationTrait;

/**
 * Tests validation functions such as min/max dimensions.
 *
 * @group image
 */
class ImageFieldValidateTest extends ImageFieldTestBase {
    use TestFileCreationTrait {
        getTestFiles as drupalGetTestFiles;
        compareFiles as drupalCompareFiles;
    }
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests image validity.
     */
    public function testValid() : void {
        $file_system = $this->container
            ->get('file_system');
        $image_files = $this->drupalGetTestFiles('image');
        $field_name = $this->randomMachineName();
        $this->createImageField($field_name, 'node', 'article', [], [
            'file_directory' => 'test-upload',
        ]);
        $expected_path = 'public://test-upload';
        // Create alt text for the image.
        $alt = $this->randomMachineName();
        // Create a node with a valid image.
        $node = $this->uploadNodeImage($image_files[0], $field_name, 'article', $alt);
        $this->assertFileExists($expected_path . '/' . $image_files[0]->filename);
        // Remove the image.
        $this->drupalGet('node/' . $node . '/edit');
        $this->submitForm([], 'Remove');
        $this->submitForm([], 'Save');
        // Get invalid image test files.
        $dir = 'core/tests/fixtures/files';
        $files = [];
        if (is_dir($dir)) {
            $files = $file_system->scanDirectory($dir, '/invalid-img-.*/');
        }
        $invalid_image_files = [];
        foreach ($files as $file) {
            $invalid_image_files[$file->filename] = $file;
        }
        // Try uploading a zero-byte image.
        $zero_size_image = $invalid_image_files['invalid-img-zero-size.png'];
        $edit = [
            'files[' . $field_name . '_0]' => $file_system->realpath($zero_size_image->uri),
        ];
        $this->drupalGet('node/' . $node . '/edit');
        $this->submitForm($edit, 'Upload');
        $this->assertFileDoesNotExist($expected_path . '/' . $zero_size_image->filename);
        // Try uploading an invalid image.
        $invalid_image = $invalid_image_files['invalid-img-test.png'];
        $edit = [
            'files[' . $field_name . '_0]' => $file_system->realpath($invalid_image->uri),
        ];
        $this->drupalGet('node/' . $node . '/edit');
        $this->submitForm($edit, 'Upload');
        $this->assertFileDoesNotExist($expected_path . '/' . $invalid_image->filename);
        // Upload a valid image again.
        $valid_image = $image_files[0];
        $edit = [
            'files[' . $field_name . '_0]' => $file_system->realpath($valid_image->uri),
        ];
        $this->drupalGet('node/' . $node . '/edit');
        $this->submitForm($edit, 'Upload');
        $this->assertFileExists($expected_path . '/' . $valid_image->filename);
    }
    
    /**
     * Tests min/max dimensions settings.
     */
    public function testResolution() : void {
        $field_names = [
            0 => $this->randomMachineName(),
            1 => $this->randomMachineName(),
            2 => $this->randomMachineName(),
        ];
        $min_resolution = [
            'width' => 50,
            'height' => 50,
        ];
        $max_resolution = [
            'width' => 100,
            'height' => 100,
        ];
        $no_height_min_resolution = [
            'width' => 50,
            'height' => NULL,
        ];
        $no_height_max_resolution = [
            'width' => 100,
            'height' => NULL,
        ];
        $no_width_min_resolution = [
            'width' => NULL,
            'height' => 50,
        ];
        $no_width_max_resolution = [
            'width' => NULL,
            'height' => 100,
        ];
        $field_settings = [
            0 => $this->getFieldSettings($min_resolution, $max_resolution),
            1 => $this->getFieldSettings($no_height_min_resolution, $no_height_max_resolution),
            2 => $this->getFieldSettings($no_width_min_resolution, $no_width_max_resolution),
        ];
        $this->createImageField($field_names[0], 'node', 'article', [], $field_settings[0]);
        $this->createImageField($field_names[1], 'node', 'article', [], $field_settings[1]);
        $this->createImageField($field_names[2], 'node', 'article', [], $field_settings[2]);
        // We want a test image that is too small, and a test image that is too
        // big, so cycle through test image files until we have what we need.
        $image_that_is_too_big = FALSE;
        $image_that_is_too_small = FALSE;
        $image_factory = $this->container
            ->get('image.factory');
        foreach ($this->drupalGetTestFiles('image') as $image) {
            $image_file = $image_factory->get($image->uri);
            if ($image_file->getWidth() > $max_resolution['width']) {
                $image_that_is_too_big = $image;
            }
            if ($image_file->getWidth() < $min_resolution['width']) {
                $image_that_is_too_small = $image;
                $image_that_is_too_small_file = $image_file;
            }
            if ($image_that_is_too_small && $image_that_is_too_big) {
                break;
            }
        }
        $this->uploadNodeImage($image_that_is_too_small, $field_names[0], 'article');
        $this->assertSession()
            ->statusMessageContains("The specified file {$image_that_is_too_small->filename} could not be uploaded.", 'error');
        $this->assertSession()
            ->statusMessageContains("The image is too small. The minimum dimensions are 50x50 pixels and the image size is {$image_that_is_too_small_file->getWidth()}x{$image_that_is_too_small_file->getHeight()} pixels.", 'error');
        $this->uploadNodeImage($image_that_is_too_big, $field_names[0], 'article');
        $this->assertSession()
            ->statusMessageContains('The image was resized to fit within the maximum allowed dimensions of 100x100 pixels.', 'status');
        $this->uploadNodeImage($image_that_is_too_small, $field_names[1], 'article');
        $this->assertSession()
            ->statusMessageContains("The specified file {$image_that_is_too_small->filename} could not be uploaded.", 'error');
        $this->uploadNodeImage($image_that_is_too_big, $field_names[1], 'article');
        $this->assertSession()
            ->statusMessageContains('The image was resized to fit within the maximum allowed width of 100 pixels.', 'status');
        $this->uploadNodeImage($image_that_is_too_small, $field_names[2], 'article');
        $this->assertSession()
            ->statusMessageContains("The specified file {$image_that_is_too_small->filename} could not be uploaded.", 'error');
        $this->uploadNodeImage($image_that_is_too_big, $field_names[2], 'article');
        $this->assertSession()
            ->statusMessageContains('The image was resized to fit within the maximum allowed height of 100 pixels.', 'status');
    }
    
    /**
     * Tests that required alt/title fields gets validated right.
     */
    public function testRequiredAttributes() : void {
        $field_name = $this->randomMachineName();
        $field_settings = [
            'alt_field' => 1,
            'alt_field_required' => 1,
            'title_field' => 1,
            'title_field_required' => 1,
            'required' => 1,
        ];
        $instance = $this->createImageField($field_name, 'node', 'article', [], $field_settings);
        $images = $this->drupalGetTestFiles('image');
        // Let's just use the first image.
        $image = $images[0];
        $this->uploadNodeImage($image, $field_name, 'article');
        // Look for form-required for the alt text.
        $this->assertSession()
            ->elementExists('xpath', '//label[@for="edit-' . $field_name . '-0-alt" and @class="js-form-required form-required"]/following-sibling::input[@id="edit-' . $field_name . '-0-alt"]');
        $this->assertSession()
            ->elementExists('xpath', '//label[@for="edit-' . $field_name . '-0-title" and @class="js-form-required form-required"]/following-sibling::input[@id="edit-' . $field_name . '-0-title"]');
        $this->assertSession()
            ->statusMessageContains('Alternative text field is required.', 'error');
        $this->assertSession()
            ->statusMessageContains('Title field is required.', 'error');
        $instance->setSetting('alt_field_required', 0);
        $instance->setSetting('title_field_required', 0);
        $instance->save();
        $edit = [
            'title[0][value]' => $this->randomMachineName(),
        ];
        $this->drupalGet('node/add/article');
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->statusMessageNotContains('Alternative text field is required.');
        $this->assertSession()
            ->statusMessageNotContains('Title field is required.');
        $instance->setSetting('required', 0);
        $instance->setSetting('alt_field_required', 1);
        $instance->setSetting('title_field_required', 1);
        $instance->save();
        $edit = [
            'title[0][value]' => $this->randomMachineName(),
        ];
        $this->drupalGet('node/add/article');
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->statusMessageNotContains('Alternative text field is required.');
        $this->assertSession()
            ->statusMessageNotContains('Title field is required.');
    }
    
    /**
     * Tests creating an entity while leaving the image field empty.
     *
     * This is tested first with edit access to the image field allowed, and then
     * with it forbidden.
     *
     * @dataProvider providerTestEmpty
     */
    public function testEmpty($field_name, $required, $cardinality, $form_element_name, $expected_page_text_when_edit_access_allowed, $expected_page_text_when_edit_access_forbidden) : void {
        $this->createImageField($field_name, 'node', 'article', [
            'cardinality' => $cardinality,
        ], [
            'required' => $required,
        ]);
        // Test with field edit access allowed.
        $this->drupalGet('node/add/article');
        $this->assertSession()
            ->fieldExists($form_element_name);
        $edit = [
            'title[0][value]' => 'Article with edit-access-allowed image field',
        ];
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains($expected_page_text_when_edit_access_allowed);
        // Test with field edit access forbidden.
        \Drupal::service('module_installer')->install([
            'image_access_test_hidden',
        ]);
        $this->drupalGet('node/add/article');
        $this->assertSession()
            ->fieldNotExists($form_element_name);
        $edit = [
            'title[0][value]' => 'Article with edit-access-forbidden image field',
        ];
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->pageTextContains($expected_page_text_when_edit_access_forbidden);
    }
    
    /**
     * Data provider for ::testEmpty()
     *
     * @return array
     *   Test cases.
     */
    public static function providerTestEmpty() {
        return [
            'optional-single' => [
                'field_image',
                FALSE,
                1,
                'files[field_image_0]',
                'Article Article with edit-access-allowed image field has been created.',
                'Article Article with edit-access-forbidden image field has been created.',
            ],
            'optional-unlimited' => [
                'field_image',
                FALSE,
                FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
                'files[field_image_0][]',
                'Article Article with edit-access-allowed image field has been created.',
                'Article Article with edit-access-forbidden image field has been created.',
            ],
            'optional-multiple-limited' => [
                'field_image',
                FALSE,
                2,
                'files[field_image_0][]',
                'Article Article with edit-access-allowed image field has been created.',
                'Article Article with edit-access-forbidden image field has been created.',
            ],
            'required-single' => [
                'field_image',
                TRUE,
                1,
                'files[field_image_0]',
                'field_image field is required.',
                'field_image field is required.',
            ],
            'required-unlimited' => [
                'field_image',
                TRUE,
                FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
                'files[field_image_0][]',
                'field_image field is required.',
                'field_image field is required.',
            ],
            // @todo Fix this discrepancy in https://www.drupal.org/project/drupal/issues/3011744.
'required-multiple-limited' => [
                'field_image',
                TRUE,
                2,
                'files[field_image_0][]',
                'This value should not be null.',
                'Article Article with edit-access-forbidden image field has been created.',
            ],
        ];
    }
    
    /**
     * Returns field settings.
     *
     * @param int[] $min_resolution
     *   The minimum width and height setting.
     * @param int[] $max_resolution
     *   The maximum width and height setting.
     *
     * @return array
     */
    protected function getFieldSettings($min_resolution, $max_resolution) : array {
        return [
            'max_resolution' => $max_resolution['width'] . 'x' . $max_resolution['height'],
            'min_resolution' => $min_resolution['width'] . 'x' . $min_resolution['height'],
            'alt_field' => 0,
        ];
    }

}