tests/PHPUnit/Util/Log/CPD.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.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  * @category   Testing
  38  * @package    PHPUnit
  39  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 3.2.0
  45  */
  46
  47 require_once 'PHPUnit/Runner/Version.php';
  48 require_once 'PHPUnit/Util/Metrics/Project.php';
  49 require_once 'PHPUnit/Util/CodeCoverage.php';
  50 require_once 'PHPUnit/Util/Filter.php';
  51 require_once 'PHPUnit/Util/Printer.php';
  52 require_once 'PHPUnit/Util/XML.php';
  53
  54 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  55
  56 /**
  57  * Generates an XML logfile with code duplication information.
  58  *
  59  * @category   Testing
  60  * @package    PHPUnit
  61  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  62  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  63  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  64  * @version    Release: 3.3.17
  65  * @link       http://www.phpunit.de/
  66  * @since      Class available since Release 3.2.0
  67  */
  68 class PHPUnit_Util_Log_CPD extends PHPUnit_Util_Printer
  69 {
  70     /**
  71      * @param  PHPUnit_Framework_TestResult $result
  72      */
  73     public function process(PHPUnit_Framework_TestResult $result, $minLines = 5, $minMatches = 70)
  74     {
  75         $codeCoverage = $result->getCodeCoverageInformation();
  76         $summary      = PHPUnit_Util_CodeCoverage::getSummary($codeCoverage);
  77         $files        = array_keys($summary);
  78         $metrics      = new PHPUnit_Util_Metrics_Project($files, $summary, TRUE, $minLines, $minMatches);
  79
  80         $document = new DOMDocument('1.0', 'UTF-8');
  81         $document->formatOutput = TRUE;
  82
  83         $cpd = $document->createElement('pmd-cpd');
  84         $cpd->setAttribute('version', 'PHPUnit ' . PHPUnit_Runner_Version::id());
  85         $document->appendChild($cpd);
  86
  87         foreach ($metrics->getDuplicates() as $duplicate) {
  88             $xmlDuplication = $cpd->appendChild(
  89               $document->createElement('duplication')
  90             );
  91
  92             $xmlDuplication->setAttribute('lines', $duplicate['numLines']);
  93             $xmlDuplication->setAttribute('tokens', $duplicate['numTokens']);
  94
  95             $xmlFile = $xmlDuplication->appendChild(
  96               $document->createElement('file')
  97             );
  98
  99             $xmlFile->setAttribute('path', $duplicate['fileA']->getPath());
 100             $xmlFile->setAttribute('line', $duplicate['firstLineA']);
 101
 102             $xmlFile = $xmlDuplication->appendChild(
 103               $document->createElement('file')
 104             );
 105
 106             $xmlFile->setAttribute('path', $duplicate['fileB']->getPath());
 107             $xmlFile->setAttribute('line', $duplicate['firstLineB']);
 108
 109             $xmlDuplication->appendChild(
 110               $document->createElement(
 111                 'codefragment',
 112                 htmlspecialchars(
 113                   PHPUnit_Util_XML::convertToUtf8(
 114                     join(
 115                       '',
 116                       array_slice(
 117                         $duplicate['fileA']->getLines(),
 118                         $duplicate['firstLineA'] - 1,
 119                         $duplicate['numLines']
 120                       )
 121                     )
 122                   ),
 123                   ENT_COMPAT,
 124                   'UTF-8'
 125                 )
 126               )
 127             );
 128         }
 129
 130         $this->write($document->saveXML());
 131         $this->flush();
 132     }
 133 }
 134 ?>