File: CustomLogTablesTest.php

package info (click to toggle)
matomo 5.8.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 95,068 kB
  • sloc: php: 289,425; xml: 127,249; javascript: 112,130; python: 202; sh: 178; makefile: 20; sql: 10
file content (141 lines) | stat: -rw-r--r-- 4,130 bytes parent folder | download
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
<?php

namespace Piwik\Plugins\ExampleLogTables\tests\System;

use Piwik\Plugins\ExampleLogTables\tests\Fixtures\VisitsWithUserIdAndCustomData;
use Piwik\Tests\Framework\TestCase\SystemTestCase;
use Piwik\Tests\Framework\TestRequest\ApiTestConfig;
use Piwik\Tests\Framework\TestRequest\Response;

/**
 * Testing Custom Log Tables
 *
 * @group ExampleLogTables
 * @group Plugins
 */
class CustomLogTablesTest extends SystemTestCase
{
    /**
     * @var VisitsWithUserIdAndCustomData
     */
    public static $fixture = null; // initialized below class definition

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

    /**
     * @dataProvider getSegmentsToTest
     */
    public function testNoApiReturnsError($segment)
    {
        self::expectNotToPerformAssertions();

        $dateTime = self::$fixture->dateTime;
        $idSite1 = self::$fixture->idSite;

        $params = [
            'idSite'       => $idSite1,
            'date'         => $dateTime,
            'periods'      => 'month',
            'setDateLastN' => false,
            'format'       => 'JSON',
            'segment'      => $segment,
            'testSuffix'   => '',
        ];

        $testConfig = new ApiTestConfig($params);
        $testRequests = $this->getTestRequestsCollection('all', $testConfig, 'all');

        foreach ($testRequests->getRequestUrls() as $apiId => $requestUrl) {
            $response = Response::loadFromApi($params, $requestUrl, false);
            $decoded = json_decode($response->getResponseText(), true);

            if (is_array($decoded) && isset($decoded['result']) && $decoded['result'] == 'error') {
                $this->fail('API returned an error when requesting ' . http_build_query($requestUrl) . "\nMessage: " . $decoded['message']);
            }
        }
    }

    public function getSegmentsToTest()
    {
        return [
            ['attrgender==men'],
            ['isadmin==1'],
        ];
    }

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

        $result = [
            [[
                'Actions.get',
                'UserId.getUsers',
                'VisitsSummary.get',
            ], [
                'idSite'       => $idSite1,
                'date'         => $dateTime,
                'periods'      => 'month',
                'setDateLastN' => false,
                'segment'      => 'attrgender==men',
                'testSuffix'   => '_men'],
            ],
            [[
                'Actions.get',
                'UserId.getUsers',
                'VisitsSummary.get',
            ], [
                'idSite'       => $idSite1,
                'date'         => $dateTime,
                'periods'      => 'month',
                'setDateLastN' => false,
                'segment'      => 'attrgender==women',
                'testSuffix'   => '_women'],
            ],
            [[
                'Actions.get',
                'UserId.getUsers',
                'VisitsSummary.get',
            ], [
                'idSite'       => $idSite1,
                'date'         => $dateTime,
                'periods'      => 'month',
                'setDateLastN' => false,
                'segment'      => 'isadmin==1',
                'testSuffix'   => '_admin'],
            ],
            [[
                'Actions.get',
                'UserId.getUsers',
                'VisitsSummary.get',
            ], [
                'idSite'       => $idSite1,
                'date'         => $dateTime,
                'periods'      => 'month',
                'setDateLastN' => false,
                'testSuffix'   => '_all'],
            ],
        ];

        return $result;
    }

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

    public static function getPathToTestDirectory()
    {
        return dirname(__FILE__);
    }
}

CustomLogTablesTest::$fixture = new VisitsWithUserIdAndCustomData();