tests/qunit/suites/resources/mediawiki/mediawiki.cookie.test.js

   1 ( function ( mw, $ ) {
   2
   3         var NOW = 9012, // miliseconds
   4                 DEFAULT_DURATION = 5678, // seconds
   5                 expiryDate = new Date();
   6
   7         expiryDate.setTime( NOW + ( DEFAULT_DURATION * 1000 ) );
   8
   9         QUnit.module( 'mediawiki.cookie', QUnit.newMwEnvironment( {
  10                 setup: function () {
  11                         this.stub( $, 'cookie' ).returns( null );
  12
  13                         this.sandbox.useFakeTimers( NOW );
  14                 },
  15                 config: {
  16                         wgCookiePrefix: 'mywiki',
  17                         wgCookieDomain: 'example.org',
  18                         wgCookiePath: '/path',
  19                         wgCookieExpiration: DEFAULT_DURATION
  20                 }
  21         } ) );
  22
  23         QUnit.test( 'set( key, value )', 7, function ( assert ) {
  24                 var call;
  25
  26                 // Simple case
  27                 mw.cookie.set( 'foo', 'bar' );
  28
  29                 call = $.cookie.lastCall.args;
  30                 assert.strictEqual( call[ 0 ], 'mywikifoo' );
  31                 assert.strictEqual( call[ 1 ], 'bar' );
  32                 assert.deepEqual( call[ 2 ], {
  33                         expires: expiryDate,
  34                         domain: 'example.org',
  35                         path: '/path',
  36                         secure: false
  37                 } );
  38
  39                 mw.cookie.set( 'foo', null );
  40                 call = $.cookie.lastCall.args;
  41                 assert.strictEqual( call[ 1 ], null, 'null removes cookie' );
  42
  43                 mw.cookie.set( 'foo', undefined );
  44                 call = $.cookie.lastCall.args;
  45                 assert.strictEqual( call[ 1 ], 'undefined', 'undefined is value' );
  46
  47                 mw.cookie.set( 'foo', false );
  48                 call = $.cookie.lastCall.args;
  49                 assert.strictEqual( call[ 1 ], 'false', 'false is a value' );
  50
  51                 mw.cookie.set( 'foo', 0 );
  52                 call = $.cookie.lastCall.args;
  53                 assert.strictEqual( call[ 1 ], '0', '0 is value' );
  54         } );
  55
  56         QUnit.test( 'set( key, value, expires )', 5, function ( assert ) {
  57                 var date, options;
  58
  59                 date = new Date();
  60                 date.setTime( 1234 );
  61
  62                 mw.cookie.set( 'foo', 'bar' );
  63                 options = $.cookie.lastCall.args[ 2 ];
  64                 assert.deepEqual( options.expires, expiryDate, 'Default cookie expiration is used' );
  65
  66                 mw.cookie.set( 'foo', 'bar', date );
  67                 options = $.cookie.lastCall.args[ 2 ];
  68                 assert.strictEqual( options.expires, date, 'Custom expiration date' );
  69
  70                 mw.cookie.set( 'foo', 'bar', null );
  71                 options = $.cookie.lastCall.args[ 2 ];
  72                 assert.strictEqual( options.expires, undefined, 'Expiry null forces session cookie' );
  73
  74                 // Per DefaultSettings.php, when wgCookieExpiration is 0, the default should
  75                 // be session cookies
  76                 mw.config.set( 'wgCookieExpiration', 0 );
  77
  78                 mw.cookie.set( 'foo', 'bar' );
  79                 options = $.cookie.lastCall.args[ 2 ];
  80                 assert.strictEqual( options.expires, undefined, 'wgCookieExpiration=0 results in session cookies by default' );
  81
  82                 mw.cookie.set( 'foo', 'bar', date );
  83                 options = $.cookie.lastCall.args[ 2 ];
  84                 assert.strictEqual( options.expires, date, 'Custom expiration when default is session cookies' );
  85         } );
  86
  87         QUnit.test( 'set( key, value, options )', 4, function ( assert ) {
  88                 var date, call;
  89
  90                 mw.cookie.set( 'foo', 'bar', {
  91                         prefix: 'myPrefix',
  92                         domain: 'myDomain',
  93                         path: 'myPath',
  94                         secure: true
  95                 } );
  96
  97                 call = $.cookie.lastCall.args;
  98                 assert.strictEqual( call[0], 'myPrefixfoo' );
  99                 assert.deepEqual( call[ 2 ], {
 100                         expires: expiryDate,
 101                         domain: 'myDomain',
 102                         path: 'myPath',
 103                         secure: true
 104                 }, 'Options (without expires)' );
 105
 106                 date = new Date();
 107                 date.setTime( 1234 );
 108
 109                 mw.cookie.set( 'foo', 'bar', {
 110                         expires: date,
 111                         prefix: 'myPrefix',
 112                         domain: 'myDomain',
 113                         path: 'myPath',
 114                         secure: true
 115                 } );
 116
 117                 call = $.cookie.lastCall.args;
 118                 assert.strictEqual( call[0], 'myPrefixfoo' );
 119                 assert.deepEqual( call[ 2 ], {
 120                         expires: date,
 121                         domain: 'myDomain',
 122                         path: 'myPath',
 123                         secure: true
 124                 }, 'Options (incl. expires)' );
 125         } );
 126
 127         QUnit.test( 'get( key ) - no values', 6, function ( assert ) {
 128                 var key, value;
 129
 130                 mw.cookie.get( 'foo' );
 131
 132                 key = $.cookie.lastCall.args[ 0 ];
 133                 assert.strictEqual( key, 'mywikifoo', 'Default prefix' );
 134
 135                 mw.cookie.get( 'foo', undefined );
 136                 key = $.cookie.lastCall.args[ 0 ];
 137                 assert.strictEqual( key, 'mywikifoo', 'Use default prefix for undefined' );
 138
 139                 mw.cookie.get( 'foo', null );
 140                 key = $.cookie.lastCall.args[ 0 ];
 141                 assert.strictEqual( key, 'mywikifoo', 'Use default prefix for null' );
 142
 143                 mw.cookie.get( 'foo', '' );
 144                 key = $.cookie.lastCall.args[ 0 ];
 145                 assert.strictEqual( key, 'foo', 'Don\'t use default prefix for empty string' );
 146
 147                 value = mw.cookie.get( 'foo' );
 148                 assert.strictEqual( value, null, 'Return null by default' );
 149
 150                 value = mw.cookie.get( 'foo', null, 'bar' );
 151                 assert.strictEqual( value, 'bar', 'Custom default value' );
 152         } );
 153
 154         QUnit.test( 'get( key ) - with value', 1, function ( assert ) {
 155                 var value;
 156
 157                 $.cookie.returns( 'bar' );
 158
 159                 value = mw.cookie.get( 'foo' );
 160                 assert.strictEqual( value, 'bar', 'Return value of cookie' );
 161         } );
 162
 163         QUnit.test( 'get( key, prefix )', 1, function ( assert ) {
 164                 var key;
 165
 166                 mw.cookie.get( 'foo', 'bar' );
 167
 168                 key = $.cookie.lastCall.args[ 0 ];
 169                 assert.strictEqual( key, 'barfoo' );
 170         } );
 171
 172 }( mediaWiki, jQuery ) );