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