php-e107/e107_tests/tests/_support/Helper/E107Base.php

<?php
namespace Helper;
include_once(codecept_root_dir() . "lib/preparers/PreparerFactory.php");

use Codeception\Lib\ModuleContainer;
use PreparerFactory;
use Twig\Environment;
use Twig\Loader\ArrayLoader;

abstract class E107Base extends Base
{
    const APP_PATH_E107_CONFIG = APP_PATH . "/e107_config.php";
    const E107_MYSQL_PREFIX = 'e107_';
    protected $preparer = null;
    private $configBackedUp = false; // Track if we’ve backed up the config

    public function __construct(ModuleContainer $moduleContainer, $config = null)
    {
        parent::__construct($moduleContainer, $config);
        $this->preparer = PreparerFactory::create();
    }

    public function _beforeSuite($settings = [])
    {
        $this->backupLocalE107Config();
        $this->preparer->snapshot();
        parent::_beforeSuite($settings);
        $this->writeLocalE107Config();
    }

    protected function backupLocalE107Config()
    {
        if (file_exists(self::APP_PATH_E107_CONFIG)) {
            rename(self::APP_PATH_E107_CONFIG, APP_PATH . '/e107_config.php.bak');
            $this->configBackedUp = true; // Mark as backed up
        }
    }

    protected function writeLocalE107Config()
    {
        $twig_loader = new ArrayLoader([
            'e107_config.php' => file_get_contents(codecept_data_dir() . "/e107_config.php.sample")
        ]);
        $twig = new Environment($twig_loader);

        $db = $this->getModule('\Helper\DelayedDb');

        $e107_config = [];
        $e107_config['mySQLserver'] = $db->_getDbHostname();
        $e107_config['mySQLuser'] = $db->_getDbUsername();
        $e107_config['mySQLpassword'] = $db->_getDbPassword();
        $e107_config['mySQLdefaultdb'] = $db->_getDbName();
        $e107_config['mySQLprefix'] = self::E107_MYSQL_PREFIX;

        $e107_config_contents = $twig->render('e107_config.php', $e107_config);
        file_put_contents(self::APP_PATH_E107_CONFIG, $e107_config_contents);
    }

    public function _afterSuite()
    {
        parent::_afterSuite();
        $this->revokeLocalE107Config();
        $this->preparer->rollback();
        $this->restoreLocalE107Config();
        $this->workaroundOldPhpUnitPhpCodeCoverage();
    }

    /**
     * Destructor: Ensures cleanup even on crashes or fatal errors.
     */
    public function __destruct()
    {
        // Only restore if we backed up and haven’t already restored
        if ($this->configBackedUp && file_exists(APP_PATH . '/e107_config.php.bak')) {
            $this->revokeLocalE107Config();
            $this->restoreLocalE107Config();
        }
    }

    protected function revokeLocalE107Config()
    {
        if (file_exists(self::APP_PATH_E107_CONFIG)) {
            unlink(self::APP_PATH_E107_CONFIG);
        }
    }

    protected function restoreLocalE107Config()
    {
        if (file_exists(APP_PATH . "/e107_config.php.bak")) {
            rename(APP_PATH . '/e107_config.php.bak', self::APP_PATH_E107_CONFIG);
            $this->configBackedUp = false; // Reset flag after restoration
        }
    }

    /**
     * Workaround for phpunit/php-code-coverage < 6.0.8
     * @see https://github.com/sebastianbergmann/php-code-coverage/commit/f4181f5c0a2af0180dadaeb576c6a1a7548b54bf
     */
    protected function workaroundOldPhpUnitPhpCodeCoverage()
    {
        $composer_installed_file = codecept_absolute_path("vendor/composer/installed.json");
        $composer_installed = json_decode(file_get_contents($composer_installed_file));
        if (isset($composer_installed->packages)) {
            // Composer 2 format for the installed packages manifest
            $composer_installed = $composer_installed->packages;
        }
        $installed_phpunit_php_code_coverage = current(array_filter($composer_installed, function ($element) {
            return $element->name == 'phpunit/php-code-coverage';
        }));
        if (version_compare($installed_phpunit_php_code_coverage->version_normalized, '6.0.8', '>='))
            return;

        @mkdir(codecept_output_dir(), 0755, true);
    }
}