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