matomo/tests/PHPUnit/Unit/ExceptionHandlerTest.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\Unit;

use Piwik\Config;
use Piwik\Container\StaticContainer;
use Piwik\Tests\Framework\Mock\FakeAccess;

/**
 * @group AssetManager
 */
class ExceptionHandlerTest extends \PHPUnit\Framework\TestCase
{
    public function setUp(): void
    {
        StaticContainer::getContainer()->set('Piwik\Access', $this->getMockAccess());
    }

    /**
     * @dataProvider getSensitiveValuesData
     * @runInSeparateProcess This is necessary because SettingsPiwik holds the salt as a static value which means that
     * it won't be pulled from the config after the first time it's checked.
     * @param $configToken
     * @param $configSalt
     * @param $configDbUser
     * @param $configDbPass
     * @return void
     * @throws \Exception
     */
    public function testReplaceSensitiveValues($configToken, $configSalt, $configDbUser, $configDbPass)
    {
        $tokenAuth = $expectedToken = 'no auth token';
        $salt = $expectedSalt = 'no salt';
        $dbUser = $expectedDbUser = 'no db user';
        $dbPass = $expectedDbPass = 'no db password';

        StaticContainer::get('Piwik\Access')->setTokenAuth($configToken);
        Config::getInstance()->General['salt'] = $configSalt;
        Config::getInstance()->database['username'] = $configDbUser;
        Config::getInstance()->database['password'] = $configDbPass;

        if (!empty($configToken)) {
            $tokenAuth = $configToken;
            $expectedToken = 'tokenauth';
        }
        if (!empty($configSalt)) {
            $salt = $configSalt;
            $expectedSalt = 'generalSalt';
        }
        if (!empty($configDbUser)) {
            $dbUser = $configDbUser;
            $expectedDbUser = 'dbuser';
        }
        if (!empty($configDbPass)) {
            $dbPass = $configDbPass;
            $expectedDbPass = 'dbpass';
        }
        $testMessage = "Error message containing $tokenAuth, $salt, $dbUser, $dbPass, and hard-coded: zero (0)";
        $expectedMessage = "Error message containing $expectedToken, $expectedSalt, $expectedDbUser, $expectedDbPass, and hard-coded: zero (0)";
        $result = \Piwik\ExceptionHandler::replaceSensitiveValues($testMessage);
        $this->assertSame($expectedMessage, $result);
    }

    public function getSensitiveValuesData(): array
    {
        return [
            [null, null, null, null],
            [null, '', '', ''],
            [0, '', '', ''],
            ['', '', '', ''],
            ['0', '', '', ''],
            ['myTestToken', 'myTestSalt', 'myTestDbUser', 'myTestDbPass'],
            ['myTestToken', '', '', ''],
            ['', 'myTestSalt', '', ''],
            ['', '', 'myTestDbUser', ''],
            ['', '', '', 'myTestDbPass'],
            ['myTestToken', 'myTestSalt', '', ''],
            ['', 'myTestSalt', 'myTestDbUser', ''],
            ['', '', 'myTestDbUser', 'myTestDbPass'],
            ['myTestToken', '', 'myTestDbUser', ''],
            ['', 'myTestSalt', '', 'myTestDbPass'],
            ['myTestToken', '', '', 'myTestDbPass'],
            ['myTestToken', 'myTestSalt', 'myTestDbUser', ''],
            ['', 'myTestSalt', 'myTestDbUser', 'myTestDbPass'],
            ['myTestToken', '', 'myTestDbUser', 'myTestDbPass'],
            ['myTestToken', 'myTestSalt', '', 'myTestDbPass'],
            ['otherTestToken', 'otherTestSalt', 'otherTestDbUser', 'otherTestDbPass'],
        ];
    }

    private function getMockAccess(): FakeAccess
    {
        return new class () extends FakeAccess {
            public function getTokenAuth()
            {
                return $this->token_auth;
            }

            public function setTokenAuth($tokenAuth): void
            {
                $this->token_auth = $tokenAuth;
            }
        };
    }
}