JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
Fix db_get_value after mysql->mysqli upgrade
[wfpl.git] / unit_tests.php
index 89b54dd..c0f101b 100644 (file)
@@ -1,25 +1,56 @@
 <?php
 
-#  Copyright (C) 2009 Jason Woofenden
-#
-#  This program is free software: you can redistribute it and/or modify
-#  it under the terms of the GNU General Public License as published by
-#  the Free Software Foundation, either version 3 of the License, or
-#  (at your option) any later version.
-#  
-#  This program is distributed in the hope that it will be useful,
-#  but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#  GNU General Public License for more details.
-#  
-#  You should have received a copy of the GNU General Public License
-#  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# This program is in the public domain within the United States. Additionally,
+# we waive copyright and related rights in the work worldwide through the CC0
+# 1.0 Universal public domain dedication, which can be found at
+# http://creativecommons.org/publicdomain/zero/1.0/
 
 
 # This file is for running unit tests. Either on wfpl or your own code.
 
-require_once('code/wfpl/template.php');
-require_once('code/wfpl/messages.php');
+require_once(__DIR__.'/'.'template.php');
+require_once(__DIR__.'/'.'messages.php');
+
+# call this to declare that a unit test has passed
+function unit_test_passed($msg) {
+       $GLOBALS['unit_tests_passed_msgs'][] = $msg;
+       $GLOBALS['unit_tests_passed'] += 1;
+}
+
+# call this to declare that a unit test has failed
+function unit_test_failed($msg) {
+       $GLOBALS['unit_tests_failed_msgs'][] = $msg;
+       $GLOBALS['unit_tests_failed'] += 1;
+}
+
+function backslashinate($str) {
+       return '"' . addcslashes($str, "\0..\37\"\\\177..\377") . '"';
+}
+
+function backslashinate_each($a) {
+       foreach($a as &$v) {
+               $v = backslashinate($v);
+       }
+
+       return $a;
+}
+       
+
+# use this function to unit-test a function
+# real prototype: ($name, $args..., $correct)
+function unit_test_func() {
+       $args = func_get_args();
+       $function = array_shift($args);
+       $correct = array_pop($args);
+       $result = call_user_func_array($function, $args);
+       $message = "$function(" . join(', ', backslashinate_each($args)) . ") returned " . backslashinate($result);
+       if($result === $correct) {
+               unit_test_passed($message);
+       } else {
+               unit_test_failed($message . " instead of " . backslashinate($correct));
+       }
+}
+
 
 function file_run_unit_tests($filename) {
        require_once($filename);
@@ -36,22 +67,40 @@ function file_run_unit_tests($filename) {
 # tests in that file. It should print a message() about each test that failed,
 # and return the number of tests that failed.
 function run_unit_tests($directory, $basenames) {
-       $errors = 0;
+       $files = array();
+       $GLOBALS['unit_tests_passed'] = 0;
+       $GLOBALS['unit_tests_failed'] = 0;
        $basenames = explode(' ', $basenames);
        foreach($basenames as $basename) {
+               $GLOBALS['unit_tests_passed_msgs'] = array();
+               $GLOBALS['unit_tests_failed_msgs'] = array();
+               $already_passed = $GLOBALS['unit_tests_passed'];
+               $already_failed = $GLOBALS['unit_tests_failed'];
                $filename = "$directory/$basename.php";
-               message("running tests in $filename");
-               $errors += file_run_unit_tests($filename);
+               file_run_unit_tests($filename);
+               $files[] = array(
+                       'file' => $filename,
+                       'fails' => columnize($GLOBALS['unit_tests_failed_msgs']),
+                       'passes' => columnize($GLOBALS['unit_tests_passed_msgs']),
+                       'count_passed' => $GLOBALS['unit_tests_passed'] - $already_passed,
+                       'count_failed' => $GLOBALS['unit_tests_failed'] - $already_failed
+               );
        }
-       message("tests finished with $errors errors");
+       $passed = $GLOBALS['unit_tests_passed'];
+       $failed = $GLOBALS['unit_tests_failed'];
+       tem_set('unit_tests', array(
+               'files' => $files,
+               'total_passed' => $passed,
+               'total_failed' => $failed
+       ));
 }
 
 # Call this to unit test wfpl. By default it tests everything, or you can pass
-# a space-separated list of the basenames of the files in code/wfpl/unit_tests/
+# a space-separated list of the basenames of the files in wfpl/unit_tests/
 # that you'd like to run.
-function unit_test_wfpl($basenames = 'format') {
-       tem_load('code/wfpl/unit_tests/template.html');
-       run_unit_tests('code/wfpl/unit_tests', $basenames);
+function unit_test_wfpl($basenames = 'format db misc encode') {
+       tem_load(__DIR__.'/'.'unit_tests/template.html');
+       run_unit_tests(__DIR__.'/'.'unit_tests', $basenames);
        display_messages();
        tem_output();
        exit();