FilterInputTest.php

<?php
/**
 *  Unit Test For HCUImport Var
 *  This is not a complete unit test, but it is a start
 *  unit testing can be difficult when testing against functions like filter_input which use
 *  builtin php superglobals.  I experimented with modifying _POST, but that does not work
 *  with the filter_input function.
 *  Building a mock function may have worked, but what I did instead was use the 
 *  HCU_FilterInput option of using the filter_var function.
 *  In order to do this I wrote a localized version of HCU_ImportVars.
 *  This option calls HCU_FilterInput slightly different
 *  
 *  MWS 3/2017

 */

use PHPUnit\Framework\TestCase;

$sharedLibrary= "/var/www/html/shared/library";

require_once("$sharedLibrary/hcuCommon.i");
require_once("$sharedLibrary/dms_imp_val.i");

class FilterInputTests extends TestCase
{

    protected static $testValues;
    protected static $testOptions;

    /**
     *  This function will setup the default values for usage in the test
     *  The test should emulate a POST action.
     *  Because of the way the calls are done through filter_input
     *  $_POST must be made.
     */
    public function setUp() {


      self::$testValues = Array(
                 'field1' => array(
                               "value" => "5'11\"",
                               "results" => array(
                                  'FILTER_SANITIZE_STRING' => '5&#39;11&#34;',
                                  'FILTER_SANITIZE_STRING_NO_ENCODE' => '5\'11"',
                                  'FILTER_SANITIZE_NUMBER_FLOAT'     => '511',
                                  'FILTER_SANITIZE_NUMBER_FLOAT_ALLOW_FRACTION' => '511',
                                  'FILTER_SANITIZE_NUMBER_INT' => '511',
                                  'FILTER_SANITIZE_FULL_SPECIAL_CHARS' => '5&#039;11&quot;',
                                  'FILTER_SANITIZE_FULL_SPECIAL_CHARS_NO_ENCODE' => '5\'11"',
                                  'FILTER_VALIDATE_EMAIL' => '',
                                  'FILTER_VALIDATE_INT' => '',
                                  'FILTER_VALIDATE_FLOAT' => '',
                                  'FILTER_VALIDATE_FLOAT_ALLOW_1000' => '',
                                  'FILTER_VALIDATE_REGEXP' => ''
                                 )
                               ),
                 'field2' => array(
                               "value" => "Billy's Account",
                               "results" => array(
                                  'FILTER_SANITIZE_STRING' => 'Billy&#39;s Account',
                                  'FILTER_SANITIZE_STRING_NO_ENCODE' => 'Billy\'s Account',
                                  'FILTER_SANITIZE_NUMBER_FLOAT'     => '',
                                  'FILTER_SANITIZE_NUMBER_FLOAT_ALLOW_FRACTION' => '',
                                  'FILTER_SANITIZE_NUMBER_INT' => '',
                                  'FILTER_SANITIZE_FULL_SPECIAL_CHARS' => 'Billy&#039;s Account',
                                  'FILTER_SANITIZE_FULL_SPECIAL_CHARS_NO_ENCODE' => 'Billy\'s Account',
                                  'FILTER_VALIDATE_EMAIL' => '',
                                  'FILTER_VALIDATE_INT' => '',
                                  'FILTER_VALIDATE_FLOAT' => '',
                                  'FILTER_VALIDATE_FLOAT_ALLOW_1000' => '',
                                  'FILTER_VALIDATE_REGEXP' => ''
                                 )
                               ),
                 'field3' => array(
                               "value" => "1,234.33",
                               "results" => array(
                                  'FILTER_SANITIZE_STRING' => '1,234.33',
                                  'FILTER_SANITIZE_STRING_NO_ENCODE' => '1,234.33',
                                  'FILTER_SANITIZE_NUMBER_FLOAT'     => '123433',
                                  'FILTER_SANITIZE_NUMBER_FLOAT_ALLOW_FRACTION' => '1234.33',
                                  'FILTER_SANITIZE_NUMBER_INT' => '123433',
                                  'FILTER_SANITIZE_FULL_SPECIAL_CHARS' => '1,234.33',
                                  'FILTER_SANITIZE_FULL_SPECIAL_CHARS_NO_ENCODE' => '1,234.33',
                                  'FILTER_VALIDATE_EMAIL' => '',
                                  'FILTER_VALIDATE_INT' => '',
                                  'FILTER_VALIDATE_FLOAT' => '',
                                  'FILTER_VALIDATE_FLOAT_ALLOW_1000' => '1234.33',
                                  'FILTER_VALIDATE_REGEXP' => ''
                                 )
                               ),
                 'field4' => array(
                               "value" => "mail@homecu.net",
                               "results" => array(
                                  'FILTER_SANITIZE_STRING' => 'mail@homecu.net',
                                  'FILTER_SANITIZE_STRING_NO_ENCODE' => 'mail@homecu.net',
                                  'FILTER_SANITIZE_NUMBER_FLOAT'     => '',
                                  'FILTER_SANITIZE_NUMBER_FLOAT_ALLOW_FRACTION' => '.',
                                  'FILTER_SANITIZE_NUMBER_INT' => '',
                                  'FILTER_SANITIZE_FULL_SPECIAL_CHARS' => 'mail@homecu.net',
                                  'FILTER_SANITIZE_FULL_SPECIAL_CHARS_NO_ENCODE' => 'mail@homecu.net',
                                  'FILTER_VALIDATE_EMAIL' => 'mail@homecu.net',
                                  'FILTER_VALIDATE_INT' => '',
                                  'FILTER_VALIDATE_FLOAT' => '',
                                  'FILTER_VALIDATE_FLOAT_ALLOW_1000' => '',
                                  'FILTER_VALIDATE_REGEXP' => 'mail@homecu.net'
                                 )
                               ),
                 'field5' => array(
                               "value" => 3299,
                               "results" => array(
                                  'FILTER_SANITIZE_STRING' => '3299',
                                  'FILTER_SANITIZE_STRING_NO_ENCODE' => '3299',
                                  'FILTER_SANITIZE_NUMBER_FLOAT'     => '3299',
                                  'FILTER_SANITIZE_NUMBER_FLOAT_ALLOW_FRACTION' => '3299',
                                  'FILTER_SANITIZE_NUMBER_INT' => '3299',
                                  'FILTER_SANITIZE_FULL_SPECIAL_CHARS' => '3299',
                                  'FILTER_SANITIZE_FULL_SPECIAL_CHARS_NO_ENCODE' => '3299',
                                  'FILTER_VALIDATE_EMAIL' => '',
                                  'FILTER_VALIDATE_INT' => '3299',
                                  'FILTER_VALIDATE_FLOAT' => '3299',
                                  'FILTER_VALIDATE_FLOAT_ALLOW_1000' => '3299',
                                  'FILTER_VALIDATE_REGEXP' => ''
                                 )
                               )
               );

      self::$testOptions = Array(
                                  'FILTER_SANITIZE_STRING' => array('filter' => FILTER_SANITIZE_STRING),
                                  'FILTER_SANITIZE_STRING_NO_ENCODE' => array('filter' => FILTER_SANITIZE_STRING, 'options' => array('flags' => FILTER_FLAG_NO_ENCODE_QUOTES)),
                                  'FILTER_SANITIZE_NUMBER_FLOAT'     => array('filter' => FILTER_SANITIZE_NUMBER_FLOAT),
                                  'FILTER_SANITIZE_NUMBER_FLOAT_ALLOW_FRACTION' => array('filter' => FILTER_SANITIZE_NUMBER_FLOAT, 'options' => array('flags' => FILTER_FLAG_ALLOW_FRACTION)),
                                  'FILTER_SANITIZE_NUMBER_INT' => array('filter' => FILTER_SANITIZE_NUMBER_INT),
                                  'FILTER_SANITIZE_FULL_SPECIAL_CHARS' => array('filter' => FILTER_SANITIZE_FULL_SPECIAL_CHARS),
                                  'FILTER_SANITIZE_FULL_SPECIAL_CHARS_NO_ENCODE' => array('filter' => FILTER_SANITIZE_FULL_SPECIAL_CHARS, 'options' => array('flags' => FILTER_FLAG_NO_ENCODE_QUOTES)),
                                  'FILTER_VALIDATE_EMAIL' => array('filter' => FILTER_VALIDATE_EMAIL),
                                  'FILTER_VALIDATE_INT' => array('filter' => FILTER_VALIDATE_INT),
                                  'FILTER_VALIDATE_FLOAT' => array('filter' => FILTER_VALIDATE_FLOAT),
                                  'FILTER_VALIDATE_FLOAT_ALLOW_1000' => array('filter' => FILTER_VALIDATE_FLOAT, 'options' => array('flags' => FILTER_FLAG_ALLOW_THOUSAND)),
                                  'FILTER_VALIDATE_REGEXP' => array('filter' => FILTER_VALIDATE_REGEXP, 'options' => array('options' => array('regexp'=>'/^m(.*)/')))
                                );

    }

    /**
     *  Test Values
     */
    public function test_post_filter() {



      $myTestValues = self::$testValues;
      $myTestOptions = self::$testOptions;

      if (count($myTestValues) > 0) {
        foreach ($myTestValues as $valKey => $valSetup) {

          $testInputValue = $valSetup['value'];

          // ** Loop through each of the results for validating the response
          foreach ($valSetup['results'] as $resultFilter => $resultVal) {

            if (array_key_exists($resultFilter, $myTestOptions)) {

              // ** Call the function to start the process of validating the filter value
              $filterResult = $this->myTestHCU_ImportVars($testInputValue, $myTestOptions[$resultFilter]);

              $this->assertEquals($resultVal, $filterResult);

            } else {
              // ** Could not find test filter -- that's a fail!!
              $this->assertFalse(true, "$resultFilter Not Defined as Valid Test Option");
            }

          }


        }
      }
    }


    /**
     *
     *  return the results of the test using the parameters passed in
     *
     */
    public function myTestHCU_ImportVars ($pFieldVal, $pFilter) {
      $fieldFilter = 0;
      $fieldFlags = false;
      $fieldOptions = 0;

      // ** Determine FILTER TYPE
      if (array_key_exists('filter', $pFilter)) {
        $fieldFilter = $pFilter['filter'];
      }
      // ** set to FILTER_DEFAULT IF NOT SET
        $fieldFilter = ($fieldFilter == 0 ? FILTER_DEFAULT : $fieldFilter);

      // ** DETERMINE IF SET FLAG FOR REQUIRE ARRAY
      if (array_key_exists('flags', $pFilter)) {
        $fieldFlags = $pFilter['flags'];
      }
      $fieldIsArray = ($fieldFlags == FILTER_REQUIRE_ARRAY ? true : false);


      // ** set the filter options
      if (array_key_exists('options', $pFilter)) {
        $fieldOptions = $pFilter['options'];
      }


      $fieldValue = HCU_FilterInput (HCUFILTER_VAR, $pFieldVal, $fieldFilter, $fieldIsArray, $fieldOptions);

      return $fieldValue;

    } // * myHcu_ImportVars

}