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

ResponseTest.php « Tracker « Unit « PHPUnit « tests - github.com/matomo-org/matomo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 996ecdefa2b1f2f741f3a320c14faad501281cbb (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
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
<?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\Tests\Unit\Tracker;

use Piwik\Common;
use Piwik\Tests\Framework\Fixture;
use Piwik\Tracker\Response;
use Piwik\Tests\Framework\Mock\Tracker;
use Exception;

class TestResponse extends Response {

    protected function logExceptionToErrorLog($e)
    {
        // prevent console from outputting the error_log message
    }

    public function getMessageFromException($e)
    {
        return parent::getMessageFromException($e);
    }
}

/**
 * @group BulkTracking
 * @group ResponseTest
 * @group Plugins
 * @group Tracker
 */
class ResponseTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @var TestResponse
     */
    private $response;

    public function setUp()
    {
        parent::setUp();
        $this->response = new TestResponse();
    }

    public function test_outputException_shouldAlwaysOutputApiResponse_IfDebugModeIsDisabled()
    {
        $this->response->init($this->getTracker());
        $this->response->outputException($this->getTracker(), new Exception('My Custom Message'), 400);

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

    public function test_outputException_shouldOutputDebugMessageIfEnabled()
    {
        $tracker = $this->getTracker();
        $this->response->init($tracker);

        $tracker->enableDebugMode();

        $this->response->outputException($tracker, new Exception('My Custom Message'), 400);

        $content = $this->response->getOutput();

        $this->assertContains('<title>Matomo &rsaquo; Error</title>', $content);
        $this->assertContains('<p>My Custom Message', $content);
    }

    public function test_outputResponse_shouldOutputStandardApiResponse()
    {
        $this->response->init($this->getTracker());
        $this->response->outputResponse($this->getTracker());

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

    public function test_outputResponse_shouldNotOutputApiResponse_IfDebugModeIsEnabled_AsWePrintOtherStuff()
    {
        $this->response->init($this->getTracker());

        $tracker = $this->getTracker();
        $tracker->enableDebugMode();
        $this->response->outputResponse($tracker);

        $this->assertEquals('', $this->response->getOutput());
    }

    public function test_outputResponse_shouldNotOutputApiResponse_IfSomethingWasPrintedUpfront()
    {
        $this->response->init($this->getTracker());

        echo 5;
        $this->response->outputResponse($this->getTracker());

        $this->assertEquals('5', $this->response->getOutput());
    }

    public function test_outputResponse_shouldNotOutputResponseTwice_IfExceptionWasAlreadyOutput()
    {
        $this->response->init($this->getTracker());

        $this->response->outputException($this->getTracker(), new Exception('My Custom Message'), 400);
        $this->response->outputResponse($this->getTracker());

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

    public function test_outputResponse_shouldOutputNoResponse_If204HeaderIsRequested()
    {
        $this->response->init($this->getTracker());

        $_GET['send_image'] = '0';
        $this->response->outputResponse($this->getTracker());
        unset($_GET['send_image']);

        $this->assertEquals('', $this->response->getOutput());
    }

    public function test_outputResponse_shouldOutputPiwikMessage_InCaseNothingWasTracked()
    {
        $this->response->init($this->getTracker());

        $tracker = $this->getTracker();
        $tracker->setCountOfLoggedRequests(0);
        $this->response->outputResponse($tracker);

        $this->assertEquals("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>.",
            $this->response->getOutput());
    }

    public function test_getMessageFromException_ShouldNotOutputAnyDetails_IfErrorContainsDbCredentials()
    {
        $message = $this->response->getMessageFromException(new Exception('Test Message', 1044));
        $this->assertStringStartsWith("Error while connecting to the Matomo database", $message);

        $message = $this->response->getMessageFromException(new Exception('Test Message', 42000));
        $this->assertStringStartsWith("Error while connecting to the Matomo database", $message);
    }

    public function test_getMessageFromException_ShouldReturnMessageAndTrace_InCaseIsCli()
    {
        $message = $this->response->getMessageFromException(new Exception('Test Message', 8150));
        $this->assertStringStartsWith("Test Message\n#0 [internal function]", $message);
    }

    public function test_getMessageFromException_ShouldOnlyReturnMessage_InCaseIsNotCli()
    {
        Common::$isCliMode = false;
        $message = $this->response->getMessageFromException(new Exception('Test Message', 8150));
        Common::$isCliMode = true;

        $this->assertStringStartsWith("Test Message", $message);
    }

    public function test_outputResponse_shouldOutputApiResponse_IfTrackerIsDisabled()
    {
        $this->response->init($this->getTracker());

        $tracker = $this->getTracker();
        $tracker->setCountOfLoggedRequests(0);
        $tracker->disableShouldRecordStatistics();
        $this->response->outputResponse($tracker);

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

    private function getTracker()
    {
        $tracker = new Tracker();
        $tracker->setCountOfLoggedRequests(5);
        return $tracker;
    }

}