upgrade to OpenPublish 7.x-1.0-alpha9
[eupraxis:fsrn.git] / openpublish / modules / simpletest / simpletest.module
1 <?php
2
3 /**
4  * @file
5  * Provides testing functionality.
6  */
7
8 /**
9  * Implements hook_help().
10  */
11 function simpletest_help($path, $arg) {
12   switch ($path) {
13     case 'admin/help#simpletest':
14       $output = '';
15       $output .= '<h3>' . t('About') . '</h3>';
16       $output .= '<p>' . t('The Testing module provides a framework for running automated unit tests. 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. For more information, see the online handbook entry for <a href="@simpletest">Testing module</a>.', array('@simpletest' => 'http://drupal.org/documentation/modules/simpletest', '@blocks' => url('admin/structure/block'))) . '</p>';
17       $output .= '<h3>' . t('Uses') . '</h3>';
18       $output .= '<dl>';
19       $output .= '<dt>' . t('Running tests') . '</dt>';
20       $output .= '<dd>' . t('Visit the <a href="@admin-simpletest">Testing page</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. For more information on creating and modifying your own tests, see the <a href="@simpletest-api">Testing API Documentation</a> in the Drupal handbook.', array('@simpletest-api' => 'http://drupal.org/simpletest', '@admin-simpletest' => url('admin/config/development/testing'))) . '</dd>';
21       $output .= '<dd>' . t('After the tests 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 the 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 failures or exceptions, the results will be expanded to show details, and the tests that had failures or exceptions will be indicated in red or pink rows. You can then use these results to refine your code and tests, until all tests pass.') . '</dd>';
22       $output .= '</dl>';
23       return $output;
24   }
25 }
26
27 /**
28  * Implements hook_menu().
29  */
30 function simpletest_menu() {
31   $items['admin/config/development/testing'] = array(
32     'title' => 'Testing',
33     'page callback' => 'drupal_get_form',
34     'page arguments' => array('simpletest_test_form'),
35     'description' => 'Run tests against Drupal core and your active modules. These tests help assure that your site code is working as designed.',
36     'access arguments' => array('administer unit tests'),
37     'file' => 'simpletest.pages.inc',
38     'weight' => -5,
39   );
40   $items['admin/config/development/testing/list'] = array(
41     'title' => 'List',
42     'type' => MENU_DEFAULT_LOCAL_TASK,
43   );
44   $items['admin/config/development/testing/settings'] = array(
45     'title' => 'Settings',
46     'page callback' => 'drupal_get_form',
47     'page arguments' => array('simpletest_settings_form'),
48     'access arguments' => array('administer unit tests'),
49     'type' => MENU_LOCAL_TASK,
50     'file' => 'simpletest.pages.inc',
51   );
52   $items['admin/config/development/testing/results/%'] = array(
53     'title' => 'Test result',
54     'page callback' => 'drupal_get_form',
55     'page arguments' => array('simpletest_result_form', 5),
56     'description' => 'View result of tests.',
57     'access arguments' => array('administer unit tests'),
58     'file' => 'simpletest.pages.inc',
59   );
60   return $items;
61 }
62
63 /**
64  * Implements hook_permission().
65  */
66 function simpletest_permission() {
67   return array(
68     'administer unit tests' => array(
69       'title' => t('Administer tests'),
70       'restrict access' => TRUE,
71     ),
72   );
73 }
74
75 /**
76  * Implements hook_theme().
77  */
78 function simpletest_theme() {
79   return array(
80     'simpletest_test_table' => array(
81       'render element' => 'table',
82       'file' => 'simpletest.pages.inc',
83     ),
84     'simpletest_result_summary' => array(
85       'render element' => 'form',
86       'file' => 'simpletest.pages.inc',
87     ),
88   );
89 }
90
91 /**
92  * Implements hook_js_alter().
93  */
94 function simpletest_js_alter(&$javascript) {
95   // Since SimpleTest is a special use case for the table select, stick the
96   // SimpleTest JavaScript above the table select.
97   $simpletest = drupal_get_path('module', 'simpletest') . '/simpletest.js';
98   if (array_key_exists($simpletest, $javascript) && array_key_exists('misc/tableselect.js', $javascript)) {
99     $javascript[$simpletest]['weight'] = $javascript['misc/tableselect.js']['weight'] - 1;
100   }
101 }
102
103 function _simpletest_format_summary_line($summary) {
104   $args = array(
105     '@pass' => format_plural(isset($summary['#pass']) ? $summary['#pass'] : 0, '1 pass', '@count passes'),
106     '@fail' => format_plural(isset($summary['#fail']) ? $summary['#fail'] : 0, '1 fail', '@count fails'),
107     '@exception' => format_plural(isset($summary['#exception']) ? $summary['#exception'] : 0, '1 exception', '@count exceptions'),
108   );
109   if (!$summary['#debug']) {
110     return t('@pass, @fail, and @exception', $args);
111   }
112   $args['@debug'] = format_plural(isset($summary['#debug']) ? $summary['#debug'] : 0, '1 debug message', '@count debug messages');
113   return t('@pass, @fail, @exception, and @debug', $args);
114 }
115
116 /**
117  * Actually runs tests.
118  *
119  * @param $test_list
120  *   List of tests to run.
121  * @param $reporter
122  *   Which reporter to use. Allowed values are: text, xml, html and drupal,
123  *   drupal being the default.
124  */
125 function simpletest_run_tests($test_list, $reporter = 'drupal') {
126   $test_id = db_insert('simpletest_test_id')
127     ->useDefaults(array('test_id'))
128     ->execute();
129
130   // Clear out the previous verbose files.
131   file_unmanaged_delete_recursive('public://simpletest/verbose');
132
133   // Get the info for the first test being run.
134   $first_test = array_shift($test_list);
135   $first_instance = new $first_test();
136   array_unshift($test_list, $first_test);
137   $info = $first_instance->getInfo();
138
139   $batch = array(
140     'title' => t('Running tests'),
141     'operations' => array(
142       array('_simpletest_batch_operation', array($test_list, $test_id)),
143     ),
144     'finished' => '_simpletest_batch_finished',
145     'progress_message' => '',
146     'css' => array(drupal_get_path('module', 'simpletest') . '/simpletest.css'),
147     'init_message' => t('Processing test @num of @max - %test.', array('%test' => $info['name'], '@num' => '1', '@max' => count($test_list))),
148   );
149   batch_set($batch);
150
151   module_invoke_all('test_group_started');
152
153   return $test_id;
154 }
155
156 /**
157  * Batch operation callback.
158  */
159 function _simpletest_batch_operation($test_list_init, $test_id, &$context) {
160   // Get working values.
161   if (!isset($context['sandbox']['max'])) {
162     // First iteration: initialize working values.
163     $test_list = $test_list_init;
164     $context['sandbox']['max'] = count($test_list);
165     $test_results = array('#pass' => 0, '#fail' => 0, '#exception' => 0, '#debug' => 0);
166   }
167   else {
168     // Nth iteration: get the current values where we last stored them.
169     $test_list = $context['sandbox']['tests'];
170     $test_results = $context['sandbox']['test_results'];
171   }
172   $max = $context['sandbox']['max'];
173
174   // Perform the next test.
175   $test_class = array_shift($test_list);
176   $test = new $test_class($test_id);
177   $test->run();
178   $size = count($test_list);
179   $info = $test->getInfo();
180
181   module_invoke_all('test_finished', $test->results);
182
183   // Gather results and compose the report.
184   $test_results[$test_class] = $test->results;
185   foreach ($test_results[$test_class] as $key => $value) {
186     $test_results[$key] += $value;
187   }
188   $test_results[$test_class]['#name'] = $info['name'];
189   $items = array();
190   foreach (element_children($test_results) as $class) {
191     array_unshift($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>');
192   }
193   $context['message'] = t('Processed test @num of @max - %test.', array('%test' => $info['name'], '@num' => $max - $size, '@max' => $max));
194   $context['message'] .= '<div class="simpletest-' . ($test_results['#fail'] + $test_results['#exception'] ? 'fail' : 'pass') . '">Overall results: ' . _simpletest_format_summary_line($test_results) . '</div>';
195   $context['message'] .= theme('item_list', array('items' => $items));
196
197   // Save working values for the next iteration.
198   $context['sandbox']['tests'] = $test_list;
199   $context['sandbox']['test_results'] = $test_results;
200   // The test_id is the only thing we need to save for the report page.
201   $context['results']['test_id'] = $test_id;
202
203   // Multistep processing: report progress.
204   $context['finished'] = 1 - $size / $max;
205 }
206
207 function _simpletest_batch_finished($success, $results, $operations, $elapsed) {
208   if ($success) {
209     drupal_set_message(t('The test run finished in @elapsed.', array('@elapsed' => $elapsed)));
210   }
211   else {
212     // Use the test_id passed as a parameter to _simpletest_batch_operation().
213     $test_id = $operations[0][1][1];
214
215     // Retrieve the last database prefix used for testing and the last test
216     // class that was run from. Use the information to read the lgo file
217     // in case any fatal errors caused the test to crash.
218     list($last_prefix, $last_test_class) = simpletest_last_test_get($test_id);
219     simpletest_log_read($test_id, $last_prefix, $last_test_class);
220
221     drupal_set_message(t('The test run did not successfully finish.'), 'error');
222     drupal_set_message(t('Use the <em>Clean environment</em> button to clean-up temporary files and tables.'), 'warning');
223   }
224   module_invoke_all('test_group_finished');
225 }
226
227 /**
228  * Get information about the last test that ran given a test ID.
229  *
230  * @param $test_id
231  *   The test ID to get the last test from.
232  * @return
233  *   Array containing the last database prefix used and the last test class
234  *   that ran.
235  */
236 function simpletest_last_test_get($test_id) {
237   $last_prefix = db_query_range('SELECT last_prefix FROM {simpletest_test_id} WHERE test_id = :test_id', 0, 1, array(':test_id' => $test_id))->fetchField();
238   $last_test_class = db_query_range('SELECT test_class FROM {simpletest} WHERE test_id = :test_id ORDER BY message_id DESC', 0, 1, array(':test_id' => $test_id))->fetchField();
239   return array($last_prefix, $last_test_class);
240 }
241
242 /**
243  * Read the error log and report any errors as assertion failures.
244  *
245  * The errors in the log should only be fatal errors since any other errors
246  * will have been recorded by the error handler.
247  *
248  * @param $test_id
249  *   The test ID to which the log relates.
250  * @param $prefix
251  *   The database prefix to which the log relates.
252  * @param $test_class
253  *   The test class to which the log relates.
254  * @param $during_test
255  *   Indicates that the current file directory path is a temporary file
256  *   file directory used during testing.
257  * @return
258  *   Found any entries in log.
259  */
260 function simpletest_log_read($test_id, $prefix, $test_class, $during_test = FALSE) {
261   $log = 'public://' . ($during_test ? '' : '/simpletest/' . substr($prefix, 10)) . '/error.log';
262   $found = FALSE;
263   if (file_exists($log)) {
264     foreach (file($log) as $line) {
265       if (preg_match('/\[.*?\] (.*?): (.*?) in (.*) on line (\d+)/', $line, $match)) {
266         // Parse PHP fatal errors for example: PHP Fatal error: Call to
267         // undefined function break_me() in /path/to/file.php on line 17
268         $caller = array(
269           'line' => $match[4],
270           'file' => $match[3],
271         );
272         DrupalTestCase::insertAssert($test_id, $test_class, FALSE, $match[2], $match[1], $caller);
273       }
274       else {
275         // Unknown format, place the entire message in the log.
276         DrupalTestCase::insertAssert($test_id, $test_class, FALSE, $line, 'Fatal error');
277       }
278       $found = TRUE;
279     }
280   }
281   return $found;
282 }
283
284 /**
285  * Get a list of all of the tests provided by the system.
286  *
287  * The list of test classes is loaded from the registry where it looks for
288  * files ending in ".test". Once loaded the test list is cached and stored in
289  * a static variable. In order to list tests provided by disabled modules
290  * hook_registry_files_alter() is used to forcefully add them to the registry.
291  *
292  * @return
293  *   An array of tests keyed with the groups specified in each of the tests
294  *   getInfo() method and then keyed by the test class. An example of the array
295  *   structure is provided below.
296  *
297  *   @code
298  *     $groups['Blog'] => array(
299  *       'BlogTestCase' => array(
300  *         'name' => 'Blog functionality',
301  *         'description' => 'Create, view, edit, delete, ...',
302  *         'group' => 'Blog',
303  *       ),
304  *     );
305  *   @endcode
306  * @see simpletest_registry_files_alter()
307  */
308 function simpletest_test_get_all() {
309   $groups = &drupal_static(__FUNCTION__);
310
311   if (!$groups) {
312     // Load test information from cache if available, otherwise retrieve the
313     // information from each tests getInfo() method.
314     if ($cache = cache_get('simpletest', 'cache')) {
315       $groups = $cache->data;
316     }
317     else {
318       // Select all clases in files ending with .test.
319       $classes = db_query("SELECT name FROM {registry} WHERE type = :type AND filename LIKE :name", array(':type' => 'class', ':name' => '%.test'))->fetchCol();
320
321       // Check that each class has a getInfo() method and store the information
322       // in an array keyed with the group specified in the test information.
323       $groups = array();
324       foreach ($classes as $class) {
325         // Test classes need to implement getInfo() to be valid.
326         if (class_exists($class) && method_exists($class, 'getInfo')) {
327           $info = call_user_func(array($class, 'getInfo'));
328
329           // If this test class requires a non-existing module, skip it.
330           if (!empty($info['dependencies'])) {
331             foreach ($info['dependencies'] as $module) {
332               if (!drupal_get_filename('module', $module)) {
333                 continue 2;
334               }
335             }
336           }
337
338           $groups[$info['group']][$class] = $info;
339         }
340       }
341
342       // Sort the groups and tests within the groups by name.
343       uksort($groups, 'strnatcasecmp');
344       foreach ($groups as $group => &$tests) {
345         uksort($tests, 'strnatcasecmp');
346       }
347
348       // Allow modules extending core tests to disable originals.
349       drupal_alter('simpletest', $groups);
350       cache_set('simpletest', $groups);
351     }
352   }
353   return $groups;
354 }
355
356 /**
357  * Implements hook_registry_files_alter().
358  *
359  * Add the test files for disabled modules so that we get a list containing
360  * all the avialable tests.
361  */
362 function simpletest_registry_files_alter(&$files, $modules) {
363   foreach ($modules as $module) {
364     // Only add test files for disabled modules, as enabled modules should
365     // already include any test files they provide.
366     if (!$module->status) {
367       $dir = $module->dir;
368       if (!empty($module->info['files'])) {
369         foreach ($module->info['files'] as $file) {
370           if (substr($file, -5) == '.test') {
371             $files["$dir/$file"] = array('module' => $module->name, 'weight' => $module->weight);
372           }
373         }
374       }
375     }
376   }
377 }
378
379 /**
380  * Generate test file.
381  */
382 function simpletest_generate_file($filename, $width, $lines, $type = 'binary-text') {
383   $size = $width * $lines - $lines;
384
385   // Generate random text
386   $text = '';
387   for ($i = 0; $i < $size; $i++) {
388     switch ($type) {
389       case 'text':
390         $text .= chr(rand(32, 126));
391         break;
392       case 'binary':
393         $text .= chr(rand(0, 31));
394         break;
395       case 'binary-text':
396       default:
397         $text .= rand(0, 1);
398         break;
399     }
400   }
401   $text = wordwrap($text, $width - 1, "\n", TRUE) . "\n"; // Add \n for symmetrical file.
402
403   // Create filename.
404   file_put_contents('public://' . $filename . '.txt', $text);
405   return $filename;
406 }
407
408 /**
409  * Remove all temporary database tables and directories.
410  */
411 function simpletest_clean_environment() {
412   simpletest_clean_database();
413   simpletest_clean_temporary_directories();
414   if (variable_get('simpletest_clear_results', TRUE)) {
415     $count = simpletest_clean_results_table();
416     drupal_set_message(format_plural($count, 'Removed 1 test result.', 'Removed @count test results.'));
417   }
418   else {
419     drupal_set_message(t('Clear results is disabled and the test results table will not be cleared.'), 'warning');
420   }
421
422   // Detect test classes that have been added, renamed or deleted.
423   registry_rebuild();
424   cache_clear_all('simpletest', 'cache');
425 }
426
427 /**
428  * Removed prefixed tables from the database that are left over from crashed tests.
429  */
430 function simpletest_clean_database() {
431   $tables = db_find_tables(Database::getConnection()->prefixTables('{simpletest}') . '%');
432   $schema = drupal_get_schema_unprocessed('simpletest');
433   $count = 0;
434   foreach (array_diff_key($tables, $schema) as $table) {
435     // Strip the prefix and skip tables without digits following "simpletest",
436     // e.g. {simpletest_test_id}.
437     if (preg_match('/simpletest\d+.*/', $table, $matches)) {
438       db_drop_table($matches[0]);
439       $count++;
440     }
441   }
442
443   if ($count > 0) {
444     drupal_set_message(format_plural($count, 'Removed 1 leftover table.', 'Removed @count leftover tables.'));
445   }
446   else {
447     drupal_set_message(t('No leftover tables to remove.'));
448   }
449 }
450
451 /**
452  * Find all leftover temporary directories and remove them.
453  */
454 function simpletest_clean_temporary_directories() {
455   $count = 0;
456   if (is_dir('public://simpletest')) {
457     $files = scandir('public://simpletest');
458     foreach ($files as $file) {
459       $path = 'public://simpletest/' . $file;
460       if (is_dir($path) && is_numeric($file)) {
461         file_unmanaged_delete_recursive($path);
462         $count++;
463       }
464     }
465   }
466
467   if ($count > 0) {
468     drupal_set_message(format_plural($count, 'Removed 1 temporary directory.', 'Removed @count temporary directories.'));
469   }
470   else {
471     drupal_set_message(t('No temporary directories to remove.'));
472   }
473 }
474
475 /**
476  * Clear the test result tables.
477  *
478  * @param $test_id
479  *   Test ID to remove results for, or NULL to remove all results.
480  * @return
481  *   The number of results removed.
482  */
483 function simpletest_clean_results_table($test_id = NULL) {
484   if (variable_get('simpletest_clear_results', TRUE)) {
485     if ($test_id) {
486       $count = db_query('SELECT COUNT(test_id) FROM {simpletest_test_id} WHERE test_id = :test_id', array(':test_id' => $test_id))->fetchField();
487
488       db_delete('simpletest')
489         ->condition('test_id', $test_id)
490         ->execute();
491       db_delete('simpletest_test_id')
492         ->condition('test_id', $test_id)
493         ->execute();
494     }
495     else {
496       $count = db_query('SELECT COUNT(test_id) FROM {simpletest_test_id}')->fetchField();
497
498       // Clear test results.
499       db_delete('simpletest')->execute();
500       db_delete('simpletest_test_id')->execute();
501     }
502
503     return $count;
504   }
505   return 0;
506 }
507
508 /**
509  * Implements hook_mail_alter().
510  *
511  * Aborts sending of messages with ID 'simpletest_cancel_test'.
512  *
513  * @see MailTestCase::testCancelMessage()
514  */
515 function simpletest_mail_alter(&$message) {
516   if ($message['id'] == 'simpletest_cancel_test') {
517     $message['send'] = FALSE;
518   }
519 }