home *** CD-ROM | disk | FTP | other *** search
- <?php
- /**
- * $Id: PHPUnit2ReportTask.php 82 2006-07-07 18:15:35Z mrook $
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * This software consists of voluntary contributions made by many individuals
- * and is licensed under the LGPL. For more information please see
- * <http://phing.info>.
- */
-
- require_once 'phing/Task.php';
- require_once 'phing/system/io/PhingFile.php';
- require_once 'phing/system/io/FileWriter.php';
- require_once 'phing/util/ExtendedFileStream.php';
-
- /**
- * Transform a PHPUnit2 xml report using XSLT.
- * This transformation generates an html report in either framed or non-framed
- * style. The non-framed style is convenient to have a concise report via mail,
- * the framed report is much more convenient if you want to browse into
- * different packages or testcases since it is a Javadoc like report.
- *
- * @author Michiel Rook <michiel.rook@gmail.com>
- * @version $Id: PHPUnit2ReportTask.php 82 2006-07-07 18:15:35Z mrook $
- * @package phing.tasks.ext.phpunit2
- * @since 2.1.0
- */
- class PHPUnit2ReportTask extends Task
- {
- private $format = "noframes";
- private $styleDir = "";
- private $toDir = "";
-
- /** the directory where the results XML can be found */
- private $inFile = "testsuites.xml";
-
- /**
- * Set the filename of the XML results file to use.
- */
- function setInFile($inFile)
- {
- $this->inFile = $inFile;
- }
-
- /**
- * Set the format of the generated report. Must be noframes or frames.
- */
- function setFormat($format)
- {
- $this->format = $format;
- }
-
- /**
- * Set the directory where the stylesheets are located.
- */
- function setStyleDir($styleDir)
- {
- $this->styleDir = $styleDir;
- }
-
- /**
- * Set the directory where the files resulting from the
- * transformation should be written to.
- */
- function setToDir($toDir)
- {
- $this->toDir = $toDir;
- }
-
- /**
- * Returns the path to the XSL stylesheet
- */
- private function getStyleSheet()
- {
- $xslname = "phpunit2-" . $this->format . ".xsl";
-
- if ($this->styleDir)
- {
- $file = new PhingFile($this->styleDir, $xslname);
- }
- else
- {
- $path = Phing::getResourcePath("phing/etc/$xslname");
-
- if ($path === NULL)
- {
- $path = Phing::getResourcePath("etc/$xslname");
-
- if ($path === NULL)
- {
- throw new BuildException("Could not find $xslname in resource path");
- }
- }
-
- $file = new PhingFile($path);
- }
-
- if (!$file->exists())
- {
- throw new BuildException("Could not find file " . $file->getPath());
- }
-
- return $file;
- }
-
- /**
- * Transforms the DOM document
- */
- private function transform(DOMDocument $document)
- {
- $dir = new PhingFile($this->toDir);
-
- if (!$dir->exists())
- {
- throw new BuildException("Directory '" . $this->toDir . "' does not exist");
- }
-
- $xslfile = $this->getStyleSheet();
-
- $xsl = new DOMDocument();
- $xsl->load($xslfile->getAbsolutePath());
-
- $proc = new XSLTProcessor();
- $proc->importStyleSheet($xsl);
-
- if ($this->format == "noframes")
- {
- $writer = new FileWriter(new PhingFile($this->toDir, "phpunit2-noframes.html"));
- $writer->write($proc->transformToXML($document));
- $writer->close();
- }
- else
- {
- ExtendedFileStream::registerStream();
-
- // no output for the framed report
- // it's all done by extension...
- $dir = new PhingFile($this->toDir);
- $proc->setParameter('', 'output.dir', $dir->getAbsolutePath());
- $proc->transformToXML($document);
- }
- }
-
- /**
- * Fixes 'testsuite' elements with no package attribute, adds
- * package="default" to those elements.
- */
- private function fixPackages(DOMDocument $document)
- {
- $testsuites = $document->getElementsByTagName('testsuite');
-
- foreach ($testsuites as $testsuite)
- {
- if (!$testsuite->hasAttribute('package'))
- {
- $testsuite->setAttribute('package', 'default');
- }
- }
- }
-
- /**
- * The main entry point
- *
- * @throws BuildException
- */
- public function main()
- {
- $testSuitesDoc = new DOMDocument();
- $testSuitesDoc->load($this->inFile);
-
- $this->fixPackages($testSuitesDoc);
-
- $this->transform($testSuitesDoc);
- }
- }
- ?>