matomo/tests/PHPUnit/Framework/Mock/TestConfig.php

<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Tests\Framework\Mock;

use Piwik\Application\Kernel\GlobalSettingsProvider;
use Piwik\Config;
use Piwik\Plugin\Manager;
use Piwik\Tests\Framework\TestingEnvironmentVariables;

class TestConfig extends Config
{
    /**
     * @var bool
     */
    private $allowSave;

    /**
     * @var bool
     */
    private $doSetTestEnvironment;

    /**
     * @var TestingEnvironmentVariables
     */
    private $testingEnvironment;

    public function __construct(GlobalSettingsProvider $provider, TestingEnvironmentVariables $testingEnvironment, $allowSave = false, $doSetTestEnvironment = true)
    {
        parent::__construct($provider);

        $this->allowSave = $allowSave;
        $this->doSetTestEnvironment = $doSetTestEnvironment;
        $this->testingEnvironment = $testingEnvironment;

        $this->reload();

        $this->setFromTestEnvironment($testingEnvironment);
    }

    public function reload($pathLocal = null, $pathGlobal = null, $pathCommon = null)
    {
        parent::reload($pathLocal, $pathGlobal, $pathCommon);

        $this->setTestEnvironment();
    }

    public function forceSave()
    {
        if ($this->allowSave) {
            parent::forceSave();
        }

        if (!$this->doSetTestEnvironment) {
            return;
        }

        $environmentPlugins = $this->testingEnvironment->configOverride['PluginsInstalled']['PluginsInstalled'] ?? [];
        $installedPlugins = Manager::getInstance()->getInstalledPluginsName();

        $onlyEnvironment = array_diff($environmentPlugins, $installedPlugins);
        $onlyInstalled = array_diff($installedPlugins, $environmentPlugins);

        if ([] === $onlyEnvironment && [] === $onlyInstalled) {
            // environment matches list of installed plugins
            return;
        }

        $this->testingEnvironment->overrideConfig('PluginsInstalled', 'PluginsInstalled', $installedPlugins);
        $this->testingEnvironment->save();
    }

    public function setTestEnvironment()
    {
        if (!$this->allowSave) {
            $this->doNotWriteConfigInTests = true;
        }

        $chain = $this->settings->getIniFileChain();

        $databaseTestsSettings = $chain->get('database_tests'); // has to be __get otherwise when called from TestConfig, PHP will issue a NOTICE
        if (!empty($databaseTestsSettings)) {
            $chain->set('database', $databaseTestsSettings);
        }

        // Ensure local mods do not affect tests
        if (empty($pathGlobal)) {
            $general = $chain->getFrom($this->getLocalPath(), 'General');
            $instanceId = isset($general['instance_id']) ? $general['instance_id'] : null;

            $chain->set('Debug', $chain->getFrom($this->getGlobalPath(), 'Debug'));
            $chain->set('mail', $chain->getFrom($this->getGlobalPath(), 'mail'));

            $globalGeneral = $chain->getFrom($this->getGlobalPath(), 'General');
            if ($instanceId) {
                $globalGeneral['instance_id'] = $instanceId;
            }
            $chain->set('General', $globalGeneral);

            $chain->set('Segments', $chain->getFrom($this->getGlobalPath(), 'Segments'));
            $chain->set('Tracker', $chain->getFrom($this->getGlobalPath(), 'Tracker'));
            $chain->set('Deletelogs', $chain->getFrom($this->getGlobalPath(), 'Deletelogs'));
            $chain->set('Deletereports', $chain->getFrom($this->getGlobalPath(), 'Deletereports'));
            $chain->set('Development', $chain->getFrom($this->getGlobalPath(), 'Development'));
        }

        // for unit tests, we set that no plugin is installed. This will force
        // the test initialization to create the plugins tables, execute ALTER queries, etc.
        $chain->set('PluginsInstalled', array('PluginsInstalled' => array()));
    }

    private function setFromTestEnvironment(\Piwik\Tests\Framework\TestingEnvironmentVariables $testingEnvironment)
    {
        $chain = $this->settings->getIniFileChain();

        $general =& $chain->get('General');
        $log =& $chain->get('log');
        $database =& $chain->get('database');

        $log['log_writers'] = array('file');

        // TODO: replace this and below w/ configOverride use
        if ($testingEnvironment->tablesPrefix) {
            $database['tables_prefix'] = $testingEnvironment->tablesPrefix;
        }

        if ($testingEnvironment->dbName) {
            $database['dbname'] = $testingEnvironment->dbName;
        }

        if ($testingEnvironment->configOverride) {
            $cache =& $chain->getAll();
            $cache = $this->arrayMergeRecursiveDistinct($cache, $testingEnvironment->configOverride);
        }
    }

    private function arrayMergeRecursiveDistinct(array $array1, array $array2)
    {
        $result = $array1;

        foreach ($array2 as $key => $value) {
            if (is_array($value)) {
                $result[$key] = isset($result[$key]) && is_array($result[$key])
                    ? $this->arrayMergeRecursiveDistinct($result[$key], $value)
                    : $value;
            } else {
                $result[$key] = $value;
            }
        }

        return $result;
    }
}