plugins/AnonymousPiwikUsageMeasurement/tests/Integration/AnonymousPiwikUsageMeasurementTest.php

<?php

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

namespace Piwik\Plugins\AnonymousPiwikUsageMeasurement\tests\Integration;

use Piwik\API\Request;
use Piwik\Container\StaticContainer;
use Piwik\Piwik;
use Piwik\Plugins\AnonymousPiwikUsageMeasurement\SystemSettings;
use Piwik\Plugins\AnonymousPiwikUsageMeasurement\Tracker\Profiles;
use Piwik\Plugins\AnonymousPiwikUsageMeasurement\UserSettings;
use Piwik\Tests\Framework\Mock\FakeAccess;
use Piwik\Tests\Framework\TestCase\IntegrationTestCase;

/**
 * @group AnonymousPiwikUsageMeasurement
 * @group AnonymousPiwikUsageMeasurementTest
 * @group Plugins
 */
class AnonymousPiwikUsageMeasurementTest extends IntegrationTestCase
{
    public function test_shouldTrackApiCall()
    {
        Request::processRequest('API.getPiwikVersion');
        Request::processRequest('API.getSettings');
        Request::processRequest('UsersManager.getUsers');
        Request::processRequest('API.getPiwikVersion');

        $profiles = new Profiles();
        $pushedProfiles = $profiles->popAll();

        foreach ($pushedProfiles as &$pushedProfile) {
            $this->assertNotEmpty($pushedProfile['creation_date']);
            unset($pushedProfile['creation_date']);

            $this->assertGreaterThanOrEqual(1, $pushedProfile['wall_time']);
            unset($pushedProfile['wall_time']);
        }

        $expected = array(
            array (
                'category' => 'API',
                'name' => 'API',
                'action' => 'API.getPiwikVersion',
                'count' => '2',
            ),
            array (
                'category' => 'API',
                'name' => 'API',
                'action' => 'API.getSettings',
                'count' => '1',
            ),
            array (
                'category' => 'API',
                'name' => 'UsersManager',
                'action' => 'UsersManager.getUsers',
                'count' => '1',
            )
        );

        $this->assertEquals($expected, $pushedProfiles);
    }

    public function test_shouldNotAddTargetsOrCustomVariables_IfDisabledByUser()
    {
        $settings = $this->makeUserSettings();
        $settings->userTrackingEnabled->setValue(false);

        $out = '';
        Piwik::postEvent('Template.jsGlobalVariables', array(&$out));

        self::assertStringContainsString('var piwikUsageTracking = {"targets":[],"visitorCustomVariables":[],', $out);
    }

    public function test_shouldAddTrackingCallsWithTargetsAndCustomVariables_IfEnabledByUser()
    {
        $settings = $this->makeUserSettings();
        $settings->userTrackingEnabled->setValue(true);

        $systemSettings = $this->makePluginSettings();
        $systemSettings->customPiwikSiteId->setValue(1);
        $systemSettings->customPiwikSiteUrl->setValue('https://demo-anonymous.matomo.org/piwik.php');

        $out = '';
        Piwik::postEvent('Template.jsGlobalVariables', array(&$out));
        self::assertStringContainsString('var piwikUsageTracking = {"targets":[{"url":"https:\/\/demo-anonymous.matomo.org\/piwik.php","idSite":1,"useAnonymization":true,"token_auth":null}],"visitorCustomVariables":[{"id":1,"name":"Access","value":"superuser"}],"trackingDomain":"https:\/\/demo-anonymous.matomo.org","exampleDomain":"http:\/\/example.com","userId":"superUserLogin"}', $out);
    }

    public function test_shouldAlwaysAddTrackingCallAndNotFail_IfUserIsAnonmyous()
    {
        $systemSettings = $this->makePluginSettings();
        $systemSettings->customPiwikSiteId->setValue(1);
        $systemSettings->customPiwikSiteUrl->setValue('https://demo-anonymous.matomo.org/piwik.php');

        FakeAccess::clearAccess($superUser = false, array(), array(), $login = 'anonymous');

        $out = '';
        Piwik::postEvent('Template.jsGlobalVariables', array(&$out));
        self::assertStringContainsString('var piwikUsageTracking = {"targets":[{"url"', $out);
        self::assertStringContainsString('{"id":1,"name":"Access","value":"anonymous"}', $out);
    }

    public function test_shouldAddTrackingCallsWithoutTargetsAndCustomVariables_IfOptOutIsDisabled()
    {
        $settings = $this->makePluginSettings();
        $settings->canUserOptOut->setValue(false);
        $settings->customPiwikSiteId->setValue(1);
        $settings->customPiwikSiteUrl->setValue('https://demo-anonymous.matomo.org/piwik.php');
        $settings->save();

        // we need to save it first and create new settings instance since the setting will be missing afterwards.
        $this->makePluginSettings();

        $out = '';
        Piwik::postEvent('Template.jsGlobalVariables', array(&$out));
        self::assertStringContainsString('var piwikUsageTracking = {"targets":[{"url":"https:\/\/demo-anonymous.matomo.org\/piwik.php","idSite":1,"useAnonymization":true,"token_auth":null}],"visitorCustomVariables":[{"id":1,"name":"Access","value":"superuser"}],"trackingDomain":"https:\/\/demo-anonymous.matomo.org","exampleDomain":"http:\/\/example.com","userId":"superUserLogin"}', $out);
    }

    private function makePluginSettings()
    {
        $settings = new SystemSettings();
        StaticContainer::getContainer()->set('Piwik\Plugins\AnonymousPiwikUsageMeasurement\SystemSettings', $settings);
        return $settings;
    }

    private function makeUserSettings()
    {
        $settings = new UserSettings($this->makePluginSettings());
        StaticContainer::getContainer()->set('Piwik\Plugins\AnonymousPiwikUsageMeasurement\UserSettings', $settings);
        return $settings;
    }

    public function provideContainerConfig()
    {
        return array(
            'Piwik\Access' => new FakeAccess()
        );
    }
}