You are here

Home » API reference » Drupal 7 » file.test

class FileSaveUploadTest in Drupal 7

Test the file_save_upload() function.

Hierarchy

Expanded class hierarchy of FileSaveUploadTest

File

modules/simpletest/tests/file.test, line 551
This provides SimpleTests for the core file handling functionality. These include FileValidateTest and FileSaveTest.

View source 
class FileSaveUploadTest extends FileHookTestCase {

  /**
   * An image file path for uploading.
   */
  protected $image;

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

  /**
   * The largest file id when the test starts.
   */
  protected $maxFidBefore;
  public static function getInfo() {
    return array(
      'name' => 'File uploading',
      'description' => 'Tests the file uploading functions.',
      'group' => 'File API',
    );
  }
  function setUp() {
    parent::setUp();
    $account = $this
      ->drupalCreateUser(array(
      'access content',
    ));
    $this
      ->drupalLogin($account);
    $image_files = $this
      ->drupalGetTestFiles('image');
    $this->image = current($image_files);
    list(, $this->image_extension) = explode('.', $this->image->filename);
    $this
      ->assertTrue(is_file($this->image->uri), "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're 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->uri),
    );
    $this
      ->drupalPost('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->filemime, 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.
    $max_fid_before = db_query('SELECT MAX(fid) AS fid FROM {file_managed}')
      ->fetchField();
    $image2 = current($this
      ->drupalGetTestFiles('image'));
    $edit = array(
      'files[file_test_upload]' => drupal_realpath($image2->uri),
    );
    $this
      ->drupalPost('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);

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

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

    // Upload a third file to a subdirectory.
    $image3 = current($this
      ->drupalGetTestFiles('image'));
    $image3_realpath = drupal_realpath($image3->uri);
    $dir = $this
      ->randomName();
    $edit = array(
      'files[file_test_upload]' => $image3_realpath,
      'file_subdir' => $dir,
    );
    $this
      ->drupalPost('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))));

    // Check that file_load_multiple() with no arguments returns FALSE.
    $this
      ->assertFalse(file_load_multiple(), 'No files were loaded.');
  }

  /**
   * 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->uri),
      'extensions' => $extensions,
    );
    $this
      ->drupalPost('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->image_extension;

    // 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->uri),
      'extensions' => $extensions,
    );
    $this
      ->drupalPost('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->uri),
      'allow_all_extensions' => 'empty_array',
    );
    $this
      ->drupalPost('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',
    ));

    // Reset the hook counters.
    file_test_reset();

    // Now tell file_save_upload() to allow any extension and try and upload a
    // malicious file.
    $edit = array(
      'file_test_replace' => FILE_EXISTS_REPLACE,
      'files[file_test_upload]' => drupal_realpath($this->phpfile->uri),
      'is_image_file' => FALSE,
      'allow_all_extensions' => 'empty_array',
    );
    $this
      ->drupalPost('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
      ->assertText('File name is php-2.php_.txt.');
    $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',
    ));
  }

  /**
   * Test dangerous file handling.
   */
  function testHandleDangerousFile() {

    // Allow the .php extension and make sure it gets munged and given a .txt
    // extension 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
      ->drupalPost('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('File name is php-2.php_.txt.');
    $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.
    variable_set('allow_insecure_uploads', 1);

    // Reset the hook counters.
    file_test_reset();
    $this
      ->drupalPost('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',
    ));

    // Reset the hook counters.
    file_test_reset();

    // Even with insecure uploads allowed, the .php file should not be uploaded
    // if it is not explicitly included in the list of allowed extensions.
    $edit['extensions'] = 'foo';
    $this
      ->drupalPost('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">' . $edit['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();

    // Turn off insecure uploads, then try the same thing as above (ensure that
    // the .php file is still rejected since it's not in the list of allowed
    // extensions).
    variable_set('allow_insecure_uploads', 0);
    $this
      ->drupalPost('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">' . $edit['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();
  }

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

    // Ensure insecure uploads are disabled for this test.
    variable_set('allow_insecure_uploads', 0);
    $original_image_uri = $this->image->uri;
    $this->image = file_move($this->image, $this->image->uri . '.foo.' . $this->image_extension);

    // Reset the hook counters to get rid of the 'move' we just called.
    file_test_reset();
    $extensions = $this->image_extension;
    $edit = array(
      'files[file_test_upload]' => drupal_realpath($this->image->uri),
      'extensions' => $extensions,
    );
    $munged_filename = $this->image->filename;
    $munged_filename = substr($munged_filename, 0, strrpos($munged_filename, '.'));
    $munged_filename .= '_.' . $this->image_extension;
    $this
      ->drupalPost('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',
    ));

    // Reset the hook counters.
    file_test_reset();

    // Ensure we don't munge the .foo extension if it is in the list of allowed
    // extensions.
    $extensions = 'foo ' . $this->image_extension;
    $edit = array(
      'files[file_test_upload]' => drupal_realpath($this->image->uri),
      'extensions' => $extensions,
    );
    $this
      ->drupalPost('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' => 'image-test.png.foo.png',
    )), 'File was not munged when all extensions within it are allowed.');
    $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->uri),
      'allow_all_extensions' => 'empty_array',
    );
    $this
      ->drupalPost('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->filename,
    )), '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 that a dangerous extension such as .php is munged even if it is in
    // the list of allowed extensions.
    $this->image = file_move($this->image, $original_image_uri . '.php.' . $this->image_extension);

    // Reset the hook counters.
    file_test_reset();
    $extensions = 'php ' . $this->image_extension;
    $edit = array(
      'files[file_test_upload]' => drupal_realpath($this->image->uri),
      'extensions' => $extensions,
    );
    $munged_filename = $this->image->filename;
    $munged_filename = substr($munged_filename, 0, strrpos($munged_filename, '.'));
    $munged_filename .= '_.' . $this->image_extension;
    $this
      ->drupalPost('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',
    ));

    // Reset the hook counters.
    file_test_reset();

    // Dangerous extensions are munged even when all extensions are allowed.
    $edit = array(
      'files[file_test_upload]' => drupal_realpath($this->image->uri),
      'allow_all_extensions' => 'empty_array',
    );
    $munged_filename = $this->image->filename;
    $munged_filename = substr($munged_filename, 0, strrpos($munged_filename, '.'));
    $munged_filename .= '_.' . $this->image_extension;
    $this
      ->drupalPost('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' => 'image-test.png_.php_.png_.txt',
    )), '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',
    ));

    // Dangerous extensions are munged if is renamed to end in .txt.
    $this->image = file_move($this->image, $original_image_uri . '.cgi.' . $this->image_extension . '.txt');

    // Reset the hook counters.
    file_test_reset();
    $edit = array(
      'files[file_test_upload]' => drupal_realpath($this->image->uri),
      'allow_all_extensions' => 'empty_array',
    );
    $munged_filename = $this->image->filename;
    $munged_filename = substr($munged_filename, 0, strrpos($munged_filename, '.'));
    $munged_filename .= '_.' . $this->image_extension;
    $this
      ->drupalPost('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' => 'image-test.png_.cgi_.png_.txt',
    )), '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',
    ));

    // Reset the hook counters.
    file_test_reset();

    // Ensure that setting $validators['file_validate_extensions'] = array('')
    // rejects all files without munging or renaming.
    $edit = array(
      'files[file_test_upload]' => drupal_realpath($this->image->uri),
      'allow_all_extensions' => 'empty_string',
    );
    $this
      ->drupalPost('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 security message.');
    $this
      ->assertRaw(t('Epic upload FAIL!'), 'Found the failure message.');

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

  /**
   * 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->uri),
    );
    $this
      ->drupalPost('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->uri),
    );
    $this
      ->drupalPost('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->uri),
    );
    $this
      ->drupalPost('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
      ->drupalPost('file-test/upload', array(), t('Submit'));
    $this
      ->assertNoRaw(t('Epic upload FAIL!'), 'Failure message not found.');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DrupalTestCase::$assertions protected property Assertions thrown in that test case.
DrupalTestCase::$databasePrefix protected property The database prefix of this test run.
DrupalTestCase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
DrupalTestCase::$results public property Current results of this test case.
DrupalTestCase::$setup protected property Flag to indicate whether the test has been set up.
DrupalTestCase::$setupDatabasePrefix protected property
DrupalTestCase::$setupEnvironment protected property
DrupalTestCase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
DrupalTestCase::$testId protected property The test run ID.
DrupalTestCase::$timeLimit protected property Time limit for the test.
DrupalTestCase::$useSetupInstallationCache public property Whether to cache the installation part of the setUp() method.
DrupalTestCase::$useSetupModulesCache public property Whether to cache the modules installation part of the setUp() method.
DrupalTestCase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
DrupalTestCase::assert protected function Internal helper: stores the assert.
DrupalTestCase::assertEqual protected function Check to see if two values are equal.
DrupalTestCase::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or FALSE).
DrupalTestCase::assertIdentical protected function Check to see if two values are identical.
DrupalTestCase::assertNotEqual protected function Check to see if two values are not equal.
DrupalTestCase::assertNotIdentical protected function Check to see if two values are not identical.
DrupalTestCase::assertNotNull protected function Check to see if a value is not NULL.
DrupalTestCase::assertNull protected function Check to see if a value is NULL.
DrupalTestCase::assertTrue protected function Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
DrupalTestCase::deleteAssert public static function Delete an assertion record by message ID.
DrupalTestCase::error protected function Fire an error assertion. 1
DrupalTestCase::errorHandler public function Handle errors during test runs. 1
DrupalTestCase::exceptionHandler protected function Handle exceptions.
DrupalTestCase::fail protected function Fire an assertion that is always negative.
DrupalTestCase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
DrupalTestCase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
DrupalTestCase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
DrupalTestCase::insertAssert public static function Store an assertion from outside the testing context.
DrupalTestCase::pass protected function Fire an assertion that is always positive.
DrupalTestCase::randomName public static function Generates a random string containing letters and numbers.
DrupalTestCase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
DrupalTestCase::run public function Run all tests in this class.
DrupalTestCase::verbose protected function Logs a verbose message in a text file.
DrupalWebTestCase::$additionalCurlOptions protected property Additional cURL options.
DrupalWebTestCase::$content protected property The content of the page currently loaded in the internal browser.
DrupalWebTestCase::$cookieFile protected property The current cookie file used by cURL.
DrupalWebTestCase::$cookies protected property The cookies of the page currently loaded in the internal browser.
DrupalWebTestCase::$curlHandle protected property The handle of the current cURL connection.
DrupalWebTestCase::$drupalSettings protected property The value of the Drupal.settings JavaScript variable for the page currently loaded in the internal browser.
DrupalWebTestCase::$elements protected property The parsed version of the page.
DrupalWebTestCase::$generatedTestFiles protected property Whether the files were copied to the test files directory.
DrupalWebTestCase::$headers protected property The headers of the page currently loaded in the internal browser.
DrupalWebTestCase::$httpauth_credentials protected property HTTP authentication credentials (<username>:<password>).
DrupalWebTestCase::$httpauth_method protected property HTTP authentication method
DrupalWebTestCase::$loggedInUser protected property The current user logged in using the internal browser.
DrupalWebTestCase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing purposes.
DrupalWebTestCase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing purposes.
DrupalWebTestCase::$plainTextContent protected property The content of the page currently loaded in the internal browser (plain text version).
DrupalWebTestCase::$profile protected property The profile to install as a basis for testing. 20
DrupalWebTestCase::$redirect_count protected property The number of redirects followed during the handling of a request.
DrupalWebTestCase::$session_id protected property The current session ID, if available.
DrupalWebTestCase::$session_name protected property The current session name, if available.
DrupalWebTestCase::$url protected property The URL currently loaded in the internal browser.
DrupalWebTestCase::assertField protected function Asserts that a field exists with the given name or ID.
DrupalWebTestCase::assertFieldById protected function Asserts that a field exists in the current page with the given ID and value.
DrupalWebTestCase::assertFieldByName protected function Asserts that a field exists in the current page with the given name and value.
DrupalWebTestCase::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
DrupalWebTestCase::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
DrupalWebTestCase::assertLink protected function Pass if a link with the specified label is found, and optional with the specified index.
DrupalWebTestCase::assertLinkByHref protected function Pass if a link containing a given href (part) is found.
DrupalWebTestCase::assertMail protected function Asserts that the most recently sent e-mail message has the given value.
DrupalWebTestCase::assertMailPattern protected function Asserts that the most recently sent e-mail message has the pattern in it.
DrupalWebTestCase::assertMailString protected function Asserts that the most recently sent e-mail message has the string in it.
DrupalWebTestCase::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
DrupalWebTestCase::assertNoField protected function Asserts that a field does not exist with the given name or ID.
DrupalWebTestCase::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
DrupalWebTestCase::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
DrupalWebTestCase::assertNoFieldByXPath protected function Asserts that a field doesn't exist or its value doesn't match, by XPath.
DrupalWebTestCase::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
DrupalWebTestCase::assertNoLink protected function Pass if a link with the specified label is not found.
DrupalWebTestCase::assertNoLinkByHref protected function Pass if a link containing a given href (part) is not found.
DrupalWebTestCase::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
DrupalWebTestCase::assertNoPattern protected function Will trigger a pass if the perl regex pattern is not present in raw content.
DrupalWebTestCase::assertNoRaw protected function Pass if the raw text is NOT found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated.
DrupalWebTestCase::assertNoResponse protected function Asserts the page did not return the specified response code.
DrupalWebTestCase::assertNoText protected function Pass if the text is NOT found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents.
DrupalWebTestCase::assertNoTitle protected function Pass if the page title is not the given string.
DrupalWebTestCase::assertNoUniqueText protected function Pass if the text is found MORE THAN ONCE on the text version of the page.
DrupalWebTestCase::assertOptionSelected protected function Asserts that a select option in the current page is checked.
DrupalWebTestCase::assertPattern protected function Will trigger a pass if the Perl regex pattern is found in the raw content.
DrupalWebTestCase::assertRaw protected function Pass if the raw text IS found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated.
DrupalWebTestCase::assertResponse protected function Asserts the page responds with the specified response code.
DrupalWebTestCase::assertText protected function Pass if the text IS found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents.
DrupalWebTestCase::assertTextHelper protected function Helper for assertText and assertNoText.
DrupalWebTestCase::assertThemeOutput protected function Asserts themed output.
DrupalWebTestCase::assertTitle protected function Pass if the page title is the given string.
DrupalWebTestCase::assertUniqueText protected function Pass if the text is found ONLY ONCE on the text version of the page.
DrupalWebTestCase::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
DrupalWebTestCase::assertUrl protected function Pass if the internal browser's URL matches the given path.
DrupalWebTestCase::buildXPathQuery protected function Builds an XPath query.
DrupalWebTestCase::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
DrupalWebTestCase::checkForMetaRefresh protected function Check for meta refresh tag and if found call drupalGet() recursively. This function looks for the http-equiv attribute to be set to "Refresh" and is case-sensitive.
DrupalWebTestCase::checkPermissions protected function Check to make sure that the array of permissions are valid.
DrupalWebTestCase::clickLink protected function Follows a link by name.
DrupalWebTestCase::constructFieldXpath protected function Helper function: construct an XPath for the given set of attributes and value.
DrupalWebTestCase::copySetupCache protected function Copy the setup cache from/to another table and files directory.
DrupalWebTestCase::cronRun protected function Runs cron in the Drupal installed by Simpletest.
DrupalWebTestCase::curlClose protected function Close the cURL handler and unset the handler.
DrupalWebTestCase::curlExec protected function Initializes and executes a cURL request.
DrupalWebTestCase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
DrupalWebTestCase::curlInitialize protected function Initializes the cURL connection.
DrupalWebTestCase::drupalCompareFiles protected function Compare two files based on size and file name.
DrupalWebTestCase::drupalCreateContentType protected function Creates a custom content type based on default settings.
DrupalWebTestCase::drupalCreateNode protected function Creates a node based on default settings.
DrupalWebTestCase::drupalCreateRole protected function Creates a role with specified permissions.
DrupalWebTestCase::drupalCreateUser protected function Create a user with a given set of permissions.
DrupalWebTestCase::drupalGet protected function Retrieves a Drupal path or an absolute path.
DrupalWebTestCase::drupalGetAJAX protected function Retrieve a Drupal path or an absolute path and JSON decode the result.
DrupalWebTestCase::drupalGetContent protected function Gets the current raw HTML of requested page.
DrupalWebTestCase::drupalGetHeader protected function Gets the value of an HTTP response header. If multiple requests were required to retrieve the page, only the headers from the last request will be checked by default. However, if TRUE is passed as the second argument, all requests will be processed…
DrupalWebTestCase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page. Normally we are only interested in the headers returned by the last request. However, if a page is redirected or HTTP authentication is in use, multiple requests will be required to retrieve the…
DrupalWebTestCase::drupalGetMails protected function Gets an array containing all e-mails sent during this test case.
DrupalWebTestCase::drupalGetNodeByTitle function Get a node from the database based on its title.
DrupalWebTestCase::drupalGetSettings protected function Gets the value of the Drupal.settings JavaScript variable for the currently loaded page.
DrupalWebTestCase::drupalGetTestFiles protected function Get a list files that can be used in tests.
DrupalWebTestCase::drupalGetToken protected function Generate a token for the currently logged in user.
DrupalWebTestCase::drupalHead protected function Retrieves only the headers for a Drupal path or an absolute path.
DrupalWebTestCase::drupalLogin protected function Log in a user with the internal browser.
DrupalWebTestCase::drupalLogout protected function
DrupalWebTestCase::drupalPost protected function Execute a POST request on a Drupal page. It will be done as usual POST request with SimpleBrowser.
DrupalWebTestCase::drupalPostAJAX protected function Execute an Ajax submission.
DrupalWebTestCase::drupalSetContent protected function Sets the raw HTML content. This can be useful when a page has been fetched outside of the internal browser and assertions need to be made on the returned page.
DrupalWebTestCase::drupalSetSettings protected function Sets the value of the Drupal.settings JavaScript variable for the currently loaded page.
DrupalWebTestCase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
DrupalWebTestCase::getAllOptions protected function Get all option elements, including nested options, in a select.
DrupalWebTestCase::getSelectedItem protected function Get the selected value from a select field.
DrupalWebTestCase::getSetupCacheKey protected function Returns the cache key used for the setup caching.
DrupalWebTestCase::getUrl protected function Get the current URL from the cURL handler.
DrupalWebTestCase::handleForm protected function Handle form input related to drupalPost(). Ensure that the specified fields exist and attempt to create POST data in the correct manner for the particular field type.
DrupalWebTestCase::loadSetupCache protected function Copies the cached tables and files for a cached installation setup.
DrupalWebTestCase::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
DrupalWebTestCase::preloadRegistry protected function Preload the registry from the testing site.
DrupalWebTestCase::prepareDatabasePrefix protected function Generates a database prefix for running tests.
DrupalWebTestCase::prepareEnvironment protected function Prepares the current environment for running the test.
DrupalWebTestCase::recursiveDirectoryCopy protected function Recursively copy one directory to another.
DrupalWebTestCase::refreshVariables protected function Refresh the in-memory set of variables. Useful after a page request is made that changes a variable in a different thread. 1
DrupalWebTestCase::resetAll protected function Reset all data structures after having enabled new modules.
DrupalWebTestCase::storeSetupCache protected function Store the installation setup to a cache.
DrupalWebTestCase::tearDown protected function Delete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix. 6
DrupalWebTestCase::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
DrupalWebTestCase::xpath protected function Perform an xpath search on the contents of the internal browser. The search is relative to the root element (HTML tag normally) of the page.
DrupalWebTestCase::__construct function Constructor for DrupalWebTestCase. Overrides DrupalTestCase::__construct 1
FileHookTestCase::assertFileHookCalled function Assert that a hook_file_* hook was called a certain number of times.
FileHookTestCase::assertFileHooksCalled function Assert that all of the specified hook_file_* hooks were called once, other values result in failure.
FileSaveUploadTest::$image protected property An image file path for uploading.
FileSaveUploadTest::$maxFidBefore protected property The largest file id when the test starts.
FileSaveUploadTest::$phpfile protected property A PHP file path for upload security testing.
FileSaveUploadTest::getInfo public static function 1
FileSaveUploadTest::setUp function Sets up a Drupal site for running functional and integration tests. Overrides FileHookTestCase::setUp 1
FileSaveUploadTest::testExistingError function Test for failure when uploading over a file that already exists.
FileSaveUploadTest::testExistingRename function Test renaming when uploading over a file that already exists.
FileSaveUploadTest::testExistingReplace function Test replacement when uploading over a file that already exists.
FileSaveUploadTest::testHandleDangerousFile function Test dangerous file handling.
FileSaveUploadTest::testHandleExtension function Test extension handling.
FileSaveUploadTest::testHandleFileMunge function Test file munge handling.
FileSaveUploadTest::testNormal function Test the file_save_upload() function.
FileSaveUploadTest::testNoUpload function Test for no failures when not uploading a file.
FileTestCase::assertDifferentFile function Check that two files are not the same by comparing the fid and filepath.
FileTestCase::assertDirectoryPermissions function Helper function to test the permissions of a directory.
FileTestCase::assertFilePermissions function Helper function to test the permissions of a file.
FileTestCase::assertFileUnchanged function Check that two files have the same values for all fields other than the timestamp.
FileTestCase::assertSameFile function Check that two files are the same by comparing the fid and filepath.
FileTestCase::createDirectory function Create a directory and assert it exists.
FileTestCase::createFile function Create a file and save it to the files table and assert that it occurs correctly.