simpletest.module 20.7 KB
Newer Older
1 2 3 4 5 6 7 8 9
<?php
// $Id$

/**
 * Implementation of hook_help().
 */
function simpletest_help($path, $arg) {
  switch ($path) {
    case 'admin/help#simpletest':
10 11 12 13 14
      $output  = '<p>' . t('The SimpleTest module is a framework for running automated unit tests in Drupal. It can be used to verify a working state of Drupal before and after any code changes, or as a means for developers to write and execute tests for their modules.') .'</p>';
      $output .= '<p>' . t('Visit <a href="@admin-simpletest">Administer >> Site building >> SimpleTest</a> to display a list of available tests. For comprehensive testing, select <em>all</em> tests, or individually select tests for more targeted testing. Note that it might take several minutes for all tests to complete.)', array('@admin-simpletest' => url('admin/build/testing'))) .'</p>';
      $output .= '<p>' . t('After the tests have run, a message will be displayed next to each test group indicating whether tests within it passed, failed, or had exceptions. A pass means that a test returned the expected results, while fail means that it did not. An exception normally indicates an error outside of the test, such as a PHP warning or notice. If there were fails or exceptions, the results are expanded, and the tests that had issues will be indicated in red or pink rows. Use these results to refine your code and tests until all tests return a pass.') .'</p>';
      $output .= '<p>' . t('For more information on creating and modifying your own tests, see the <a href="@simpletest-api">SimpleTest API Documentation</a> in the Drupal handbook.', array('@simpletest-api' => 'http://drupal.org/simpletest')) .'</p>';
      $output .= '<p>' . t('For more information, see the online handbook entry for <a href="@simpletest">SimpleTest module</a>.', array('@simpletest' => 'http://drupal.org/handbook/modules/simpletest')) .'</p>';
15 16 17 18 19 20 21 22 23 24
      return $output;
  }
}

/**
 * Implementation of hook_menu().
 */
function simpletest_menu() {
  $items['admin/build/testing'] = array(
    'title' => 'Testing',
25 26
    'page callback' => 'drupal_get_form',
    'page arguments' => array('simpletest_test_form'),
27 28 29 30 31 32 33 34 35 36 37
    'description' => 'Run tests against Drupal core and your active modules. These tests help assure that your site code is working as designed.',
    'access arguments' => array('administer unit tests'),
  );
  return $items;
}

/**
 * Implementation of hook_perm().
 */
function simpletest_perm() {
  return array(
38 39 40 41
    'administer unit tests' => array(
      'title' => t('Administer unit tests'),
      'description' => t('Manage and run automated testing. %warning', array('%warning' => t('Warning: Give to trusted roles only; this permission has security implications.'))),
    ),
42 43 44 45 46 47 48 49
  );
}

/**
 * Implemenation of hook_theme().
 */
function simpletest_theme() {
  return array(
50 51
    'simpletest_test_table' => array(
      'arguments' => array('table' => NULL)
52 53
    ),
    'simpletest_result_summary' => array(
54 55 56 57 58 59
      'arguments' => array('form' => NULL)
    ),
  );
}

/**
60
 * Menu callback for both running tests and listing possible tests
61
 */
62 63
function simpletest_test_form() {
  global $db_prefix, $db_prefix_original;
64

65
  $form = array();
66 67

  // List out all tests in groups for selection.
68 69 70
  $uncategorized_tests = simpletest_get_all_tests();
  $tests = simpletest_categorize_tests($uncategorized_tests);
  if (isset($_SESSION['test_id'])) {
71
    // Select all results using the active test ID used to group them.
72
    $results = db_query("SELECT * FROM {simpletest} WHERE test_id = %d ORDER BY test_class, message_id", $_SESSION['test_id']);
73

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
    $summary = array(
      '#theme' => 'simpletest_result_summary',
      '#pass' => 0,
      '#fail' => 0,
      '#exception' => 0,
      '#weight' => -10,
    );
    $form['summary'] = $summary;
    $form['results'] = array();
    $group_summary = array();
    $map = array(
      'pass' => theme('image', 'misc/watchdog-ok.png'),
      'fail' => theme('image', 'misc/watchdog-error.png'),
      'exception' => theme('image', 'misc/watchdog-warning.png'),
    );
    $header = array(t('Message'), t('Group'), t('Filename'), t('Line'), t('Function'), array('colspan' => 2, 'data' => t('Status')));
    while ($result = db_fetch_object($results)) {
      $class = $result->test_class;
      $info = $uncategorized_tests[$class]->getInfo();
      $group = $info['group'];
      if (!isset($group_summary[$group])) {
        $group_summary[$group] = $summary;
      }
      $element = &$form['results'][$group][$class];
      if (!isset($element)) {
        $element['summary'] = $summary;
      }
      $status = $result->status;
      // This reporter can only handle pass, fail and exception.
      if (isset($map[$status])) {
        $element['#title'] = $info['name'];
        $status_index = '#'. $status;
        $form['summary'][$status_index]++;
        $group_summary[$group][$status_index]++;
        $element['summary'][$status_index]++;
        $element['result_table']['#rows'][] = array(
          'data' => array(
            $result->message,
            $result->message_group,
            basename($result->file),
            $result->line,
115
            $result->function,
116 117 118 119 120 121
            $map[$status],
          ),
          'class' => "simpletest-$status",
        );
      }
      unset($element);
122
    }
123 124 125 126 127 128 129 130

    // Clear test results.
    if (variable_get('simpletest_clear_results', TRUE)) {
      db_query('DELETE FROM {simpletest} WHERE test_id = %d', $_SESSION['test_id']);
      db_query('DELETE FROM {simpletest_test_id} WHERE test_id = %d', $_SESSION['test_id']);
    }
    unset($_SESSION['test_id']);

131 132 133 134 135 136 137 138 139 140 141 142
    $all_ok = TRUE;
    foreach ($form['results'] as $group => &$elements) {
      $group_ok = TRUE;
      foreach ($elements as $class => &$element) {
        $info = $uncategorized_tests[$class]->getInfo();
        $ok = $element['summary']['#fail'] + $element['summary']['#exception'] == 0;
        $element += array(
          '#type' => 'fieldset',
          '#collapsible' => TRUE,
          '#collapsed' => $ok,
          '#description' => $info['description'],
        );
143
        $element['result_table']['#markup'] = theme('table', $header, $element['result_table']['#rows']);
144 145 146 147 148 149 150 151 152 153 154 155
        $element['summary']['#ok'] = $ok;
        $group_ok = $group_ok && $ok;
      }
      $elements += array(
        '#type' => 'fieldset',
        '#title' => $group,
        '#collapsible' => TRUE,
        '#collapsed' => $group_ok,
        'summary' => $group_summary[$group],
      );
      $elements['summary']['#ok'] = $group_ok;
      $all_ok = $group_ok && $all_ok;
156
    }
157
    $form['summary']['#ok'] = $all_ok;
158
  }
159 160 161 162 163 164 165 166
  $form['tests'] = array(
    '#type' => 'fieldset',
    '#title' => t('Tests'),
    '#description' => t('Select the tests you would like to run, and click Run tests.'),
  );
  $form['tests']['table'] = array(
    '#theme' => 'simpletest_test_table'
    );
167 168
  foreach ($tests as $group_name => $test_group) {
    foreach ($test_group as $test) {
169
      $test_info = $test->getInfo();
170
      $test_class = get_class($test);
171
      $form['tests']['table'][$group_name][$test_class] = array(
172 173 174 175 176 177 178 179
        '#type' => 'checkbox',
        '#title' => $test_info['name'],
        '#default_value' => 0,
        '#description' => $test_info['description'],
      );
    }
  }

180 181
  // Action buttons.
  $form['tests']['op'] = array(
182 183 184
    '#type' => 'submit',
    '#value' => t('Run tests'),
  );
185
  $form['reset'] = array(
186 187 188 189
    '#type' => 'fieldset',
    '#collapsible' => FALSE,
    '#collapsed' => FALSE,
    '#title' => t('Clean test environment'),
190
    '#description' => t('Remove tables with the prefix "simpletest" and temporary directories that are left over from tests that crashed. This is intended for developers when creating tests.'),
191
  );
192
  $form['reset']['op'] = array(
193 194
    '#type' => 'submit',
    '#value' => t('Clean environment'),
195
    '#submit' => array('simpletest_clean_environment'),
196
  );
197

198
  return $form;
199 200
}

201
function theme_simpletest_test_table($table) {
202
  drupal_add_css(drupal_get_path('module', 'simpletest') . '/simpletest.css');
203 204 205
  drupal_add_js(drupal_get_path('module', 'simpletest') . '/simpletest.js', 'module');

  // Create header for test selection table.
206
  $header = array(
207 208 209
  theme('table_select_header_cell'),
  array('data' => t('Test'), 'class' => 'simpletest_test'),
  array('data' => t('Description'), 'class' => 'simpletest_description'),
210
  );
211 212

  // Define the images used to expand/collapse the test groups.
213 214
  $js = array(
    'images' => array(
215 216 217
  theme('image', 'misc/menu-collapsed.png', 'Expand', 'Expand'),
  theme('image', 'misc/menu-expanded.png', 'Collapsed', 'Collapsed'),
  ),
218 219
  );

220
  // Go through each test group and create a row.
221
  $rows = array();
222 223
  foreach (element_children($table) as $key) {
    $element = &$table[$key];
224
    $row = array();
225 226 227 228 229 230

    // Make the class name safe for output on the pace by replacing all
    // non-word/decimal characters with a dash (-).
    $test_class = strtolower(trim(preg_replace("/[^\w\d]/", "-", $key)));

    // Place-holder for checkboxes to select group of tests.
231
    $row[] = array('id' => $test_class, 'class' => 'simpletest-select-all');
232 233

    // Expand/collapse image and group title.
234
    $row[] = array(
235
      'data' =>  '<div class="simpletest-image" id="simpletest-test-group-' . $test_class . '"></div>&nbsp;' .
236
                 '<label for="' . $test_class . '-select-all" class="simpletest-group-label">' . $key . '</label>',
237
      'style' => 'font-weight: bold;'
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
      );

      $row[] = isset($element['#description']) ? $element['#description'] : '&nbsp;';
      $rows[] = array('data' => $row, 'class' => 'simpletest-group');

      // Add individual tests to group.
      $current_js = array('testClass' => $test_class . '-test', 'testNames' => array(), 'imageDirection' => 0, 'clickActive' => FALSE);
      foreach (element_children($element) as $test_name) {
        $test = $element[$test_name];
        $row = array();

        $current_js['testNames'][] = 'edit-' . $test_name;

        // Store test title and description so that checkbox won't render them.
        $title = $test['#title'];
        $description = $test['#description'];

        unset($test['#title']);
        unset($test['#description']);

        // Test name is used to determine what tests to run.
        $test['#name'] = $test_name;

        $row[] = drupal_render($test);
        $row[] = theme('indentation', 1) . '<label for="edit-' . $test_name . '">' . $title . '</label>';
        $row[] = '<div class="description">' . $description . '</div>';
264
        $rows[] = array('data' => $row, 'class' => $test_class . '-test js-hide');
265
      }
266 267
      $js['simpletest-test-group-'. $test_class] = $current_js;
      unset($table[$key]);
268
  }
269 270

  // Add js array of settings.
271
  drupal_add_js(array('simpleTest' => $js), 'setting');
272 273 274

  if (empty($rows)) {
    return '<strong>' . t('No tests to display.') . '</strong>';
275
  }
276
  else {
277
    return theme('table', $header, $rows, array('id' => 'simpletest-form-table'));
278 279 280
  }
}

281 282 283 284 285 286 287 288 289 290 291 292
function theme_simpletest_result_summary($form, $text = NULL) {
  return '<div class="simpletest-'. ($form['#ok'] ? 'pass' : 'fail') .'">' . _simpletest_format_summary_line($form) . '</div>';
}

function _simpletest_format_summary_line($summary) {
  return t('@pass, @fail, @exception', array(
    '@pass' => format_plural(isset($summary['#pass']) ? $summary['#pass'] : 0, '1 pass', '@count passes'),
    '@fail' => format_plural(isset($summary['#fail']) ? $summary['#fail'] : 0, '1 fail', '@count fails'),
    '@exception' => format_plural(isset($summary['#exception']) ? $summary['#exception'] : 0, '1 exception', '@count exceptions'),
  ));
}

293
/**
294
 * Run selected tests.
295
 */
296
function simpletest_test_form_submit($form, &$form_state) {
297
  // Ensure that all classes are loaded before we create instances to get test information and run.
298
  simpletest_get_all_tests();
299 300 301

  // Get list of tests.
  $tests_list = array();
302
  foreach ($form_state['values'] as $class_name => $value) {
303
    if (class_exists($class_name) && $value === 1) {
304 305 306 307
      $tests_list[] = $class_name;
    }
  }
  if (count($tests_list) > 0 ) {
308
    simpletest_run_tests($tests_list, 'drupal');
309 310
  }
  else {
311
    drupal_set_message(t('No test(s) selected.'), 'error');
312 313 314 315
  }
}

/**
316 317 318 319 320 321
 * Actually runs tests
 * @param $test_list
 *   List of tests to run.
 * @param $reporter
 *   Which reporter to use. Allowed values are: text, xml, html and drupal,
 *   drupal being the default.
322
 */
323
function simpletest_run_tests($test_list, $reporter = 'drupal') {
324 325
  global $db_prefix, $db_prefix_original;
  cache_clear_all();
326
  $test_id = db_insert('simpletest_test_id')->useDefaults(array('test_id'))->execute();
327

328 329 330 331
  $batch = array(
    'title' => t('Running SimpleTests'),
    'operations' => array(
      array('_simpletest_batch_operation', array($test_list, $test_id)),
332
    ),
333 334 335 336 337 338 339
    'finished' => '_simpletest_batch_finished',
    'redirect' => 'admin/build/testing',
    'progress_message' => t('Processing tests.'),
    'css' => array(drupal_get_path('module', 'simpletest') . '/simpletest.css'),
    'init_message' => t('SimpleTest is initializing...') . ' ' . format_plural(count($test_list), "one test case will run.", "@count test cases will run."),
  );
  batch_set($batch);
340 341 342 343 344 345 346
  // Normally, the forms portion of the batch API takes care of calling
  // batch_process(), but in the process it saves the whole $form into the
  // database (which is huge for the test selection form).
  // By calling batch_process() directly, we skip that behavior and ensure
  // that we don't exceed the size of data that can be sent to the database
  // (max_allowed_packet on MySQL).
  batch_process();
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
}

/**
 * Batch operation callback.
 */
function _simpletest_batch_operation($test_list_init, $test_id, &$context) {
  // Ensure that all classes are loaded before we unserialize some instances.
  simpletest_get_all_tests();

  // Get working values.
  if (!isset($context['sandbox']['max'])) {
    // First iteration: initialize working values.
    $test_list = $test_list_init;
    $context['sandbox']['max'] = count($test_list);
    $test_results = array('#pass' => 0, '#fail' => 0, '#exception' => 0);
  }
  else {
    // Nth iteration: get the current values where we last stored them.
    $test_list = $context['sandbox']['tests'];
    $test_results = $context['sandbox']['test_results'];
  }
  $max = $context['sandbox']['max'];

  // Perform the next test.
  $test_class = array_shift($test_list);
  $test = new $test_class($test_id);
  $test->run();
  $size = count($test_list);
  $info = $test->getInfo();

  // Gather results and compose the report.
  $test_results[$test_class] = $test->_results;
  foreach ($test_results[$test_class] as $key => $value) {
    $test_results[$key] += $value;
  }
  $test_results[$test_class]['#name'] = $info['name'];
  $items = array();
  foreach (element_children($test_results) as $class) {
    $items[] = '<div class="simpletest-' . ($test_results[$class]['#fail'] + $test_results[$class]['#exception'] ? 'fail' : 'pass') . '">' . t('@name: @summary', array('@name' => $test_results[$class]['#name'], '@summary' => _simpletest_format_summary_line($test_results[$class]))) . '</div>';
  }
  $message = t('Processed test @num of @max - %test.', array('%test' => $info['name'], '@num' => $max - $size, '@max' => $max));
  $message .= theme('item_list', $items);
  $context['message'] = $message;
  // TODO: Do we want a summary of all?

  // Save working values for the next iteration.
  $context['sandbox']['tests'] = $test_list;
  $context['sandbox']['test_results'] = $test_results;
  // The test_id is the only thing we need to save for the report page.
  $context['results']['test_id'] = $test_id;

  // Multistep processing: report progress.
  $context['finished'] = 1 - $size / $max;
}

function _simpletest_batch_finished($success, $results, $operations) {
  $_SESSION['test_id'] = $results['test_id'];
  if ($success) {
    drupal_set_message(t('The tests have finished running.'));
  }
  else {
    drupal_set_message(t('The tests did not successfully finish.'), 'error');
  }
}

/**
 * Get a list of all of the tests.
 *
 * @return
 *   An array of tests, with the class name as the keys and the instantiated
 *   versions of the classes as the values.
 */
function simpletest_get_all_tests() {
  static $formatted_classes;
  if (!isset($formatted_classes)) {
422
    require_once DRUPAL_ROOT . '/' . drupal_get_path('module', 'simpletest') . '/drupal_web_test_case.php';
423 424 425 426 427 428 429 430 431 432
    $files = array();
    foreach (array_keys(module_rebuild_cache()) as $module) {
      $module_path = drupal_get_path('module', $module);
      $test = $module_path . "/$module.test";
      if (file_exists($test)) {
        $files[] = $test;
      }

      $tests_directory = $module_path . '/tests';
      if (is_dir($tests_directory)) {
433
        foreach (file_scan_directory($tests_directory, '/\.test$/') as $file) {
434
          $files[] = $file->filename;
435 436
        }
      }
437 438 439 440
    }

    $existing_classes = get_declared_classes();
    foreach ($files as $file) {
441
      include_once DRUPAL_ROOT . '/' . $file;
442 443 444 445 446 447
    }
    $classes = array_values(array_diff(get_declared_classes(), $existing_classes));
    $formatted_classes = array();
    foreach ($classes as $key => $class) {
      if (method_exists($class, 'getInfo')) {
        $formatted_classes[$class] = new $class;
448
      }
449
    }
450
  }
451 452 453 454 455 456
  if (count($formatted_classes) == 0) {
    drupal_set_message('No test cases found.', 'error');
    return FALSE;
  }
  return $formatted_classes;
}
457

458 459 460 461 462 463 464 465 466 467 468 469 470
/**
 * Categorize the tests into groups.
 *
 * @param $tests
 *   A list of tests from simpletest_get_all_tests.
 * @see simpletest_get_all_tests.
 */
function simpletest_categorize_tests($tests) {
  $groups = array();
  foreach ($tests as $test => $instance) {
    $info = $instance->getInfo();
    $groups[$info['group']][$test] = $instance;
  }
471
  uksort($groups, 'strnatcasecmp');
472
  return $groups;
473 474 475 476 477 478 479 480
}

/**
 * Remove all temporary database tables and directories.
 */
function simpletest_clean_environment() {
  simpletest_clean_database();
  simpletest_clean_temporary_directories();
481
  simpletest_clean_results_table();
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
}

/**
 * Removed prefixed talbes from the database that are left over from crashed tests.
 */
function simpletest_clean_database() {
  $tables = simpletest_get_like_tables();

  $ret = array();
  foreach ($tables as $table) {
    db_drop_table($ret, $table);
  }

  if (count($ret) > 0) {
    drupal_set_message(t('Removed @count left over tables.', array('@count' => count($ret))));
  }
  else {
    drupal_set_message(t('No left over tables to remove.'));
  }
}

/**
 * Find all tables that are like the specified base table name.
 *
 * @param string $base_table Base table name.
 * @param boolean $count Return the table count instead of list of tables.
 * @return mixed Array of matching tables or count of tables.
 */
function simpletest_get_like_tables($base_table = 'simpletest', $count = FALSE) {
511 512 513
  global $db_prefix, $database;
  $connection_info = Database::getConnectionInfo();
  $database_name = $connection_info['default']['database'];
514
  $select = $count ? 'COUNT(table_name)' : 'table_name';
515 516 517 518
  $result = db_query("SELECT $select FROM information_schema.tables WHERE table_schema = :database AND table_name LIKE :table_name", array(
    ':database' => $database_name,
    ':table_name' => $db_prefix . $base_table . '%',
  ));
519
  $schema = drupal_get_schema_unprocessed('simpletest');
520 521 522 523 524 525

  if ($count) {
    return db_result($result);
  }
  $tables = array();
  while ($table = db_result($result)) {
526 527 528
    if (!isset($schema[$table])) {
      $tables[] = $table;
    }
529 530 531 532 533 534 535 536 537 538 539
  }
  return $tables;
}

/**
 * Find all left over temporary directories and remove them.
 */
function simpletest_clean_temporary_directories() {
  $files = scandir(file_directory_path());
  $count = 0;
  foreach ($files as $file) {
540
    $path = file_directory_path() . '/' . $file;
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
    if (is_dir($path) && preg_match('/^simpletest\d+/', $file)) {
      simpletest_clean_temporary_directory($path);
      $count++;
    }
  }

  if ($count > 0) {
    drupal_set_message(t('Removed @count temporary directories.', array('@count' => $count)));
  }
  else {
    drupal_set_message(t('No temporary directories to remove.'));
  }
}

/**
 * Remove all files from specified firectory and then remove directory.
 *
 * @param string $path Directory path.
 */
function simpletest_clean_temporary_directory($path) {
  $files = scandir($path);
  foreach ($files as $file) {
    if ($file != '.' && $file != '..') {
      $file_path = "$path/$file";
      if (is_dir($file_path)) {
        simpletest_clean_temporary_directory($file_path);
      }
      else {
569
        file_unmanaged_delete($file_path);
570 571 572 573 574
      }
    }
  }
  rmdir($path);
}
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589

/**
 * Clear the test results tables.
 */
function simpletest_clean_results_table() {
  if (variable_get('simpletest_clear_results', TRUE)) {
    $count = db_result(db_query('SELECT COUNT(test_id) FROM {simpletest_test_id}'));

    // Clear test results.
    db_query('DELETE FROM {simpletest}');
    db_query('DELETE FROM {simpletest_test_id}');

    drupal_set_message(t('Removed @count test results.', array('@count' => $count)));
  }
}