$Id: INSTALL.txt,v 1.6.4.12 2009-02-08 03:59:56 boombatower Exp $

AUTHOR
------
Jimmy Berry ("boombatower", http://drupal.org/user/214218)

INSTALLATION
------------
1. Add the following code to the bottom of your site's settings.php file. If
   you are running Windows make sure you encode the file with the UNIX
   standard.

   $GLOBALS['simpletest_installed'] = TRUE;
   if (preg_match("/^simpletest\d+$/", $_SERVER['HTTP_USER_AGENT'])) {
     $db_prefix = $_SERVER['HTTP_USER_AGENT'];
   }

2. (Optional)
   It is hightly recommonded, but not neccessary, that you add the following
   code to install.php at the beginning of install_main(). Should look like
   7.x branch of Drupal core.

   // The user agent header is used to pass a database prefix in the request when
   // running tests. However, for security reasons, it is imperative that no
   // installation be permitted using such a prefix.
   if (preg_match("/^simpletest\d+$/", $_SERVER['HTTP_USER_AGENT'])) {
     header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden');
     exit;
   }

3. (Optional)
   If there are any test modules they will be displayed on the admin modules
   page (admin/build/modules) unless the following code is added to
   modules/system/system.admin.inc in system_modules() just after:
   "$files = module_rebuild_cache();".

   // Remove hidden modules from display list.
   foreach ($files as $filename => $file) {
     if (!empty($file->info['hidden'])) {
       unset($files[$filename]);
     }
   }

4. (Optional)
   Apply the "Show fatal errors in tests" batch to misc/drupal.js if you want
   the reason for test failure to be displayed on the batch API screen. The
   patch can be found at: http://drupal.org/files/issues/313902-2.patch.

5. (Optional)
   Move/Copy the run-tests.sh file into the Drupal scripts folder. The script
   allows the tests to be run from the command line.

3. Go to Administer >> Site building >> Modules (admin/build/modules) and
   enable the SimpleTest module.

4. Go to Administer >> Site building >> Testing (admin/build/testing) to
   begin using the module.

5. (Optional)
   Go to Administer >> Help >> SimpleTest (admin/help/simpletest)
   for more information on how to use the SimpleTest module.