1. sfTesterResponse.class.php
  2. /**
 * sfTesterResponse implements tests for the symfony response object.
 *
 * @package    symfony
 * @subpackage test
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfTesterResponse.class.php 27061 2010-01-22 17:08:04Z FabianLange $
 */
  3. class sfTesterResponse extends sfTester
  4. {
  5.   protected
  6.     $response       = null,
  7.     $dom            = null,
  8.     $domCssSelector = null;
  10.   /**
  11.    * Prepares the tester.
  12.    */
  13.   public function prepare()
  14.   {
  15.   }
  17.   /**
  18.    * Initializes the tester.
  19.    */
  20.   public function initialize()
  21.   {
  22.     $this->response = $this->browser->getResponse();
  24.     $this->dom = null;
  25.     $this->domCssSelector = null;
  26.     if (preg_match('/(x|ht)ml/i', $this->response->getContentType(), $matches))
  27.     {
  28.       $this->dom = new DOMDocument('1.0', $this->response->getCharset());
  29.       $this->dom->validateOnParse = true;
  30.       if ('x' == $matches[1])
  31.       {
  32.         @$this->dom->loadXML($this->response->getContent());
  33.       }
  34.       else
  35.       {
  36.         @$this->dom->loadHTML($this->response->getContent());
  37.       }
  38.       $this->domCssSelector = new sfDomCssSelector($this->dom);
  39.     }
  40.   }
  42.   /**
  43.    * Tests that the response matches a given CSS selector.
  44.    *
  45.    * @param  string $selector  The response selector or a sfDomCssSelector object
  46.    * @param  mixed  $value     Flag for the selector
  47.    * @param  array  $options   Options for the current test
  48.    *
  49.    * @return sfTestFunctionalBase|sfTester
  50.    */
  51.   public function checkElement($selector, $value = true, $options = array())
  52.   {
  53.     if (null === $this->dom)
  54.     {
  55.       throw new LogicException('The DOM is not accessible because the browser response content type is not HTML.');
  56.     }
  58.     if (is_object($selector))
  59.     {
  60.       $values = $selector->getValues();
  61.     }
  62.     else
  63.     {
  64.       $values = $this->domCssSelector->matchAll($selector)->getValues();
  65.     }
  67.     if (false === $value)
  68.     {
  69.       $this->tester->is(count($values), 0, sprintf('response selector "%s" does not exist', $selector));
  70.     }
  71.     else if (true === $value)
  72.     {
  73.       $this->tester->cmp_ok(count($values), '>', 0, sprintf('response selector "%s" exists', $selector));
  74.     }
  75.     else if (is_int($value))
  76.     {
  77.       $this->tester->is(count($values), $value, sprintf('response selector "%s" matches "%s" times', $selector, $value));
  78.     }
  79.     else if (preg_match('/^(!)?([^a-zA-Z0-9\\\\]).+?\\2[ims]?$/', $value, $match))
  80.     {
  81.       $position = isset($options['position']) ? $options['position'] : 0;
  82.       if ($match[1] == '!')
  83.       {
  84.         $this->tester->unlike(@$values[$position], substr($value, 1), sprintf('response selector "%s" does not match regex "%s"', $selector, substr($value, 1)));
  85.       }
  86.       else
  87.       {
  88.         $this->tester->like(@$values[$position], $value, sprintf('response selector "%s" matches regex "%s"', $selector, $value));
  89.       }
  90.     }
  91.     else
  92.     {
  93.       $position = isset($options['position']) ? $options['position'] : 0;
  94.       $this->tester->is(@$values[$position], $value, sprintf('response selector "%s" matches "%s"', $selector, $value));
  95.     }
  97.     if (isset($options['count']))
  98.     {
  99.       $this->tester->is(count($values), $options['count'], sprintf('response selector "%s" matches "%s" times', $selector, $options['count']));
  100.     }
  102.     return $this->getObjectToReturn();
  103.   }
  105.   /**
  106.    * Checks that a form is rendered correctly.
  107.    * 
  108.    * @param  sfForm|string $form     A form object or the name of a form class
  109.    * @param  string        $selector CSS selector for the root form element for this form
  110.    * 
  111.    * @return sfTestFunctionalBase|sfTester
  112.    */
  113.   public function checkForm($form, $selector = 'form')
  114.   {
  115.     if (!$form instanceof sfForm)
  116.     {
  117.       $form = new $form();
  118.     }
  120.     $rendered = array();
  121.     foreach ($this->domCssSelector->matchAll(sprintf('%1$s input, %1$s textarea, %1$s select', $selector))->getNodes() as $element)
  122.     {
  123.       $rendered[] = $element->getAttribute('name');
  124.     }
  126.     foreach ($form as $field => $widget)
  127.     {
  128.       $dom = new DOMDocument('1.0', sfConfig::get('sf_charset'));
  129.       $dom->loadHTML((string) $widget);
  131.       foreach ($dom->getElementsByTagName('*') as $element)
  132.       {
  133.         if (in_array($element->tagName, array('input', 'select', 'textarea')))
  134.         {
  135.           if (false !== $pos = array_search($element->getAttribute('name'), $rendered))
  136.           {
  137.             unset($rendered[$pos]);
  138.           }
  140.           $this->tester->ok(false !== $pos, sprintf('response includes "%s" form "%s" field - "%s %s[name=%s]"', get_class($form), $field, $selector, $element->tagName, $element->getAttribute('name')));
  141.         }
  142.       }
  143.     }
  145.     return $this->getObjectToReturn();
  146.   }
  148.   /**
  149.    * Validates the response.
  150.    *
  151.    * @param mixed $checkDTD Either true to validate against the response DTD or
  152.    *                        provide the path to a *.xsd, *.rng or *.rnc schema
  153.    *
  154.    * @return sfTestFunctionalBase|sfTester
  155.    *
  156.    * @throws LogicException If the response is neither XML nor (X)HTML
  157.    */
  158.   public function isValid($checkDTD = false)
  159.   {
  160.     if (preg_match('/(x|ht)ml/i', $this->response->getContentType()))
  161.     {
  162.       $revert = libxml_use_internal_errors(true);
  164.       $dom = new DOMDocument('1.0', $this->response->getCharset());
  165.       $content = $this->response->getContent();
  167.       if (true === $checkDTD)
  168.       {
  169.         $cache = sfConfig::get('sf_cache_dir').'/sf_tester_response/w3';
  170.         if ($cache[1] == ':')
  171.         {
  172.           // On Windows systems the path will be like c:\symfony\cache\xml.dtd
  173.           // I did not manage to get DOMDocument loading a file protocol url including the drive letter
  174.           // file://c:\symfony\cache\xml.dtd or file://c:/symfony/cache/xml.dtd
  175.           // The first one simply doesnt work, the second one is treated as remote call.
  176.           // However the following works. Unfortunatly this means we can only access the current disk
  177.           // file:///symfony/cache/xml.dtd
  178.           // Note that all work for file_get_contents so the bug is most likely in DOMDocument.
  179.           $local = 'file://'.substr(str_replace(DIRECTORY_SEPARATOR, '/', $cache), 2);
  180.         }
  181.         else
  182.         {
  183.           $local = 'file://'.$cache;
  184.         }
  186.         if (!file_exists($cache.'/TR/xhtml11/DTD/xhtml11.dtd'))
  187.         {
  188.           $filesystem = new sfFilesystem();
  190.           $finder = sfFinder::type('any')->discard('.sf');
  191.           $filesystem->mirror(dirname(__FILE__).'/w3', $cache, $finder);
  193.           $finder = sfFinder::type('file');
  194.           $filesystem->replaceTokens($finder->in($cache), '##', '##', array('LOCAL_W3' => $local));
  195.         }
  197.         $content = preg_replace('#(<!DOCTYPE[^>]+")http://www.w3.org(.*")#i', '\\1'.$local.'\\2', $content);
  198.         $dom->validateOnParse = $checkDTD;
  199.       }
  201.       $dom->loadXML($content);
  203.       switch (pathinfo($checkDTD, PATHINFO_EXTENSION))
  204.       {
  205.         case 'xsd':
  206.           $dom->schemaValidate($checkDTD);
  207.           $message = sprintf('response validates per XSD schema "%s"', basename($checkDTD));
  208.           break;
  209.         case 'rng':
  210.         case 'rnc':
  211.           $dom->relaxNGValidate($checkDTD);
  212.           $message = sprintf('response validates per relaxNG schema "%s"', basename($checkDTD));
  213.           break;
  214.         default:
  215.           $message = $dom->validateOnParse ? sprintf('response validates as "%s"', $dom->doctype->name) : 'response is well-formed "xml"';
  216.       }
  218.       if (count($errors = libxml_get_errors()))
  219.       {
  220.         $lines = explode(PHP_EOL, $this->response->getContent());
  222.         $this->tester->fail($message);
  223.         foreach ($errors as $error)
  224.         {
  225.           $this->tester->diag('    '.trim($error->message));
  226.           if (preg_match('/line (\d+)/', $error->message, $match) && $error->line != $match[1])
  227.           {
  228.             $this->tester->diag('      '.str_pad($match[1].':', 6).trim($lines[$match[1] - 1]));
  229.           }
  230.           $this->tester->diag('      '.str_pad($error->line.':', 6).trim($lines[$error->line - 1]));
  231.         }
  232.       }
  233.       else
  234.       {
  235.         $this->tester->pass($message);
  236.       }
  238.       libxml_use_internal_errors($revert);
  239.     }
  240.     else
  241.     {
  242.       throw new LogicException(sprintf('Unable to validate responses of content type "%s"', $this->response->getContentType()));
  243.     }
  245.     return $this->getObjectToReturn();
  246.   }
  248.   /**
  249.    * Tests for a response header.
  250.    *
  251.    * @param  string $key
  252.    * @param  string $value
  253.    *
  254.    * @return sfTestFunctionalBase|sfTester
  255.    */
  256.   public function isHeader($key, $value)
  257.   {
  258.     $headers = explode(', ', $this->response->getHttpHeader($key));
  259.     $ok = false;
  260.     $regex = false;
  261.     $mustMatch = true;
  262.     if (preg_match('/^(!)?([^a-zA-Z0-9\\\\]).+?\\2[ims]?$/', $value, $match))
  263.     {
  264.       $regex = $value;
  265.       if ($match[1] == '!')
  266.       {
  267.         $mustMatch = false;
  268.         $regex = substr($value, 1);
  269.       }
  270.     }
  272.     foreach ($headers as $header)
  273.     {
  274.       if (false !== $regex)
  275.       {
  276.         if ($mustMatch)
  277.         {
  278.           if (preg_match($regex, $header))
  279.           {
  280.             $ok = true;
  281.             $this->tester->pass(sprintf('response header "%s" matches "%s" (%s)', $key, $value, $this->response->getHttpHeader($key)));
  282.             break;
  283.           }
  284.         }
  285.         else
  286.         {
  287.           if (preg_match($regex, $header))
  288.           {
  289.             $ok = true;
  290.             $this->tester->fail(sprintf('response header "%s" does not match "%s" (%s)', $key, $value, $this->response->getHttpHeader($key)));
  291.             break;
  292.           }
  293.         }
  294.       }
  295.       else if ($header == $value)
  296.       {
  297.         $ok = true;
  298.         $this->tester->pass(sprintf('response header "%s" is "%s" (%s)', $key, $value, $this->response->getHttpHeader($key)));
  299.         break;
  300.       }
  301.     }
  303.     if (!$ok)
  304.     {
  305.       if (!$mustMatch)
  306.       {
  307.         $this->tester->pass(sprintf('response header "%s" matches "%s" (%s)', $key, $value, $this->response->getHttpHeader($key)));
  308.       }
  309.       else
  310.       {
  311.         $this->tester->fail(sprintf('response header "%s" matches "%s" (%s)', $key, $value, $this->response->getHttpHeader($key)));
  312.       }
  313.     }
  315.     return $this->getObjectToReturn();
  316.   }
  318.   /**
  319.    * Tests if a cookie was set.
  320.    * 
  321.    * @param  string $name
  322.    * @param  string $value
  323.    * @param  array  $attributes Other cookie attributes to check (expires, path, domain, etc)
  324.    * 
  325.    * @return sfTestFunctionalBase|sfTester
  326.    */
  327.   public function setsCookie($name, $value = null, $attributes = array())
  328.   {
  329.     foreach ($this->response->getCookies() as $cookie)
  330.     {
  331.       if ($name == $cookie['name'])
  332.       {
  333.         if (null === $value)
  334.         {
  335.           $this->tester->pass(sprintf('response sets cookie "%s"', $name));
  336.         }
  337.         else
  338.         {
  339.           $this->tester->ok($value == $cookie['value'], sprintf('response sets cookie "%s" to "%s"', $name, $value));
  340.         }
  342.         foreach ($attributes as $attributeName => $attributeValue)
  343.         {
  344.           if (!array_key_exists($attributeName, $cookie))
  345.           {
  346.             throw new LogicException(sprintf('The cookie attribute "%s" is not valid.', $attributeName));
  347.           }
  349.           $this->tester->is($cookie[$attributeName], $attributeValue, sprintf('"%s" cookie "%s" attribute is "%s"', $name, $attributeName, $attributeValue));
  350.         }
  352.         return $this->getObjectToReturn();
  353.       }
  354.     }
  356.     $this->tester->fail(sprintf('response sets cookie "%s"', $name));
  358.     return $this->getObjectToReturn();
  359.   }
  361.   /**
  362.    * Tests the response content against a regex.
  363.    *
  364.    * @param string Regex
  365.    *
  366.    * @return sfTestFunctionalBase|sfTester
  367.    */
  368.   public function matches($regex)
  369.   {
  370.     if (!preg_match('/^(!)?([^a-zA-Z0-9\\\\]).+?\\2[ims]?$/', $regex, $match))
  371.     {
  372.       throw new InvalidArgumentException(sprintf('"%s" is not a valid regular expression.', $regex));
  373.     }
  375.     if ($match[1] == '!')
  376.     {
  377.       $this->tester->unlike($this->response->getContent(), substr($regex, 1), sprintf('response content does not match regex "%s"', substr($regex, 1)));
  378.     }
  379.     else
  380.     {
  381.       $this->tester->like($this->response->getContent(), $regex, sprintf('response content matches regex "%s"', $regex));
  382.     }
  384.     return $this->getObjectToReturn();
  385.   }
  387.   /**
  388.    * Tests the status code.
  389.    *
  390.    * @param string $statusCode Status code to check, default 200
  391.    *
  392.    * @return sfTestFunctionalBase|sfTester
  393.    */
  394.   public function isStatusCode($statusCode = 200)
  395.   {
  396.     $this->tester->is($this->response->getStatusCode(), $statusCode, sprintf('status code is "%s"', $statusCode));
  398.     return $this->getObjectToReturn();
  399.   }
  401.   /**
  402.    * Tests if the current request has been redirected.
  403.    *
  404.    * @param  bool $boolean  Flag for redirection mode
  405.    *
  406.    * @return sfTestFunctionalBase|sfTester
  407.    */
  408.   public function isRedirected($boolean = true)
  409.   {
  410.     if ($location = $this->response->getHttpHeader('location'))
  411.     {
  412.       $boolean ? $this->tester->pass(sprintf('page redirected to "%s"', $location)) : $this->tester->fail(sprintf('page redirected to "%s"', $location));
  413.     }
  414.     else
  415.     {
  416.       $boolean ? $this->tester->fail('page redirected') : $this->tester->pass('page not redirected');
  417.     }
  419.     return $this->getObjectToReturn();
  420.   }
  422.   /**
  423.    * Outputs some debug information about the current response.
  424.    *
  425.    * @param string $realOutput Whether to display the actual content of the response when an error occurred
  426.    *                           or the exception message and the stack trace to ease debugging
  427.    */
  428.   public function debug($realOutput = false)
  429.   {
  430.     print $this->tester->error('Response debug');
  432.     if (!$realOutput && null !== sfException::getLastException())
  433.     {
  434.       // print the exception and the stack trace instead of the "normal" output
  435.       $this->tester->comment('WARNING');
  436.       $this->tester->comment('An error occurred when processing this request.');
  437.       $this->tester->comment('The real response content has been replaced with the exception message to ease debugging.');
  438.     }
  440.     printf("HTTP/1.X %s\n", $this->response->getStatusCode());
  442.     foreach ($this->response->getHttpHeaders() as $name => $value)
  443.     {
  444.       printf("%s: %s\n", $name, $value);
  445.     }
  447.     foreach ($this->response->getCookies() as $cookie)
  448.     {
  449.       vprintf("Set-Cookie: %s=%s; %spath=%s%s%s%s\n", array(
  450.         $cookie['name'],
  451.         $cookie['value'],
  452.         null === $cookie['expire'] ? '' : sprintf('expires=%s; ', date('D d-M-Y H:i:s T', $cookie['expire'])),
  453.         $cookie['path'],
  454.         $cookie['domain'] ? sprintf('; domain=%s', $cookie['domain']) : '',
  455.         $cookie['secure'] ? '; secure' : '',
  456.         $cookie['httpOnly'] ? '; HttpOnly' : '',
  457.       ));
  458.     }
  460.     echo "\n";
  461.     if (!$realOutput && null !== $exception = sfException::getLastException())
  462.     {
  463.       echo $exception;
  464.     }
  465.     else
  466.     {
  467.       echo $this->response->getContent();
  468.     }
  469.     echo "\n";
  471.     exit(1);
  472.   }
  473. }
Debug toolbar