plugin-CustomVariables/tests/System/CustomVariablesSystemTest.php at 632552495180259bba4672f49a63d978f2c543be · matomo-org/plugin-CustomVariables · GitHub

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
<?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\CustomVariables\tests\System;

use Piwik\Plugins\CustomVariables\tests\Fixtures\VisitWithManyCustomVariables;
use Piwik\Tests\Framework\TestCase\SystemTestCase;
use Piwik\Version;

/**
 * @group CustomVariables
 * @group CustomVariablesSystemTest
 * @group Plugins
 */
class CustomVariablesSystemTest extends SystemTestCase
{
    /**
     * @var VisitWithManyCustomVariables
     */
    public static $fixture = null; // initialized below class definition

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

    /**
     * @dataProvider getApiForTesting
     */
    public function testApi($api, $params)
    {
        $this->runApiTests($api, $params);
    }

    public function getApiForTesting()
    {
        $apiToCall = ['CustomVariables.getCustomVariables', 'Live.getLastVisitsDetails'];

        $xmlFieldsToRemove = [];

        if (version_compare(Version::VERSION, '4.12.0-rc1', '<')) {
            // those fields have been added to goal details
            $xmlFieldsToRemove = [
                'referrerType',
                'referrerName',
                'referrerKeyword',
            ];
        }

        if (version_compare(Version::VERSION, '5.5.0-b1', '<')) {
            // In Matomo 5.5 ai referrer had been added
            $xmlFieldsToRemove = array_merge($xmlFieldsToRemove, ['referrerAIAssistantUrl', 'referrerAIAssistantIcon']);
        }

        return [
            [
                $apiToCall,
                [
                    'idSite'            => self::$fixture->idSite,
                    'date'              => self::$fixture->dateTime,
                    'periods'           => ['day'],
                    'xmlFieldsToRemove' => $xmlFieldsToRemove,
                ],
            ],
        ];
    }

    /**
     * Path where expected/processed output files are stored.
     */
    public static function getPathToTestDirectory()
    {
        return __DIR__;
    }
}

CustomVariablesSystemTest::$fixture = new VisitWithManyCustomVariables();