You are here

Home » API reference » SimpleTest 7 » file.test

class FileScanDirectoryTest in SimpleTest 7

Tests the file_scan_directory() function.

Hierarchy

Expanded class hierarchy of FileScanDirectoryTest

File

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

View source 
class FileScanDirectoryTest extends FileTestCase {
  public static function getInfo() {
    return array(
      'name' => 'File scan directory',
      'description' => 'Tests the file_scan_directory() function.',
      'group' => 'File API',
    );
  }
  function setUp() {
    parent::setUp();
    $this->path = $this->originalFileDirectory . '/simpletest';
  }

  /**
   * Check the format of the returned values.
   */
  function testReturn() {

    // Grab a listing of all the JavaSscript files and check that they're
    // passed to the callback.
    $all_files = file_scan_directory($this->path, '/^javascript-/');
    ksort($all_files);
    $this
      ->assertEqual(2, count($all_files), t('Found two, expected javascript files.'));

    // Check the first file.
    $file = reset($all_files);
    $this
      ->assertEqual(key($all_files), $file->uri, t('Correct array key was used for the first returned file.'));
    $this
      ->assertEqual($file->uri, $this->path . '/javascript-1.txt', t('First file name was set correctly.'));
    $this
      ->assertEqual($file->filename, 'javascript-1.txt', t('First basename was set correctly'));
    $this
      ->assertEqual($file->name, 'javascript-1', t('First name was set correctly.'));

    // Check the second file.
    $file = next($all_files);
    $this
      ->assertEqual(key($all_files), $file->uri, t('Correct array key was used for the second returned file.'));
    $this
      ->assertEqual($file->uri, $this->path . '/javascript-2.script', t('Second file name was set correctly.'));
    $this
      ->assertEqual($file->filename, 'javascript-2.script', t('Second basename was set correctly'));
    $this
      ->assertEqual($file->name, 'javascript-2', t('Second name was set correctly.'));
  }

  /**
   * Check that the callback function is called correctly.
   */
  function testOptionCallback() {

    // When nothing is matched nothing should be passed to the callback.
    $all_files = file_scan_directory($this->path, '/^NONEXISTINGFILENAME/', array(
      'callback' => 'file_test_file_scan_callback',
    ));
    $this
      ->assertEqual(0, count($all_files), t('No files were found.'));
    $results = file_test_file_scan_callback();
    file_test_file_scan_callback_reset();
    $this
      ->assertEqual(0, count($results), t('No files were passed to the callback.'));

    // Grab a listing of all the JavaSscript files and check that they're
    // passed to the callback.
    $all_files = file_scan_directory($this->path, '/^javascript-/', array(
      'callback' => 'file_test_file_scan_callback',
    ));
    $this
      ->assertEqual(2, count($all_files), t('Found two, expected javascript files.'));
    $results = file_test_file_scan_callback();
    file_test_file_scan_callback_reset();
    $this
      ->assertEqual(2, count($results), t('Files were passed to the callback.'));
  }

  /**
   * Check that the no-mask parameter is honored.
   */
  function testOptionNoMask() {

    // Grab a listing of all the JavaSscript files.
    $all_files = file_scan_directory($this->path, '/^javascript-/');
    $this
      ->assertEqual(2, count($all_files), t('Found two, expected javascript files.'));

    // Now use the nomast parameter to filter out the .script file.
    $filtered_files = file_scan_directory($this->path, '/^javascript-/', array(
      'nomask' => '/.script$/',
    ));
    $this
      ->assertEqual(1, count($filtered_files), t('Filtered correctly.'));
  }

  /**
   * Check that key parameter sets the return value's key.
   */
  function testOptionKey() {

    // "filename", for the path starting with $dir.
    $expected = array(
      $this->path . '/javascript-1.txt',
      $this->path . '/javascript-2.script',
    );
    $actual = array_keys(file_scan_directory($this->path, '/^javascript-/', array(
      'key' => 'filepath',
    )));
    sort($actual);
    $this
      ->assertEqual($expected, $actual, t('Returned the correct values for the filename key.'));

    // "basename", for the basename of the file.
    $expected = array(
      'javascript-1.txt',
      'javascript-2.script',
    );
    $actual = array_keys(file_scan_directory($this->path, '/^javascript-/', array(
      'key' => 'filename',
    )));
    sort($actual);
    $this
      ->assertEqual($expected, $actual, t('Returned the correct values for the basename key.'));

    // "name" for the name of the file without an extension.
    $expected = array(
      'javascript-1',
      'javascript-2',
    );
    $actual = array_keys(file_scan_directory($this->path, '/^javascript-/', array(
      'key' => 'name',
    )));
    sort($actual);
    $this
      ->assertEqual($expected, $actual, t('Returned the correct values for the name key.'));

    // Invalid option that should default back to "filename".
    $expected = array(
      $this->path . '/javascript-1.txt',
      $this->path . '/javascript-2.script',
    );
    $actual = array_keys(file_scan_directory($this->path, '/^javascript-/', array(
      'key' => 'INVALID',
    )));
    sort($actual);
    $this
      ->assertEqual($expected, $actual, t('An invalid key defaulted back to the default.'));
  }

  /**
   * Check that the recurse option decends into subdirectories.
   */
  function testOptionRecurse() {
    $files = file_scan_directory($this->originalFileDirectory, '/^javascript-/', array(
      'recurse' => FALSE,
    ));
    $this
      ->assertTrue(empty($files), t("Without recursion couldn't find javascript files."));
    $files = file_scan_directory($this->originalFileDirectory, '/^javascript-/', array(
      'recurse' => TRUE,
    ));
    $this
      ->assertEqual(2, count($files), t('With recursion we found the expected javascript files.'));
  }

  /**
   * Check that the min_depth options lets us ignore files in the starting
   * directory.
   */
  function testOptionMinDepth() {
    $files = file_scan_directory($this->path, '/^javascript-/', array(
      'min_depth' => 0,
    ));
    $this
      ->assertEqual(2, count($files), t('No minimum-depth gets files in current directory.'));
    $files = file_scan_directory($this->path, '/^javascript-/', array(
      'min_depth' => 1,
    ));
    $this
      ->assertTrue(empty($files), t("Minimum-depth of 1 successfully excludes files from current directory."));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DrupalTestCase::$assertions protected property Assertions thrown in that test case.
DrupalTestCase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
DrupalTestCase::$originalPrefix protected property The original database prefix, before it was changed for testing purposes.
DrupalTestCase::$results public property Current results of this test case.
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::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::error protected function Fire an error assertion. 1
DrupalTestCase::errorHandler public function Handle errors.
DrupalTestCase::exceptionHandler protected function Handle exceptions.
DrupalTestCase::fail protected function Fire an assertion that is always negative.
DrupalTestCase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
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.
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::$curlHandle protected property The handle of the current cURL connection.
DrupalWebTestCase::$elements protected property The parsed version of the page.
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::$loggedInUser protected property The current user logged in using the internal browser.
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::$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 Assert that a field exists with the given name or id.
DrupalWebTestCase::assertFieldById protected function Assert that a field exists in the current page with the given id and value.
DrupalWebTestCase::assertFieldByName protected function Assert that a field exists in the current page with the given name and value.
DrupalWebTestCase::assertFieldByXPath protected function Assert that a field exists in the current page by the given XPath.
DrupalWebTestCase::assertFieldChecked protected function Assert 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::assertMail protected function Assert that the most recently sent e-mail message has a field with the given value.
DrupalWebTestCase::assertNoField protected function Assert that a field does not exist with the given name or id.
DrupalWebTestCase::assertNoFieldById protected function Assert that a field does not exist with the given id and value.
DrupalWebTestCase::assertNoFieldByName protected function Assert that a field does not exist with the given name and value.
DrupalWebTestCase::assertNoFieldByXPath protected function Assert that a field does not exist in the current page by the given XPath.
DrupalWebTestCase::assertNoFieldChecked protected function Assert 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::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::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::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 Assert 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::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::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::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 Performs a cURL exec with the specified options after calling curlConnect().
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 Internal helper function; Create a role with specified permissions.
DrupalWebTestCase::drupalCreateUser protected function Create a user with a given set of permissions. The permissions correspond to the names given on the privileges page.
DrupalWebTestCase::drupalGet protected function Retrieves a Drupal path or an absolute path.
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::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::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::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::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::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
DrupalWebTestCase::preloadRegistry protected function This method is called by DrupalWebTestCase::setUp, and preloads the registry from the testing site to cut down on the time it takes to setup a clean environment for the current test run.
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.
DrupalWebTestCase::tearDown protected function Delete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix. 3
DrupalWebTestCase::verbose protected function Log verbose message in a text file.
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
FileScanDirectoryTest::getInfo public static function
FileScanDirectoryTest::setUp function Generates a random database prefix, runs the install scripts on the prefixed database and enable the specified modules. After installation many caches are flushed and the internal browser is setup so that the page requests will run on the new prefix.… Overrides DrupalWebTestCase::setUp
FileScanDirectoryTest::testOptionCallback function Check that the callback function is called correctly.
FileScanDirectoryTest::testOptionKey function Check that key parameter sets the return value's key.
FileScanDirectoryTest::testOptionMinDepth function Check that the min_depth options lets us ignore files in the starting directory.
FileScanDirectoryTest::testOptionNoMask function Check that the no-mask parameter is honored.
FileScanDirectoryTest::testOptionRecurse function Check that the recurse option decends into subdirectories.
FileScanDirectoryTest::testReturn function Check the format of the returned values.
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.