You are here

Home » API reference » Commerce Core 7 » commerce_base.test

abstract class CommerceBaseTestCase in Commerce Core 7

Abstract class for Commerce testing. All Commerce tests should extend this class.

Hierarchy

Expanded class hierarchy of CommerceBaseTestCase

File

tests/commerce_base.test, line 12
Defines abstract base test class for the Commerce module tests.

View source 
abstract class CommerceBaseTestCase extends DrupalWebTestCase {
  protected $profile = 'minimal';

  /**
   * Helper function to determine which modules should be enabled. Should be
   * used in place of standard parent::setUp('moduleA', 'moduleB') call.
   *
   * @param $set
   *  Which set of modules to load. Can be one of:
   *    'all': (default) All Commerce modules, including UI and payment modules.
   *    'ui': All API and UI modules.
   *    'api': Just API modules (includes commerce_ui since checkout depends on it).
   *    'dependencies': Common dependencies required by many Commerce API and UI
   *      modules.
   * @param $other_modules
   *  Array of modules to include in addition to the sets loaded by $set
   */
  protected function setUpHelper($set = 'all', array $other_modules = array()) {
    $dependencies = array(
      // API
      'entity',
      'entity_token',
      'rules',
      'addressfield',
      //'rules_admin',

      // UI
      'ctools',
      'views',
      //'views_ui',
      'field',
      'field_ui',
      'field_sql_storage',
      'text',
      'list',
    );
    $api = array(
      'commerce',
      'commerce_product',
      'commerce_price',
      'commerce_customer',
      'commerce_line_item',
      'commerce_order',
      'commerce_product_reference',
      'commerce_payment',
      'commerce_tax',
      'commerce_product_pricing',
    );
    $ui = array(
      'commerce_ui',
      'commerce_checkout',
      'commerce_cart',
      'commerce_line_item_ui',
      'commerce_order_ui',
      'commerce_product_ui',
      'commerce_customer_ui',
      'commerce_payment_ui',
      'commerce_product_pricing_ui',
      'commerce_tax_ui',
    );
    $payment = array(
      'commerce_payment_example',
    );

    // Final module list
    $modules = array();

    // Cascade down the list and add sets
    switch ($set) {
      case 'all':
        $modules = array_merge($payment, $modules);
      case 'ui':
        $modules = array_merge($ui, $modules);
      case 'api':
        $modules = array_merge($api, $modules);
      case 'dependencies':
        $modules = array_merge($dependencies, $modules);
        break;
    }

    // Bring in modules specified by caller
    $modules = array_merge($modules, $other_modules);
    return $modules;
  }

  /**
   * Helper function to get different combinations of permission sets.
   *
   * @param $set
   *  Can be a single string (from the following) or can be an array containing
   *  multiple values that should be merged:
   *    'site admin': Admin permissions for Drupal core modules
   *    'store admin': All commerce "administer X" permissions
   */
  protected function permissionBuilder($sets) {
    if (is_string($sets)) {
      $sets = array(
        $sets,
      );
    }
    $site_admin = array(
      'administer content types',
      'administer nodes',
      'bypass node access',
      'administer modules',
      'administer site configuration',
      'administer themes',
      'administer actions',
      'access administration pages',
      'access site in maintenance mode',
      'access site reports',
      'block IP addresses',
      'administer permissions',
      'administer users',
      'administer rules',
      'administer fields',
    );
    $store_admin = array(
      'access administration pages',
      'administer checkout',
      'access checkout',
      'configure store',
      'administer commerce_customer_profile entities',
      'administer customer profile types',
      'administer line items',
      'administer line item types',
      'administer commerce_order entities',
      'configure order settings',
      'view any commerce_order entity',
      'create commerce_order entities',
      'edit any commerce_order entity',
      'administer commerce_product entities',
      'administer product types',
      'administer product pricing',
      'administer payment methods',
      'administer payments',
      'administer taxes',
      'administer rules',
      'administer fields',
    );
    $store_customer = array(
      'access content',
      'access checkout',
      'view own commerce_order entities',
    );
    $final_permissions = array();
    foreach ($sets as $set) {
      switch ($set) {
        case 'site admin':
          $final_permissions = array_unique(array_merge($final_permissions, $site_admin));
          break;
        case 'store admin':
          $final_permissions = array_unique(array_merge($final_permissions, $store_admin));
          break;
        case 'store customer':
          $final_permissions = array_unique(array_merge($final_permissions, $store_customer));
          break;
      }
    }
    return $final_permissions;
  }

  /**
   * Wrapper to easily create users from arrays returned by permissionBuilder().
   *
   * @param $set
   *  See permissionBuilder() function
   * @return
   *  A user with the permissions returned from permissionBuilder().
   */
  protected function createUserWithPermissionHelper($set) {
    $permissions = $this
      ->permissionBuilder($set);
    $user = $this
      ->drupalCreateUser($permissions);
    return $user;
  }

  /**
   * Returns a site administrator user. Only has permissions for administering
   * modules in Drupal core.
   */
  protected function createSiteAdmin() {
    return $this
      ->createUserWithPermissionHelper('site admin');
  }

  /**
   * Returns a store administrator user. Only has permissions for administering
   * Commerce modules.
   */
  protected function createStoreAdmin() {
    return $this
      ->createUserWithPermissionHelper('store admin');
  }

  /**
   * Returns a store customer. It's a regular user with some Commerce
   * permissions as access to checkout.
   */
  protected function createStoreCustomer() {
    return $this
      ->createUserWithPermissionHelper('store customer');
  }

  /**
   * Return one of the Commerce configured urls.
   */
  protected function getCommerceUrl($element = 'cart') {
    $links = commerce_line_item_summary_links();
    if ($element == 'cart') {
      return $links['view_cart']['href'];
    }
    if ($element == 'checkout') {
      return $links['checkout']['href'];
    }
  }

  /**
   * Creates a dummy product type for use with other tests.
   *
   * @return
   *  A product type.
   *  FALSE if the appropiate modules were not available.
   */
  public function createDummyProductType($type = 'product_type', $name = 'Product Type', $description = '', $help = '', $append_random = TRUE) {
    if (module_exists('commerce_product_ui')) {
      if ($append_random) {
        $type = $type . '_' . $this
          ->randomName(20 - strlen($type) - 1);
        $name = $name . ' ' . $this
          ->randomName(40 - strlen($name) - 1);
        $description = $description . ' ' . $this
          ->randomString(128);
        $help = $help . ' ' . $this
          ->randomString(128);
      }
      $new_product_type = commerce_product_ui_product_type_new();
      $new_product_type['type'] = $type;
      $new_product_type['name'] = $name;
      $new_product_type['description'] = $description;
      $new_product_type['help'] = $help;
      $new_product_type['is_new'] = TRUE;
      $save_result = commerce_product_ui_product_type_save($new_product_type);
      if ($save_result === FALSE) {
        return FALSE;
      }
      return $new_product_type;
    }
    else {
      return FALSE;
    }
  }

  /**
   * Creates a dummy product for use with other tests.
   *
   * @param $type_given
   *  Optional. The product type to base this product on. Defaults to 'product'.
   * @return
   *  A product type with most of it's basic fields set random values.
   *  FALSE if the appropiate modules were not available.
   */
  public function createDummyProduct($sku = '', $title = '', $amount = -1, $currency_code = 'USD', $uid = 1, $type_given = 'product') {
    if (module_exists('commerce_product')) {
      $new_product = commerce_product_new($type_given);
      $new_product->sku = empty($sku) ? $this
        ->randomName(10) : $sku;
      $new_product->title = empty($title) ? $this
        ->randomName(10) : $title;
      $new_product->uid = $uid;
      $new_product->commerce_price[LANGUAGE_NONE][0]['amount'] = $amount < 0 ? rand(2, 500) : $amount;
      $new_product->commerce_price[LANGUAGE_NONE][0]['currency_code'] = $currency_code;
      commerce_product_save($new_product);
      return $new_product;
    }
    else {
      return FALSE;
    }
  }

  /**
   * Create a dummy product display content type.
   *
   * @param $type
   *  Machine name of the content type to create. Also used for human readable
   *  name to keep things simple.
   * @param $attach_product_reference_field
   *  If TRUE, automatically add a product reference field to the new content
   *  type.
   * @param $field_name
   *  Only used if $attach_product_reference_field is TRUE. Sets the name for
   *  the field instance to attach. Creates the field if it doesn't exist.
   * @param $cardinality_reference_field
   *  Only used if $attach_product_reference_field is TRUE. Sets the
   *  cardinality for the field instance to attach.
   * @return
   *  An object for the content type.
   * @see attachProductReferenceField()
   */
  public function createDummyProductDisplayContentType($type = 'product_display', $attach_product_reference_field = TRUE, $field_name = 'field_product', $cardinality_reference_field = 1) {

    // If the specified node type already exists, return it now.
    if ($content_type = node_type_load($type)) {
      return $content_type;
    }
    $content_type = array(
      'type' => $type,
      'name' => $type,
      // Don't use a human readable name here to keep it simple.
      'base' => 'node_content',
      'description' => 'Use <em>product displays</em> to display products for sale to your customers.',
      'custom' => 1,
      'modified' => 1,
      'locked' => 0,
    );
    $content_type = node_type_set_defaults($content_type);
    node_type_save($content_type);
    node_add_body_field($content_type);
    $this
      ->pass("Created content type: {$type}");
    if ($attach_product_reference_field) {

      // Maybe $instance should be returned as well
      $instance = $this
        ->attachProductReferenceField($type, $field_name, $cardinality_reference_field);
    }
    return $content_type;
  }

  /**
   * Create a dummy order in a given status.
   *
   * @param $uid
   * 	 ID of the user that owns the order.
   * @param $products
   *  	Array of products that are going to be added to the order: keys are
   *    product ids, values are the quantity of products to add.
   * @param $status
   * 	 Status of the order
   *
   * @return
   *   A commerce order object in the given status.
   */
  public function createDummyOrder($uid = 1, $products = array(), $status = 'cart', $customer_profile_id = NULL) {

    // If there aren't any products to add to the order, create one.
    if (empty($products)) {
      $product = $this
        ->createDummyProduct('PROD-01', 'Product One', -1, 'USD', $uid);
      $products[$product->product_id] = rand(1, 10);
    }

    // Create a new shopping cart order by adding the products to it.
    foreach ($products as $product_id => $quantity) {
      if ($product = commerce_product_load($product_id)) {
        $line_item = commerce_product_line_item_new($product, $quantity);
        $line_item = commerce_cart_product_add($uid, $line_item);
      }
    }

    // Load the order for returning it.
    $order = commerce_cart_order_load($uid);
    if (!empty($customer_profile_id)) {
      $order->commerce_customer_billing[LANGUAGE_NONE][0]['profile_id'] = $customer_profile_id;
    }

    // If the order should be in a different status, update it.
    if ($status != 'cart') {
      $order = commerce_order_status_update($order, $status, TRUE);
    }
    commerce_order_save($order);
    return $order;
  }

  /**
   * Attach a product reference field to a given content type. Creates the field
   * if the given name doesn't already exist. Automatically sets the display
   * formatters to be the "add to cart form" for the teaser and full modes.
   *
   * @param $content_type
   *  Name of the content type that should have a field instance attached.
   * @param $field_name
   *  Only used if $attach_product_reference_field is TRUE. Sets the name for
   *  the field instance to attach. Creates the field if it doesn't exist.
   * @return
   *  An object containing the field instance that was created.
   * @see createDummyProductDisplayContentType()
   */
  public function attachProductReferenceField($content_type = 'product_display', $field_name = 'field_product', $cardinality = 1) {
    if (module_exists('commerce_product')) {

      // Check if the field has already been created.
      $field_info = field_info_field($field_name);
      if (empty($field_info)) {

        // Add a product reference field to the product display node type
        $field = array(
          'field_name' => $field_name,
          'type' => 'commerce_product_reference',
          'cardinality' => $cardinality,
          'translatable' => FALSE,
        );
        field_create_field($field);
        $this
          ->pass("New field created: {$field_name}");
      }
      else {
        debug("NOTE: attachProductReferenceField attempting to create field <code>{$field_name}</code> that already exists. This is fine and this message is just for your information.");
      }

      // Check that this instance doesn't already exist
      $instance = field_info_instance('node', $field_name, $content_type);
      if (empty($insance)) {

        // Add an instance of the field to the given content type
        $instance = array(
          'field_name' => $field_name,
          'entity_type' => 'node',
          'label' => 'Product',
          'bundle' => $content_type,
          'description' => 'Choose a product to display for sale.',
          'required' => TRUE,
          'widget' => array(
            'type' => 'options_select',
          ),
          'display' => array(
            'default' => array(
              'label' => 'hidden',
              'type' => 'commerce_cart_add_to_cart_form',
            ),
            'teaser' => array(
              'label' => 'hidden',
              'type' => 'commerce_cart_add_to_cart_form',
            ),
          ),
        );
        field_create_instance($instance);
        $this
          ->pass("Create field instance of field <code>{$field_name}</code> on content type <code>{$content_type}</code>");
      }
      else {
        $this
          ->fail("Test Develoepr: You attempted to create a field that already exists. Field: {$field_name} -- Content Type: {$content_type}");
      }
      return $instance;
    }
    else {
      $this
        ->fail('Cannot create product reference field because Product module is not enabled.');
    }
  }

  /**
   * Creates a product display node with an associated product.
   *
   * @param $product_ids
   *  Array of product IDs to use for the product reference field.
   * @param $title
   *  Optional title for the product node. Will default to a random name.
   * @param $product_display_content_type
   *  Machine name for the product display content type to use for creating the
   *  node. Defaults to 'product_display'.
   * @param $product_ref_field_name
   *  Machine name for the product reference field on this product display
   *  content type. Defaults to 'field_product'.
   * @return
   *  The newly saved $node object.
   */
  public function createDummyProductNode($product_ids, $title = '', $product_display_content_type = 'product_display', $product_ref_field_name = 'field_product') {
    if (module_exists('commerce_product')) {
      if (empty($title)) {
        $title = $this
          ->randomString(10);
      }
      $node = (object) array(
        'type' => $product_display_content_type,
      );
      node_object_prepare($node);
      $node->uid = 1;
      $node->title = $title;
      foreach ($product_ids as $product_id) {
        $node->{$product_ref_field_name}[LANGUAGE_NONE][]['product_id'] = $product_id;
      }
      node_save($node);
      return $node;
    }
    else {
      $this
        ->fail(t('Cannot use use createProductNode because the product module is not enabled.'));
    }
  }

  /**
   * Create a full product node without worrying about the earlier steps in
   * the process.
   *
   * @param $count
   *  Number of product nodes to create. Each one will have a new product
   *  entity associated with it. SKUs will be like PROD-n. Titles will be
   *  like 'Product #n'. Price will be 10*n. Counting begins at 1.
   * @return
   *  An array of product node objects.
   */
  public function createDummyProductNodeBatch($count) {
    $this
      ->createDummyProductDisplayContentType();
    $product_nodes = array();
    for ($i = 1; $i < $count; $i++) {
      $sku = "PROD-{$i}";
      $title = "Product #{$i}";
      $price = $i * 10;
      $product = $this
        ->createDummyProduct($sku, $title, $price);
      $product_node = $this
        ->createDummyProductNode(array(
        $product->product_id,
      ), $title);
      $product_nodes[$i] = $product_node;
    }
    return $product_nodes;
  }

  /**
   * Create a dummy tax type.
   *
   * @param $tax_type
   * 	Array with the specific elements for the tax type, all the elements not
   * 	specified and required will be generated randomly.
   * 	@see hook_commerce_tax_type_info
   *
   * @return
   *  The tax type array just created or FALSE if it wasn't created.
   */
  public function createDummyTaxType($tax_type = array()) {
    $defaults = array(
      'name' => 'example_tax_type',
      'title' => t('Example tax type'),
      'display_title' => t('Example tax type'),
      'description' => t('Example tax type for testing purposes'),
    );

    // Generate a tax type array based on defaults and specific elements.
    $tax_type = array_merge(commerce_tax_ui_tax_type_new(), $defaults, $tax_type);
    if (commerce_tax_ui_tax_type_save($tax_type)) {
      return commerce_tax_type_load($tax_type['name']);
    }
    else {
      return FALSE;
    }
  }

  /**
   * Create a dummy tax rate.
   *
   * @param $tax_type
   * 	Array with the specific elements for the tax rate, all elements not
   * 	specified and required will be generated randomly.
   *	@see hook_commerce_tax_rate_info
   *
   * @return
   *  The tax type array just created or FALSE if it wasn't created.
   */
  public function createDummyTaxRate($tax_rate = array()) {
    $defaults = array(
      'name' => 'example_tax_rate',
      'title' => t('Example tax rate'),
      'display_title' => t('Example tax rate'),
      'rate' => rand(1, 100) / 1000,
      'type' => 'example_tax_type',
    );

    // Generate a tax type array based on defaults and specific elements.
    $tax_rate = array_merge(commerce_tax_ui_tax_rate_new(), $defaults, $tax_rate);
    if (commerce_tax_ui_tax_rate_save($tax_rate)) {
      return commerce_tax_rate_load($tax_rate['name']);
    }
    else {
      return FALSE;
    }
  }

  /**
   * Create a customer profile.
   *
   *  @param $type
   *  	Type of the customer profile, default billing.
   *  @param $uid
   *  	User id that will own the profile, by default anonymous.
   *
   *  @return
   *  	The customer profile created or FALSE if the profile wasn't created.
   */
  public function createDummyCustomerProfile($type = 'billing', $uid = 0) {

    // Initialize the profile.
    $profile = commerce_customer_profile_new($type, $uid);

    // Initialize the address.
    $defaults = array();
    $defaults['name_line'] = $this
      ->randomName();
    $field = field_info_field('commerce_customer_address');
    $instance = field_info_instance('commerce_customer_profile', 'commerce_customer_address', $type);
    $values = array_merge($defaults, addressfield_default_values($field, $instance), $this
      ->generateAddressInformation());
    $values['data'] = serialize($values['data']);
    $profile->commerce_customer_address[LANGUAGE_NONE][] = $values;

    // Save the dummy profile.
    commerce_customer_profile_save($profile);
    return $profile;
  }

  /**
   * Enable extra currencies in the store.
   *
   * @param $currencies
   *  Array of currency codes to be enabled
   */
  public function enableCurrencies($currencies) {
    $currencies = array_merge(drupal_map_assoc($currencies), variable_get('commerce_enabled_currencies', array(
      'USD' => 'USD',
    )));
    variable_set('commerce_enabled_currencies', $currencies);
  }

  // =============== Helper functions ===============

  /**
   * Checks if a group of modules is enabled.
   *
   * @param $module_name
   *  Array of module names to check (without the .module extension)
   * @return
   *  TRUE if all of the modules are enabled.
   */
  protected function modulesUp($module_names) {
    if (is_string($module_names)) {
      $module_names = array(
        $module_names,
      );
    }
    foreach ($module_names as $module_name) {
      if (!module_exists($module_name)) {
        return FALSE;
      }
    }
    return TRUE;
  }

  /**
   * Generate random valid information for Address information.
   */
  protected function generateAddressInformation() {
    $address_info['name_line'] = $this
      ->randomName();
    $address_info['thoroughfare'] = $this
      ->randomName();
    $address_info['locality'] = $this
      ->randomName();
    $address_info['postal_code'] = rand(00, 99999);
    $address_info['administrative_area'] = 'KY';
    return $address_info;
  }

  /**
   * Generate a random valid email
   *
   * @param string $type
   *  Domain type
   *
   * @return string
   *  Valid email
   */
  protected function generateEmail($type = 'com') {
    return $this
      ->randomName() . '@' . $this
      ->randomName() . '.' . $type;
  }

  /**
   * Assertions for Drupal Commerce.
   */

  /**
   * Asserts that a product has been added to the cart.
   *
   * @param $order
   *  A full loaded commerce_order object.
   * @param $product
   *  A full loaded commerce_product object.
   * @param $user
   * 	User that owns the cart.
   *
   * @return TRUE if the product is in the cart, FALSE otherwise.
   */
  public function assertProductAddedToCart($order, $product, $user = NULL) {

    // The order should be in cart status.
    $this
      ->assertTrue(commerce_cart_order_is_cart($order), t('The order checked is in cart status'));
    $product_is_in_cart = FALSE;

    // Loop through the line items looking for products.
    foreach (entity_metadata_wrapper('commerce_order', $order)->commerce_line_items as $delta => $line_item_wrapper) {

      // If this line item matches the product checked...
      if ($line_item_wrapper
        ->getBundle() == 'product' && $line_item_wrapper->commerce_product->product_id
        ->value() == $product->product_id) {
        $product_is_in_cart = TRUE;
      }
    }
    $this
      ->assertTrue($product_is_in_cart, t('Product !product_title is present in the cart', array(
      '!product_title' => $product->title,
    )));

    // Access to the cart page to check if the product is there.
    if (empty($user)) {
      $user = $this
        ->createStoreCustomer();
    }
    $this
      ->drupalLogin($user);
    $this
      ->drupalGet($this
      ->getCommerceUrl('cart'));
    $this
      ->assertText($product->title, t('Product !product_title is present in the cart view', array(
      '!product_title' => $product->title,
    )));
  }

  /**
   *	Asserts that a product has been created.
   *
   * @param $product
   *  A full loaded commerce_product object.
   * @param $user
   * 	User that access the admin pages. Optional, if not informed, the check
   * 	is done with the store admin.
   */
  public function assertProductCreated($product, $user = NULL) {

    // Check if the product is not empty and reload it from database.
    $this
      ->assertFalse(empty($product), t('Product object is not empty'));
    $product = commerce_product_load($product->product_id);
    $this
      ->assertFalse(empty($product), t('Product object is correctly loaded from database'));

    // Access to the admin page for the product and check if the product is there.
    if (empty($user)) {
      $user = $this
        ->createStoreAdmin();
    }
    $this
      ->drupalLogin($user);
    $this
      ->drupalGet('admin/commerce/products/' . $product->product_id);
    $this
      ->assertFieldById('edit-sku', $product->sku, t('When editing the product in the administration interface, the SKU is informed correctly'));
    $this
      ->assertFieldById('edit-title', $product->title, t('When editing the product in the administration interface, the Title is informed correctly'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CommerceBaseTestCase::$profile protected property The profile to install as a basis for testing. Overrides DrupalWebTestCase::$profile
CommerceBaseTestCase::assertProductAddedToCart public function Asserts that a product has been added to the cart.
CommerceBaseTestCase::assertProductCreated public function Asserts that a product has been created.
CommerceBaseTestCase::attachProductReferenceField public function Attach a product reference field to a given content type. Creates the field if the given name doesn't already exist. Automatically sets the display formatters to be the "add to cart form" for the teaser and full modes.
CommerceBaseTestCase::createDummyCustomerProfile public function Create a customer profile.
CommerceBaseTestCase::createDummyOrder public function Create a dummy order in a given status.
CommerceBaseTestCase::createDummyProduct public function Creates a dummy product for use with other tests.
CommerceBaseTestCase::createDummyProductDisplayContentType public function Create a dummy product display content type.
CommerceBaseTestCase::createDummyProductNode public function Creates a product display node with an associated product.
CommerceBaseTestCase::createDummyProductNodeBatch public function Create a full product node without worrying about the earlier steps in the process.
CommerceBaseTestCase::createDummyProductType public function Creates a dummy product type for use with other tests.
CommerceBaseTestCase::createDummyTaxRate public function * Create a dummy tax rate. * *
CommerceBaseTestCase::createDummyTaxType public function * Create a dummy tax type. * *
CommerceBaseTestCase::createSiteAdmin protected function Returns a site administrator user. Only has permissions for administering modules in Drupal core.
CommerceBaseTestCase::createStoreAdmin protected function Returns a store administrator user. Only has permissions for administering Commerce modules.
CommerceBaseTestCase::createStoreCustomer protected function Returns a store customer. It's a regular user with some Commerce permissions as access to checkout.
CommerceBaseTestCase::createUserWithPermissionHelper protected function Wrapper to easily create users from arrays returned by permissionBuilder().
CommerceBaseTestCase::enableCurrencies public function Enable extra currencies in the store.
CommerceBaseTestCase::generateAddressInformation protected function Generate random valid information for Address information.
CommerceBaseTestCase::generateEmail protected function Generate a random valid email
CommerceBaseTestCase::getCommerceUrl protected function Return one of the Commerce configured urls.
CommerceBaseTestCase::modulesUp protected function Checks if a group of modules is enabled.
CommerceBaseTestCase::permissionBuilder protected function Helper function to get different combinations of permission sets.
CommerceBaseTestCase::setUpHelper protected function Helper function to determine which modules should be enabled. Should be used in place of standard parent::setUp('moduleA', 'moduleB') call. 1
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::$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::setUp protected function Sets up a Drupal site for running functional and integration tests. 303
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