You are here

Home » API reference » Smart Crop 6 » smartcrop.test

class SmartcropTestCase in Smart Crop 6

Same name and namespace in other branches
  1. 7 tests/smartcrop.test \SmartcropTestCase

@file Tests for the smartcrop module.

Hierarchy

Expanded class hierarchy of SmartcropTestCase

File

tests/smartcrop.test, line 8
Tests for the smartcrop module.

View source 
class SmartcropTestCase extends DrupalWebTestCase {
  protected $admin_user;
  public static function getInfo() {
    return array(
      'name' => t('Smartcrop test'),
      'description' => t('Test Smartcrop.'),
      'group' => t('Imagecache'),
    );
  }
  function setUp() {
    parent::setUp('smartcrop', 'imagecache', 'imagecache_ui', 'imageapi', 'imageapi_gd', 'upload');

    // Menu router must be rebuilt because imagecache_menu() is called before $conf['file_directory_path'] is set.
    // Fix in progress at http://drupal.org/node/654752
    menu_router_build(TRUE);

    // Create and login user
    $this->admin_user = $this
      ->drupalCreateUser(array(
      'access administration pages',
      'administer imagecache',
      'administer nodes',
      'upload files',
      'view uploaded files',
    ));
    $this
      ->drupalLogin($this->admin_user);
  }

  /**
   * Verify the entropy calculation with a known image.
   */
  function testEntropy() {

    // Create a test image with 3 red, 3 green, and 3 blue pixels.
    $image = imagecreatetruecolor(3, 3);
    imagefilledrectangle($image, 0, 0, 2, 0, imagecolorallocate($image, 255, 0, 0));
    imagefilledrectangle($image, 0, 1, 2, 1, imagecolorallocate($image, 0, 255, 0));
    imagefilledrectangle($image, 0, 2, 2, 2, imagecolorallocate($image, 0, 0, 255));

    // Calculate the expected values.
    // There are 9 bins in the histogram, 3 colors * 3 channels.
    $expected_entroy = (1 / 3 * log(1 / 9, 2) + 2 / 3 * log(2 / 9, 2)) * -1;
    $image_entropy = _smartcrop_gd_entropy($image);
    $this
      ->assertTrue($image_entropy - $expected_entroy < 0.001, t('Entropy value is correct.'));
  }

  /**
   * Test the ImageEqual assertions.
   */
  function testImageEqual() {
    $image1 = $expected_image = imagecreatefrompng(dirname(__FILE__) . '/left.png');
    $image2 = $expected_image = imagecreatefrompng(dirname(__FILE__) . '/right.png');
    $this
      ->assertImageNotEqual($image1, $image2);
    $image2 = $expected_image = imagecreatefrompng(dirname(__FILE__) . '/left.png');
    $this
      ->assertImageEqual($image1, $image2);

    // Clean up.
    imagedestroy($image1);
    imagedestroy($image2);
  }

  /**
   * Test cropping of images with known properties.
   */
  function testScaleAndCrop() {

    // Create a preset with entropy crop.
    $this
      ->drupalPost('admin/build/imagecache/add', array(
      'presetname' => 'test',
    ), t('Save Preset'));
    $this
      ->clickLink(t('Add !action', array(
      '!action' => 'Scale and Smart Crop',
    )));
    $edit = array(
      'data[width]' => 10,
      'data[height]' => 10,
    );
    $this
      ->drupalPost(NULL, $edit, t('Create Action'));

    // Test cropping with synthetic images.
    $test_files = array(
      'bottom.png',
      'left.png',
      'right.png',
      'top.png',
    );
    $expected_image = imagecreatefrompng(dirname(__FILE__) . '/center.png');
    foreach ($test_files as $file) {

      // Upload a file
      $edit = array(
        'title' => $this
          ->randomName(),
        'files[upload]' => realpath(dirname(__FILE__) . '/' . $file),
      );
      $this
        ->drupalPost('node/add/page', $edit, t('Save'));
      $this
        ->drupalGet(file_create_url('imagecache/test/' . $file));
      $this
        ->assertResponse(200, t('Retrieved cropped image.'));
      $actual_image = imagecreatefrompng(file_create_url('imagecache/test/' . $file));
      $this
        ->assertImageEqual($actual_image, $expected_image, 1, t('@file was cropped correctly.', array(
        '@file' => $file,
      )));
    }

    // Test Upscaling.
    $this
      ->drupalGet('admin/build/imagecache');
    $this
      ->clickLink('test');
    $this
      ->clickLink('Configure');
    $edit = array(
      'data[width]' => 100,
      'data[height]' => 100,
      'data[upscale]' => 1,
    );
    $this
      ->drupalPost(NULL, $edit, t('Update Action'));
    $file = 'center.png';
    $edit = array(
      'title' => $this
        ->randomName(),
      'files[upload]' => realpath(dirname(__FILE__) . '/' . $file),
    );
    $this
      ->drupalPost('node/add/page', $edit, t('Save'));
    $this
      ->drupalGet(file_create_url('imagecache/test/' . $file));
    $this
      ->assertResponse(200, t('Retrieved cropped image.'));
    $expected_image = imagecreatefrompng(dirname(__FILE__) . '/center_10X.png');
    $actual_image = imagecreatefrompng(file_create_url('imagecache/test/' . $file));
    $this
      ->assertImageEqual($actual_image, $expected_image, 1, t('@file was upscaled correctly.', array(
      '@file' => $file,
    )));

    // Test percentage units.
    $this
      ->drupalGet('admin/build/imagecache');
    $this
      ->clickLink('test');
    $this
      ->clickLink('Configure');
    $edit = array(
      'data[width]' => '200%',
      'data[height]' => '200%',
      'data[upscale]' => 1,
    );
    $this
      ->drupalPost(NULL, $edit, t('Update Action'));
    $file = 'center.png';
    $edit = array(
      'title' => $this
        ->randomName(),
      'files[upload]' => realpath(dirname(__FILE__) . '/' . $file),
    );
    $this
      ->drupalPost('node/add/page', $edit, t('Save'));
    $this
      ->drupalGet(file_create_url('imagecache/test/center_0.png'));
    $this
      ->assertResponse(200, t('Retrieved cropped image.'));
    $actual_image = imagecreatefrompng(file_create_url('imagecache/test/center_0.png'));
    $expected_image = imagecreatefrompng(dirname(__FILE__) . '/center_2X.png');
    $this
      ->assertImageEqual($actual_image, $expected_image, 1, t('@file was upscaled correctly.', array(
      '@file' => $file,
    )));

    // Clean up.
    imagedestroy($expected_image);
    imagedestroy($actual_image);
  }
  function testCrop() {

    // Create a preset with entropy crop.
    $this
      ->drupalPost('admin/build/imagecache/add', array(
      'presetname' => 'test2',
    ), t('Save Preset'));
    $this
      ->clickLink(t('Add !action', array(
      '!action' => 'Smart Crop',
    )));
    $edit = array(
      'data[width]' => '25%',
      'data[height]' => '25%',
    );
    $this
      ->drupalPost(NULL, $edit, t('Create Action'));
    $file = 'quarter.png';
    $edit = array(
      'title' => $this
        ->randomName(),
      'files[upload]' => realpath(dirname(__FILE__) . '/' . $file),
    );
    $this
      ->drupalPost('node/add/page', $edit, t('Save'));
    $this
      ->drupalGet(file_create_url('imagecache/test2/quarter.png'));
    $this
      ->assertResponse(200, t('Retrieved cropped image.'));
    $expected_image = imagecreatefrompng(dirname(__FILE__) . '/center.png');
    $actual_image = imagecreatefrompng(file_create_url('imagecache/test2/' . $file));
    $this
      ->assertImageEqual($actual_image, $expected_image, 1, t('@file was cropped correctly.', array(
      '@file' => $file,
    )));

    // Clean up.
    imagedestroy($expected_image);
    imagedestroy($actual_image);
  }

  /**
   * Assert that two images are the same, with some difference allowed to account for e.g. compression artifacts.
   * @param $image1 A GD image resource.
   * @param $image2 A GD image resource.
   * @param $max_diff (optional) The maximum allowed difference, range from 0 to 255, defaults to 1.
   * @param $message (optional) The message to display along with the assertion.
   */
  function assertImageEqual($image1, $image2, $max_diff = 1, $message = NULL) {
    if (empty($message)) {
      $message = t('Images are equal.');
    }
    $difference = $this
      ->difference($image1, $image2);
    $mean = $this
      ->mean($difference);
    $this
      ->assertTrue($mean < $max_diff, $message);
    imagedestroy($difference);
  }

  /**
   * Assert that two images are not the same, with some difference allowed to account for e.g. compression artifacts.
   * @param $image1 A GD image resource.
   * @param $image2 A GD image resource.
   * @param $min_diff (optional) The minimum allowed difference, range from 0 to 255, defaults to 1.
   * @param $message (optional) The message to display along with the assertion.
   */
  function assertImageNotEqual($image1, $image2, $min_diff = 1, $message = NULL) {
    if (empty($message)) {
      $message = t('Images are not equal.');
    }
    $difference = $this
      ->difference($image1, $image2);
    $mean = $this
      ->mean($difference);
    $this
      ->assertTrue($mean > $min_diff, $message);
  }

  /**
   * Calculate the mean pixel intensity.
   * @param $image GD image resource.
   * @return The mean.
   */
  function mean($image) {
    $mean = 0;
    $size = imagesx($image) * imagesy($image) * 3;
    for ($i = 0; $i < imagesx($image); $i++) {
      for ($j = 0; $j < imagesy($image); $j++) {
        $rgb = imagecolorat($image, $i, $j);
        $r = $rgb >> 16 & 0xff;
        $g = $rgb >> 8 & 0xff;
        $b = $rgb & 0xff;
        $mean += $r / $size;
        $mean += $g / $size;
        $mean += $b / $size;
      }
    }
    return $mean;
  }

  /**
   * Calculate the difference of 2 images.
   * @param $image1 A GD image resource.
   * @param $image2 A GD image resource.
   * @return A GD image resource, with the subtracted image.
   */
  function difference($image1, $image2) {
    $this
      ->assertEqual(imagesx($image1), imagesx($image2), t('Images have the same width.'));
    $this
      ->assertEqual(imagesy($image1), imagesy($image2), t('Images have the same height.'));
    $difference = imagecreatetruecolor(imagesx($image1), imagesy($image1));
    for ($i = 0; $i < imagesx($image1); $i++) {
      for ($j = 0; $j < imagesy($image1); $j++) {
        $rgb1 = imagecolorat($image1, $i, $j);
        $r1 = $rgb1 >> 16 & 0xff;
        $g1 = $rgb1 >> 8 & 0xff;
        $b1 = $rgb1 & 0xff;
        $rgb2 = imagecolorat($image2, $i, $j);
        $r2 = $rgb2 >> 16 & 0xff;
        $g2 = $rgb2 >> 8 & 0xff;
        $b2 = $rgb2 & 0xff;
        imagesetpixel($difference, $i, $j, imagecolorallocate($difference, abs($r2 - $r1), abs($g2 - $g1), abs($b2 - $b1)));
      }
    }
    return $difference;
  }

}

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::$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::deleteAssert public static function Delete an assertion record by message ID.
DrupalTestCase::error protected function Fire an error assertion.
DrupalTestCase::errorHandler public function Handle errors during test runs.
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::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 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::$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::$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.
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 does not exist in the current page by the given 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::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::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 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 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::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::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::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::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::resetAll protected function Reset all data structures after having enabled new modules.
DrupalWebTestCase::tearDown protected function Delete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix.
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
SmartcropTestCase::$admin_user protected property
SmartcropTestCase::assertImageEqual function Assert that two images are the same, with some difference allowed to account for e.g. compression artifacts.
SmartcropTestCase::assertImageNotEqual function Assert that two images are not the same, with some difference allowed to account for e.g. compression artifacts.
SmartcropTestCase::difference function Calculate the difference of 2 images.
SmartcropTestCase::getInfo public static function
SmartcropTestCase::mean function Calculate the mean pixel intensity.
SmartcropTestCase::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
SmartcropTestCase::testCrop function
SmartcropTestCase::testEntropy function Verify the entropy calculation with a known image.
SmartcropTestCase::testImageEqual function Test the ImageEqual assertions.
SmartcropTestCase::testScaleAndCrop function Test cropping of images with known properties.