File size: 5,802 Bytes
968114b
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<?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()
        );
    }
}