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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
<?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\Tests\System;
use Piwik\Access;
use Piwik\Plugins\SitesManager\API;
use Piwik\Tests\Framework\Fixture;
use Piwik\Tests\Framework\TestCase\SystemTestCase;
use Piwik\Tests\Fixtures\ManySitesImportedLogs;
use Piwik\Tests\Framework\TestingEnvironmentVariables;
use Piwik\Tracker\Request;
use Piwik\Tracker\RequestSet;
/**
* Tests the log importer.
*
* @group ImportLogsTest
* @group Core
*/
class ImportLogsTest extends SystemTestCase
{
/** @var ManySitesImportedLogs */
public static $fixture = null; // initialized below class definition
public function setUp(): void
{
parent::setUp();
$this->resetTestingEnvironmentChanges();
}
/**
* @dataProvider getApiForTesting
*/
public function testApi($api, $params)
{
$this->runApiTests($api, $params);
}
public function getApiForTesting()
{
$apis = array(
array('all', array('idSite' => self::$fixture->idSite,
'date' => '2012-08-09',
'periods' => 'month')),
array('Referrers.getNumberOfDistinctWebsites', array('idSite' => self::$fixture->idSite,
'date' => '2012-08-09',
'setDateLastN' => true,
'periods' => 'day')),
array('MultiSites.getAll', array('idSite' => self::$fixture->idSite,
'date' => '2012-08-09',
'periods' => array('month'),
'setDateLastN' => true,
'otherRequestParameters' => array('enhanced' => 1),
'testSuffix' => '_withEnhancedAndLast7')),
// report generated from custom log format including generation time
array('Actions.getPageUrls', array('idSite' => self::$fixture->idSite,
'date' => '2012-09-30',
'periods' => 'day')),
array('VisitsSummary.get', array('idSite' => self::$fixture->idSite2,
'date' => '2012-08-09',
'periods' => 'month',
'testSuffix' => '_siteIdTwo_TrackedUsingLogReplay')),
);
// Running a few interesting tests for Log Replay use case
$apiMethods = array();
if (getenv('MYSQL_ADAPTER') != 'MYSQLI') {
// Mysqli rounds latitude/longitude
$apiMethods = array('Live.getLastVisitsDetails');
}
$apiMethods[] = 'Actions';
$apiMethods[] = 'VisitorInterest';
$apiMethods[] = 'VisitFrequency';
$apis[] = array($apiMethods, array(
'idSite' => self::$fixture->idSite,
'date' => '2012-08-09,2014-04-01',
'periods' => 'range',
'otherRequestParameters' => array(
'filter_limit' => 1000
),
'xmlFieldsToRemove' => array('fingerprint')
));
// imported via --replay-tracking --idsite=3 should ignore idSite from logs and use fixed idSite instead
$apis[] = array($apiMethods, array(
'idSite' => 3,
'date' => '2012-08-09,2014-04-01',
'periods' => 'range',
'otherRequestParameters' => array(
'filter_limit' => 1000
),
'testSuffix' => '_siteIdThree_TrackedUsingLogReplayWithFixedSiteId'
));
return $apis;
}
/**
* NOTE: This test must be last since the new sites that get added are added in
* random order.
* NOTE: This test combines two tests in order to avoid executing the log importer another time.
* If the log importer were refactored, the invalid requests test could be a unit test in
* python.
*/
public function test_LogImporter_CreatesSitesWhenDynamicResolverUsed_AndReportsOnInvalidRequests()
{
$this->simulateInvalidTrackerRequest();
$output = self::$fixture->logVisitsWithDynamicResolver($maxPayloadSize = 3);
// reload access so new sites are viewable
Access::getInstance()->setSuperUserAccess(true);
// make sure sites aren't created twice
$piwikDotNet = API::getInstance()->getSitesIdFromSiteUrl('http://piwik.net');
$this->assertEquals(1, count($piwikDotNet));
$anothersiteDotCom = API::getInstance()->getSitesIdFromSiteUrl('http://anothersite.com');
$this->assertEquals(1, count($anothersiteDotCom));
$whateverDotCom = API::getInstance()->getSitesIdFromSiteUrl('http://whatever.com');
$this->assertEquals(1, count($whateverDotCom));
// make sure invalid requests are reported correctly
self::assertStringContainsString('The Matomo tracker identified 2 invalid requests on lines: 10, 11', $output);
self::assertStringContainsString("The following lines were not tracked by Matomo, either due to a malformed tracker request or error in the tracker:\n\n10, 11", $output);
}
public function test_LogImporter_RetriesWhenServerFails()
{
$this->simulateTrackerFailure();
$logFile = PIWIK_INCLUDE_PATH . '/tests/resources/access-logs/fake_logs_enable_all.log';
$options = array(
'--idsite' => self::$fixture->idSite,
'--token-auth' => Fixture::getTokenAuth(),
'--retry-max-attempts' => 5,
'--retry-delay' => 1
);
$output = Fixture::executeLogImporter($logFile, $options, $allowFailure = true);
$output = implode("\n", $output);
for ($i = 2; $i != 6; ++$i) {
self::assertStringContainsString("Retrying request, attempt number $i", $output);
}
self::assertStringNotContainsString("Retrying request, attempt number 6", $output);
self::assertStringContainsString("Max number of attempts reached, server is unreachable!", $output);
}
private function simulateTrackerFailure()
{
$testingEnvironment = new TestingEnvironmentVariables();
$testingEnvironment->_triggerTrackerFailure = true;
$testingEnvironment->save();
}
public static function getOutputPrefix()
{
return 'ImportLogs';
}
private function resetTestingEnvironmentChanges()
{
$testingEnvironment = new TestingEnvironmentVariables();
$testingEnvironment->_triggerTrackerFailure = null;
$testingEnvironment->_triggerInvalidRequests = null;
$testingEnvironment->save();
}
private function simulateInvalidTrackerRequest()
{
$testEnvironment = new TestingEnvironmentVariables();
$testEnvironment->_triggerInvalidRequests = true;
$testEnvironment->save();
}
public static function provideContainerConfigBeforeClass()
{
$result = array();
$observers = array();
$testingEnvironment = new TestingEnvironmentVariables();
if ($testingEnvironment->_triggerTrackerFailure) {
$observers[] = array('Tracker.newHandler', function () {
@http_response_code(500);
throw new \Exception("injected exception");
});
}
if ($testingEnvironment->_triggerInvalidRequests) {
// we trigger an invalid request by checking for triggerInvalid=1 in a request, and if found replacing the
// request w/ a request that has an nonexistent idsite
$observers[] = array('Tracker.initRequestSet', function (RequestSet $requestSet) {
$requests = $requestSet->getRequests();
foreach ($requests as $index => $request) {
$url = $request->getParam('url');
if (strpos($url, 'triggerInvalid=1') !== false) {
$newParams = $request->getParams();
$newParams['idsite'] = 1000;
$requests[$index] = new Request($newParams);
}
}
$requestSet->setRequests($requests);
});
}
if (!empty($observers)) {
$result['observers.global'] = \DI\add($observers);
}
return $result;
}
}
ImportLogsTest::$fixture = new ManySitesImportedLogs();
ImportLogsTest::$fixture->includeIisWithCustom = true;
ImportLogsTest::$fixture->includeNetscaler = true;
ImportLogsTest::$fixture->includeCloudfront = true;
ImportLogsTest::$fixture->includeCloudfrontRtmp = true;
ImportLogsTest::$fixture->includeNginxJson = true;
ImportLogsTest::$fixture->includeApiCustomVarMapping = true;
|