You are here

Home » API reference » Zircon Profile 8 » SaveUploadTest.php

class SaveUploadTest in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/file/src/Tests/SaveUploadTest.php \Drupal\file\Tests\SaveUploadTest

Tests the file_save_upload() function.

@group file

Hierarchy

Expanded class hierarchy of SaveUploadTest

File

core/modules/file/src/Tests/SaveUploadTest.php, line 17
Contains \Drupal\file\Tests\SaveUploadTest.

Namespace

Drupal\file\Tests
View source 
class SaveUploadTest extends FileManagedTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'dblog',
  );

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

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

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

  /**
   * Extension of the image filename.
   *
   * @var string
   */
  protected $imageExtension;
  protected function setUp() {
    parent::setUp();
    $account = $this
      ->drupalCreateUser(array(
      'access site reports',
    ));
    $this
      ->drupalLogin($account);
    $image_files = $this
      ->drupalGetTestFiles('image');
    $this->image = entity_create('file', (array) current($image_files));
    list(, $this->imageExtension) = explode('.', $this->image
      ->getFilename());
    $this
      ->assertTrue(is_file($this->image
      ->getFileUri()), "The image file we're going to upload exists.");
    $this->phpfile = current($this
      ->drupalGetTestFiles('php'));
    $this
      ->assertTrue(is_file($this->phpfile->uri), 'The PHP file we are going to upload exists.');
    $this->maxFidBefore = db_query('SELECT MAX(fid) AS fid FROM {file_managed}')
      ->fetchField();

    // Upload with replace to guarantee there's something there.
    $edit = array(
      'file_test_replace' => FILE_EXISTS_REPLACE,
      'files[file_test_upload]' => drupal_realpath($this->image
        ->getFileUri()),
    );
    $this
      ->drupalPostForm('file-test/upload', $edit, t('Submit'));
    $this
      ->assertResponse(200, 'Received a 200 response for posted test file.');
    $this
      ->assertRaw(t('You WIN!'), 'Found the success message.');

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

  /**
   * Test the file_save_upload() function.
   */
  function testNormal() {
    $max_fid_after = db_query('SELECT MAX(fid) AS fid FROM {file_managed}')
      ->fetchField();
    $this
      ->assertTrue($max_fid_after > $this->maxFidBefore, 'A new file was created.');
    $file1 = File::load($max_fid_after);
    $this
      ->assertTrue($file1, 'Loaded the file.');

    // MIME type of the uploaded image may be either image/jpeg or image/png.
    $this
      ->assertEqual(substr($file1
      ->getMimeType(), 0, 5), 'image', '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'));
    $edit = array(
      'files[file_test_upload]' => drupal_realpath($image2->uri),
    );
    $this
      ->drupalPostForm('file-test/upload', $edit, t('Submit'));
    $this
      ->assertResponse(200, 'Received a 200 response for posted test file.');
    $this
      ->assertRaw(t('You WIN!'));
    $max_fid_after = db_query('SELECT MAX(fid) AS fid FROM {file_managed}')
      ->fetchField();

    // Check that the correct hooks were called.
    $this
      ->assertFileHooksCalled(array(
      'validate',
      'insert',
    ));
    $file2 = File::load($max_fid_after);
    $this
      ->assertTrue($file2, 'Loaded the file');

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

    // Load both files using File::loadMultiple().
    $files = File::loadMultiple(array(
      $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 = drupal_realpath($image3->uri);
    $dir = $this
      ->randomMachineName();
    $edit = array(
      'files[file_test_upload]' => $image3_realpath,
      'file_subdir' => $dir,
    );
    $this
      ->drupalPostForm('file-test/upload', $edit, t('Submit'));
    $this
      ->assertResponse(200, 'Received a 200 response for posted test file.');
    $this
      ->assertRaw(t('You WIN!'));
    $this
      ->assertTrue(is_file('temporary://' . $dir . '/' . trim(drupal_basename($image3_realpath))));
  }

  /**
   * Test extension handling.
   */
  function testHandleExtension() {

    // 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() to only allow ".foo".
    $extensions = 'foo';
    $edit = array(
      'file_test_replace' => FILE_EXISTS_REPLACE,
      'files[file_test_upload]' => drupal_realpath($this->image
        ->getFileUri()),
      'extensions' => $extensions,
    );
    $this
      ->drupalPostForm('file-test/upload', $edit, t('Submit'));
    $this
      ->assertResponse(200, 'Received a 200 response for posted test file.');
    $message = t('Only files with the following extensions are allowed:') . ' <em class="placeholder">' . $extensions . '</em>';
    $this
      ->assertRaw($message, 'Cannot upload a disallowed extension');
    $this
      ->assertRaw(t('Epic upload FAIL!'), 'Found the failure message.');

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

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

    // Now tell file_save_upload() to allow the extension of our test image.
    $edit = array(
      'file_test_replace' => FILE_EXISTS_REPLACE,
      'files[file_test_upload]' => drupal_realpath($this->image
        ->getFileUri()),
      'extensions' => $extensions,
    );
    $this
      ->drupalPostForm('file-test/upload', $edit, t('Submit'));
    $this
      ->assertResponse(200, 'Received a 200 response for posted test file.');
    $this
      ->assertNoRaw(t('Only files with the following extensions are allowed:'), 'Can upload an allowed extension.');
    $this
      ->assertRaw(t('You WIN!'), 'Found the success message.');

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

    // Reset the hook counters.
    file_test_reset();

    // Now tell file_save_upload() to allow any extension.
    $edit = array(
      'file_test_replace' => FILE_EXISTS_REPLACE,
      'files[file_test_upload]' => drupal_realpath($this->image
        ->getFileUri()),
      'allow_all_extensions' => TRUE,
    );
    $this
      ->drupalPostForm('file-test/upload', $edit, t('Submit'));
    $this
      ->assertResponse(200, 'Received a 200 response for posted test file.');
    $this
      ->assertNoRaw(t('Only files with the following extensions are allowed:'), 'Can upload any extension.');
    $this
      ->assertRaw(t('You WIN!'), 'Found the success message.');

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

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

    // 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 = array(
      'file_test_replace' => FILE_EXISTS_REPLACE,
      'files[file_test_upload]' => drupal_realpath($this->phpfile->uri),
      'is_image_file' => FALSE,
      'extensions' => 'php',
    );
    $this
      ->drupalPostForm('file-test/upload', $edit, t('Submit'));
    $this
      ->assertResponse(200, 'Received a 200 response for posted test file.');
    $message = t('For security reasons, your upload has been renamed to') . ' <em class="placeholder">' . $this->phpfile->filename . '.txt' . '</em>';
    $this
      ->assertRaw($message, 'Dangerous file was renamed.');
    $this
      ->assertRaw(t('File MIME type is text/plain.'), "Dangerous file's MIME type was changed.");
    $this
      ->assertRaw(t('You WIN!'), 'Found the success message.');

    // Check that the correct hooks were called.
    $this
      ->assertFileHooksCalled(array(
      '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
      ->drupalPostForm('file-test/upload', $edit, t('Submit'));
    $this
      ->assertResponse(200, 'Received a 200 response for posted test file.');
    $this
      ->assertNoRaw(t('For security reasons, your upload has been renamed'), 'Found no security message.');
    $this
      ->assertRaw(t('File name is @filename', array(
      '@filename' => $this->phpfile->filename,
    )), 'Dangerous file was not renamed when insecure uploads is TRUE.');
    $this
      ->assertRaw(t('You WIN!'), 'Found the success message.');

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

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

  /**
   * Test file munge handling.
   */
  function testHandleFileMunge() {

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

    // Reset the hook counters to get rid of the 'move' we just called.
    file_test_reset();
    $extensions = $this->imageExtension;
    $edit = array(
      'files[file_test_upload]' => drupal_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
      ->drupalPostForm('file-test/upload', $edit, t('Submit'));
    $this
      ->assertResponse(200, 'Received a 200 response for posted test file.');
    $this
      ->assertRaw(t('For security reasons, your upload has been renamed'), 'Found security message.');
    $this
      ->assertRaw(t('File name is @filename', array(
      '@filename' => $munged_filename,
    )), 'File was successfully munged.');
    $this
      ->assertRaw(t('You WIN!'), 'Found the success message.');

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

    // Ensure we don't munge files if we're allowing any extension.
    // Reset the hook counters.
    file_test_reset();
    $edit = array(
      'files[file_test_upload]' => drupal_realpath($this->image
        ->getFileUri()),
      'allow_all_extensions' => TRUE,
    );
    $this
      ->drupalPostForm('file-test/upload', $edit, t('Submit'));
    $this
      ->assertResponse(200, 'Received a 200 response for posted test file.');
    $this
      ->assertNoRaw(t('For security reasons, your upload has been renamed'), 'Found no security message.');
    $this
      ->assertRaw(t('File name is @filename', array(
      '@filename' => $this->image
        ->getFilename(),
    )), 'File was not munged when allowing any extension.');
    $this
      ->assertRaw(t('You WIN!'), 'Found the success message.');

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

  /**
   * Test renaming when uploading over a file that already exists.
   */
  function testExistingRename() {
    $edit = array(
      'file_test_replace' => FILE_EXISTS_RENAME,
      'files[file_test_upload]' => drupal_realpath($this->image
        ->getFileUri()),
    );
    $this
      ->drupalPostForm('file-test/upload', $edit, t('Submit'));
    $this
      ->assertResponse(200, 'Received a 200 response for posted test file.');
    $this
      ->assertRaw(t('You WIN!'), 'Found the success message.');

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

  /**
   * Test replacement when uploading over a file that already exists.
   */
  function testExistingReplace() {
    $edit = array(
      'file_test_replace' => FILE_EXISTS_REPLACE,
      'files[file_test_upload]' => drupal_realpath($this->image
        ->getFileUri()),
    );
    $this
      ->drupalPostForm('file-test/upload', $edit, t('Submit'));
    $this
      ->assertResponse(200, 'Received a 200 response for posted test file.');
    $this
      ->assertRaw(t('You WIN!'), 'Found the success message.');

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

  /**
   * Test for failure when uploading over a file that already exists.
   */
  function testExistingError() {
    $edit = array(
      'file_test_replace' => FILE_EXISTS_ERROR,
      'files[file_test_upload]' => drupal_realpath($this->image
        ->getFileUri()),
    );
    $this
      ->drupalPostForm('file-test/upload', $edit, t('Submit'));
    $this
      ->assertResponse(200, 'Received a 200 response for posted test file.');
    $this
      ->assertRaw(t('Epic upload FAIL!'), 'Found the failure message.');

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

  /**
   * Test for no failures when not uploading a file.
   */
  function testNoUpload() {
    $this
      ->drupalPostForm('file-test/upload', array(), t('Submit'));
    $this
      ->assertNoRaw(t('Epic upload FAIL!'), 'Failure message not found.');
  }

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

    // Create a directory and make it not writable.
    $test_directory = 'test_drupal_move_uploaded_file_fail';
    drupal_mkdir('temporary://' . $test_directory, 00);
    $this
      ->assertTrue(is_dir('temporary://' . $test_directory));
    $edit = array(
      'file_subdir' => $test_directory,
      'files[file_test_upload]' => drupal_realpath($this->image
        ->getFileUri()),
    );
    \Drupal::state()
      ->set('file_test.disable_error_collection', TRUE);
    $this
      ->drupalPostForm('file-test/upload', $edit, t('Submit'));
    $this
      ->assertResponse(200, 'Received a 200 response for posted test file.');
    $this
      ->assertRaw(t('File upload error. Could not move uploaded file.'), 'Found the failure message.');
    $this
      ->assertRaw(t('Epic upload FAIL!'), 'Found the failure message.');

    // Uploading failed. Now check the log.
    $this
      ->drupalGet('admin/reports/dblog');
    $this
      ->assertResponse(200);
    $this
      ->assertRaw(t('Upload error. Could not move uploaded file @file to destination @destination.', array(
      '@file' => $this->image
        ->getFilename(),
      '@destination' => 'temporary://' . $test_directory . '/' . $this->image
        ->getFilename(),
    )), 'Found upload error log entry.');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 2
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected function Casts MarkupInterface objects into strings.
FileManagedTestBase::assertDifferentFile function Asserts that two files are not the same by comparing the fid and filepath.
FileManagedTestBase::assertFileHookCalled function Assert that a hook_file_* hook was called a certain number of times.
FileManagedTestBase::assertFileHooksCalled function Assert that all of the specified hook_file_* hooks were called once, other values result in failure.
FileManagedTestBase::assertFileUnchanged function Asserts that two files have the same values (except timestamp).
FileManagedTestBase::assertSameFile function Asserts that two files are the same by comparing the fid and filepath.
FileManagedTestBase::createFile function Create a file and save it to the files table and assert that it occurs correctly.
FileManagedTestBase::createUri function Creates a file and returns its URI.
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.
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.
SaveUploadTest::$image protected property An image file path for uploading.
SaveUploadTest::$imageExtension protected property Extension of the image filename.
SaveUploadTest::$maxFidBefore protected property The largest file id when the test starts.
SaveUploadTest::$modules public static property Modules to enable. Overrides FileManagedTestBase::$modules 1
SaveUploadTest::$phpfile protected property A PHP file path for upload security testing.
SaveUploadTest::setUp protected function Sets up a Drupal site for running functional and integration tests. Overrides FileManagedTestBase::setUp 1
SaveUploadTest::testDrupalMovingUploadedFileError function Tests for log entry on failing destination.
SaveUploadTest::testExistingError function Test for failure when uploading over a file that already exists.
SaveUploadTest::testExistingRename function Test renaming when uploading over a file that already exists.
SaveUploadTest::testExistingReplace function Test replacement when uploading over a file that already exists.
SaveUploadTest::testHandleDangerousFile function Test dangerous file handling.
SaveUploadTest::testHandleExtension function Test extension handling.
SaveUploadTest::testHandleFileMunge function Test file munge handling.
SaveUploadTest::testNormal function Test the file_save_upload() function.
SaveUploadTest::testNoUpload function Test for no failures when not uploading a file.
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.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 5
TestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestBase::$container protected property The dependency injection container used in the test.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials protected property HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod protected property HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$originalConf protected property The original configuration (variables), if available.
TestBase::$originalConfig protected property The original configuration (variables).
TestBase::$originalConfigDirectories protected property The original configuration directories.
TestBase::$originalContainer protected property The original container.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage protected property The original language.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalProfile protected property The original installation profile.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$originalSite protected property The site directory of the original parent site.
TestBase::$privateFilesDirectory protected property The private file directory for the test environment.
TestBase::$publicFilesDirectory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$siteDirectory protected property The site directory of this test run.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestBase::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
TestBase::$verbose public property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertErrorLogged protected function Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse protected function Check to see if a value is false.
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged protected function Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false.
TestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. 1
TestBase::changeDatabasePrefix private function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 2
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 5
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 3
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix private function Generates a database prefix for running tests.
TestBase::prepareEnvironment private function Prepares the current environment for running the test.
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 1
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database.
TestBase::verbose protected function Logs a verbose message in a text file.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
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.
WebTestBase::$additionalCurlOptions protected property Additional cURL options.
WebTestBase::$assertAjaxHeader protected property Whether or not to assert the presence of the X-Drupal-Ajax-Token.
WebTestBase::$classLoader protected property The class loader to use for installation and initialization of setup.
WebTestBase::$configDirectories protected property The config directories used in this test.
WebTestBase::$cookieFile protected property The current cookie file used by cURL.
WebTestBase::$cookies protected property The cookies of the page currently loaded in the internal browser.
WebTestBase::$curlCookies protected property Cookies to set on curl requests.
WebTestBase::$curlHandle protected property The handle of the current cURL connection.
WebTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
WebTestBase::$dumpHeaders protected property Indicates that headers should be dumped if verbose output is enabled. 12
WebTestBase::$generatedTestFiles protected property Whether the files were copied to the test files directory.
WebTestBase::$headers protected property The headers of the page currently loaded in the internal browser.
WebTestBase::$kernel protected property The kernel used in this test. Overrides TestBase::$kernel
WebTestBase::$loggedInUser protected property The current user logged in using the internal browser.
WebTestBase::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
WebTestBase::$maximumRedirects protected property The maximum number of redirects to follow when handling responses.
WebTestBase::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
WebTestBase::$originalBatch protected property The original batch, before it was changed for testing purposes.
WebTestBase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing. Overrides TestBase::$originalShutdownCallbacks
WebTestBase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing. Overrides TestBase::$originalUser
WebTestBase::$profile protected property The profile to install as a basis for testing. 30
WebTestBase::$redirectCount protected property The number of redirects followed during the handling of a request.
WebTestBase::$rootUser protected property The "#1" admin user.
WebTestBase::$sessionId protected property The current session ID, if available.
WebTestBase::$url protected property The URL currently loaded in the internal browser.
WebTestBase::addCustomTranslations protected function Queues custom translations to be written to settings.php.
WebTestBase::assertBlockAppears protected function Checks to see whether a block appears on the page.
WebTestBase::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
WebTestBase::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
WebTestBase::assertHeader protected function Check if a HTTP response header exists and has the expected value.
WebTestBase::assertMail protected function Asserts that the most recently sent email message has the given value.
WebTestBase::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
WebTestBase::assertMailString protected function Asserts that the most recently sent email message has the string in it.
WebTestBase::assertNoBlockAppears protected function Checks to see whether a block does not appears on the page.
WebTestBase::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
WebTestBase::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
WebTestBase::assertNoResponse protected function Asserts the page did not return the specified response code.
WebTestBase::assertResponse protected function Asserts the page responds with the specified response code.
WebTestBase::assertUrl protected function Passes if the internal browser's URL matches the given path.
WebTestBase::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
WebTestBase::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
WebTestBase::clickLink protected function Follows a link by complete name.
WebTestBase::clickLinkHelper protected function Provides a helper for ::clickLink() and ::clickLinkPartialName().
WebTestBase::clickLinkPartialName protected function Follows a link by partial name.
WebTestBase::cronRun protected function Runs cron in the Drupal installed by Simpletest.
WebTestBase::curlClose protected function Close the cURL handler and unset the handler.
WebTestBase::curlExec protected function Initializes and executes a cURL request. 2
WebTestBase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
WebTestBase::curlInitialize protected function Initializes the cURL connection.
WebTestBase::doInstall protected function Execute the non-interactive installer.
WebTestBase::drupalBuildEntityView protected function Builds the renderable view of an entity.
WebTestBase::drupalCompareFiles protected function Compare two files based on size and file name.
WebTestBase::drupalCreateContentType protected function Creates a custom content type based on default settings.
WebTestBase::drupalCreateNode protected function Creates a node based on default settings.
WebTestBase::drupalGet protected function Retrieves a Drupal path or an absolute path. 1
WebTestBase::drupalGetAjax protected function Requests a path or URL in drupal_ajax format and JSON-decodes the response.
WebTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
WebTestBase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page.
WebTestBase::drupalGetJSON protected function Retrieves a Drupal path or an absolute path and JSON decodes the result.
WebTestBase::drupalGetMails protected function Gets an array containing all emails sent during this test case.
WebTestBase::drupalGetNodeByTitle function Get a node from the database based on its title.
WebTestBase::drupalGetTestFiles protected function Gets a list of files that can be used in tests.
WebTestBase::drupalGetWithFormat protected function Retrieves a Drupal path or an absolute path for a given format.
WebTestBase::drupalGetXHR protected function Requests a Drupal path or an absolute path as if it is a XMLHttpRequest.
WebTestBase::drupalHead protected function Retrieves only the headers for a Drupal path or an absolute path.
WebTestBase::drupalLogin protected function Log in a user with the internal browser.
WebTestBase::drupalLogout protected function Logs a user out of the internal browser and confirms.
WebTestBase::drupalPlaceBlock protected function Creates a block instance based on default settings.
WebTestBase::drupalPost protected function Perform a POST HTTP request.
WebTestBase::drupalPostAjaxForm protected function Executes an Ajax form submission.
WebTestBase::drupalPostForm protected function Executes a form submission.
WebTestBase::drupalPostWithFormat protected function Performs a POST HTTP request with a specific format.
WebTestBase::drupalProcessAjaxResponse protected function Processes an AJAX response into current content.
WebTestBase::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
WebTestBase::findBlockInstance protected function Find a block instance on the page.
WebTestBase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
WebTestBase::getAjaxPageStatePostData protected function Get the Ajax page state from drupalSettings and prepare it for POSTing.
WebTestBase::getDatabaseTypes protected function Returns all supported database driver installer objects.
WebTestBase::handleForm protected function Handles form input related to drupalPostForm().
WebTestBase::initConfig protected function Initialize various configurations post-installation.
WebTestBase::initKernel protected function Initializes the kernel after installation.
WebTestBase::initSettings protected function Initialize settings created during install.
WebTestBase::initUserSession protected function Initializes user 1 for the site to be installed.
WebTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`.
WebTestBase::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 2
WebTestBase::isInChildSite protected function Returns whether the test is being executed from within a test site.
WebTestBase::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
WebTestBase::prepareSettings protected function Prepares site settings and services before installation. 1
WebTestBase::rebuildAll protected function Reset and rebuild the environment after setup.
WebTestBase::rebuildContainer protected function Rebuilds \Drupal::getContainer().
WebTestBase::refreshVariables protected function Refreshes in-memory configuration and state information. 1
WebTestBase::resetAll protected function Resets all data structures after having enabled new modules.
WebTestBase::restoreBatch protected function Restore the original batch.
WebTestBase::serializePostValues protected function Serialize POST HTTP request values.
WebTestBase::setBatch protected function Preserve the original batch, and instantiate the test batch.
WebTestBase::setContainerParameter protected function Changes parameters in the services.yml file.
WebTestBase::setHttpResponseDebugCacheabilityHeaders protected function Enables/disables the cacheability headers.
WebTestBase::tearDown protected function Cleans up after testing. Overrides TestBase::tearDown 2
WebTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm().
WebTestBase::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
WebTestBase::writeCustomTranslations protected function Writes custom translations to the test site's settings.php.
WebTestBase::writeSettings protected function Rewrites the settings.php file of the test site.
WebTestBase::__construct function Constructor for \Drupal\simpletest\WebTestBase. Overrides TestBase::__construct 1