PHPSocialNetwork/phpfastcache

View on GitHub
lib/Phpfastcache/Helper/TestHelper.php

Summary

Maintainability
B
4 hrs
Test Coverage
<?php
/**
 *
 * This file is part of phpFastCache.
 *
 * @license MIT License (MIT)
 *
 * For full copyright and license information, please see the docs/CREDITS.txt file.
 *
 * @author Khoa Bui (khoaofgod)  <khoaofgod@gmail.com> https://www.phpfastcache.com
 * @author Georges.L (Geolim4)  <contact@geolim4.com>
 *
 */
declare(strict_types=1);

namespace Phpfastcache\Helper;

use Phpfastcache\Api;
use Phpfastcache\Exceptions\PhpfastcacheDriverCheckException;

/**
 * Class TestHelper
 * @package phpFastCache\Helper
 */
class TestHelper
{
    /**
     * @var string
     */
    protected $testName;

    /**
     * @var int
     */
    protected $exitCode = 0;

    /**
     * @var int
     */
    protected $timestamp;

    /**
     * TestHelper constructor.
     *
     * @param string $testName
     * @throws \Phpfastcache\Exceptions\PhpfastcacheIOException
     * @throws \Phpfastcache\Exceptions\PhpfastcacheLogicException
     */
    public function __construct(string $testName)
    {
        $this->timestamp = microtime(true);
        $this->testName = $testName;

        /**
         * Catch all uncaught exception
         * to our own exception handler
         */
        set_exception_handler([$this, 'exceptionHandler']);
        set_error_handler([$this, 'errorHandler']);

        $this->printHeaders();
    }

    /**
     * @throws \Phpfastcache\Exceptions\PhpfastcacheIOException
     * @throws \Phpfastcache\Exceptions\PhpfastcacheLogicException
     */
    public function printHeaders()
    {
        if (!$this->isCli() && !\headers_sent()) {
            \header('Content-Type: text/plain, true');
        }

        $this->printText('[PhpFastCache CORE v' . Api::getPhpFastCacheVersion() . Api::getPhpFastCacheGitHeadHash() . ']', true);
        $this->printText('[PhpFastCache API v' . Api::getVersion() . ']', true);
        $this->printText('[PHP v' . PHP_VERSION . ']', true);
        $this->printText("[Begin Test: '{$this->testName}']");
        $this->printText('---');

    }

    /**
     * @return int
     */
    public function getExitCode(): int
    {
        return $this->exitCode;
    }

    /**
     * @return $this
     */
    public function resetExitCode(): self
    {
        $this->exitCode = 0;

        return $this;
    }

    /**
     * @param string $string
     * @return $this
     */
    public function printSkipText(string $string): self
    {
        $this->printText($string, false, 'SKIP');

        return $this;
    }

    /**
     * @param string $string
     * @return $this
     */
    public function printPassText(string $string): self
    {
        $this->printText($string, false, 'PASS');


        return $this;
    }

    /**
     * @param string printFailText
     * @return $this
     */
    public function printInfoText(string $string): self
    {
        $this->printText($string, false, 'INFO');


        return $this;
    }

    /**
     * @param string $string
     * @return $this
     */
    public function printDebugText(string $string): self
    {
        $this->printText($string, false, 'DEBUG');

        return $this;
    }

    /**
     * @param string $string
     * @return $this
     */
    public function printNoteText(string $string): self
    {
        $this->printText($string, false, 'NOTE');

        return $this;
    }

    /**
     * @param string $string
     * @return $this
     */
    public function printFailText(string $string): self
    {
        $this->printText($string, false, 'FAIL');
        $this->exitCode = 1;

        return $this;
    }

    /**
     * @param int $count
     * @return $this
     */
    public function printNewLine(int $count = 1): self
    {
        print \str_repeat(PHP_EOL, $count);
        return $this;
    }

    /**
     * @param string $string
     * @param bool $strtoupper
     * @param string $prefix
     * @return $this
     */
    public function printText(string $string, bool $strtoupper = false, string $prefix = ''): self
    {
        if ($prefix) {
            $string = "[{$prefix}] {$string}";
        }
        if (!$strtoupper) {
            print \trim($string) . PHP_EOL;
        } else {
            print \strtoupper(\trim($string) . PHP_EOL);
        }

        return $this;
    }

    /**
     * @param string $cmd
     */
    public function runAsyncProcess(string $cmd)
    {
        if (\substr(\php_uname(), 0, 7) === 'Windows') {
            \pclose(\popen('start /B ' . $cmd, 'r'));
        } else {
            \exec($cmd . ' > /dev/null &');
        }
    }

    /**
     * @param string $file
     * @param string $ext
     */
    public function runSubProcess(string $file, string $ext = '.php')
    {
        $this->runAsyncProcess(($this->isHHVM() ? 'hhvm ' : 'php ') . \getcwd() . \DIRECTORY_SEPARATOR . 'subprocess' . \DIRECTORY_SEPARATOR . $file . '.subprocess' . $ext);
    }

    /**
     * @return void
     */
    public function terminateTest()
    {
        $execTime = \round(\microtime(true) - $this->timestamp, 3);

        $this->printText('Test duration: ' . $execTime . 's');
        exit($this->exitCode);
    }

    /**
     * @return bool
     */
    public function isHHVM(): bool
    {
        return \defined('HHVM_VERSION');
    }

    /**
     * @param $obj
     * @param $prop
     * @return mixed
     * @throws \ReflectionException
     */
    public function accessInaccessibleMember($obj, $prop)
    {
        $reflection = new \ReflectionClass($obj);
        $property = $reflection->getProperty($prop);
        $property->setAccessible(true);
        return $property->getValue($obj);
    }

    /**
     * @param \Throwable $exception
     */
    public function exceptionHandler(\Throwable $exception)
    {
        if ($exception instanceof PhpfastcacheDriverCheckException) {
            $this->printSkipText('A driver could not be initialized due to missing requirement: ' . $exception->getMessage());
            $this->exitCode = 0;
        } else {
            $this->printFailText(\sprintf(
                'Uncaught exception "%s" in "%s" line %d with message: "%s"',
                \get_class($exception),
                $exception->getFile(),
                $exception->getLine(),
                $exception->getMessage()
            ));
        }
        $this->terminateTest();
    }

    /**
     * @param int $errno
     * @param string $errstr
     * @param string $errfile
     * @param int $errline
     */
    public function errorHandler(int $errno, string $errstr, string $errfile, int $errline)
    {
        $errorType = '';

        switch ($errno) {
            case \E_PARSE:
            case \E_ERROR:
            case \E_CORE_ERROR:
            case \E_COMPILE_ERROR:
            case \E_USER_ERROR:
                $errorType = '[FATAL ERROR]';
                break;
            case \E_WARNING:
            case \E_USER_WARNING:
            case \E_COMPILE_WARNING:
            case \E_RECOVERABLE_ERROR:
                $errorType = '[WARNING]';
                break;
            case \E_NOTICE:
            case \E_USER_NOTICE:
                $errorType = '[NOTICE]';
                break;
            case \E_STRICT:
                $errorType = '[STRICT]';
                break;
            case \E_DEPRECATED:
            case \E_USER_DEPRECATED:
                $errorType = '[DEPRECATED]';
                break;
            default:
                break;
        }

        if ($errorType === '[FATAL ERROR]') {
            $this->printFailText(\sprintf(
                "A critical error has been caught: \"%s\" in %s line %d",
                "$errorType $errstr",
                $errfile,
                $errline
            ));
        } else {
            $this->printDebugText(\sprintf(
                "A non-critical error has been caught: \"%s\" in %s line %d",
                "$errorType $errstr",
                $errfile,
                $errline
            ));
        }
    }

    /**
     * @see https://stackoverflow.com/questions/933367/php-how-to-best-determine-if-the-current-invocation-is-from-cli-or-web-server
     * @return bool
     */
    public function isCli(): bool
    {
        if (\defined('STDIN')) {
            return true;
        }

        if (\php_sapi_name() === 'cli') {
            return true;
        }

        if (\array_key_exists('SHELL', $_ENV)) {
            return true;
        }

        if (empty($_SERVER['REMOTE_ADDR']) && !isset($_SERVER['HTTP_USER_AGENT']) && \count($_SERVER['argv']) > 0) {
            return true;
        }

        if (!\array_key_exists('REQUEST_METHOD', $_SERVER)) {
            return true;
        }

        return false;
    }
}