tests/phpunit/includes/GlobalFunctions/wfUrlencodeTest.php

   1 <?php
   2 /**
   3  * The function only need a string parameter and might react to IIS7.0
   4  * @covers ::wfUrlencode
   5  */
   6 class WfUrlencodeTest extends MediaWikiTestCase {
   7         #### TESTS ##############################################################
   8
   9         /**
  10          * @dataProvider provideURLS
  11          */
  12         public function testEncodingUrlWith( $input, $expected ) {
  13                 $this->verifyEncodingFor( 'Apache', $input, $expected );
  14         }
  15
  16         /**
  17          * @dataProvider provideURLS
  18          */
  19         public function testEncodingUrlWithMicrosoftIis7( $input, $expected ) {
  20                 $this->verifyEncodingFor( 'Microsoft-IIS/7', $input, $expected );
  21         }
  22
  23         #### HELPERS #############################################################
  24
  25         /**
  26          * Internal helper that actually run the test.
  27          * Called by the public methods testEncodingUrlWith...()
  28          *
  29          */
  30         private function verifyEncodingFor( $server, $input, $expectations ) {
  31                 $expected = $this->extractExpect( $server, $expectations );
  32
  33                 // save up global
  34                 $old = isset( $_SERVER['SERVER_SOFTWARE'] )
  35                         ? $_SERVER['SERVER_SOFTWARE']
  36                         : null;
  37                 $_SERVER['SERVER_SOFTWARE'] = $server;
  38                 wfUrlencode( null );
  39
  40                 // do the requested test
  41                 $this->assertEquals(
  42                         $expected,
  43                         wfUrlencode( $input ),
  44                         "Encoding '$input' for server '$server' should be '$expected'"
  45                 );
  46
  47                 // restore global
  48                 if ( $old === null ) {
  49                         unset( $_SERVER['SERVER_SOFTWARE'] );
  50                 } else {
  51                         $_SERVER['SERVER_SOFTWARE'] = $old;
  52                 }
  53                 wfUrlencode( null );
  54         }
  55
  56         /**
  57          * Interprets the provider array. Return expected value depending
  58          * the HTTP server name.
  59          */
  60         private function extractExpect( $server, $expectations ) {
  61                 if ( is_string( $expectations ) ) {
  62                         return $expectations;
  63                 } elseif ( is_array( $expectations ) ) {
  64                         if ( !array_key_exists( $server, $expectations ) ) {
  65                                 throw new MWException( __METHOD__ . " expectation does not have any "
  66                                         . "value for server name $server. Check the provider array.\n" );
  67                         } else {
  68                                 return $expectations[$server];
  69                         }
  70                 } else {
  71                         throw new MWException( __METHOD__ . " given invalid expectation for "
  72                                 . "'$server'. Should be a string or an array( <http server name> => <string> ).\n" );
  73                 }
  74         }
  75
  76         #### PROVIDERS ###########################################################
  77
  78         /**
  79          * Format is either:
  80          *   array( 'input', 'expected' );
  81          * Or:
  82          *   array( 'input',
  83          *       array( 'Apache', 'expected' ),
  84          *       array( 'Microsoft-IIS/7', 'expected' ),
  85          *    ),
  86          * If you want to add other HTTP server name, you will have to add a new
  87          * testing method much like the testEncodingUrlWith() method above.
  88          */
  89         public static function provideURLS() {
  90                 return array(
  91                         ### RFC 1738 chars
  92                         // + is not safe
  93                         array( '+', '%2B' ),
  94                         // & and = not safe in queries
  95                         array( '&', '%26' ),
  96                         array( '=', '%3D' ),
  97
  98                         array( ':', array(
  99                                 'Apache' => ':',
 100                                 'Microsoft-IIS/7' => '%3A',
 101                         ) ),
 102
 103                         // remaining chars do not need encoding
 104                         array(
 105                                 ';@$-_.!*',
 106                                 ';@$-_.!*',
 107                         ),
 108
 109                         ### Other tests
 110                         // slash remain unchanged. %2F seems to break things
 111                         array( '/', '/' ),
 112
 113                         // Other 'funnies' chars
 114                         array( '[]', '%5B%5D' ),
 115                         array( '<>', '%3C%3E' ),
 116
 117                         // Apostrophe is encoded
 118                         array( '\'', '%27' ),
 119                 );
 120         }
 121 }