test/PMA_Message_test.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Test for PMA_Message class
   5  *
   6  * @version $Id$
   7  */
   8
   9 /**
  10  * Tests core.
  11  */
  12 require_once 'PHPUnit/Framework.php';
  13 require_once 'PHPUnit/Extensions/OutputTestCase.php';
  14
  15 /**
  16  * Include to test.
  17  */
  18 require_once './libraries/Message.class.php';
  19
  20 /**
  21  * Test class PMA_Message.
  22  *
  23  * @package phpMyAdmin-test
  24  */
  25 class PMA_Message_test extends PHPUnit_Extensions_OutputTestCase
  26 {
  27     /**
  28      * @var    PMA_Message
  29      * @access protected
  30      */
  31     protected $object;
  32
  33     /**
  34      * Sets up the fixture, for example, opens a network connection.
  35      * This method is called before a test is executed.
  36      *
  37      * @access protected
  38      */
  39     protected function setUp()
  40     {
  41         $this->object = new PMA_Message;
  42     }
  43
  44     /**
  45      * Tears down the fixture, for example, closes a network connection.
  46      * This method is called after a test is executed.
  47      *
  48      * @access protected
  49      */
  50     protected function tearDown()
  51     {
  52     }
  53
  54     /**
  55      * to String casting test
  56      */
  57     public function test__toString()
  58     {
  59         $this->object->setMessage('test<&>', true);
  60         $this->assertEquals('test&lt;&amp;&gt;', (string)$this->object);
  61     }
  62
  63     /**
  64      * test success method
  65      */
  66     public function testSuccess()
  67     {
  68         $this->object = new PMA_Message('test<&>', PMA_Message::SUCCESS);
  69         $this->assertEquals($this->object, PMA_Message::success('test<&>'));
  70         $this->assertEquals('strSuccess', PMA_Message::success()->getString());
  71     }
  72
  73     /**
  74      * test error method
  75      */
  76     public function testError()
  77     {
  78         $this->object = new PMA_Message('test<&>', PMA_Message::ERROR);
  79         $this->assertEquals($this->object, PMA_Message::error('test<&>'));
  80         $this->assertEquals('strError', PMA_Message::error()->getString());
  81     }
  82
  83     /**
  84      * test warning method
  85      */
  86     public function testWarning()
  87     {
  88         $this->object = new PMA_Message('test<&>', PMA_Message::WARNING);
  89         $this->assertEquals($this->object, PMA_Message::warning('test<&>'));
  90     }
  91
  92     /**
  93      * test notice method
  94      */
  95     public function testNotice()
  96     {
  97         $this->object = new PMA_Message('test<&>', PMA_Message::NOTICE);
  98         $this->assertEquals($this->object, PMA_Message::notice('test<&>'));
  99     }
 100
 101     /**
 102      * test rawError method
 103      */
 104     public function testRawError()
 105     {
 106         $this->object = new PMA_Message('', PMA_Message::ERROR);
 107         $this->object->setMessage('test<&>');
 108
 109         $this->assertEquals($this->object, PMA_Message::rawError('test<&>'));
 110     }
 111
 112     /**
 113      * test rawWarning method
 114      */
 115     public function testRawWarning()
 116     {
 117         $this->object = new PMA_Message('', PMA_Message::WARNING);
 118         $this->object->setMessage('test<&>');
 119
 120         $this->assertEquals($this->object, PMA_Message::rawWarning('test<&>'));
 121     }
 122
 123     /**
 124      * test rawNotice method
 125      */
 126     public function testRawNotice()
 127     {
 128         $this->object = new PMA_Message('', PMA_Message::NOTICE);
 129         $this->object->setMessage('test<&>');
 130
 131         $this->assertEquals($this->object, PMA_Message::rawNotice('test<&>'));
 132     }
 133
 134     /**
 135      * test rawSuccess method
 136      */
 137     public function testRawSuccess()
 138     {
 139         $this->object = new PMA_Message('', PMA_Message::SUCCESS);
 140         $this->object->setMessage('test<&>');
 141
 142         $this->assertEquals($this->object, PMA_Message::rawSuccess('test<&>'));
 143     }
 144
 145     /**
 146      * testing isSuccess method
 147      */
 148     public function testIsSuccess()
 149     {
 150         $this->assertFalse($this->object->isSuccess());
 151         $this->assertTrue($this->object->isSuccess(true));
 152     }
 153
 154     /**
 155      * testing isNotice method
 156      */
 157     public function testIsNotice()
 158     {
 159         $this->assertTrue($this->object->isNotice());
 160         $this->object->isWarning(true);
 161         $this->assertFalse($this->object->isNotice());
 162         $this->assertTrue($this->object->isNotice(true));
 163     }
 164
 165     /**
 166      * testing isWarning method
 167      */
 168     public function testIsWarning()
 169     {
 170         $this->assertFalse($this->object->isWarning());
 171         $this->assertTrue($this->object->isWarning(true));
 172     }
 173
 174     /**
 175      * testing isError method
 176      */
 177     public function testIsError()
 178     {
 179         $this->assertFalse($this->object->isError());
 180         $this->assertTrue($this->object->isError(true));
 181     }
 182
 183     /**
 184      * testign setter of message
 185      */
 186     public function testSetMessage()
 187     {
 188         $this->object->setMessage('test&<>', false);
 189         $this->assertEquals('test&<>', $this->object->getMessage());
 190         $this->object->setMessage('test&<>', true);
 191         $this->assertEquals('test&amp;&lt;&gt;', $this->object->getMessage());
 192     }
 193
 194     /**
 195      * testing setter of string
 196      */
 197     public function testSetString()
 198     {
 199         $this->object->setString('test&<>', false);
 200         $this->assertEquals('test&<>', $this->object->getString());
 201         $this->object->setString('test&<>', true);
 202         $this->assertEquals('test&amp;&lt;&gt;', $this->object->getString());
 203     }
 204
 205     /**
 206      * testing add param method
 207      */
 208     public function testAddParam()
 209     {
 210         $this->object->addParam(PMA_Message::notice('test'));
 211         $this->assertEquals(array(PMA_Message::notice('test')), $this->object->getParams());
 212         $this->object->addParam('test', true);
 213         $this->assertEquals(array(PMA_Message::notice('test'), 'test'), $this->object->getParams());
 214         $this->object->addParam('test', false);
 215         $this->assertEquals(array(PMA_Message::notice('test'), 'test', PMA_Message::notice('test')), $this->object->getParams());
 216     }
 217
 218     /**
 219      * testing add string method
 220      */
 221     public function testAddString()
 222     {
 223         $this->object->addString('test', '*');
 224         $this->assertEquals(array('*', PMA_Message::notice('test')), $this->object->getAddedMessages());
 225         $this->object->addString('test', '');
 226         $this->assertEquals(array('*', PMA_Message::notice('test'), '', PMA_Message::notice('test')), $this->object->getAddedMessages());
 227     }
 228
 229     /**
 230      * testing add messages method
 231      */
 232     public function testAddMessages()
 233     {
 234         $this->object->addMessages(array('test', PMA_Message::rawWarning('test')), '&');
 235         $this->assertEquals(array('&', PMA_Message::rawNotice('test'), '&', PMA_Message::rawWarning('test')), $this->object->getAddedMessages());
 236     }
 237
 238     /**
 239      * testing add message method
 240      */
 241     public function testAddMessage()
 242     {
 243         $this->object->addMessage('test', '');
 244         $this->assertEquals(array(PMA_Message::rawNotice('test')), $this->object->getAddedMessages());
 245         $this->object->addMessage('test');
 246         $this->assertEquals(array(PMA_Message::rawNotice('test'), ' ', PMA_Message::rawNotice('test')), $this->object->getAddedMessages());
 247         $this->object->addMessage(PMA_Message::rawWarning('test'), '&');
 248         $this->assertEquals(array(PMA_Message::rawNotice('test'), ' ', PMA_Message::rawNotice('test'), '&', PMA_Message::rawWarning('test')), $this->object->getAddedMessages());
 249     }
 250
 251     /**
 252      * testing setter of params
 253      */
 254     public function testSetParams()
 255     {
 256         $this->object->setParams('test&<>');
 257         $this->assertEquals('test&<>', $this->object->getParams());
 258         $this->object->setParams('test&<>', true);
 259         $this->assertEquals('test&amp;&lt;&gt;', $this->object->getParams());
 260     }
 261
 262     /**
 263      * testing sanitize method
 264      */
 265     public function testSanitize()
 266     {
 267         $this->object->setString('test&string<>', false);
 268         $this->assertEquals('test&amp;string&lt;&gt;', PMA_Message::sanitize($this->object));
 269         $this->assertEquals(array('test&amp;string&lt;&gt;', 'test&amp;string&lt;&gt;'), PMA_Message::sanitize(array($this->object, $this->object)));
 270     }
 271
 272     public function decodeBBDataProvider()
 273     {
 274         return array(
 275             array('[i]test[/i][i]aa[i/][em]test[/em]', '<em>test</em><em>aa[i/]<em>test</em>'),
 276             array('[b]test[/b][strong]test[/strong]', '<strong>test</strong><strong>test</strong>'),
 277             array('[tt]test[/tt][code]test[/code]', '<code>test</code><code>test</code>'),
 278             array('[kbd]test[/kbd][br][sup]test[/sup]', '<kbd>test</kbd><br /><sup>test</sup>')
 279         );
 280     }
 281
 282     /**
 283      * testing decodeBB method
 284      * @dataProvider decodeBBDataProvider
 285      */
 286
 287     public function testDecodeBB($actual, $expected)
 288     {
 289         $this->assertEquals($expected, PMA_Message::decodeBB($actual));
 290     }
 291
 292     /**
 293      * testing format method
 294      */
 295     public function testFormat()
 296     {
 297         $this->assertEquals('test string', PMA_Message::format('test string'));
 298         $this->assertEquals('test string', PMA_Message::format('test string', 'a'));
 299         $this->assertEquals('test string', PMA_Message::format('test string', array()));
 300         $this->assertEquals('test string', PMA_Message::format('%s string', array('test')));
 301
 302     }
 303
 304     /**
 305      * testing getHash method
 306      */
 307     public function testGetHash()
 308     {
 309         $this->object->setString('<&>test', false);
 310         $this->object->setMessage('<&>test', false);
 311         $this->assertEquals(md5(PMA_Message::NOTICE . '<&>test<&>test'), $this->object->getHash());
 312     }
 313
 314     /**
 315      * getMessage test - with empty message and with non-empty string - not key in globals
 316      * additional params are defined
 317      */
 318     public function testGetMessageWithoutMessageWithStringWithParams()
 319     {
 320         $this->object->setMessage('');
 321         $this->object->setString('test string %s %s');
 322         $this->object->addParam('test param 1');
 323         $this->object->addParam('test param 2');
 324         $this->assertEquals('test string test param 1 test param 2', $this->object->getMessage());
 325     }
 326
 327     /**
 328      * getMessage test - with empty message and with empty string
 329      */
 330     public function testGetMessageWithoutMessageWithEmptyString()
 331     {
 332         $this->object->setMessage('');
 333         $this->object->setString('');
 334         $this->assertEquals('', $this->object->getMessage());
 335     }
 336
 337     /**
 338      * getMessage test - with empty message and with string, which is key to GLOBALS
 339      * additional messages are defined
 340      */
 341     public function testGetMessageWithoutMessageWithGlobalStringWithAddMessages()
 342     {
 343         $GLOBALS['key'] = 'test message';
 344         $this->object->setMessage('');
 345         $this->object->setString('key');
 346         $this->object->addMessage('test message 2', ' - ');
 347         $this->object->addMessage('test message 3', '&');
 348         $this->assertEquals('test message - test message 2&test message 3', $this->object->getMessage());
 349         unset($GLOBALS['key']);
 350     }
 351
 352     /**
 353      * getMessage test - message is defined
 354      * message with BBCode defined
 355      */
 356     public function testGetMessageWithMessageWithBBCode()
 357     {
 358         $this->object->setMessage('[kbd]test[/kbd] [a@./Documentation.html#cfg_Example@_blank]test[/a]');
 359         $this->assertEquals('<kbd>test</kbd> <a href="./Documentation.html#cfg_Example" target="_blank">test</a>', $this->object->getMessage());
 360     }
 361
 362     /**
 363      * getLevel test
 364      */
 365     public function testGetLevel()
 366     {
 367         $this->assertEquals('notice', $this->object->getLevel());
 368         $this->object->setNumber(PMA_Message::SUCCESS);
 369         $this->assertEquals('success', $this->object->getLevel());
 370         $this->object->setNumber(PMA_Message::ERROR);
 371         $this->assertEquals('error', $this->object->getLevel());
 372         $this->object->setNumber(PMA_Message::WARNING);
 373         $this->assertEquals('warning', $this->object->getLevel());
 374     }
 375
 376     /**
 377      * testing display method (output string and _is_displayed varible)
 378      */
 379     public function testDisplay()
 380     {
 381         $this->assertFalse($this->object->isDisplayed());
 382         $this->object->setMessage('Test Message');
 383
 384         $this->expectOutputString('<div class="notice">Test Message</div>');
 385         $this->object->display();
 386
 387         $this->assertTrue($this->object->isDisplayed());
 388     }
 389
 390     /**
 391      * getDisplay test
 392      */
 393     public function testGetDisplay()
 394     {
 395         $this->object->setMessage('Test Message');
 396         $this->assertEquals('<div class="notice">Test Message</div>', $this->object->getDisplay());
 397     }
 398
 399     /**
 400      * isDisplayed test
 401      */
 402     public function testIsDisplayed()
 403     {
 404         $this->assertFalse($this->object->isDisplayed(false));
 405         $this->assertTrue($this->object->isDisplayed(true));
 406         $this->assertTrue($this->object->isDisplayed(false));
 407     }
 408 }
 409 ?>