tests/HTMLPurifier/ErrorCollectorTest.php

   1 <?php
   2
   3 /**
   4  * @warning HTML output is in flux, but eventually needs to be stabilized.
   5  */
   6 class HTMLPurifier_ErrorCollectorTest extends HTMLPurifier_Harness
   7 {
   8
   9     protected $language, $generator, $line;
  10     protected $collector;
  11
  12     public function setup()
  13     {
  14         generate_mock_once('HTMLPurifier_Language');
  15         generate_mock_once('HTMLPurifier_Generator');
  16         parent::setup();
  17         $this->language  = new HTMLPurifier_LanguageMock();
  18         $this->language->setReturnValue('getErrorName',  'Error',   array(E_ERROR));
  19         $this->language->setReturnValue('getErrorName',  'Warning', array(E_WARNING));
  20         $this->language->setReturnValue('getErrorName',  'Notice',  array(E_NOTICE));
  21         // this might prove to be troublesome if we need to set config
  22         $this->generator = new HTMLPurifier_Generator($this->config, $this->context);
  23         $this->line = false;
  24         $this->context->register('Locale', $this->language);
  25         $this->context->register('CurrentLine', $this->line);
  26         $this->context->register('Generator', $this->generator);
  27         $this->collector = new HTMLPurifier_ErrorCollector($this->context);
  28     }
  29
  30     public function test()
  31     {
  32         $language = $this->language;
  33         $language->setReturnValue('getMessage',    'Message 1',   array('message-1'));
  34         $language->setReturnValue('formatMessage', 'Message 2',   array('message-2', array(1 => 'param')));
  35         $language->setReturnValue('formatMessage', ' at line 23', array('ErrorCollector: At line', array('line' => 23)));
  36         $language->setReturnValue('formatMessage', ' at line 3',  array('ErrorCollector: At line', array('line' => 3)));
  37
  38         $this->line = 23;
  39         $this->collector->send(E_ERROR, 'message-1');
  40
  41         $this->line = 3;
  42         $this->collector->send(E_WARNING, 'message-2', 'param');
  43
  44         $result = array(
  45             0 => array(23, E_ERROR, 'Message 1', array()),
  46             1 => array(3, E_WARNING, 'Message 2', array())
  47         );
  48
  49         $this->assertIdentical($this->collector->getRaw(), $result);
  50
  51         /*
  52         $formatted_result =
  53             '<ul><li><strong>Warning</strong>: Message 2 at line 3</li>'.
  54             '<li><strong>Error</strong>: Message 1 at line 23</li></ul>';
  55
  56         $this->assertIdentical($this->collector->getHTMLFormatted($this->config), $formatted_result);
  57         */
  58
  59     }
  60
  61     public function testNoErrors()
  62     {
  63         $this->language->setReturnValue('getMessage', 'No errors', array('ErrorCollector: No errors'));
  64
  65         $formatted_result = '<p>No errors</p>';
  66         $this->assertIdentical(
  67             $this->collector->getHTMLFormatted($this->config),
  68             $formatted_result
  69         );
  70     }
  71
  72     public function testNoLineNumbers()
  73     {
  74         $this->language->setReturnValue('getMessage', 'Message 1', array('message-1'));
  75         $this->language->setReturnValue('getMessage', 'Message 2', array('message-2'));
  76
  77         $this->collector->send(E_ERROR, 'message-1');
  78         $this->collector->send(E_ERROR, 'message-2');
  79
  80         $result = array(
  81             0 => array(false, E_ERROR, 'Message 1', array()),
  82             1 => array(false, E_ERROR, 'Message 2', array())
  83         );
  84         $this->assertIdentical($this->collector->getRaw(), $result);
  85
  86         /*
  87         $formatted_result =
  88             '<ul><li><strong>Error</strong>: Message 1</li>'.
  89             '<li><strong>Error</strong>: Message 2</li></ul>';
  90         $this->assertIdentical($this->collector->getHTMLFormatted($this->config), $formatted_result);
  91         */
  92     }
  93
  94     public function testContextSubstitutions()
  95     {
  96         $current_token = false;
  97         $this->context->register('CurrentToken', $current_token);
  98
  99         // 0
 100         $current_token = new HTMLPurifier_Token_Start('a', array('href' => 'http://example.com'), 32);
 101         $this->language->setReturnValue('formatMessage', 'Token message',
 102           array('message-data-token', array('CurrentToken' => $current_token)));
 103         $this->collector->send(E_NOTICE, 'message-data-token');
 104
 105         $current_attr  = 'href';
 106         $this->language->setReturnValue('formatMessage', '$CurrentAttr.Name => $CurrentAttr.Value',
 107           array('message-attr', array('CurrentToken' => $current_token)));
 108
 109         // 1
 110         $this->collector->send(E_NOTICE, 'message-attr'); // test when context isn't available
 111
 112         // 2
 113         $this->context->register('CurrentAttr', $current_attr);
 114         $this->collector->send(E_NOTICE, 'message-attr');
 115
 116         $result = array(
 117             0 => array(32, E_NOTICE, 'Token message', array()),
 118             1 => array(32, E_NOTICE, '$CurrentAttr.Name => $CurrentAttr.Value', array()),
 119             2 => array(32, E_NOTICE, 'href => http://example.com', array())
 120         );
 121         $this->assertIdentical($this->collector->getRaw(), $result);
 122
 123     }
 124
 125     /*
 126     public function testNestedErrors()
 127     {
 128         $this->language->setReturnValue('getMessage', 'Message 1',   array('message-1'));
 129         $this->language->setReturnValue('getMessage', 'Message 2',   array('message-2'));
 130         $this->language->setReturnValue('formatMessage', 'End Message', array('end-message', array(1 => 'param')));
 131         $this->language->setReturnValue('formatMessage', ' at line 4', array('ErrorCollector: At line', array('line' => 4)));
 132
 133         $this->line = 4;
 134         $this->collector->start();
 135         $this->collector->send(E_WARNING, 'message-1');
 136         $this->collector->send(E_NOTICE,  'message-2');
 137         $this->collector->end(E_NOTICE, 'end-message', 'param');
 138
 139         $expect = array(
 140             0 => array(4, E_NOTICE, 'End Message', array(
 141                 0 => array(4, E_WARNING, 'Message 1', array()),
 142                 1 => array(4, E_NOTICE,  'Message 2', array()),
 143             )),
 144         );
 145         $result = $this->collector->getRaw();
 146         $this->assertIdentical($result, $expect);
 147
 148         $formatted_expect =
 149             '<ul><li><strong>Notice</strong>: End Message at line 4<ul>'.
 150                 '<li><strong>Warning</strong>: Message 1 at line 4</li>'.
 151                 '<li><strong>Notice</strong>: Message 2 at line 4</li></ul>'.
 152             '</li></ul>';
 153         $formatted_result = $this->collector->getHTMLFormatted($this->config);
 154         $this->assertIdentical($formatted_result, $formatted_expect);
 155
 156     }
 157     */
 158
 159 }
 160
 161 // vim: et sw=4 sts=4