File size: 6,807 Bytes
bf8c0ce
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
<?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\System;

use Piwik\Tests\Framework\TestCase\SystemTestCase;
use Piwik\Tests\Fixtures\ThreeVisitsWithCustomEvents;

/**
 * Testing Custom Events
 *
 * @group CustomEventsTest
 * @group Plugins
 */
class CustomEventsTest extends SystemTestCase
{
    /**
     * @var ThreeVisitsWithCustomEvents
     */
    public static $fixture = null; // initialized below class definition

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

    protected function getApiToCall()
    {
        return array(
            'Events.getCategory',
            'Events.getAction',
            'Events.getName',
            'Actions.get',
            'Live.getLastVisitsDetails',
            'Actions.getPageUrls',
        );
    }

    public function tearDown(): void
    {
        parent::tearDown();
    }

    public function getApiForTesting()
    {
        $dateTime = self::$fixture->dateTime;
        $idSite1 = self::$fixture->idSite;

        $apiToCallProcessedReportMetadata = $this->getApiToCall();

        $dayPeriod = 'day';
        $periods = array($dayPeriod, 'month');

        $apiEventAndAction = array('Events', 'Actions.getPageUrls');

        $result = array(
            array(
                $apiToCallProcessedReportMetadata, array(
                'idSite'       => $idSite1,
                'date'         => $dateTime,
                'periods'      => $periods,
                'setDateLastN' => false,
                'testSuffix' => '',
            ),
            ),

            array(
                $apiEventAndAction, array(
                'idSite'       => $idSite1,
                'date'         => $dateTime,
                'periods'      => $dayPeriod,
                'segment'      => "eventCategory==Movie,eventName==" . urlencode('La fiancée de l\'eau'),
                'setDateLastN' => false,
                'testSuffix' => '_eventCategoryOrNameMatch',
            ),
            ),

            array(
                $apiEventAndAction, array(
                'idSite'       => $idSite1,
                'date'         => $dateTime,
                'periods'      => $dayPeriod,
                'segment'      => "eventAction==rating;eventValue>9",
                'setDateLastN' => false,
                'testSuffix' => '_eventValueMatch',
            ),
            ),

            // eventAction should not match any page view
            array(
                $apiEventAndAction, array(
                'idSite'       => $idSite1,
                'date'         => $dateTime,
                'periods'      => $dayPeriod,
                'segment'      => "eventAction=@play",
                'setDateLastN' => false,
                'testSuffix' => '_segmentMatchesEventActionPlay',
            ),
            ),

            // Goals and events
            array(
                'Goals.get', array(
                'idSite'       => $idSite1,
                'date'         => $dateTime,
                'periods'      => $dayPeriod,
                'idGoal'       => ThreeVisitsWithCustomEvents::$idGoalTriggeredOnEventCategory,
                'setDateLastN' => false,
            ),
            ),

        );

        $apiToCallProcessedReportMetadata = [
            'Events.getCategory',
            'Events.getAction',
            'Events.getName',
        ];
        // testing metadata API for Events reports
        foreach ($apiToCallProcessedReportMetadata as $api) {
            [$apiModule, $apiAction] = explode(".", $api);

            $result[] = [
                'API.getProcessedReport', [
                    'idSite'       => $idSite1,
                    'date'         => $dateTime,
                    'periods'      => $dayPeriod,
                    'setDateLastN' => true,
                    'apiModule'    => $apiModule,
                    'apiAction'    => $apiAction,
                    'testSuffix'   => '_' . $api . '_lastN',
                ],
            ];
            $result[] = [
                'API.getProcessedReport', [
                    'idSite'                 => $idSite1,
                    'date'                   => $dateTime,
                    'periods'                => $dayPeriod,
                    'setDateLastN'           => true,
                    'apiModule'              => $apiModule,
                    'apiAction'              => $apiAction,
                    'otherRequestParameters' => ['flat' => '1'],
                    'testSuffix'             => '_' . $api . '_flat',
                ],
            ];
        }

        // Test secondary dimensions
        $secondaryDimensions = ['eventCategory', 'eventAction', 'eventName'];
        foreach ($secondaryDimensions as $secondaryDimension) {
            $result[] = [
                ['Events'], [
                    'idSite'                 => $idSite1,
                    'date'                   => $dateTime,
                    'periods'                => $periods,
                    'otherRequestParameters' => [
                        'secondaryDimension' => $secondaryDimension,
                    ],
                    'setDateLastN'           => false,
                    'testSuffix'             => '_secondaryDimensionIs' . ucfirst($secondaryDimension),
                ],
            ];
        }

        $result[] = [
            'Events.getCategory', [
                'idSite'                 => $idSite1,
                'date'                   => $dateTime,
                'periods'                => $dayPeriod,
                'otherRequestParameters' => [
                    'flat'         => '1',
                    'showMetadata' => '0',
                ],
                'testSuffix'             => '_flat',
            ],
        ];

        $result[] = [
            'Events.getCategory', [
                'idSite'                 => $idSite1,
                'date'                   => $dateTime,
                'periods'                => $dayPeriod,
                'otherRequestParameters' => [
                    'showMetadata'    => '0',
                    'flat'            => '1',
                    'show_dimensions' => '1',
                ],
                'testSuffix'             => '_flat_with_dimensions',
            ],
        ];

        return $result;
    }

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

CustomEventsTest::$fixture = new ThreeVisitsWithCustomEvents();