Welcome to mirror list, hosted at ThFree Co, Russian Federation.

APITest.php « System « tests « PrivacyManager « plugins - github.com/matomo-org/matomo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: c46f7416cc49a12492fc9c89ad78829c5221c9ff (plain)
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
147
148
<?php
/**
 * Piwik - 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\PrivacyManager\tests\System;

use Piwik\Common;
use Piwik\Db;
use Piwik\Plugins\PrivacyManager\API;
use Piwik\Plugins\PrivacyManager\tests\Fixtures\MultipleSitesMultipleVisitsFixture;
use Piwik\Tests\Framework\TestCase\SystemTestCase;

/**
 * @group PrivacyManager
 * @group APITest
 * @group Plugins
 */
class APITest extends SystemTestCase
{
    /**
     * @var MultipleSitesMultipleVisitsFixture
     */
    public static $fixture = null; // initialized below class definition

    /**
     * @var API
     */
    private $api;

    public function setUp(): void
    {
        parent::setUp();
        $this->api = API::getInstance();
    }

    public function test_exportDataSubjects_failsWhenNoVisitsGiven()
    {
        $this->expectException(\Exception::class);
        $this->expectExceptionMessage('No list of visits given');

        $this->assertNull($this->api->exportDataSubjects(false));
    }

    public function test_exportDataSubjects_whenOneVisitGiven()
    {
        $result = $this->api->exportDataSubjects([['idsite' => '1', 'idvisit' => '1']]);
        $this->assertJsonResponse('exportDataSubject_oneVisitGiven', $result);
    }

    public function test_exportDataSubjects_whenNotMatchingVisitGiven()
    {
        $noMatch = $this->api->exportDataSubjects([['idsite' => '9999', 'idvisit' => '9999']]);
        $this->assertJsonResponse('exportDataSubject_noMatch', $noMatch);
    }

    public function test_exportDataSubjects_whenAllVisitsGiven()
    {
        $rows = Db::fetchAll('SELECT idsite, idvisit from ' . Common::prefixTable('log_visit'));
        $result = $this->api->exportDataSubjects($rows);
        $this->assertJsonResponse('exportDataSubject_allVisits', $result);
    }

    public function test_exportDataSubjects_failsWhenMissingIdSite()
    {
        $this->expectException(\Exception::class);
        $this->expectExceptionMessage('No idsite key set for visit at index 1');

        $this->assertNull($this->api->exportDataSubjects([['idsite' => '9999', 'idvisit' => '9999'], []]));
    }

    private function assertJsonResponse($fileName, $result)
    {
        $result = MultipleSitesMultipleVisitsFixture::cleanResult($result);
        $result = json_encode($result, JSON_PRETTY_PRINT);
        $fileExpected = PIWIK_DOCUMENT_ROOT . '/plugins/PrivacyManager/tests/System/expected/' . $fileName . '.json';
        $fileProcessed = str_replace('/expected/', '/processed/', $fileExpected);
        \Piwik\Filesystem::mkdir(dirname($fileProcessed));
        file_put_contents($fileProcessed, $result);

        $this->assertJsonStringEqualsJsonFile($fileExpected, $result);
    }

    /**
     * @dataProvider getApiForTesting
     */
    public function testApi($api, $params)
    {
        $params['xmlFieldsToRemove'] = array('totalEcommerceRevenue', 'revenue', 'revenueDiscount');
        $this->runApiTests($api, $params);
    }

    public function getApiForTesting()
    {
        $api = array(
            'PrivacyManager.getAvailableVisitColumnsToAnonymize',
            'PrivacyManager.getAvailableLinkVisitActionColumnsToAnonymize',
        );

        $apiToTest   = array();
        $apiToTest[] = array($api,
            array(
                'idSite'     => 1,
                'date'       => self::$fixture->dateTime,
                'periods'    => array('day'),
                'testSuffix' => ''
            )
        );

        $apiToTest[] = array(array('Live.getLastVisitsDetails'),
            array(
                'idSite'     => 'all',
                'date'       => self::$fixture->dateTime,
                'periods'    => array('year'),
                'otherRequestParameters' => array('filter_limit' => '-1'),
                'testSuffix' => 'allSites'
            )
        );

        $apiToTest[] = array(array('Live.getLastVisitsDetails'),
            array(
                'idSite'     => 'all',
                'date'       => self::$fixture->dateTime,
                'periods'    => array('year'),
                'otherRequestParameters' => array('doNotFetchActions' => '1', 'filter_limit' => '-1'),
                'testSuffix' => 'allSites_noActions'
            )
        );

        return $apiToTest;
    }

    public static function getOutputPrefix()
    {
        return '';
    }

    public static function getPathToTestDirectory()
    {
        return dirname(__FILE__);
    }

}

APITest::$fixture = new MultipleSitesMultipleVisitsFixture();