tests/PHPUnit/PHPUnit/Util/Filter.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2011, Sebastian Bergmann <sebastian@phpunit.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @package    PHPUnit
  38  * @subpackage Util
  39  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  40  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42  * @link       http://www.phpunit.de/
  43  * @since      File available since Release 2.0.0
  44  */
  45
  46 require_once 'File/Iterator/Factory.php';
  47
  48 /**
  49  * Utility class for code filtering.
  50  *
  51  * @package    PHPUnit
  52  * @subpackage Util
  53  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  54  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  55  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  56  * @version    Release: 3.5.14
  57  * @link       http://www.phpunit.de/
  58  * @since      Class available since Release 2.0.0
  59  */
  60 class PHPUnit_Util_Filter
  61 {
  62     /**
  63      * Filters stack frames from PHPUnit classes.
  64      *
  65      * @param  Exception $e
  66      * @param  boolean   $filterTests
  67      * @param  boolean   $asString
  68      * @return string
  69      */
  70     public static function getFilteredStacktrace(Exception $e, $filterTests = TRUE, $asString = TRUE)
  71     {
  72         if ($asString === TRUE) {
  73             $filteredStacktrace = '';
  74         } else {
  75             $filteredStacktrace = array();
  76         }
  77
  78         $groups = array('DEFAULT');
  79
  80         if (!defined('PHPUNIT_TESTSUITE')) {
  81             $groups[] = 'PHPUNIT';
  82         }
  83
  84         if ($filterTests) {
  85             $groups[] = 'TESTS';
  86         }
  87
  88         if ($e instanceof PHPUnit_Framework_SyntheticError) {
  89             $eTrace = $e->getSyntheticTrace();
  90         } else {
  91             $eTrace = $e->getTrace();
  92         }
  93
  94         if (!self::frameExists($eTrace, $e->getFile(), $e->getLine())) {
  95             array_unshift(
  96               $eTrace, array('file' => $e->getFile(), 'line' => $e->getLine())
  97             );
  98         }
  99
 100         foreach ($eTrace as $frame) {
 101             if (isset($frame['file']) && is_file($frame['file']) &&
 102                 !PHP_CodeCoverage::getInstance()->filter()->isFiltered(
 103                   $frame['file'], $groups, TRUE)) {
 104                 if ($asString === TRUE) {
 105                     $filteredStacktrace .= sprintf(
 106                       "%s:%s\n",
 107
 108                       $frame['file'],
 109                       isset($frame['line']) ? $frame['line'] : '?'
 110                     );
 111                 } else {
 112                     $filteredStacktrace[] = $frame;
 113                 }
 114             }
 115         }
 116
 117         return $filteredStacktrace;
 118     }
 119
 120     /**
 121      * @param  array  $trace
 122      * @param  string $file
 123      * @param  int    $line
 124      * @return boolean
 125      * @since  Method available since Release 3.3.2
 126      */
 127     public static function frameExists(array $trace, $file, $line)
 128     {
 129         foreach ($trace as $frame) {
 130             if (isset($frame['file']) && $frame['file'] == $file &&
 131                 isset($frame['line']) && $frame['line'] == $line) {
 132                 return TRUE;
 133             }
 134         }
 135
 136         return FALSE;
 137     }
 138 }