tests/PHPUnit/PHPUnit/Util/Fileloader.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.3.0
  44  */
  45
  46 /**
  47  * Utility methods to load PHP sourcefiles.
  48  *
  49  * @package    PHPUnit
  50  * @subpackage Util
  51  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  52  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  53  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  54  * @version    Release: @package_version@
  55  * @link       http://www.phpunit.de/
  56  * @since      Class available since Release 2.3.0
  57  */
  58 class PHPUnit_Util_Fileloader
  59 {
  60     /**
  61      * Checks if a PHP sourcefile is readable and is optionally checked for
  62      * syntax errors through the syntaxCheck() method. The sourcefile is
  63      * loaded through the load() method.
  64      *
  65      * @param  string  $filename
  66      * @param  boolean $syntaxCheck
  67      * @return string
  68      * @throws RuntimeException
  69      */
  70     public static function checkAndLoad($filename, $syntaxCheck = FALSE)
  71     {
  72         $includePathFilename = PHPUnit_Util_Filesystem::fileExistsInIncludePath(
  73           $filename
  74         );
  75
  76         if (!$includePathFilename || !is_readable($includePathFilename)) {
  77             throw new RuntimeException(
  78               sprintf('Cannot open file "%s".' . "\n", $filename)
  79             );
  80         }
  81
  82         if ($syntaxCheck) {
  83             self::syntaxCheck($includePathFilename);
  84         }
  85
  86         self::load($includePathFilename);
  87
  88         return $includePathFilename;
  89     }
  90
  91     /**
  92      * Loads a PHP sourcefile.
  93      *
  94      * @param  string $filename
  95      * @return mixed
  96      * @since  Method available since Release 3.0.0
  97      */
  98     public static function load($filename)
  99     {
 100         $oldVariableNames = array_keys(get_defined_vars());
 101
 102         include_once $filename;
 103
 104         $newVariables     = get_defined_vars();
 105         $newVariableNames = array_diff(
 106                               array_keys($newVariables), $oldVariableNames
 107                             );
 108
 109         foreach ($newVariableNames as $variableName) {
 110             if ($variableName != 'oldVariableNames') {
 111                 $GLOBALS[$variableName] = $newVariables[$variableName];
 112             }
 113         }
 114
 115         return $filename;
 116     }
 117
 118     /**
 119      * Uses a separate process to perform a syntax check on a PHP sourcefile.
 120      *
 121      * @param  string $filename
 122      * @throws RuntimeException
 123      * @since  Method available since Release 3.0.0
 124      */
 125     protected static function syntaxCheck($filename)
 126     {
 127         $command = PHPUnit_Util_PHP::getPhpBinary();
 128
 129         if (DIRECTORY_SEPARATOR == '\\') {
 130             $command = escapeshellarg($command);
 131         }
 132
 133         $command .= ' -l ' . escapeshellarg($filename);
 134         $output   = shell_exec($command);
 135
 136         if (strpos($output, 'Errors parsing') !== FALSE) {
 137             throw new RuntimeException($output);
 138         }
 139     }
 140 }