You are here

Home » API reference » Ubercart 6.2 » uc_credit.test

class UbercartCreditCardTestCase in Ubercart 6.2

Same name and namespace in other branches
  1. 7.3 payment/uc_credit/tests/uc_credit.test \UbercartCreditCardTestCase

Tests the credit card payments with the test gateway.

This class is intended to be subclassed for use in testing other credit card gateways. Subclasses which test other gateways should always override configureGateway(), to implement gateway-specific configuration, and testGatewayFails(), to test gateway-specific failure modes. No other overrides are necessary, although a subclass may want to add additional test functions to cover cases not included in this base class.

Hierarchy

Expanded class hierarchy of UbercartCreditCardTestCase

File

payment/uc_credit/uc_credit.test, line 21
Credit card payment method tests.

View source 
class UbercartCreditCardTestCase extends UbercartTestHelper {

  /**
   * A selection of "test" numbers to use for testing credit card payments.
   * These numbers all pass the Luhn algorithm check and are reserved by
   * the card issuer for testing purposes.
   */
  protected static $test_cards = array(
    '378282246310005',
    // American Express
    '371449635398431',
    '378734493671000',
    // American Express Corporate
    '5610591081018250',
    // Australian BankCard
    '30569309025904',
    // Diners Club
    '38520000023237',
    '6011111111111117',
    // Discover
    '6011000990139424',
    '3530111333300000',
    // JCB
    '3566002020360505',
    '5555555555554444',
    // MasterCard
    '5105105105105100',
    '4111111111111111',
    // Visa
    '4012888888881881',
  );

  /**
   * Describes this test case.
   */
  public static function getInfo() {
    return array(
      'name' => 'Credit cards',
      'description' => 'Uses a test gateway to ensure credit card processing is functioning.',
      'group' => 'Ubercart',
    );
  }

  /**
   * Implements DrupalWebTestCase::setUp().
   */
  public function setUp() {
    $modules = array(
      'uc_payment',
      'uc_credit',
      'test_gateway',
    );
    $permissions = array(
      'administer credit cards',
      'process credit cards',
    );
    parent::setUp($modules, $permissions);

    // Need admin permissions in order to change credit card settings.
    $this
      ->drupalLogin($this->adminUser);

    // Configure and enable Credit card module and Test gateway.
    $this
      ->configureCreditCard();
    $this
      ->configureGateway();
  }

  /**
   * Helper function to configure Credit Card payment method settings.
   */
  protected function configureCreditCard() {
    $this
      ->drupalPost('admin/store/settings/payment/edit/methods', array(
      'uc_payment_method_credit_checkout' => TRUE,
    ), t('Save configuration'));
    $this
      ->assertFieldByName('uc_payment_method_credit_checkout', TRUE, t('Credit card payment method is enabled'));

    // Create key directory, make it readable and writeable.
    // Putting this under sites/default/files because SimpleTest needs to be
    // able to create the directory - this is NOT where you'd put the key file
    // on a live site.  On a live site, it should be outside the web root.
    mkdir('sites/default/files/simpletest.keys', 0755);
    $this
      ->drupalPost('admin/store/settings/payment/edit/methods', array(
      'uc_credit_encryption_path' => 'sites/default/files/simpletest.keys',
    ), t('Save configuration'));
    $this
      ->assertFieldByName('uc_credit_encryption_path', 'sites/default/files/simpletest.keys', t('Key file path has been set.'));
    $this
      ->assertTrue(file_exists('sites/default/files/simpletest.keys/' . UC_CREDIT_KEYFILE_NAME), t('Key has been generated and stored.'));
    $this
      ->pass('Key = ' . uc_credit_encryption_key());
  }

  /**
   * Helper function to configure Credit Card gateway.
   */
  protected function configureGateway() {
    $this
      ->drupalPost('admin/store/settings/payment/edit/methods', array(
      'uc_payment_credit_gateway' => 'test_gateway',
    ), t('Save configuration'));
    $this
      ->drupalPost('admin/store/settings/payment/edit/gateways', array(
      'uc_pg_test_gateway_enabled' => TRUE,
    ), t('Save configuration'));
    $this
      ->assertFieldByName('uc_pg_test_gateway_enabled', TRUE, t('Test gateway is enabled'));
  }

  /**
   * Implements DrupalWebTestCase::tearDown().
   */
  public function tearDown() {

    // Cleanup keys directory after test.
    unlink('sites/default/files/simpletest.keys/' . UC_CREDIT_KEYFILE_NAME);
    rmdir('sites/default/files/simpletest.keys');
    parent::tearDown();
  }

  /**
   * Helper function. Creates a new order.
   */
  protected function createOrder($fields = array()) {
    $order = uc_order_new();
    foreach ($fields as $key => $value) {
      $order->{$key} = $value;
    }
    if (empty($order->primary_email)) {
      $order->primary_email = $this
        ->randomString() . '@example.org';
    }
    if (!isset($fields['products'])) {
      $item = clone $this->product;
      $item->qty = 1;
      $item->price = $item->sell_price;
      $item->data = array();
      $order->products = array(
        $item,
      );
    }
    $order->order_total = uc_order_get_total($order, TRUE);
    $order->line_items = uc_order_load_line_items($order, TRUE);
    uc_order_save($order);
    return $order;
  }

  /****************************************************************************
   * Test cases
   ****************************************************************************/

  /**
   * Tests security settings configuration.
   */
  public function testSecuritySettings() {

    // TODO:  Still need tests with existing key file
    // where key file is not readable or doesn't contain a valid key
    // Create key directory, make it readable and writeable.
    mkdir('sites/default/files/testkey', 0755);

    // Try to submit settings form without a key file path.
    // Save current variable, reset to its value when first installed.
    $temp_variable = variable_get('uc_credit_encryption_path', '');
    variable_set('uc_credit_encryption_path', '');
    $this
      ->drupalGet('admin/store/settings/payment/edit/methods');
    $this
      ->assertText(t('Credit card encryption must be configured to accept credit card payments.'));
    $this
      ->drupalPost('admin/store/settings/payment/edit/methods', array(), t('Save configuration'));
    $this
      ->assertFieldByName('uc_credit_encryption_path', t('Not configured.'), t('Key file has not yet been configured.'));

    // Restore variable setting.
    variable_set('uc_credit_encryption_path', $temp_variable);

    // Try to submit settings form with an empty key file path.
    $this
      ->drupalPost('admin/store/settings/payment/edit/methods', array(
      'uc_credit_encryption_path' => '',
    ), t('Save configuration'));
    $this
      ->assertText('Key path must be specified in security settings tab.');

    // Specify non-existent directory
    $this
      ->drupalPost('admin/store/settings/payment/edit/methods', array(
      'uc_credit_encryption_path' => 'sites/default/ljkh/asdfasfaaaaa',
    ), t('Save configuration'));
    $this
      ->assertText('You have specified a non-existent directory.');

    // Next, specify existing directory that's write protected.
    // Use /dev, as that should never be accessible.
    $this
      ->drupalPost('admin/store/settings/payment/edit/methods', array(
      'uc_credit_encryption_path' => '/dev',
    ), t('Save configuration'));
    $this
      ->assertText('Cannot write to directory, please verify the directory permissions.');

    // Next, specify writeable directory, but with excess whitespace
    // and trailing /
    $this
      ->drupalPost('admin/store/settings/payment/edit/methods', array(
      'uc_credit_encryption_path' => '  sites/default/files/testkey/ ',
    ), t('Save configuration'));

    // See that the directory has been properly re-written to remove
    // whitespace and trailing /
    $this
      ->assertFieldByName('uc_credit_encryption_path', 'sites/default/files/testkey', t('Key file path has been set.'));
    $this
      ->assertText('Credit card encryption key file generated.');

    // Check that warning about needing key file goes away.
    $this
      ->assertNoText(t('Credit card encryption must be configured to accept credit card payments.'));

    // Remove key file.
    unlink('sites/default/files/testkey/' . UC_CREDIT_KEYFILE_NAME);

    // Finally, specify good directory
    $this
      ->drupalPost('admin/store/settings/payment/edit/methods', array(
      'uc_credit_encryption_path' => 'sites/default/files/testkey',
    ), t('Save configuration'));
    $this
      ->assertText('Credit card encryption key file generated.');

    // Test contents - must contain 32-character hexadecimal string.
    $this
      ->assertTrue(file_exists('sites/default/files/simpletest.keys/' . UC_CREDIT_KEYFILE_NAME), t('Key has been generated and stored.'));
    $this
      ->assertTrue(preg_match("([0-9a-fA-F]{32})", uc_credit_encryption_key()), t('Valid key detected in key file.'));

    // Cleanup keys directory after test.
    unlink('sites/default/files/testkey/' . UC_CREDIT_KEYFILE_NAME);
    rmdir('sites/default/files/testkey');
  }

  /**
   * Tests that an order can be placed using the test gateway.
   */
  public function brokentestCheckout() {
    $this
      ->drupalPost('node/' . $this->product->nid, array(), t('Add to cart'));
    $this
      ->checkout(array(
      'cc_number' => array_rand(array_flip(self::$test_cards)),
      'cc_cvv' => mt_rand(100, 999),
      'cc_exp_month' => mt_rand(1, 12),
      'cc_exp_year' => mt_rand(2012, 2022),
    ));
    $this
      ->assertText('Your order is complete!');
  }

  /**
   * Tests that expiry date validation functions correctly.
   */
  public function testExpiryDate() {
    $order = $this
      ->createOrder(array(
      'payment_method' => 'credit',
    ));
    $year = date('Y');
    $month = date('n');
    for ($y = $year; $y <= $year + 2; $y++) {
      for ($m = 1; $m <= 12; $m++) {
        $edit = array(
          'amount' => 1,
          'cc_data[cc_number]' => '4111111111111111',
          'cc_data[cc_cvv]' => '123',
          'cc_data[cc_exp_month]' => $m,
          'cc_data[cc_exp_year]' => $y,
        );
        $this
          ->drupalPost('admin/store/orders/' . $order->order_id . '/credit', $edit, 'Charge amount');
        if ($y > $year || $m >= $month) {
          $this
            ->assertText('The credit card was processed successfully.', t('Card with expiry date @month/@year passed validation.', array(
            '@month' => $m,
            '@year' => $y,
          )));
        }
        else {
          $this
            ->assertNoText('The credit card was processed successfully.', t('Card with expiry date @month/@year correctly failed validation.', array(
            '@month' => $m,
            '@year' => $y,
          )));
        }
      }
    }
  }

}

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::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::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
UbercartCreditCardTestCase::$test_cards protected static property A selection of "test" numbers to use for testing credit card payments. These numbers all pass the Luhn algorithm check and are reserved by the card issuer for testing purposes.
UbercartCreditCardTestCase::brokentestCheckout public function Tests that an order can be placed using the test gateway.
UbercartCreditCardTestCase::configureCreditCard protected function Helper function to configure Credit Card payment method settings.
UbercartCreditCardTestCase::configureGateway protected function Helper function to configure Credit Card gateway.
UbercartCreditCardTestCase::createOrder protected function Helper function. Creates a new order.
UbercartCreditCardTestCase::getInfo public static function Describes this test case.
UbercartCreditCardTestCase::setUp public function Implements DrupalWebTestCase::setUp(). Overrides UbercartTestHelper::setUp
UbercartCreditCardTestCase::tearDown public function Implements DrupalWebTestCase::tearDown(). Overrides DrupalWebTestCase::tearDown
UbercartCreditCardTestCase::testExpiryDate public function Tests that expiry date validation functions correctly.
UbercartCreditCardTestCase::testSecuritySettings public function Tests security settings configuration.
UbercartTestHelper::$adminUser protected property User with privileges to do everything.
UbercartTestHelper::$customer protected property Authenticated but unprivileged user.
UbercartTestHelper::$product protected property Test product.
UbercartTestHelper::checkout function Executes the checkout process.
UbercartTestHelper::createProduct function Creates a new product.
UbercartTestHelper::createProductClass function
UbercartTestHelper::cronRun protected function Runs cron in the Drupal installed by Simpletest. Overrides DrupalWebTestCase::cronRun
UbercartTestHelper::findMail function Assert that an email was sent with a specific subject line.