File size: 6,699 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
<?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\Http;
use Piwik\Tests\Framework\Fixture;
use Piwik\Tests\Framework\TestCase\SystemTestCase;

/**
 * @group TrackerTest
 * @group Plugins
 */
class TrackerResponseTest extends SystemTestCase
{
    public static $fixture = null;

    /**
     * @var \MatomoTracker
     */
    private $tracker;

    public function setUp(): void
    {
        parent::setUp();

        $idSite = 1;
        $dateTime = '2014-01-01 00:00:01';

        if (!Fixture::siteCreated($idSite)) {
            Fixture::createWebsite($dateTime);
        }

        $this->tracker = Fixture::getTracker($idSite, $dateTime, $defaultInit = true);
    }

    public function testResponseShouldContainAnImage()
    {
        $response = $this->tracker->doTrackPageView('Test');

        Fixture::checkResponse($response);
        $this->assertNotEmpty($response);
    }

    public function testResponseShouldBeEmptyIfImageIsDisabled()
    {
        $this->tracker->disableSendImageResponse();

        $response = $this->tracker->doTrackPageView('Test');

        $this->assertSame('', $response);
    }

    public function testResponseShouldSend200ResponseCodeIfImageIsEnabled()
    {
        $url = $this->tracker->getUrlTrackPageView('Test');
        $url .= '&token_auth=' . Fixture::getTokenAuth();
        $response = $this->sendHttpRequest($url);
        $this->assertEquals(200, $response['status']);
        $this->assertArrayHasKey('Cache-Control', $response['headers']);
        $this->assertEquals('no-store', $response['headers']['Cache-Control']);
    }

    public function testResponseShouldSend204ResponseCodeIfImageIsDisabled()
    {
        $url = $this->tracker->getUrlTrackPageView('Test');
        $url .= '&token_auth=' . Fixture::getTokenAuth();
        $url .= '&send_image=0';

        $response = $this->sendHttpRequest($url);
        $this->assertEquals(204, $response['status']);
        $this->assertArrayHasKey('Cache-Control', $response['headers']);
        $this->assertEquals('no-store', $response['headers']['Cache-Control']);
    }

    public function testResponseShouldSend400ResponseCodeIfSiteIdIsInvalid()
    {
        $url = $this->tracker->getUrlTrackPageView('Test');
        $url .= '&idsite=100';

        $response = $this->sendHttpRequest($url);
        $this->assertEquals(400, $response['status']);
    }

    public function testResponseShouldSend400ResponseCodeIfIdGoalIsInvalid()
    {
        $url = $this->tracker->getUrlTrackPageView('Test');
        $url .= '&idgoal=9999';

        $response = $this->sendHttpRequest($url);
        $this->assertEquals(400, $response['status']);
    }

    public function testResponseShouldSend400ResponseCodeIfSiteIdIsNegative()
    {
        $url = $this->tracker->getUrlTrackPageView('Test');
        $url .= '&idsite=-1';

        $response = $this->sendHttpRequest($url);
        $this->assertEquals(400, $response['status']);
    }

    public function testResponseShouldSend400ResponseCodeIfSiteIdIsZero()
    {
        $url = $this->tracker->getUrlTrackPageView('Test');
        $url .= '&idsite=0';

        $response = $this->sendHttpRequest($url);
        $this->assertEquals(400, $response['status']);
    }

    public function testResponseShouldSend400ResponseCodeIfInvalidRequestParameterIsGiven()
    {
        $url = $this->tracker->getUrlTrackPageView('Test');
        $url .= '&token_auth=' . Fixture::getTokenAuth();
        $url .= '&ua=' . urlencode('Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.77 Safari/537.36');
        $url .= '&cid=' . str_pad('1', 16, '1');

        $response = $this->sendHttpRequest($url);
        $this->assertArrayHasKey('Cache-Control', $response['headers']);
        $this->assertEquals('no-store', $response['headers']['Cache-Control']);
        $this->assertEquals(200, $response['status']);

        $response = $this->sendHttpRequest($url . '1'); // has to be 16 char, but is 17 now
        $this->assertEquals(400, $response['status']);
    }

    // See https://github.com/piwik/piwik/issues/7850 piwik.php is used by plugins and monitoring systems to test for Piwik installation.
    // it is important to return a 200 if someone does a GET request with no parameters
    public function testResponseShouldReturnPiwikMessageWithHttp200InCaseOfEmptyGETRequest()
    {
        $url = Fixture::getTrackerUrl();
        $response = Http::sendHttpRequest($url, 10, null, null, 0, false, false, true);
        $this->assertEquals(200, $response['status']);

        $expected = "This resource is part of Matomo. Keep full control of your data with the leading free and open source <a href='https://matomo.org' target='_blank' rel='noopener noreferrer nofollow'>web analytics & conversion optimisation platform</a>.<br>\nThis file is the endpoint for the Matomo tracking API. If you want to access the Matomo UI or use the Reporting API, please use <a href='index.php'>index.php</a> instead.\n";
        $this->assertEquals($expected, $response['data']);
    }

    public function testResponseShouldReturnPiwikMessageWithHttp400InCaseOfInvalidRequestOrIfNothingIsTracked()
    {
        $url = Fixture::getTrackerUrl();
        $response = $this->sendHttpRequest($url . '?rec=1');
        $this->assertEquals(400, $response['status']);

        $response = $this->sendHttpRequest($url);
        $expected = "This resource is part of Matomo. Keep full control of your data with the leading free and open source <a href='https://matomo.org' target='_blank' rel='noopener noreferrer nofollow'>web analytics & conversion optimisation platform</a>.<br>\nThis file is the endpoint for the Matomo tracking API. If you want to access the Matomo UI or use the Reporting API, please use <a href='index.php'>index.php</a> instead.\n";
        $this->assertEquals($expected, $response['data']);
    }

    public function testResponseShouldReturnPiwikMessageWithHttp503InCaseOfMaintenanceMode()
    {
        $url = $this->tracker->getUrlTrackPageView('Test');
        $url .= '&token_auth=' . Fixture::getTokenAuth();
        $response = $this->sendHttpRequest($url);
        $this->assertEquals(200, $response['status']);

        $url = $url . "&forceEnableTrackerMaintenanceMode=1";
        $response = $this->sendHttpRequest($url);
        $this->assertEquals(503, $response['status']);
    }

    protected function sendHttpRequest($url)
    {
        return Http::sendHttpRequest($url, 10, null, null, 0, false, false, true);
    }
}