Index: INSTALL.txt
===================================================================
RCS file: /cvs/drupal/contributions/modules/simpletest/INSTALL.txt,v
retrieving revision 1.5
diff -u -p -r1.5 INSTALL.txt
--- INSTALL.txt 28 May 2006 14:55:58 -0000 1.5
+++ INSTALL.txt 21 Jan 2008 01:40:29 -0000
@@ -1,9 +1,18 @@
-Install
------------------------
+$Id$
-- Copy this module package to your modules directory
-- Install the simpletest framework to a new subdirectory of simpletest module: modules/simpletest/simpletest
- You can find it at https://sourceforge.net/project/showfiles.php?group_id=76550
-- At least Version 1.0.1 alpha3 of the simpletest framework is required (for upload tests).
-- Activate the simpletest.module
-- Visit the admin/simpletest page
\ No newline at end of file
+Installation
+------------
+1. Uncompress the SimpleTest module package to your sites/all/modules directory.
+2. Download the latest SimpleTest package from SourceForge.net:
+ https://sourceforge.net/project/showfiles.php?group_id=76550&package_id=77275
+ Note: At least version 1.0.1 alpha3 is required (for upload tests)
+3. Uncompress it inside your SimpleTest module directory:
+ sites/all/modules/simpletest/simpletest
+4. Go to Administer >> Site Building >> Modules (admin/build/modules) and
+ enable the SimpleTest module.
+5. Go to Administer >> Site building >> SimpleTest (admin/build/simpletest) to
+ begin using the module.
+6. (Optional) Go to Administer >> Help >> SimpleTest (admin/help/simpletest) fo
+ more information on how to use the SimpleTest module.
+7. (Optional) Go to Administer >> Site configuration >> SimpleTest
+ (admin/settings/simpletest) to configure advanced settings.
Index: README.txt
===================================================================
RCS file: /cvs/drupal/contributions/modules/simpletest/README.txt,v
retrieving revision 1.11
diff -u -p -r1.11 README.txt
--- README.txt 3 Jan 2008 10:11:22 -0000 1.11
+++ README.txt 21 Jan 2008 01:40:29 -0000
@@ -1,42 +1,46 @@
+$Id$
+
Description
------------------------
+-----------
A framework for running unit tests in Drupal.
USAGE WARNING
------------------------
+-------------
NEVER USE THIS MODULE IN A PRODUCTION ENVIRONMENT!
While running a test this module may (completely) change your Drupal setup.
Though it usually recovers the original setup at the end of a test, there is
no guarantee that it will work correctly, especially if an error or timeout
occurs.
-Since all registered users have the registered users role this role
-MUST have the default settings for current tests to run correct.
-This also applies for anonymous user.
-
-
Status
------------------------
-Some core tests have been written - see the /tests subdirectory. We need more,
-especially for contributed modules.
-
-Simpletest hook
------------------------
-This module offers a new 'simpletest' hook. Modules implementing this hook should return an array of paths which
-point to test files. These paths should be relative to the /simpletest directory.
-
-Writing Tests
------------------------
-Please write some tests.
-See http://drupal.org/simpletest
-
-Authors
------------------------
-Moshe Weitzman < weitzman at tejasa dot com >
-Kuba Zygmunt < kuba.zygmunt at gmail dot com >
-Thomas Ilsche < ThomasIlsche at gmx dot de >
+------
+Drupal core tests are in the /tests subdirectory. We need people to help
+expand our library of core tests, as well as provide tests for contributed
+modules.
+
+Documentation
+-------------
+* Official SimpleTest documentation:
+ http://simpletest.org/en/start-testing.html
+* SimpleTest module API documentation:
+ http://drupal.org/simpletest
+* An Introduction to Unit Testing in Drupal:
+ http://www.lullabot.com/articles/introduction-unit-testing
+* A Drupal Module Developer's Guide to SimpleTest:
+ http://www.lullabot.com/articles/drupal-module-developer-guide-simpletest
+
+Module Authors
+--------------
+* Moshe Weitzman < weitzman at tejasa dot com >
+* Kuba Zygmunt < kuba.zygmunt at gmail dot com >
+* Thomas Ilsche < ThomasIlsche at gmx dot de >
+* Rok Zlender < rok.zlender at gmail dot com >
Thanks
------------------------
-to Google for sponsoring the testsuite Summer of Code project.
-see http://code.google.com/summerofcode.html
+------
+* Google for sponsoring the initial test suite (and subsequent improvements)
+ as Summer of Code projects:
+ http://code.google.com/soc/
+* Google and all students/mentors involved in the creation of a huge set of
+ core tests during the Google Highly Open Participation contest:
+ http://code.google.com/opensource/ghop/
Index: simpletest.module
===================================================================
RCS file: /cvs/drupal/contributions/modules/simpletest/simpletest.module,v
retrieving revision 1.32
diff -u -p -r1.32 simpletest.module
--- simpletest.module 11 Jan 2008 17:03:04 -0000 1.32
+++ simpletest.module 21 Jan 2008 01:40:32 -0000
@@ -2,18 +2,33 @@
// $Id: simpletest.module,v 1.32 2008/01/11 17:03:04 rokZlender Exp $
/**
+ * Implementation of hook_help().
+ */
+function simpletest_help($path, $arg) {
+ switch ($path) {
+ case 'admin/help#simpletest':
+ $output = ''. 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. It integrates with the SimpleTest PHP library.', array('@simpletest-official' => 'http://www.simpletest.org/')) .'
';
+ $output .= ''. t('To begin, visit Administer >> Site building >> SimpleTest to bring up the main screen. Here, you will see a list of available test groups, which may be checked off individually to run a subset whose results you are interested in. You may also choose to run all tests (which will take several minutes to finish), if you are interested in more comprehensive results.', array('@admin-simpletest' => url('admin/build/simpletest'))) .'
';
+ $output .= ''. 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 intended test results happened as expected. A fail means that they 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. These results can then be used to make refinements in the code and tests until a 100% success rate is achieved.') .'
';
+ $output .= ''. t('Extensive API documentation for developers who wish to write tests for their own modules is available at SimpleTest API Documentation in the Drupal handbook.', array('@simpletest-api' => 'http://drupal.org/simpletest')) .'
';
+ $output .= ''. t('For more information, see the online handbook entry for SimpleTest module.', array('@simpletest' => 'http://drupal.org/handbook/modules/simpletest')) .'
';
+ return $output;
+ }
+}
+
+/**
* Implementation of hook_menu().
*/
function simpletest_menu() {
$items['admin/build/simpletest'] = array(
- 'title' => 'Simpletest unit testing',
+ 'title' => 'Simpletest',
'page callback' => 'simpletest_entrypoint',
- 'description' => t('Run tests against Drupal core and your active modules. These tests help assure that your site code is working as designed.'),
+ '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'),
);
$items['admin/settings/simpletest'] = array(
- 'title' => t('Simpletest settings'),
- 'description' => t('Configure unit testing framework.'),
+ 'title' => 'Simpletest settings',
+ 'description' => 'Configure unit testing framework.',
'page callback' => 'drupal_get_form',
'page arguments' => array('simpletest_settings'),
'access arguments' => array('access administration pages'),