drupal_web_test_case.php 67.9 KB
Newer Older
1 2 3 4 5 6
<?php
// $Id$

/**
 * Test case for typical Drupal tests.
 */
7
class DrupalWebTestCase {
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

  /**
   * The test run ID.
   *
   * @var string
   */
  protected $testId;

  /**
   * The URL currently loaded in the internal browser.
   *
   * @var string
   */
  protected $url;

  /**
   * The handle of the current cURL connection.
   *
   * @var resource
   */
  protected $curlHandle;

30 31 32 33 34 35 36
  /**
   * The headers of the page currently loaded in the internal browser.
   *
   * @var Array
   */
  protected $headers;

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
  /**
   * The content of the page currently loaded in the internal browser.
   *
   * @var string
   */
  protected $content;

  /**
   * The content of the page currently loaded in the internal browser (plain text version).
   *
   * @var string
   */
  protected $plainTextContent;

  /**
   * The parsed version of the page.
   *
   * @var SimpleXMLElement
   */
  protected $elements = NULL;

  /**
59
   * The current user logged in using the internal browser.
60 61 62
   *
   * @var bool
   */
63
  protected $loggedInUser = FALSE;
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93

  /**
   * The current cookie file used by cURL.
   *
   * We do not reuse the cookies in further runs, so we do not need a file
   * but we still need cookie handling, so we set the jar to NULL.
   */
  protected $cookieFile = NULL;

  /**
   * Additional cURL options.
   *
   * DrupalWebTestCase itself never sets this but always obeys what is set.
   */
  protected $additionalCurlOptions = array();

  /**
   * The original database prefix, before it was changed for testing purposes.
   *
   * @var string
   */
  protected $originalPrefix = NULL;

  /**
   * The original file directory, before it was changed for testing purposes.
   *
   * @var string
   */
  protected $originalFileDirectory = NULL;

94 95 96 97 98 99 100
  /**
   * The original user, before it was changed to a clean uid = 1 for testing purposes.
   *
   * @var object
   */
  protected $originalUser = NULL;

101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
  /**
   * Current results of this test case.
   *
   * @var Array
   */
  public $results = array(
    '#pass' => 0,
    '#fail' => 0,
    '#exception' => 0,
  );

  /**
   * Assertions thrown in that test case.
   *
   * @var Array
   */
  protected $assertions = array();
118

119 120 121 122
  /**
   * Time limit for the test.
   */
  protected $timeLimit = 180;
123 124 125 126 127
  
  /**
   * HTTP authentication credentials (<username>:<password>).
   */
  protected $httpauth_credentials = NULL;
128 129


130 131 132
  /**
   * Constructor for DrupalWebTestCase.
   *
133
   * @param $test_id
134 135
   *   Tests with the same id are reported together.
   */
136 137
  public function __construct($test_id = NULL) {
    $this->testId = $test_id;
138 139 140
  }

  /**
141
   * Internal helper: stores the assert.
142 143
   *
   * @param $status
144 145
   *   Can be 'pass', 'fail', 'exception'.
   *   TRUE is a synonym for 'pass', FALSE for 'fail'.
146 147 148
   * @param $message
   *   The message string.
   * @param $group
149
   *   Which group this assert belongs to.
150
   * @param $caller
151
   *   By default, the assert comes from a function whose name starts with
152
   *   'test'. Instead, you can specify where this assert originates from
153
   *   by passing in an associative array as $caller. Key 'file' is
154 155 156
   *   the name of the source file, 'line' is the line number and 'function'
   *   is the caller function itself.
   */
157
  private function assert($status, $message = '', $group = 'Other', array $caller = NULL) {
158
    global $db_prefix;
159 160

    // Convert boolean status to string status.
161 162 163
    if (is_bool($status)) {
      $status = $status ? 'pass' : 'fail';
    }
164 165

    // Increment summary result counter.
166
    $this->results['#' . $status]++;
167 168 169 170

    // Get the function information about the call to the assertion method.
    if (!$caller) {
      $caller = $this->getAssertionCall();
171
    }
172 173

    // Switch to non-testing database to store results in.
174
    $current_db_prefix = $db_prefix;
175
    $db_prefix = $this->originalPrefix;
176 177

    // Creation assertion array that can be displayed while tests are running.
178 179
    $this->assertions[] = $assertion = array(
      'test_id' => $this->testId,
180
      'test_class' => get_class($this),
181 182
      'status' => $status,
      'message' => $message,
183 184 185 186
      'message_group' => $group,
      'function' => $caller['function'],
      'line' => $caller['line'],
      'file' => $caller['file'],
187
    );
188 189 190 191 192

    // Store assertion for display after the test has completed.
    db_insert('simpletest')->fields($assertion)->execute();

    // Return to testing prefix.
193
    $db_prefix = $current_db_prefix;
194
    return $status == 'pass' ? TRUE : FALSE;
195 196
  }

197 198 199 200 201 202 203 204 205 206
  /**
   * Cycles through backtrace until the first non-assertion method is found.
   *
   * @return
   *   Array representing the true caller.
   */
  protected function getAssertionCall() {
    $backtrace = debug_backtrace();

    // The first element is the call. The second element is the caller.
207
    // We skip calls that occurred in one of the methods of DrupalWebTestCase
208 209 210 211 212 213 214 215 216 217 218
    // or in an assertion function.
    while (($caller = $backtrace[1]) &&
          ((isset($caller['class']) && $caller['class'] == 'DrupalWebTestCase') ||
            substr($caller['function'], 0, 6) == 'assert')) {
      // We remove that call.
      array_shift($backtrace);
    }

    return _drupal_get_last_caller($backtrace);
  }

219 220 221 222 223 224 225 226 227 228
  /**
   * Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
   *
   * @param $value
   *   The value on which the assertion is to be done.
   * @param $message
   *   The message to display along with the assertion.
   * @param $group
   *   The type of assertion - examples are "Browser", "PHP".
   * @return
229
   *   TRUE if the assertion succeeded, FALSE otherwise.
230 231
   */
  protected function assertTrue($value, $message = '', $group = 'Other') {
232
    return $this->assert((bool) $value, $message ? $message : t('Value is TRUE'), $group);
233 234 235 236 237 238 239 240 241 242 243 244
  }

  /**
   * Check to see if a value is false (an empty string, 0, NULL, or FALSE).
   *
   * @param $value
   *   The value on which the assertion is to be done.
   * @param $message
   *   The message to display along with the assertion.
   * @param $group
   *   The type of assertion - examples are "Browser", "PHP".
   * @return
245
   *   TRUE if the assertion succeeded, FALSE otherwise.
246 247
   */
  protected function assertFalse($value, $message = '', $group = 'Other') {
248
    return $this->assert(!$value, $message ? $message : t('Value is FALSE'), $group);
249 250 251 252 253 254 255 256 257 258 259 260
  }

  /**
   * Check to see if a value is NULL.
   *
   * @param $value
   *   The value on which the assertion is to be done.
   * @param $message
   *   The message to display along with the assertion.
   * @param $group
   *   The type of assertion - examples are "Browser", "PHP".
   * @return
261
   *   TRUE if the assertion succeeded, FALSE otherwise.
262 263
   */
  protected function assertNull($value, $message = '', $group = 'Other') {
264
    return $this->assert(!isset($value), $message ? $message : t('Value is NULL'), $group);
265 266 267 268 269 270 271 272 273 274 275 276
  }

  /**
   * Check to see if a value is not NULL.
   *
   * @param $value
   *   The value on which the assertion is to be done.
   * @param $message
   *   The message to display along with the assertion.
   * @param $group
   *   The type of assertion - examples are "Browser", "PHP".
   * @return
277
   *   TRUE if the assertion succeeded, FALSE otherwise.
278 279
   */
  protected function assertNotNull($value, $message = '', $group = 'Other') {
280
    return $this->assert(isset($value), $message ? $message : t('Value is not NULL'), $group);
281 282 283 284 285 286 287 288 289 290 291 292 293 294
  }

  /**
   * Check to see if two values are equal.
   *
   * @param $first
   *   The first value to check.
   * @param $second
   *   The second value to check.
   * @param $message
   *   The message to display along with the assertion.
   * @param $group
   *   The type of assertion - examples are "Browser", "PHP".
   * @return
295
   *   TRUE if the assertion succeeded, FALSE otherwise.
296 297
   */
  protected function assertEqual($first, $second, $message = '', $group = 'Other') {
298
    return $this->assert($first == $second, $message ? $message : t('First value is equal to second value'), $group);
299 300 301 302 303 304 305 306 307 308 309 310 311 312
  }

  /**
   * Check to see if two values are not equal.
   *
   * @param $first
   *   The first value to check.
   * @param $second
   *   The second value to check.
   * @param $message
   *   The message to display along with the assertion.
   * @param $group
   *   The type of assertion - examples are "Browser", "PHP".
   * @return
313
   *   TRUE if the assertion succeeded, FALSE otherwise.
314 315
   */
  protected function assertNotEqual($first, $second, $message = '', $group = 'Other') {
316
    return $this->assert($first != $second, $message ? $message : t('First value is not equal to second value'), $group);
317 318 319 320 321 322 323 324 325 326 327 328 329 330
  }

  /**
   * Check to see if two values are identical.
   *
   * @param $first
   *   The first value to check.
   * @param $second
   *   The second value to check.
   * @param $message
   *   The message to display along with the assertion.
   * @param $group
   *   The type of assertion - examples are "Browser", "PHP".
   * @return
331
   *   TRUE if the assertion succeeded, FALSE otherwise.
332 333
   */
  protected function assertIdentical($first, $second, $message = '', $group = 'Other') {
334
    return $this->assert($first === $second, $message ? $message : t('First value is identical to second value'), $group);
335 336 337 338 339 340 341 342 343 344 345 346 347 348
  }

  /**
   * Check to see if two values are not identical.
   *
   * @param $first
   *   The first value to check.
   * @param $second
   *   The second value to check.
   * @param $message
   *   The message to display along with the assertion.
   * @param $group
   *   The type of assertion - examples are "Browser", "PHP".
   * @return
349
   *   TRUE if the assertion succeeded, FALSE otherwise.
350 351
   */
  protected function assertNotIdentical($first, $second, $message = '', $group = 'Other') {
352
    return $this->assert($first !== $second, $message ? $message : t('First value is not identical to second value'), $group);
353 354 355 356 357 358 359 360 361 362 363 364 365
  }

  /**
   * Fire an assertion that is always positive.
   *
   * @param $message
   *   The message to display along with the assertion.
   * @param $group
   *   The type of assertion - examples are "Browser", "PHP".
   * @return
   *   TRUE.
   */
  protected function pass($message = NULL, $group = 'Other') {
366
    return $this->assert(TRUE, $message, $group);
367 368
  }

369
  /**
370
   * Fire an assertion that is always negative.
371
   *
372 373 374 375 376 377 378 379
   * @param $message
   *   The message to display along with the assertion.
   * @param $group
   *   The type of assertion - examples are "Browser", "PHP".
   * @return
   *   FALSE.
   */
  protected function fail($message = NULL, $group = 'Other') {
380
    return $this->assert(FALSE, $message, $group);
381 382 383 384 385 386 387 388 389
  }

  /**
   * Fire an error assertion.
   *
   * @param $message
   *   The message to display along with the assertion.
   * @param $group
   *   The type of assertion - examples are "Browser", "PHP".
390
   * @param $caller
391
   *   The caller of the error.
392 393
   * @return
   *   FALSE.
394
   */
395
  protected function error($message = '', $group = 'Other', array $caller = NULL) {
396
    return $this->assert('exception', $message, $group, $caller);
397 398 399 400
  }

  /**
   * Run all tests in this class.
401
   */
402
  public function run() {
403 404 405 406
    // HTTP auth settings (<username>:<password>) for the simpletest browser
    // when sending requests to the test site.
    $this->httpauth_credentials = variable_get('simpletest_httpauth_credentials', NULL);

407 408 409 410 411 412
    set_error_handler(array($this, 'errorHandler'));
    $methods = array();
    // Iterate through all the methods in this class.
    foreach (get_class_methods(get_class($this)) as $method) {
      // If the current method starts with "test", run it - it's a test.
      if (strtolower(substr($method, 0, 4)) == 'test') {
413
        $this->setUp();
414 415 416 417 418 419 420
        try {
          $this->$method();
          // Finish up.
        }
        catch (Exception $e) {
          $this->exceptionHandler($e);
        }
421
        $this->tearDown();
422 423
      }
    }
424 425
    // Clear out the error messages and restore error handler.
    drupal_get_messages();
426 427 428 429 430 431
    restore_error_handler();
  }

  /**
   * Handle errors.
   *
432
   * Because this is registered in set_error_handler(), it has to be public.
433
   * @see set_error_handler
434
   *
435
   */
436
  public function errorHandler($severity, $message, $file = NULL, $line = NULL) {
437
    if ($severity & error_reporting()) {
438 439 440 441 442 443 444 445 446 447 448
      $error_map = array(
        E_STRICT => 'Run-time notice',
        E_WARNING => 'Warning',
        E_NOTICE => 'Notice',
        E_CORE_ERROR => 'Core error',
        E_CORE_WARNING => 'Core warning',
        E_USER_ERROR => 'User error',
        E_USER_WARNING => 'User warning',
        E_USER_NOTICE => 'User notice',
        E_RECOVERABLE_ERROR => 'Recoverable error',
      );
449 450 451

      $backtrace = debug_backtrace();
      $this->error($message, $error_map[$severity], _drupal_get_last_caller($backtrace));
452 453
    }
    return TRUE;
454 455
  }

456 457 458 459 460
  /**
   * Handle exceptions.
   *
   * @see set_exception_handler
   */
461
  protected function exceptionHandler($exception) {
462 463 464 465 466 467 468 469 470
    $backtrace = $exception->getTrace();
    // Push on top of the backtrace the call that generated the exception.
    array_unshift($backtrace, array(
      'line' => $exception->getLine(),
      'file' => $exception->getFile(),
    ));
    $this->error($exception->getMessage(), 'Uncaught exception', _drupal_get_last_caller($backtrace));
  }

471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
  /**
   * Get a node from the database based on its title.
   *
   * @param title
   *   A node title, usually generated by $this->randomName().
   *
   * @return
   *   A node object matching $title.
   */
  function drupalGetNodeByTitle($title) {
    $nodes = node_load_multiple(array(), array('title' => $title));
    // Load the first node returned from the database.
    $returned_node = reset($nodes);
    return $returned_node;
  }

487 488 489
  /**
   * Creates a node based on default settings.
   *
490 491
   * @param $settings
   *   An associative array of settings to change from the defaults, keys are
492
   *   node properties, for example 'body' => 'Hello, world!'.
493 494
   * @return
   *   Created node object.
495
   */
496
  protected function drupalCreateNode($settings = array()) {
497
    // Populate defaults array
498
    $settings += array(
499 500 501
      'body'      => $this->randomName(32),
      'title'     => $this->randomName(8),
      'comment'   => 2,
502
      'changed'   => REQUEST_TIME,
503 504 505 506 507 508 509 510 511 512 513
      'format'    => FILTER_FORMAT_DEFAULT,
      'moderate'  => 0,
      'promote'   => 0,
      'revision'  => 1,
      'log'       => '',
      'status'    => 1,
      'sticky'    => 0,
      'type'      => 'page',
      'revisions' => NULL,
      'taxonomy'  => NULL,
    );
514 515 516 517

    // Use the original node's created time for existing nodes.
    if (isset($settings['created']) && !isset($settings['date'])) {
      $settings['date'] = format_date($settings['created'], 'custom', 'Y-m-d H:i:s O');
518
    }
519 520 521 522

    // Add the default teaser.
    if (!isset($settings['teaser'])) {
      $settings['teaser'] = $settings['body'];      
523 524
    }

525 526 527 528 529 530 531 532 533 534 535 536 537
    // If the node's user uid is not specified manually, use the currently
    // logged in user if available, or else the user running the test.
    if (!isset($settings['uid'])) {
      if ($this->loggedInUser) {
        $settings['uid'] = $this->loggedInUser->uid;
      }
      else {
        global $user;
        $settings['uid'] = $user->uid;
      }
    }

    $node = (object) $settings;
538 539 540
    node_save($node);

    // small hack to link revisions to our test user
541
    db_query('UPDATE {node_revision} SET uid = %d WHERE vid = %d', $node->uid, $node->vid);
542 543 544 545 546 547
    return $node;
  }

  /**
   * Creates a custom content type based on default settings.
   *
548
   * @param $settings
549 550
   *   An array of settings to change from the defaults.
   *   Example: 'type' => 'foo'.
551 552
   * @return
   *   Created content type.
553
   */
554
  protected function drupalCreateContentType($settings = array()) {
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
    // find a non-existent random type name.
    do {
      $name = strtolower($this->randomName(3, 'type_'));
    } while (node_get_types('type', $name));

    // Populate defaults array
    $defaults = array(
      'type' => $name,
      'name' => $name,
      'description' => '',
      'help' => '',
      'min_word_count' => 0,
      'title_label' => 'Title',
      'body_label' => 'Body',
      'has_title' => 1,
      'has_body' => 1,
    );
    // imposed values for a custom type
    $forced = array(
      'orig_type' => '',
      'old_type' => '',
      'module' => 'node',
      'custom' => 1,
      'modified' => 1,
      'locked' => 0,
    );
    $type = $forced + $settings + $defaults;
    $type = (object)$type;

584
    $saved_type = node_type_save($type);
585 586
    node_types_rebuild();

587
    $this->assertEqual($saved_type, SAVED_NEW, t('Created content type %type.', array('%type' => $type->type)));
588

589 590 591
    // Reset permissions so that permissions for this content type are available.
    $this->checkPermissions(array(), TRUE);

592 593 594 595 596 597
    return $type;
  }

  /**
   * Get a list files that can be used in tests.
   *
598 599 600 601 602 603
   * @param $type
   *   File type, possible values: 'binary', 'html', 'image', 'javascript', 'php', 'sql', 'text'.
   * @param $size
   *   File size in bytes to match. Please check the tests/files folder.
   * @return
   *   List of files that match filter.
604
   */
605
  protected function drupalGetTestFiles($type, $size = NULL) {
606 607 608 609 610
    $files = array();

    // Make sure type is valid.
    if (in_array($type, array('binary', 'html', 'image', 'javascript', 'php', 'sql', 'text'))) {
     // Use original file directory instead of one created during setUp().
611
      $path = $this->originalFileDirectory . '/simpletest';
612
      $files = file_scan_directory($path, '/' . $type . '\-.*/');
613 614 615 616

      // If size is set then remove any files that are not of that size.
      if ($size !== NULL) {
        foreach ($files as $file) {
617
          $stats = stat($file->filepath);
618
          if ($stats['size'] != $size) {
619
            unset($files[$file->filepath]);
620 621 622 623 624 625 626 627 628
          }
        }
      }
    }
    usort($files, array($this, 'drupalCompareFiles'));
    return $files;
  }

  /**
629
   * Compare two files based on size and file name.
630
   */
631
  protected function drupalCompareFiles($file1, $file2) {
632 633 634 635
    $compare_size = filesize($file1->filepath) - filesize($file2->filepath);
    if ($compare_size) {
      // Sort by file size.
      return $compare_size;
636 637
    }
    else {
638 639
      // The files were the same size, so sort alphabetically.
      return strnatcmp($file1->name, $file2->name);
640 641 642 643 644 645
    }
  }

  /**
   * Generates a random string.
   *
646 647 648 649 650 651
   * @param $number
   *   Number of characters in length to append to the prefix.
   * @param $prefix
   *   Prefix to use.
   * @return
   *   Randomly generated string.
652
   */
653
  public static function randomName($number = 4, $prefix = 'simpletest_') {
654 655 656 657 658 659 660 661 662 663 664 665 666 667
    $chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_';
    for ($x = 0; $x < $number; $x++) {
      $prefix .= $chars{mt_rand(0, strlen($chars) - 1)};
      if ($x == 0) {
        $chars .= '0123456789';
      }
    }
    return $prefix;
  }

  /**
   * Create a user with a given set of permissions. The permissions correspond to the
   * names given on the privileges page.
   *
668 669 670 671
   * @param $permissions
   *   Array of permission names to assign to user.
   * @return
   *   A fully loaded user object with pass_raw property, or FALSE if account
672 673
   *   creation fails.
   */
674
  protected function drupalCreateUser($permissions = NULL) {
675
    // Create a role with the given permission set.
676
    if (!($rid = $this->_drupalCreateRole($permissions))) {
677 678 679 680 681 682
      return FALSE;
    }

    // Create a user assigned to that role.
    $edit = array();
    $edit['name']   = $this->randomName();
683
    $edit['mail']   = $edit['name'] . '@example.com';
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
    $edit['roles']  = array($rid => $rid);
    $edit['pass']   = user_password();
    $edit['status'] = 1;

    $account = user_save('', $edit);

    $this->assertTrue(!empty($account->uid), t('User created with name %name and pass %pass', array('%name' => $edit['name'], '%pass' => $edit['pass'])), t('User login'));
    if (empty($account->uid)) {
      return FALSE;
    }

    // Add the raw password so that we can log in as this user.
    $account->pass_raw = $edit['pass'];
    return $account;
  }

  /**
   * Internal helper function; Create a role with specified permissions.
   *
703 704 705 706
   * @param $permissions
   *   Array of permission names to assign to role.
   * @return
   *   Role ID of newly created role, or FALSE if role creation failed.
707
   */
708
  protected function _drupalCreateRole(array $permissions = NULL) {
709 710
    // Generate string version of permissions list.
    if ($permissions === NULL) {
711
      $permissions = array('access comments', 'access content', 'post comments', 'post comments without approval');
712 713
    }

714 715 716 717
    if (!$this->checkPermissions($permissions)) {
      return FALSE;
    }

718 719 720 721 722 723 724
    // Create new role.
    $role_name = $this->randomName();
    db_query("INSERT INTO {role} (name) VALUES ('%s')", $role_name);
    $role = db_fetch_object(db_query("SELECT * FROM {role} WHERE name = '%s'", $role_name));
    $this->assertTrue($role, t('Created role of name: @role_name, id: @rid', array('@role_name' => $role_name, '@rid' => (isset($role->rid) ? $role->rid : t('-n/a-')))), t('Role'));
    if ($role && !empty($role->rid)) {
      // Assign permissions to role and mark it for clean-up.
725 726 727 728 729
      foreach ($permissions as $permission_string) {
        db_query("INSERT INTO {role_permission} (rid, permission) VALUES (%d, '%s')", $role->rid, $permission_string);
      }
      $count = db_result(db_query("SELECT COUNT(*) FROM {role_permission} WHERE rid = %d", $role->rid));
      $this->assertTrue($count == count($permissions), t('Created permissions: @perms', array('@perms' => implode(', ', $permissions))), t('Role'));
730 731 732 733 734 735 736
      return $role->rid;
    }
    else {
      return FALSE;
    }
  }

737 738 739
  /**
   * Check to make sure that the array of permissions are valid.
   *
740 741 742 743 744 745
   * @param $permissions
   *   Permissions to check.
   * @param $reset
   *   Reset cached available permissions.
   * @return
   *   TRUE or FALSE depending on whether the permissions are valid.
746
   */
747
  protected function checkPermissions(array $permissions, $reset = FALSE) {
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
    static $available;

    if (!isset($available) || $reset) {
      $available = array_keys(module_invoke_all('perm'));
    }

    $valid = TRUE;
    foreach ($permissions as $permission) {
      if (!in_array($permission, $available)) {
        $this->fail(t('Invalid permission %permission.', array('%permission' => $permission)), t('Role'));
        $valid = FALSE;
      }
    }
    return $valid;
  }

764
  /**
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
   * Log in a user with the internal browser.
   *
   * If a user is already logged in, then the current user is logged out before
   * logging in the specified user.
   *
   * Please note that neither the global $user nor the passed in user object is
   * populated with data of the logged in user. If you need full access to the
   * user object after logging in, it must be updated manually. If you also need
   * access to the plain-text password of the user (set by drupalCreateUser()),
   * e.g. to login the same user again, then it must be re-assigned manually.
   * For example:
   * @code
   *   // Create a user.
   *   $account = $this->drupalCreateUser(array());
   *   $this->drupalLogin($account);
   *   // Load real user object.
   *   $pass_raw = $account->pass_raw;
   *   $account = user_load($account->uid);
   *   $account->pass_raw = $pass_raw;
   * @endcode
785
   *
786 787
   * @param $user
   *   User object representing the user to login.
788 789
   *
   * @see drupalCreateUser()
790
   */
791
  protected function drupalLogin(stdClass $user) {
792
    if ($this->loggedInUser) {
793 794 795 796 797 798 799 800 801 802 803 804 805
      $this->drupalLogout();
    }

    $edit = array(
      'name' => $user->name,
      'pass' => $user->pass_raw
    );
    $this->drupalPost('user', $edit, t('Log in'));

    $pass = $this->assertText($user->name, t('Found name: %name', array('%name' => $user->name)), t('User login'));
    $pass = $pass && $this->assertNoText(t('The username %name has been blocked.', array('%name' => $user->name)), t('No blocked message at login page'), t('User login'));
    $pass = $pass && $this->assertNoText(t('The name %name is a reserved username.', array('%name' => $user->name)), t('No reserved message at login page'), t('User login'));

806 807 808
    if ($pass) {
      $this->loggedInUser = $user;
    }
809 810 811 812 813
  }

  /*
   * Logs a user out of the internal browser, then check the login page to confirm logout.
   */
814
  protected function drupalLogout() {
815
    // Make a request to the logout page.
816
    $this->drupalGet('user/logout');
817 818 819 820 821 822

    // Load the user page, the idea being if you were properly logged out you should be seeing a login screen.
    $this->drupalGet('user');
    $pass = $this->assertField('name', t('Username field found.'), t('Logout'));
    $pass = $pass && $this->assertField('pass', t('Password field found.'), t('Logout'));

823 824 825
    if ($pass) {
      $this->loggedInUser = FALSE;
    }
826 827 828
  }

  /**
829 830 831 832
   * 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. A temporary files directory
833
   * is created with the same name as the database prefix.
834
   *
835
   * @param ...
836
   *   List of modules to enable for the duration of the test.
837
   */
838
  protected function setUp() {
839
    global $db_prefix, $user;
840 841

    // Store necessary current values before switching to prefixed database.
842
    $this->originalPrefix = $db_prefix;
843
    $this->originalFileDirectory = file_directory_path();
844
    $clean_url_original = variable_get('clean_url', 0);
845 846

    // Generate temporary prefixed database to ensure that tests have a clean starting point.
847
    $db_prefix = Database::getConnection()->prefixTables('{simpletest' . mt_rand(1000, 1000000) . '}');
848

849
    include_once DRUPAL_ROOT . '/includes/install.inc';
850
    drupal_install_system();
851

852 853
    $this->preloadRegistry();

854
    // Add the specified modules to the list of modules in the default profile.
855
    $args = func_get_args();
856
    $modules = array_unique(array_merge(drupal_get_profile_modules('default', 'en'), $args));
857
    drupal_install_modules($modules, TRUE);
858

859
    // Because the schema is static cached, we need to flush
860
    // it between each run. If we don't, then it will contain
861 862 863
    // stale data for the previous run's database prefix and all
    // calls to it will fail.
    drupal_get_schema(NULL, TRUE);
864

865
    // Run default profile tasks.
866 867
    $task = 'profile';
    default_profile_tasks($task, '');
868 869

    // Rebuild caches.
870 871
    actions_synchronize();
    _drupal_flush_css_js();
872
    $this->refreshVariables();
873
    $this->checkPermissions(array(), TRUE);
874

875 876 877
    // Log in with a clean $user.
    $this->originalUser = $user;
    drupal_save_session(FALSE);
878
    $user = user_load(1);
879

880
    // Restore necessary variables.
881 882 883
    variable_set('install_profile', 'default');
    variable_set('install_task', 'profile-finished');
    variable_set('clean_url', $clean_url_original);
884
    variable_set('site_mail', 'simpletest@example.com');
885 886

    // Use temporary files directory with the same prefix as database.
887
    variable_set('file_directory_path', $this->originalFileDirectory . '/' . $db_prefix);
888
    $directory = file_directory_path();
889 890 891
    // Create the files directory.
    file_check_directory($directory, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);

892
    set_time_limit($this->timeLimit);
893 894
  }

895
  /**
896 897 898 899
   * This method is called by DrupalWebTestCase::setUp, and preloads the
   * registry from the testing site to cut down on the time it takes to
   * setup a clean environment for the current test run.
   */
900 901 902 903 904
  protected function preloadRegistry() {
    db_query('INSERT INTO {registry} SELECT * FROM ' . $this->originalPrefix . 'registry');
    db_query('INSERT INTO {registry_file} SELECT * FROM ' . $this->originalPrefix . 'registry_file');
  }

905 906 907 908 909 910 911 912 913 914 915 916
  /**
   * Refresh the in-memory set of variables. Useful after a page request is made
   * that changes a variable in a different thread.
   *
   * In other words calling a settings page with $this->drupalPost() with a changed
   * value would update a variable to reflect that change, but in the thread that
   * made the call (thread running the test) the changed variable would not be
   * picked up.
   *
   * This method clears the variables cache and loads a fresh copy from the database
   * to ensure that the most up-to-date set of variables is loaded.
   */
917
  protected function refreshVariables() {
918 919 920 921 922
    global $conf;
    cache_clear_all('variables', 'cache');
    $conf = variable_init();
  }

923 924 925 926
  /**
   * Delete created files and temporary files directory, delete the tables created by setUp(),
   * and reset the database prefix.
   */
927
  protected function tearDown() {
928
    global $db_prefix, $user;
929 930
    if (preg_match('/simpletest\d+/', $db_prefix)) {
      // Delete temporary files directory and reset files directory path.
931
      file_unmanaged_delete_recursive(file_directory_path());
932
      variable_set('file_directory_path', $this->originalFileDirectory);
933

934
      // Remove all prefixed tables (all the tables in the schema).
935 936 937 938 939
      $schema = drupal_get_schema(NULL, TRUE);
      $ret = array();
      foreach ($schema as $name => $table) {
        db_drop_table($ret, $name);
      }
940 941

      // Return the database prefix to the original.
942
      $db_prefix = $this->originalPrefix;
943

944 945 946 947
      // Return the user to the original one.
      $user = $this->originalUser;
      drupal_save_session(TRUE);

948
      // Ensure that internal logged in variable and cURL options are reset.
949
      $this->loggedInUser = FALSE;
950
      $this->additionalCurlOptions = array();
951

952 953
      // Reload module list and implementations to ensure that test module hooks
      // aren't called after tests.
954
      module_list(TRUE);
955
      module_implements(MODULE_IMPLEMENTS_CLEAR_CACHE);
956

957 958 959
      // Reset the Field API.
      field_cache_clear();

960 961 962
      // Rebuild caches.
      $this->refreshVariables();

963
      // Close the CURL handler.
964 965 966 967 968
      $this->curlClose();
    }
  }

  /**
969
   * Initializes the cURL connection.
970
   *
971 972 973 974
   * If the simpletest_httpauth_credentials variable is set, this function will
   * add HTTP authentication headers. This is necessary for testing sites that
   * are protected by login credentials from public access.
   * See the description of $curl_options for other options.
975
   */
976
  protected function curlInitialize() {
977
    global $base_url, $db_prefix;
978 979 980 981
    if (!isset($this->curlHandle)) {
      $this->curlHandle = curl_init();
      $curl_options = $this->additionalCurlOptions + array(
        CURLOPT_COOKIEJAR => $this->cookieFile,
982 983
        CURLOPT_URL => $base_url,
        CURLOPT_FOLLOWLOCATION => TRUE,
984
        CURLOPT_MAXREDIRS => 5,
985
        CURLOPT_RETURNTRANSFER => TRUE,
986 987
        CURLOPT_SSL_VERIFYPEER => FALSE,  // Required to make the tests run on https://
        CURLOPT_SSL_VERIFYHOST => FALSE,  // Required to make the tests run on https://
988
        CURLOPT_HEADERFUNCTION => array(&$this, 'curlHeaderCallback'),
989
      );
990 991
      if (preg_match('/simpletest\d+/', $db_prefix, $matches)) {
        $curl_options[CURLOPT_USERAGENT] = $matches[0];
992
      }
993 994
      if (isset($this->httpauth_credentials)) {
        $curl_options[CURLOPT_USERPWD] = $this->httpauth_credentials;
995
      }
996
      curl_setopt_array($this->curlHandle, $this->additionalCurlOptions + $curl_options);
997 998 999 1000
    }
  }

  /**
1001
   * Performs a cURL exec with the specified options after calling curlConnect().
1002
   *
1003 1004
   * @param $curl_options
   *   Custom cURL options.
1005 1006
   * @return
   *   Content returned from the exec.
1007 1008
   */
  protected function curlExec($curl_options) {
1009
    $this->curlInitialize();
1010
    $url = empty($curl_options[CURLOPT_URL]) ? curl_getinfo($this->curlHandle, CURLINFO_EFFECTIVE_URL) : $curl_options[CURLOPT_URL];
1011 1012 1013 1014 1015 1016 1017 1018
    if (!empty($curl_options[CURLOPT_POST])) {
      // This is a fix for the Curl library to prevent Expect: 100-continue
      // headers in POST requests, that may cause unexpected HTTP response
      // codes from some webservers (like lighttpd that returns a 417 error
      // code). It is done by setting an empty "Expect" header field that is
      // not overwritten by Curl.
      $curl_options[CURLOPT_HTTPHEADER][] = 'Expect:';
    }
1019
    curl_setopt_array($this->curlHandle, $this->additionalCurlOptions + $curl_options);
1020
    $this->headers = array();
1021
    $this->drupalSetContent(curl_exec($this->curlHandle), curl_getinfo($this->curlHandle, CURLINFO_EFFECTIVE_URL));
1022 1023 1024 1025 1026 1027 1028 1029
    $message_vars = array(
      '!method' => !empty($curl_options[CURLOPT_NOBODY]) ? 'HEAD' : (empty($curl_options[CURLOPT_POSTFIELDS]) ? 'GET' : 'POST'),
      '@url' => $url,
      '@status' => curl_getinfo($this->curlHandle, CURLINFO_HTTP_CODE),
      '!length' => format_size(strlen($this->content))
    );
    $message = t('!method @url returned @status (!length).', $message_vars);
    $this->assertTrue($this->content !== FALSE, $message, t('Browser'));
1030
    return $this->drupalGetContent();
1031 1032
  }

1033 1034 1035 1036 1037
  /**
   * Reads headers and registers errors received from the tested site.
   *
   * @see _drupal_log_error().
   *
1038 1039 1040 1041
   * @param $curlHandler
   *   The cURL handler.
   * @param $header
   *   An header.
1042
   */
1043
  protected function curlHeaderCallback($curlHandler, $header) {
1044
    $this->headers[] = $header;
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
    // Errors are being sent via X-Drupal-Assertion-* headers,
    // generated by _drupal_log_error() in the exact form required
    // by DrupalWebTestCase::error().
    if (preg_match('/^X-Drupal-Assertion-[0-9]+: (.*)$/', $header, $matches)) {
      // Call DrupalWebTestCase::error() with the parameters from the header.
      call_user_func_array(array(&$this, 'error'), unserialize(urldecode($matches[1])));
    }
    // This is required by cURL.
    return strlen($header);
  }

1056 1057 1058 1059
  /**
   * Close the cURL handler and unset the handler.
   */
  protected function curlClose() {
1060 1061 1062
    if (isset($this->curlHandle)) {
      curl_close($this->curlHandle);
      unset($this->curlHandle);
1063 1064 1065 1066
    }
  }

  /**
1067
   * Parse content returned from curlExec using DOM and SimpleXML.
1068
   *
1069 1070
   * @return
   *   A SimpleXMLElement or FALSE on failure.
1071 1072 1073
   */
  protected function parse() {
    if (!$this->elements) {
1074
      // DOM can load HTML soup. But, HTML soup can throw warnings, suppress
1075
      // them.
1076
      @$htmlDom = DOMDocument::loadHTML($this->content);
1077
      if ($htmlDom) {
1078
        $this->pass(t('Valid HTML found on "@path"', array('@path' => $this->getUrl())), t('Browser'));
1079 1080 1081 1082 1083
        // It's much easier to work with simplexml than DOM, luckily enough
        // we can just simply import our DOM tree.
        $this->elements = simplexml_import_dom($htmlDom);
      }
    }
1084 1085 1086
    if (!$this->elements) {
      $this->fail(t('Parsed page successfully.'), t('Browser'));
    }
1087

1088 1089 1090 1091 1092 1093
    return $this->elements;
  }

  /**
   * Retrieves a Drupal path or an absolute path.
   *
1094
   * @param $path
1095
   *   Drupal path or URL to load into internal browser
1096
   * @param $options
1097
   *   Options to be forwarded to url().
1098 1099 1100
   * @param $headers
   *   An array containing additional HTTP request headers, each formatted as
   *   "name: value".
1101
   * @return
1102
   *   The retrieved HTML string, also available as $this->drupalGetContent()
1103
   */
1104
  protected function drupalGet($path, array $options = array(), array $headers = array()) {
1105
    $options['absolute'] = TRUE;
1106

1107 1108
    // We re-using a CURL connection here. If that connection still has certain
    // options set, it might change the GET into a POST. Make sure we clear out
1109
    // previous options.
1110
    $out = $this->curlExec(array(CURLOPT_HTTPGET => TRUE, CURLOPT_URL => url($path, $options), CURLOPT_NOBODY => FALSE, CURLOPT_HTTPHEADER => $headers));
1111
    $this->refreshVariables(); // Ensure that any changes to variables in the other thread are picked up.
1112 1113 1114 1115 1116

    // Replace original page output with new output from redirected page(s).
    if (($new = $this->checkForMetaRefresh())) {
      $out = $new;
    }
1117
    return $out;
1118 1119 1120
  }

  /**
1121 1122
   * Execute a POST request on a Drupal page.
   * It will be done as usual POST request with SimpleBrowser.
1123
   *
1124
   * @param $path
1125
   *   Location of the post form. Either a Drupal path or an absolute path or
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
   *   NULL to post to the current page. For multi-stage forms you can set the
   *   path to NULL and have it post to the last received page. Example:
   *
   *   // First step in form.
   *   $edit = array(...);
   *   $this->drupalPost('some_url', $edit, t('Save'));
   *
   *   // Second step in form.
   *   $edit = array(...);
   *   $this->drupalPost(NULL, $edit, t('Save'));
1136
   * @param  $edit
1137
   *   Field data in an associative array. Changes the current input fields
1138
   *   (where possible) to the values indicated. A checkbox can be set to
1139 1140 1141
   *   TRUE to be checked and FALSE to be unchecked. Note that when a form
   *   contains file upload fields, other fields cannot start with the '@'
   *   character.
1142 1143 1144 1145 1146
   *
   *   Multiple select fields can be set using name[] and setting each of the
   *   possible values. Example:
   *   $edit = array();
   *   $edit['name[]'] = array('value1', 'value2');
1147
   * @param $submit
1148
   *   Value of the submit button.
1149 1150
   * @param $options
   *   Options to be forwarded to url().
1151 1152 1153
   * @param $headers
   *   An array containing additional HTTP request headers, each formatted as
   *   "name: value".
1154
   */
1155
  protected function drupalPost($path, $edit, $submit, array $options = array(), array $headers = array()) {
1156 1157
    $submit_matches = FALSE;
    if (isset($path)) {
1158
      $html = $this->drupalGet($path, $options);
1159 1160 1161 1162
    }
    if ($this->parse()) {
      $edit_save = $edit;
      // Let's iterate over all the forms.
1163
      $forms = $this->xpath('//form');
1164
      foreach ($forms as $form) {
1165 1166 1167 1168 1169 1170
        // We try to set the fields of this form as specified in $edit.
        $edit = $edit_save;
        $post = array();
        $upload = array();
        $submit_matches = $this->handleForm($post, $edit, $upload, $submit, $form);
        $action = isset($form['action']) ? $this->getAbsoluteUrl($form['action']) : $this->getUrl();
1171

1172
        // We post only if we managed to handle every field in edit and the
1173
        // submit button matches.
1174
        if (!$edit && $submit_matches) {
1175 1176 1177 1178 1179
          if ($upload) {
            // TODO: cURL handles file uploads for us, but the implementation
            // is broken. This is a less than elegant workaround. Alternatives
            // are being explored at #253506.
            foreach ($upload as $key => $file) {
1180 1181 1182 1183
              $file = realpath($file);
              if ($file && is_file($file)) {
                $post[$key] = '@' . $file;
              }
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
            }
          }
          else {
            foreach ($post as $key => $value) {
              // Encode according to application/x-www-form-urlencoded
              // Both names and values needs to be urlencoded, according to
              // http://www.w3.org/TR/html4/interact/forms.html#h-17.13.4.1
              $post[$key] = urlencode($key) . '=' . urlencode($value);
            }
            $post = implode('&', $post);
1194
          }
1195
          $out = $this->curlExec(array(CURLOPT_URL => $action, CURLOPT_POST => TRUE, CURLOPT_POSTFIELDS => $post, CURLOPT_HTTPHEADER => $headers));
1196
          // Ensure that any changes to variables in the other thread are picked up.
1197
          $this->refreshVariables();
1198 1199 1200 1201 1202

          // Replace original page output with new output from redirected page(s).
          if (($new = $this->checkForMetaRefresh())) {
            $out = $new;
          }
1203
          return $out;
1204 1205 1206 1207 1208 1209
        }
      }
      // We have not found a form which contained all fields of $edit.
      foreach ($edit as $name => $value) {
        $this->fail(t('Failed to set field @name to @value', array('@name' => $name, '@value' => $value)));
      }
1210 1211
      $this->assertTrue($submit_matches, t('Found the @submit button', array('@submit' => $submit)));
      $this->fail(t('Found the requested form fields at @path', array('@path' => $path)));
1212 1213 1214
    }
  }

1215 1216 1217 1218 1219 1220 1221 1222
  /**
   * 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.
   *
   * @return
   *   Either the new page content or FALSE.
   */
1223
  protected function checkForMetaRefresh() {
1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
    if ($this->drupalGetContent() != '' && $this->parse()) {
      $refresh = $this->xpath('//meta[@http-equiv="Refresh"]');
      if (!empty($refresh)) {
        // Parse the content attribute of the meta tag for the format:
        // "[delay]: URL=[page_to_redirect_to]".
        if (preg_match('/\d+;\s*URL=(?P<url>.*)/i', $refresh[0]['content'], $match)) {
          return $this->drupalGet($this->getAbsoluteUrl(decode_entities($match['url'])));
        }
      }
    }
    return FALSE;
  }

1237 1238 1239 1240 1241 1242 1243
  /**
   * Retrieves only the headers for a Drupal path or an absolute path.
   *
   * @param $path
   *   Drupal path or URL to load into internal browser
   * @param $options
   *   Options to be forwarded to url().
1244 1245 1246
   * @param $headers
   *   An array containing additional HTTP request headers, each formatted as
   *   "name: value".
1247 1248 1249
   * @return
   *   The retrieved headers, also available as $this->drupalGetContent()
   */
1250
  protected function drupalHead($path, array $options = array(), array $headers = array()) {
1251
    $options['absolute'] = TRUE;
1252
    $out = $this->curlExec(array(CURLOPT_NOBODY => TRUE, CURLOPT_URL => url($path, $options), CURLOPT_HTTPHEADER => $headers));
1253 1254 1255 1256
    $this->refreshVariables(); // Ensure that any changes to variables in the other thread are picked up.
    return $out;
  }

1257 1258
  /**
   * Handle form input related to drupalPost(). Ensure that the specified fields
1259
   * exist and attempt to create POST data in the correct manner for the particular
1260 1261
   * field type.
   *
1262
   * @param $post
1263
   *   Reference to array of post values.
1264
   * @param $edit
1265
   *   Reference to array of edit values to be checked against the form.
1266
   * @param $submit
1267
   *   Form submit button value.
1268
   * @param $form
1269
   *   Array of form elements.