class SaveUploadFormTest in Drupal 9

Same name and namespace in other branches

8 core/modules/file/tests/src/Functional/SaveUploadFormTest.php \Drupal\Tests\file\Functional\SaveUploadFormTest

Tests the _file_save_upload_from_form() function.

@group file

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\file\Functional\FileManagedTestBase
  - class \Drupal\Tests\file\Functional\SaveUploadFormTest uses TestFileCreationTrait

Expanded class hierarchy of SaveUploadFormTest

File

core/modules/file/tests/src/Functional/SaveUploadFormTest.php, line 16

Namespace

Drupal\Tests\file\Functional

View source

class SaveUploadFormTest extends FileManagedTestBase {
  use TestFileCreationTrait {
    getTestFiles as drupalGetTestFiles;
  }

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'dblog',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'classy';

  /**
   * An image file path for uploading.
   *
   * @var \Drupal\file\FileInterface
   */
  protected $image;

  /**
   * A PHP file path for upload security testing.
   *
   * @var string
   */
  protected $phpfile;

  /**
   * The largest file id when the test starts.
   *
   * @var int
   */
  protected $maxFidBefore;

  /**
   * Extension of the image filename.
   *
   * @var string
   */
  protected $imageExtension;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $account = $this
      ->drupalCreateUser([
      'access site reports',
    ]);
    $this
      ->drupalLogin($account);
    $image_files = $this
      ->drupalGetTestFiles('image');
    $this->image = File::create((array) current($image_files));
    list(, $this->imageExtension) = explode('.', $this->image
      ->getFilename());
    $this
      ->assertFileExists($this->image
      ->getFileUri());
    $this->phpfile = current($this
      ->drupalGetTestFiles('php'));
    $this
      ->assertFileExists($this->phpfile->uri);
    $this->maxFidBefore = (int) \Drupal::entityQueryAggregate('file')
      ->accessCheck(FALSE)
      ->aggregate('fid', 'max')
      ->execute()[0]['fid_max'];

    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
    $file_system = \Drupal::service('file_system');

    // Upload with replace to guarantee there's something there.
    $edit = [
      'file_test_replace' => FileSystemInterface::EXISTS_REPLACE,
      'files[file_test_upload][]' => $file_system
        ->realpath($this->image
        ->getFileUri()),
    ];
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains("You WIN!");

    // Check that the correct hooks were called then clean out the hook
    // counters.
    $this
      ->assertFileHooksCalled([
      'validate',
      'insert',
    ]);
    file_test_reset();
  }

  /**
   * Tests the _file_save_upload_from_form() function.
   */
  public function testNormal() {
    $max_fid_after = (int) \Drupal::entityQueryAggregate('file')
      ->accessCheck(FALSE)
      ->aggregate('fid', 'max')
      ->execute()[0]['fid_max'];

    // Verify that a new file was created.
    $this
      ->assertGreaterThan($this->maxFidBefore, $max_fid_after);
    $file1 = File::load($max_fid_after);
    $this
      ->assertInstanceOf(File::class, $file1);

    // MIME type of the uploaded image may be either image/jpeg or image/png.
    $this
      ->assertEquals('image', substr($file1
      ->getMimeType(), 0, 5), 'A MIME type was set.');

    // Reset the hook counters to get rid of the 'load' we just called.
    file_test_reset();

    // Upload a second file.
    $image2 = current($this
      ->drupalGetTestFiles('image'));

    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
    $file_system = \Drupal::service('file_system');
    $edit = [
      'files[file_test_upload][]' => $file_system
        ->realpath($image2->uri),
    ];
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains("You WIN!");
    $max_fid_after = (int) \Drupal::entityQueryAggregate('file')
      ->accessCheck(FALSE)
      ->aggregate('fid', 'max')
      ->execute()[0]['fid_max'];

    // Check that the correct hooks were called.
    $this
      ->assertFileHooksCalled([
      'validate',
      'insert',
    ]);
    $file2 = File::load($max_fid_after);
    $this
      ->assertInstanceOf(File::class, $file2);

    // MIME type of the uploaded image may be either image/jpeg or image/png.
    $this
      ->assertEquals('image', substr($file2
      ->getMimeType(), 0, 5), 'A MIME type was set.');

    // Load both files using File::loadMultiple().
    $files = File::loadMultiple([
      $file1
        ->id(),
      $file2
        ->id(),
    ]);
    $this
      ->assertTrue(isset($files[$file1
      ->id()]), 'File was loaded successfully');
    $this
      ->assertTrue(isset($files[$file2
      ->id()]), 'File was loaded successfully');

    // Upload a third file to a subdirectory.
    $image3 = current($this
      ->drupalGetTestFiles('image'));
    $image3_realpath = $file_system
      ->realpath($image3->uri);
    $dir = $this
      ->randomMachineName();
    $edit = [
      'files[file_test_upload][]' => $image3_realpath,
      'file_subdir' => $dir,
    ];
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains("You WIN!");
    $this
      ->assertFileExists('temporary://' . $dir . '/' . trim(\Drupal::service('file_system')
      ->basename($image3_realpath)));
  }

  /**
   * Tests extension handling.
   */
  public function testHandleExtension() {

    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
    $file_system = \Drupal::service('file_system');

    // The file being tested is a .gif which is in the default safe list
    // of extensions to allow when the extension validator isn't used. This is
    // implicitly tested at the testNormal() test. Here we tell
    // _file_save_upload_from_form() to only allow ".foo".
    $extensions = 'foo';
    $edit = [
      'file_test_replace' => FileSystemInterface::EXISTS_REPLACE,
      'files[file_test_upload][]' => $file_system
        ->realpath($this->image
        ->getFileUri()),
      'extensions' => $extensions,
    ];
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->responseContains('Only files with the following extensions are allowed: <em class="placeholder">' . $extensions . '</em>');
    $this
      ->assertSession()
      ->pageTextContains("Epic upload FAIL!");

    // Check that the correct hooks were called.
    $this
      ->assertFileHooksCalled([
      'validate',
    ]);

    // Reset the hook counters.
    file_test_reset();
    $extensions = 'foo ' . $this->imageExtension;

    // Now tell _file_save_upload_from_form() to allow the extension of our test image.
    $edit = [
      'file_test_replace' => FileSystemInterface::EXISTS_REPLACE,
      'files[file_test_upload][]' => $file_system
        ->realpath($this->image
        ->getFileUri()),
      'extensions' => $extensions,
    ];
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextNotContains('Only files with the following extensions are allowed:');
    $this
      ->assertSession()
      ->pageTextContains("You WIN!");

    // Check that the correct hooks were called.
    $this
      ->assertFileHooksCalled([
      'validate',
      'load',
      'update',
    ]);

    // Reset the hook counters.
    file_test_reset();

    // Now tell _file_save_upload_from_form() to allow any extension.
    $edit = [
      'file_test_replace' => FileSystemInterface::EXISTS_REPLACE,
      'files[file_test_upload][]' => $file_system
        ->realpath($this->image
        ->getFileUri()),
      'allow_all_extensions' => 'empty_array',
    ];
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextNotContains('Only files with the following extensions are allowed:');
    $this
      ->assertSession()
      ->pageTextContains("You WIN!");

    // Check that the correct hooks were called.
    $this
      ->assertFileHooksCalled([
      'validate',
      'load',
      'update',
    ]);
  }

  /**
   * Tests dangerous file handling.
   */
  public function testHandleDangerousFile() {
    $config = $this
      ->config('system.file');

    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
    $file_system = \Drupal::service('file_system');

    // Allow the .php extension and make sure it gets renamed to .txt for
    // safety. Also check to make sure its MIME type was changed.
    $edit = [
      'file_test_replace' => FileSystemInterface::EXISTS_REPLACE,
      'files[file_test_upload][]' => $file_system
        ->realpath($this->phpfile->uri),
      'is_image_file' => FALSE,
      'extensions' => 'php txt',
    ];
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->responseContains('For security reasons, your upload has been renamed to <em class="placeholder">' . $this->phpfile->filename . '_.txt' . '</em>');
    $this
      ->assertSession()
      ->pageTextContains('File MIME type is text/plain.');
    $this
      ->assertSession()
      ->pageTextContains("You WIN!");

    // Check that the correct hooks were called.
    $this
      ->assertFileHooksCalled([
      'validate',
      'insert',
    ]);

    // Ensure dangerous files are not renamed when insecure uploads is TRUE.
    // Turn on insecure uploads.
    $config
      ->set('allow_insecure_uploads', 1)
      ->save();

    // Reset the hook counters.
    file_test_reset();
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextNotContains('For security reasons, your upload has been renamed');
    $this
      ->assertSession()
      ->pageTextContains("File name is {$this->phpfile->filename}");
    $this
      ->assertSession()
      ->pageTextContains("You WIN!");

    // Check that the correct hooks were called.
    $this
      ->assertFileHooksCalled([
      'validate',
      'insert',
    ]);

    // Turn off insecure uploads.
    $config
      ->set('allow_insecure_uploads', 0)
      ->save();

    // Reset the hook counters.
    file_test_reset();
    $edit = [
      'file_test_replace' => FileSystemInterface::EXISTS_REPLACE,
      'files[file_test_upload]' => \Drupal::service('file_system')
        ->realpath($this->phpfile->uri),
      'is_image_file' => FALSE,
      'extensions' => 'php',
    ];
    $this
      ->drupalGet('file-test/upload');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains('For security reasons, your upload has been rejected.');
    $this
      ->assertSession()
      ->pageTextContains('Epic upload FAIL!');

    // Check that the correct hooks were called.
    $this
      ->assertFileHooksCalled([
      'validate',
    ]);
  }

  /**
   * Tests file munge handling.
   */
  public function testHandleFileMunge() {

    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
    $file_system = \Drupal::service('file_system');

    // Ensure insecure uploads are disabled for this test.
    $this
      ->config('system.file')
      ->set('allow_insecure_uploads', 0)
      ->save();
    $original_uri = $this->image
      ->getFileUri();
    $this->image = file_move($this->image, $original_uri . '.foo.' . $this->imageExtension);

    // Reset the hook counters to get rid of the 'move' we just called.
    file_test_reset();
    $extensions = $this->imageExtension;
    $edit = [
      'files[file_test_upload][]' => $file_system
        ->realpath($this->image
        ->getFileUri()),
      'extensions' => $extensions,
    ];
    $munged_filename = $this->image
      ->getFilename();
    $munged_filename = substr($munged_filename, 0, strrpos($munged_filename, '.'));
    $munged_filename .= '_.' . $this->imageExtension;
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains('For security reasons, your upload has been renamed');
    $this
      ->assertSession()
      ->pageTextContains("File name is {$munged_filename}");
    $this
      ->assertSession()
      ->pageTextContains("You WIN!");

    // Check that the correct hooks were called.
    $this
      ->assertFileHooksCalled([
      'validate',
      'insert',
    ]);

    // Test with uppercase extensions.
    $this->image = file_move($this->image, $original_uri . '.foo2.' . $this->imageExtension);

    // Reset the hook counters.
    file_test_reset();
    $extensions = $this->imageExtension;
    $edit = [
      'files[file_test_upload][]' => $file_system
        ->realpath($this->image
        ->getFileUri()),
      'extensions' => mb_strtoupper($extensions),
    ];
    $munged_filename = $this->image
      ->getFilename();
    $munged_filename = substr($munged_filename, 0, strrpos($munged_filename, '.'));
    $munged_filename .= '_.' . $this->imageExtension;
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains('For security reasons, your upload has been renamed');
    $this
      ->assertSession()
      ->pageTextContains("File name is {$munged_filename}");
    $this
      ->assertSession()
      ->pageTextContains("You WIN!");

    // Check that the correct hooks were called.
    $this
      ->assertFileHooksCalled([
      'validate',
      'insert',
    ]);

    // Ensure we don't munge files if we're allowing any extension.
    // Reset the hook counters.
    file_test_reset();

    // Ensure we don't munge files if we're allowing any extension.
    $edit = [
      'files[file_test_upload][]' => $file_system
        ->realpath($this->image
        ->getFileUri()),
      'allow_all_extensions' => 'empty_array',
    ];
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextNotContains('For security reasons, your upload has been renamed');
    $this
      ->assertSession()
      ->pageTextContains("File name is {$this->image->getFilename()}");
    $this
      ->assertSession()
      ->pageTextContains("You WIN!");

    // Check that the correct hooks were called.
    $this
      ->assertFileHooksCalled([
      'validate',
      'insert',
    ]);

    // Ensure that setting $validators['file_validate_extensions'] = ['']
    // rejects all files.
    // Reset the hook counters.
    file_test_reset();
    $edit = [
      'files[file_test_upload][]' => $file_system
        ->realpath($this->image
        ->getFileUri()),
      'allow_all_extensions' => 'empty_string',
    ];
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextNotContains('For security reasons, your upload has been renamed');
    $this
      ->assertSession()
      ->pageTextContains("Epic upload FAIL!");

    // Check that the correct hooks were called.
    $this
      ->assertFileHooksCalled([
      'validate',
    ]);
  }

  /**
   * Tests renaming when uploading over a file that already exists.
   */
  public function testExistingRename() {

    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
    $file_system = \Drupal::service('file_system');
    $edit = [
      'file_test_replace' => FileSystemInterface::EXISTS_RENAME,
      'files[file_test_upload][]' => $file_system
        ->realpath($this->image
        ->getFileUri()),
    ];
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains("You WIN!");

    // Check that the correct hooks were called.
    $this
      ->assertFileHooksCalled([
      'validate',
      'insert',
    ]);
  }

  /**
   * Tests replacement when uploading over a file that already exists.
   */
  public function testExistingReplace() {

    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
    $file_system = \Drupal::service('file_system');
    $edit = [
      'file_test_replace' => FileSystemInterface::EXISTS_REPLACE,
      'files[file_test_upload][]' => $file_system
        ->realpath($this->image
        ->getFileUri()),
    ];
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains("You WIN!");

    // Check that the correct hooks were called.
    $this
      ->assertFileHooksCalled([
      'validate',
      'load',
      'update',
    ]);
  }

  /**
   * Tests for failure when uploading over a file that already exists.
   */
  public function testExistingError() {

    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
    $file_system = \Drupal::service('file_system');
    $edit = [
      'file_test_replace' => FileSystemInterface::EXISTS_ERROR,
      'files[file_test_upload][]' => $file_system
        ->realpath($this->image
        ->getFileUri()),
    ];
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains("Epic upload FAIL!");

    // Check that the no hooks were called while failing.
    $this
      ->assertFileHooksCalled([]);
  }

  /**
   * Tests for no failures when not uploading a file.
   */
  public function testNoUpload() {
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm([], 'Submit');
    $this
      ->assertSession()
      ->pageTextNotContains("Epic upload FAIL!");
  }

  /**
   * Tests for log entry on failing destination.
   */
  public function testDrupalMovingUploadedFileError() {

    // Create a directory and make it not writable.
    $test_directory = 'test_drupal_move_uploaded_file_fail';
    \Drupal::service('file_system')
      ->mkdir('temporary://' . $test_directory, 00);
    $this
      ->assertDirectoryExists('temporary://' . $test_directory);

    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
    $file_system = \Drupal::service('file_system');
    $edit = [
      'file_subdir' => $test_directory,
      'files[file_test_upload][]' => $file_system
        ->realpath($this->image
        ->getFileUri()),
    ];
    \Drupal::state()
      ->set('file_test.disable_error_collection', TRUE);
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains('File upload error. Could not move uploaded file.');
    $this
      ->assertSession()
      ->pageTextContains("Epic upload FAIL!");

    // Uploading failed. Now check the log.
    $this
      ->drupalGet('admin/reports/dblog');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // The full log message is in the title attribute of the link, so we cannot
    // use ::pageTextContains() here.
    $destination = 'temporary://' . $test_directory . '/' . $this->image
      ->getFilename();
    $this
      ->assertSession()
      ->responseContains("Upload error. Could not move uploaded file {$this->image->getFilename()} to destination {$destination}.");
  }

  /**
   * Tests that form validation does not change error messages.
   */
  public function testErrorMessagesAreNotChanged() {
    $error = 'An error message set before _file_save_upload_from_form()';

    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
    $file_system = \Drupal::service('file_system');
    $edit = [
      'files[file_test_upload][]' => $file_system
        ->realpath($this->image
        ->getFileUri()),
      'error_message' => $error,
    ];
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains("You WIN!");

    // Ensure the expected error message is present and the counts before and
    // after calling _file_save_upload_from_form() are correct.
    $this
      ->assertSession()
      ->pageTextContains($error);
    $this
      ->assertSession()
      ->pageTextContains('Number of error messages before _file_save_upload_from_form(): 1');
    $this
      ->assertSession()
      ->pageTextContains('Number of error messages after _file_save_upload_from_form(): 1');

    // Test that error messages are preserved when an error occurs.
    $edit = [
      'files[file_test_upload][]' => $file_system
        ->realpath($this->image
        ->getFileUri()),
      'error_message' => $error,
      'extensions' => 'foo',
    ];
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains("Epic upload FAIL!");

    // Ensure the expected error message is present and the counts before and
    // after calling _file_save_upload_from_form() are correct.
    $this
      ->assertSession()
      ->pageTextContains($error);
    $this
      ->assertSession()
      ->pageTextContains('Number of error messages before _file_save_upload_from_form(): 1');
    $this
      ->assertSession()
      ->pageTextContains('Number of error messages after _file_save_upload_from_form(): 1');

    // Test a successful upload with no messages.
    $edit = [
      'files[file_test_upload][]' => $file_system
        ->realpath($this->image
        ->getFileUri()),
    ];
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains("You WIN!");

    // Ensure the error message is not present and the counts before and after
    // calling _file_save_upload_from_form() are correct.
    $this
      ->assertSession()
      ->pageTextNotContains($error);
    $this
      ->assertSession()
      ->pageTextContains('Number of error messages before _file_save_upload_from_form(): 0');
    $this
      ->assertSession()
      ->pageTextContains('Number of error messages after _file_save_upload_from_form(): 0');
  }

  /**
   * Tests that multiple validation errors are combined in one message.
   */
  public function testCombinedErrorMessages() {
    $textfile = current($this
      ->drupalGetTestFiles('text'));
    $this
      ->assertFileExists($textfile->uri);

    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
    $file_system = \Drupal::service('file_system');

    // Can't use submitForm() for set nonexistent fields.
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $client = $this
      ->getSession()
      ->getDriver()
      ->getClient();
    $submit_xpath = $this
      ->assertSession()
      ->buttonExists('Submit')
      ->getXpath();
    $form = $client
      ->getCrawler()
      ->filterXPath($submit_xpath)
      ->form();
    $edit = [
      'is_image_file' => TRUE,
      'extensions' => 'jpeg',
    ];
    $edit += $form
      ->getPhpValues();
    $files['files']['file_test_upload'][0] = $file_system
      ->realpath($this->phpfile->uri);
    $files['files']['file_test_upload'][1] = $file_system
      ->realpath($textfile->uri);
    $client
      ->request($form
      ->getMethod(), $form
      ->getUri(), $edit, $files);
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains("Epic upload FAIL!");

    // Search for combined error message followed by a formatted list of messages.
    $this
      ->assertSession()
      ->responseContains('One or more files could not be uploaded.<div class="item-list">');
  }

  /**
   * Tests highlighting of file upload field when it has an error.
   */
  public function testUploadFieldIsHighlighted() {
    $this
      ->assertCount(0, $this
      ->cssSelect('input[name="files[file_test_upload][]"].error'), 'Successful file upload has no error.');

    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
    $file_system = \Drupal::service('file_system');
    $edit = [
      'files[file_test_upload][]' => $file_system
        ->realpath($this->image
        ->getFileUri()),
      'extensions' => 'foo',
    ];
    $this
      ->drupalGet('file-test/save_upload_from_form_test');
    $this
      ->submitForm($edit, 'Submit');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertSession()
      ->pageTextContains("Epic upload FAIL!");
    $this
      ->assertCount(1, $this
      ->cssSelect('input[name="files[file_test_upload][]"].error'), 'File upload field has error.');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertEscaped Deprecated	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated	protected	function	Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertLink Deprecated	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNoText Deprecated	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::assertNoUniqueText Deprecated	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated	protected	function	Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated	protected	function	Gets the current raw content.
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	protected	function
BlockCreationTrait::placeBlock	protected	function	Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl	protected	property	The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName	protected	property	Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter	protected	property	Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage	protected	property	Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory	protected	property	Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled	protected	property	HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile	protected	property	The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId	protected	property	HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders	protected	function	Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders	protected	function	Returns headers in HTML output format.	1
BrowserHtmlDebugTrait::getResponseLogHandler	protected	function	Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput	protected	function	Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile	protected	function	Creates the directory to store browser output.
BrowserTestBase::$baseUrl	protected	property	The base URL.
BrowserTestBase::$configImporter	protected	property	The config importer that can be used in a test.
BrowserTestBase::$customTranslations	protected	property	An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix	protected	property	The database prefix of this test run.
BrowserTestBase::$mink	protected	property	Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs	protected	property	Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass	protected	property	Mink class for the default driver to use.	1
BrowserTestBase::$originalContainer	protected	property	The original container.
BrowserTestBase::$originalShutdownCallbacks	protected	property	The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState	protected	property
BrowserTestBase::$profile	protected	property	The profile to install as a basis for testing.	39
BrowserTestBase::$root	protected	property	The app root.
BrowserTestBase::$runTestInSeparateProcess	protected	property	Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit	protected	property	Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory	protected	property	The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment	protected	function	Clean up the Simpletest environment.
BrowserTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated	protected	function	Gets the value of an HTTP response header.
BrowserTestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance	protected	function	Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings	protected	function	Gets the JavaScript drupalSettings variable for the currently-loaded page.	1
BrowserTestBase::getHttpClient	protected	function	Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs	protected	function	Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests.	1
BrowserTestBase::getOptions	protected	function	Helper function to get the options of select field.
BrowserTestBase::getSession	public	function	Returns Mink session.
BrowserTestBase::getSessionCookies	protected	function	Get session cookies from current session.
BrowserTestBase::getTestMethodCaller	protected	function	Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage	protected	function	Visits the front page when initializing Mink.	3
BrowserTestBase::initMink	protected	function	Initializes Mink sessions.	1
BrowserTestBase::installDrupal	public	function	Installs Drupal into the Simpletest site.	1
BrowserTestBase::registerSessions	protected	function	Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot	protected	function	Sets up the root application path.
BrowserTestBase::setUpBeforeClass	public static	function		1
BrowserTestBase::tearDown	protected	function		3
BrowserTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep	public	function	Prevents serializing any properties.
ConfigTestTrait::configImporter	protected	function	Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig	protected	function	Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType	protected	function	Creates a custom content type based on default settings. Aliased as: drupalCreateContentType	1
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
FileManagedTestBase::assertDifferentFile	public	function	Asserts that two files are not the same by comparing the fid and filepath.
FileManagedTestBase::assertFileHookCalled	public	function	Assert that a hook_file_* hook was called a certain number of times.
FileManagedTestBase::assertFileHooksCalled	public	function	Assert that all of the specified hook_file_* hooks were called once, other values result in failure.
FileManagedTestBase::assertFileUnchanged	public	function	Asserts that two files have the same values (except timestamp).
FileManagedTestBase::assertSameFile	public	function	Asserts that two files are the same by comparing the fid and filepath.
FileManagedTestBase::createFile	public	function	Create a file and save it to the files table and assert that it occurs correctly.
FileManagedTestBase::createUri	public	function	Creates a file and returns its URI.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix	protected	property	The flag to set 'apcu_ensure_unique_prefix' setting.	1
FunctionalTestSetupTrait::$classLoader	protected	property	The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser	protected	property	The "#1" admin user.
FunctionalTestSetupTrait::doInstall	protected	function	Execute the non-interactive installer.	1
FunctionalTestSetupTrait::getDatabaseTypes	protected	function	Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig	protected	function	Initialize various configurations post-installation.	1
FunctionalTestSetupTrait::initKernel	protected	function	Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings	protected	function	Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession	protected	function	Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty	protected	function	Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty	protected	function	Install modules defined by `static::$modules`.	1
FunctionalTestSetupTrait::installParameters	protected	function	Returns the parameters that will be used when Simpletest installs Drupal.	9
FunctionalTestSetupTrait::prepareEnvironment	protected	function	Prepares the current environment for running the test.	20
FunctionalTestSetupTrait::prepareRequestForGenerator	protected	function	Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings	protected	function	Prepares site settings and services before installation.	2
FunctionalTestSetupTrait::rebuildAll	protected	function	Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer	protected	function	Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll	protected	function	Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter	protected	function	Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl	protected	function	Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings	protected	function	Rewrites the settings.php file of the test site.	1
NodeCreationTrait::createNode	protected	function	Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle	public	function	Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
RandomGeneratorTrait::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName	protected	function	Generates a unique random string containing letters and numbers.	1
RandomGeneratorTrait::randomObject	public	function	Generates a random PHP object.
RandomGeneratorTrait::randomString	public	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
RefreshVariablesTrait::refreshVariables	protected	function	Refreshes in-memory configuration and state information.	1
SaveUploadFormTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
SaveUploadFormTest::$image	protected	property	An image file path for uploading.
SaveUploadFormTest::$imageExtension	protected	property	Extension of the image filename.
SaveUploadFormTest::$maxFidBefore	protected	property	The largest file id when the test starts.
SaveUploadFormTest::$modules	protected static	property	Modules to enable. Overrides FileManagedTestBase::$modules
SaveUploadFormTest::$phpfile	protected	property	A PHP file path for upload security testing.
SaveUploadFormTest::setUp	protected	function	Overrides FileManagedTestBase::setUp
SaveUploadFormTest::testCombinedErrorMessages	public	function	Tests that multiple validation errors are combined in one message.
SaveUploadFormTest::testDrupalMovingUploadedFileError	public	function	Tests for log entry on failing destination.
SaveUploadFormTest::testErrorMessagesAreNotChanged	public	function	Tests that form validation does not change error messages.
SaveUploadFormTest::testExistingError	public	function	Tests for failure when uploading over a file that already exists.
SaveUploadFormTest::testExistingRename	public	function	Tests renaming when uploading over a file that already exists.
SaveUploadFormTest::testExistingReplace	public	function	Tests replacement when uploading over a file that already exists.
SaveUploadFormTest::testHandleDangerousFile	public	function	Tests dangerous file handling.
SaveUploadFormTest::testHandleExtension	public	function	Tests extension handling.
SaveUploadFormTest::testHandleFileMunge	public	function	Tests file munge handling.
SaveUploadFormTest::testNormal	public	function	Tests the _file_save_upload_from_form() function.
SaveUploadFormTest::testNoUpload	public	function	Tests for no failures when not uploading a file.
SaveUploadFormTest::testUploadFieldIsHighlighted	public	function	Tests highlighting of file upload field when it has an error.
SessionTestTrait::$sessionName	protected	property	The name of the session cookie.
SessionTestTrait::generateSessionName	protected	function	Generates a session cookie name.
SessionTestTrait::getSessionName	protected	function	Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestFileCreationTrait::$generatedTestFiles	protected	property	Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles	protected	function	Compares two files based on size and file name.
TestFileCreationTrait::generateFile	public static	function	Generates a test file.
TestFileCreationTrait::getTestFiles	protected	function	Gets a list of files that can be used in tests. Aliased as: drupalGetTestFiles
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
TestSetupTrait::$container	protected	property	The dependency injection container used in the test.
TestSetupTrait::$kernel	protected	property	The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite	protected	property	The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory	protected	property	The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory	protected	property	The public file directory for the test environment.
TestSetupTrait::$siteDirectory	protected	property	The site directory of this test run.
TestSetupTrait::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	1
TestSetupTrait::$tempFilesDirectory	protected	property	The temporary file directory for the test environment.
TestSetupTrait::$testId	protected	property	The test run ID.
TestSetupTrait::changeDatabasePrefix	protected	function	Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection	public static	function	Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix	protected	function	Generates a database prefix for running tests.	1
UiHelperTrait::$loggedInUser	protected	property	The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount	protected	property	The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount	protected	property	The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession	public	function	Returns WebAssert object.	1
UiHelperTrait::buildUrl	protected	function	Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh	protected	function	Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click	protected	function	Clicks the element with the given CSS selector.
UiHelperTrait::clickLink	protected	function	Follows a link by complete name.
UiHelperTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath	protected	function	Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	2
UiHelperTrait::drupalLogin	protected	function	Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout	protected	function	Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm Deprecated	protected	function	Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn	protected	function	Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl	protected	function	Takes a path and returns an absolute path.
UiHelperTrait::getTextContent	protected	function	Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl	protected	function	Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient	protected	function	Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest	protected	function	Prepare for a request to testing site.	1
UiHelperTrait::submitForm	protected	function	Fills and submits a form.
UserCreationTrait::checkPermissions	protected	function	Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole	protected	function	Creates an administrative role.
UserCreationTrait::createRole	protected	function	Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser	protected	function	Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions	protected	function	Grant permissions to a user role.
UserCreationTrait::setCurrentUser	protected	function	Switch the current logged in user.
UserCreationTrait::setUpCurrentUser	protected	function	Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest	protected	function	Adds xdebug cookies, from request setup.

You are here

class SaveUploadFormTest in Drupal 9

Hierarchy

See also

File

Namespace

Members

API Navigation