JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
clean up include paths and docs
[wfpl.git] / unit_tests / format.php
index 261ed65..6d5de15 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 
-#  Copyright (C) 2009 Jason Woofenden
+#  Copyright (C) 2010 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
 #  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
-# This file contains tests for functions in code/wfpl/format.php
+# This file contains tests for functions in wfpl/format.php
 #
-# See code/wfpl/test.php for details on how to run or create tests
+# See wfpl/test.php for details on how to run or create tests
 
 
-require_once('code/wfpl/format.php');
+require_once(__DIR__.'/../'.'format.php');
 
-function _test_format_money($input, $dollars_correct, $money_correct) {
-       $errors = 0;
-       $dollars = format_dollars($input);
-       $money = format_money($input);
-       if($dollars != $dollars_correct) {
-               ++$errors;
-               message("format_dollars(\"$input\") returned \"$dollars\" instead of \"$dollars_correct\"");
-       }
-       if($money != $money_correct) {
-               ++$errors;
-               message("format_money(\"$input\") returned \"$money\" instead of \"$money_correct\"");
-       }
-
-       return $errors;
+function _test_format_money($arg, $dollars_correct, $money_correct) {
+       unit_test_func('format_dollars', $arg, $dollars_correct);
+       unit_test_func('format_money', $arg, $money_correct);
 }
 
 function test_format_money() {
-       $errors = 0;
-       $errors += _test_format_money('1', '$1', '$1.00');
-       $errors += _test_format_money('0', '$0', '$0.00');
-       $errors += _test_format_money('0.0', '$0', '$0.00');
-       $errors += _test_format_money('0.00', '$0', '$0.00');
-       $errors += _test_format_money('0.01', '$0', '$0.01');
-       $errors += _test_format_money('0.51', '$1', '$0.51');
-       $errors += _test_format_money('2.05', '$2', '$2.05');
-       $errors += _test_format_money('2.10000500', '$2', '$2.10');
-       $errors += _test_format_money('2.005', '$2', '$2.01');
-       $errors += _test_format_money('2.004', '$2', '$2.00');
-       $errors += _test_format_money('2.1', '$2', '$2.10');
-       $errors += _test_format_money('2.0', '$2', '$2.00');
-       $errors += _test_format_money('1000', '$1,000', '$1,000.00');
-       $errors += _test_format_money('10000000', '$10,000,000', '$10,000,000.00');
-       $errors += _test_format_money('100000000000', '$100,000,000,000', '$100,000,000,000.00');
-       $errors += _test_format_money('1.99', '$2', '$1.99');
-       $errors += _test_format_money('1.555', '$2', '$1.56');
-       $errors += _test_format_money('19.555', '$20', '$19.56');
-       $errors += _test_format_money('9.499', '$9', '$9.50');
-       $errors += _test_format_money('9.989', '$10', '$9.99');
-       $errors += _test_format_money('9.999', '$10', '$10.00');
-       $errors += _test_format_money('19999999999.555', '$20,000,000,000', '$19,999,999,999.56');
-       return $errors;
+       _test_format_money('1', '$1', '$1.00');
+       _test_format_money('0', '$0', '$0.00');
+       _test_format_money('0.0', '$0', '$0.00');
+       _test_format_money('0.00', '$0', '$0.00');
+       _test_format_money('00.00', '$0', '$0.00');
+       _test_format_money('0.000', '$0', '$0.00');
+       _test_format_money('0000.00000', '$0', '$0.00');
+       _test_format_money('0.01', '$0', '$0.01');
+       _test_format_money('0.51', '$1', '$0.51');
+       _test_format_money('2.05', '$2', '$2.05');
+       _test_format_money('2.10000500', '$2', '$2.10');
+       _test_format_money('2.005', '$2', '$2.01');
+       _test_format_money('2.004', '$2', '$2.00');
+       _test_format_money('2.1', '$2', '$2.10');
+       _test_format_money('2.0', '$2', '$2.00');
+       _test_format_money('1000', '$1,000', '$1,000.00');
+       _test_format_money('10000000', '$10,000,000', '$10,000,000.00');
+       _test_format_money('100000000000', '$100,000,000,000', '$100,000,000,000.00');
+       _test_format_money('1.99', '$2', '$1.99');
+       _test_format_money('1.555', '$2', '$1.56');
+       _test_format_money('19.555', '$20', '$19.56');
+       _test_format_money('9.499', '$9', '$9.50');
+       _test_format_money('9.989', '$10', '$9.99');
+       _test_format_money('9.999', '$10', '$10.00');
+       _test_format_money('19999999999.555', '$20,000,000,000', '$19,999,999,999.56');
 }
 
-# returns number of errors
-function _test_format_misc($name, $arg, $correct) {
-       $function = "format_$name";
-       $ret = $function($arg);
-       if($ret !== $correct) {
-               message("$function($arg) returned \"$ret\" instead of \"$correct\"");
-               return 1;
-       }
-       return 0;
-}
 
 # run tests where int, int_0, decimal, positive_decimal should return the same result
 function _test_format_int($arg, $correct) {
@@ -84,103 +64,103 @@ function _test_format_int($arg, $correct) {
        } else {
                $correct_0 = $correct;
        }
-       $errons = 0;
-       $errors += _test_format_misc('int', $arg, $correct);
-       $errors += _test_format_misc('int_0', $arg, $correct_0);
-       $errors += _test_format_misc('positive_decimal', $arg, $correct);
-       $errors += _test_format_misc('decimal', $arg, $correct);
-       return $errors;
+       unit_test_func('format_int', $arg, $correct);
+       unit_test_func('format_int_0', $arg, $correct_0);
+       unit_test_func('format_positive_decimal', $arg, $correct);
+       unit_test_func('format_decimal', $arg, $correct);
 }
 
-# returns number of errors
 function test_format_misc() {
-       $errors = 0;
-
-       $errors += _test_format_misc('caption', 'something', 'Something');
-       $errors += _test_format_misc('caption', 'two_words', 'Two Words');
-       $errors += _test_format_misc('caption', 'email_special_case', 'E-mail Special Case');
-       $errors += _test_format_misc('caption', 'BIG', 'BIG');
-       $errors += _test_format_misc('caption', '1,2.3%^&', '1,2.3%^&');
+       unit_test_func('format_caption', 'something', 'Something');
+       unit_test_func('format_caption', 'two_words', 'Two Words');
+       unit_test_func('format_caption', 'email_special_case', 'E-mail Special Case');
+       unit_test_func('format_caption', 'BIG', 'BIG');
+       unit_test_func('format_caption', '1,2.3%^&', '1,2.3%^&');
 
        # test int, int_0, positive_decimal, decimal
-       $errors += _test_format_int('', '');
-       $errors += _test_format_int('abcdef', '');
-       $errors += _test_format_int('0', '0');
-       $errors += _test_format_int('00', '0');
-       $errors += _test_format_int('0000', '0');
-       $errors += _test_format_int('1', '1');
-       $errors += _test_format_int('100000000000000000000000000', '100000000000000000000000000');
-       $errors += _test_format_int('10000 0000000000000000000000', '100000000000000000000000000');
-       $errors += _test_format_int(' 1a2b3c%^&', '123');
+       _test_format_int('', '');
+       _test_format_int('abcdef', '');
+       _test_format_int('0', '0');
+       _test_format_int('00', '0');
+       _test_format_int('0000', '0');
+       _test_format_int('1', '1');
+       _test_format_int('100000000000000000000000000', '100000000000000000000000000');
+       _test_format_int('10000 0000000000000000000000', '100000000000000000000000000');
+       _test_format_int(' 1a2b3c%^&', '123');
        
-       $errors += _test_format_misc('int', '-1', '1');
-       $errors += _test_format_misc('int', '+1', '1');
-       $errors += _test_format_misc('int_0', '-1', '1');
-       $errors += _test_format_misc('int_0', '+1', '1');
-       $errors += _test_format_misc('positive_decimal', '-1', '1');
-       $errors += _test_format_misc('positive_decimal', '+1', '1');
-       $errors += _test_format_misc('decimal', '-1', '-1');
-       $errors += _test_format_misc('decimal', '+1', '1');
-
-       $errors += _test_format_misc('int', '-1.0', '10'); # FIXME?
-       $errors += _test_format_misc('int', '+1.0', '10'); # FIXME?
-       $errors += _test_format_misc('int_0', '-1.0', '10'); # FIXME?
-       $errors += _test_format_misc('int_0', '+1.0', '10'); # FIXME?
-       $errors += _test_format_misc('positive_decimal', '-1.0', '1.0');
-       $errors += _test_format_misc('positive_decimal', '+1.0', '1.0');
-       $errors += _test_format_misc('decimal', '-1.0', '-1.0');
-       $errors += _test_format_misc('decimal', '+1.0', '1.0');
-
-       $errors += _test_format_misc('positive_decimal', '1.0', '1.0');
-       $errors += _test_format_misc('decimal', '1.0', '1.0');
+       unit_test_func('format_int', '-1', '1');
+       unit_test_func('format_int', '+1', '1');
+       unit_test_func('format_int_0', '-1', '1');
+       unit_test_func('format_int_0', '+1', '1');
+       unit_test_func('format_positive_decimal', '-1', '1');
+       unit_test_func('format_positive_decimal', '+1', '1');
+       unit_test_func('format_decimal', '-1', '-1');
+       unit_test_func('format_decimal', '+1', '1');
+
+       unit_test_func('format_int', '-1.0', '1');
+       unit_test_func('format_int', '+1.0', '1');
+       unit_test_func('format_int_0', '-1.0', '1');
+       unit_test_func('format_int_0', '+1.0', '1');
+       unit_test_func('format_positive_decimal', '-1.0', '1.0');
+       unit_test_func('format_positive_decimal', '+1.0', '1.0');
+       unit_test_func('format_decimal', '-1.0', '-1.0');
+       unit_test_func('format_decimal', '+1.0', '1.0');
+
+       unit_test_func('format_positive_decimal', '1.0', '1.0');
+       unit_test_func('format_decimal', '1.0', '1.0');
 
        # extra zeros after the decimal point
-       $errors += _test_format_misc('positive_decimal', '-1.00', '1.0');
-       $errors += _test_format_misc('positive_decimal', '+1.00', '1.0');
-       $errors += _test_format_misc('decimal', '-1.00', '-1.0');
-       $errors += _test_format_misc('decimal', '+1.00', '1.0');
-       $errors += _test_format_misc('positive_decimal', '-1.000', '1.0');
-       $errors += _test_format_misc('positive_decimal', '+1.000', '1.0');
-       $errors += _test_format_misc('decimal', '-1.000', '-1.0');
-       $errors += _test_format_misc('decimal', '+1.000', '1.0');
+       unit_test_func('format_positive_decimal', '-1.00', '1.0');
+       unit_test_func('format_positive_decimal', '+1.00', '1.0');
+       unit_test_func('format_decimal', '-1.00', '-1.0');
+       unit_test_func('format_decimal', '+1.00', '1.0');
+       unit_test_func('format_positive_decimal', '-1.000', '1.0');
+       unit_test_func('format_positive_decimal', '+1.000', '1.0');
+       unit_test_func('format_decimal', '-1.000', '-1.0');
+       unit_test_func('format_decimal', '+1.000', '1.0');
        # important zeros after the decimal point
-       $errors += _test_format_misc('positive_decimal', '-1.020', '1.02');
-       $errors += _test_format_misc('positive_decimal', '+1.020', '1.02');
-       $errors += _test_format_misc('decimal', '-1.020', '-1.02');
-       $errors += _test_format_misc('decimal', '+1.020', '1.02');
-       $errors += _test_format_misc('positive_decimal', '-1.0020', '1.002');
-       $errors += _test_format_misc('positive_decimal', '+1.0020', '1.002');
-       $errors += _test_format_misc('decimal', '-1.0020', '-1.002');
-       $errors += _test_format_misc('decimal', '+1.0020', '1.002');
+       unit_test_func('format_positive_decimal', '-1.020', '1.02');
+       unit_test_func('format_positive_decimal', '+1.020', '1.02');
+       unit_test_func('format_decimal', '-1.020', '-1.02');
+       unit_test_func('format_decimal', '+1.020', '1.02');
+       unit_test_func('format_positive_decimal', '-1.0020', '1.002');
+       unit_test_func('format_positive_decimal', '+1.0020', '1.002');
+       unit_test_func('format_decimal', '-1.0020', '-1.002');
+       unit_test_func('format_decimal', '+1.0020', '1.002');
        # signs in weird places
-       $errors += _test_format_misc('positive_decimal', '-1.-0020', '1.002');
-       $errors += _test_format_misc('positive_decimal', '+1.-0020', '1.002');
-       $errors += _test_format_misc('decimal', '-1.-0020', '-1.002');
-       $errors += _test_format_misc('decimal', '+1.-0020', '1.002');
-       $errors += _test_format_misc('positive_decimal', '-1.0-020', '1.002');
-       $errors += _test_format_misc('positive_decimal', '+1.0-020', '1.002');
-       $errors += _test_format_misc('decimal', '-1.0-020', '-1.002');
-       $errors += _test_format_misc('decimal', '+1.0-020', '1.002');
-       $errors += _test_format_misc('positive_decimal', '-1-.0020', '1.002');
-       $errors += _test_format_misc('positive_decimal', '+1-.0020', '1.002');
-       $errors += _test_format_misc('decimal', '-1-.0020', '-1.002');
-       $errors += _test_format_misc('decimal', '+1-.0020', '1.002');
-       $errors += _test_format_misc('positive_decimal', '--1.0020', '1.002');
-       $errors += _test_format_misc('positive_decimal', '+-1.0020', '1.002');
-       $errors += _test_format_misc('decimal', '--1.0020', '-1.002');
-       $errors += _test_format_misc('decimal', '+-1.0020', '-1.002');
-
-
-       $errors += _test_format_misc('zip', '', '');
-       $errors += _test_format_misc('zip', '12345', '12345');
-       $errors += _test_format_misc('zip', 'snt3nvwm4vm2zvw0%^&3-', '34203');
-       $errors += _test_format_misc('zip', '123456', '12345-6');
-       $errors += _test_format_misc('zip', '1234567890', '12345-67890');
-
+       unit_test_func('format_positive_decimal', '-1.-0020', '1.002');
+       unit_test_func('format_positive_decimal', '+1.-0020', '1.002');
+       unit_test_func('format_decimal', '-1.-0020', '-1.002');
+       unit_test_func('format_decimal', '+1.-0020', '1.002');
+       unit_test_func('format_positive_decimal', '-1.0-020', '1.002');
+       unit_test_func('format_positive_decimal', '+1.0-020', '1.002');
+       unit_test_func('format_decimal', '-1.0-020', '-1.002');
+       unit_test_func('format_decimal', '+1.0-020', '1.002');
+       unit_test_func('format_positive_decimal', '-1-.0020', '1.002');
+       unit_test_func('format_positive_decimal', '+1-.0020', '1.002');
+       unit_test_func('format_decimal', '-1-.0020', '-1.002');
+       unit_test_func('format_decimal', '+1-.0020', '1.002');
+       unit_test_func('format_positive_decimal', '--1.0020', '1.002');
+       unit_test_func('format_positive_decimal', '+-1.0020', '1.002');
+       unit_test_func('format_decimal', '--1.0020', '-1.002');
+       unit_test_func('format_decimal', '+-1.0020', '-1.002');
+
+
+       unit_test_func('format_zip', '', '');
+       unit_test_func('format_zip', '12345', '12345');
+       unit_test_func('format_zip', 'snt3nvwm4vm2zvw0%^&3-', '34203');
+       unit_test_func('format_zip', '123456', '12345-6');
+       unit_test_func('format_zip', '1234567890', '12345-67890');
+
+       unit_test_func('format_filename', '1234567890', '1234567890');
+       unit_test_func('format_filename', 'A*b#C:D/E?f<g&H!I', 'a_b_c_d_e_f_g_h_i');
+       unit_test_func('format_filename', '-?', '__');
+       unit_test_func('format_filename', '--help', '_-help');
+       unit_test_func('format_filename', '.secret', '_secret');
+       # allow uppercase:
+       unit_test_func('format_filename', 'A*b#C:D/E?f<g&H!I', true, 'A_b_C_D_E_f_g_H_I');
 
        /* FIXME test these
-       format_options($str, $name)
-       format_filename($str, $allow_uppercase = false)
        format_path($str, $allow_uppercase = false)
        client_path_to_filename($path)
        format_image_w_h($str)
@@ -202,14 +182,9 @@ function test_format_misc() {
        format_12hr_to_hours($str)
        format_phone($str)
        */
-
-       return $errors;
 }
 
-# returns number of errors
 function format_unit_tests_main() {
-       $errors = 0;
-       $errors += test_format_money();
-       $errors += test_format_misc();
-       return $errors;
+       test_format_money();
+       test_format_misc();
 }