File size: 12,537 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
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
<?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\Integration;

use Piwik\Plugin\Dependency;
use Piwik\Plugin\Manager as PluginManager;
use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
use Piwik\Version;

/**
 * @group Core
 */
class DependencyTest extends IntegrationTestCase
{
    /**
     * @var Dependency
     */
    private $dependency;

    public static function setUpBeforeClass(): void
    {
        // skip to set up fixture, as it's not needed for tests
    }

    public function setUp(): void
    {
        parent::setUp();
        $this->dependency = new Dependency();
    }

    public function testGetMissingDependenciesShouldReturnEmptyArrayIfNoInputGiven()
    {
        $this->assertMissingDependency(null, array());
        $this->assertMissingDependency(array(), array());
    }

    public function testGetMissingDependenciesEmptyVersionShouldBeIgnored()
    {
        $this->assertMissingDependency(array('php' => ''), array());
    }

    public function testGetMissingDependenciesMultipleConditions()
    {
        $this->assertMissingDependency(array('php' => '<5.2', 'piwik' => '<2.0'), array(
            $this->missingPhp('<5.2'),
            $this->missingPiwik('>=2.0.0-b1,<2.0', '<2.0'),
        ));

        $this->assertMissingDependency(array('php' => '<5.2', 'piwik' => '>=4.0.0-b1,<9.0'), array(
            $this->missingPhp('<5.2'),
        ));

        $this->assertMissingDependency(array('php' => '<9.2', 'piwik' => '<2.0'), array(
            $this->missingPiwik('>=2.0.0-b1,<2.0', '<2.0'),
        ));

        $this->assertMissingDependency(array('php' => '<9.2', 'piwik' => '>=2.0,<9.0'), array());
    }

    public function testGetMissingDependenciesMultipleConditionsDifferentConditions()
    {
        $this->assertMissingDependency(array('php' => '<5.2', 'piwik' => '>2.0,<9.0.0'), array(
            $this->missingPhp('<5.2'),
        ));

        $this->assertMissingDependency(array('php' => '>=5.3', 'piwik' => '>1.0,<2.0'), array(
            $this->missingPiwik('>1.0,<2.0', '<2.0'),
        ));

        $this->assertMissingDependency(array('php' => '!=' . $this->formatPhpVersion(), 'piwik' => '<>' . Version::VERSION), array(
            $this->missingPhp('!=' . $this->formatPhpVersion()),
            $this->missingPiwik('<>' . Version::VERSION . ',<' . (Version::MAJOR_VERSION + 1) . '.0.0-b1', '<>' . Version::VERSION),
        ));
    }

    public function testGetMissingVersionANDCondition()
    {
        $this->assertMissingDependency(array('php' => '<2.0,>=9.0', 'piwik' => '>=3.0.0-b1,<4.0.0-b1'), array(
            $this->missingPhp('<2.0,>=9.0', '<2.0, >=9.0'),
            $this->missingPiwik('>=3.0.0-b1,<4.0.0-b1', '<4.0.0-b1'),
        ));
    }

    public function testGetMissingDependenciesDetectsPHPVersion()
    {
        $phpVersion = $this->formatPhpVersion();
        $this->assertMissingDependency(array('php' => '>=2.1'), array());
        $this->assertMissingDependency(array('php' => '>=' . $phpVersion), array());
        $this->assertMissingDependency(array('php' => '>' . $phpVersion), array(
            $this->missingPhp('>' . $phpVersion),
        ));
        $this->assertMissingDependency(array('php' => '>=9.2'), array(
            $this->missingPhp('>=9.2'),
        ));
    }

    public function testGetMissingDependenciesDetectsPiwikVersion()
    {
        $this->assertMissingDependency(array('piwik' => '>=2.1,<9.0.0'), array());
        $this->assertMissingDependency(array('piwik' => '>=' . Version::VERSION), array());
        $this->assertMissingDependency(array('piwik' => '>' . Version::VERSION), array(
            $this->missingPiwik('>' . Version::VERSION . ',<' . (Version::MAJOR_VERSION + 1) . '.0.0-b1', '>' . Version::VERSION),
        ));
        $this->assertMissingDependency(array('piwik' => '>=9.2'), array(
            $this->missingPiwik('>=9.2,<10.0.0-b1', '>=9.2'),
        ));
    }

    public function testGetMissingDependenciesDetectUnknownDependencyName()
    {
        $this->assertMissingDependency(array('unkNowN' => '>99.99'), array(
            $this->buildMissingDependecy('unkNowN', '', '>99.99'),
        ));
        $this->assertMissingDependency(array('unkNowN' => '>=0.01'), array(
            $this->buildMissingDependecy('unkNowN', '', '>=0.01'),
        ));
    }

    public function testGetMissingDependenciesDetectsPluginVersion()
    {
        PluginManager::getInstance()->loadAllPluginsAndGetTheirInfo();

        $this->assertMissingDependency(array('Annotations' => '>=2.1'), array());
        $this->assertMissingDependency(array('Annotations' => '>=' . Version::VERSION), array());
        $this->assertMissingDependency(array('Annotations' => '>' . Version::VERSION), array(
            $this->buildMissingDependecy('Annotations', Version::VERSION, '>' . Version::VERSION),
        ));
        $this->assertMissingDependency(array('Annotations' => '>=9.2'), array(
            $this->buildMissingDependecy('Annotations', Version::VERSION, '>=9.2'),
        ));
    }

    public function testGetMissingDependenciesSetPiwikVersion()
    {
        $this->assertMissingDependency(array('piwik' => '>=9.2'), array($this->missingPiwik('>=9.2,<10.0.0-b1', '>=9.2')));

        $this->dependency->setPiwikVersion('9.2');

        $this->assertMissingDependency(array('piwik' => '>=9.2'), array());
    }

    public function testGetMissingVersionEmptyCurrentAndRequiredVersionShouldBeIgnored()
    {
        $this->assertMissingVersion(null, null, array());
        $this->assertMissingVersion('', '', array());
    }

    public function testGetMissingVersionEmptyCurrentVersionShouldBeDeclaredAsMissing()
    {
        $this->assertMissingVersion('', '>=5.5', array('>=5.5'));
    }

    public function testGetMissingVersionEmptyRequiredVersionShouldBeIgnored()
    {
        $this->assertMissingVersion('5.5', '', array());
    }

    public function testGetMissingVersionShouldIgnoreAnyWhitespace()
    {
        $this->assertMissingVersion('5.5 ', '5.5', array());
        $this->assertMissingVersion(' 5.5 ', '5.5', array());
        $this->assertMissingVersion('5.5', ' 5.5', array());
        $this->assertMissingVersion('5.5', ' 5.5 ', array());
    }

    public function testGetMissingVersionNoComparisonDefinedShouldUseGreatherThanOrEqualByDefault()
    {
        $this->assertMissingVersion('5.4', '5.2', array());
        $this->assertMissingVersion('5.4', '5.4', array());
        $this->assertMissingVersion('5.4', '9.2', array('>=9.2'));
    }

    public function testGetMissingVersionGreatherThanOrEqual()
    {
        $this->assertMissingVersion('5.4', '>=5.2', array());
        $this->assertMissingVersion('5.4', '>=5.4', array());
        $this->assertMissingVersion('5.4', '>=9.2', array('>=9.2'));
    }

    public function testGetMissingVersionGreatherThan()
    {
        $this->assertMissingVersion('5.4', '>5.2', array());
        $this->assertMissingVersion('5.4', '>5.4', array('>5.4'));
        $this->assertMissingVersion('5.4', '>9.2', array('>9.2'));
    }

    public function testGetMissingVersionLowerThanOrEqual()
    {
        $this->assertMissingVersion('5.4', '<=5.2', array('<=5.2'));
        $this->assertMissingVersion('5.4', '<=5.4', array());
        $this->assertMissingVersion('5.4', '<=9.2', array());
    }

    public function testGetMissingVersionLowerThan()
    {
        $this->assertMissingVersion('5.4', '<5.2', array('<5.2'));
        $this->assertMissingVersion('5.4', '<5.4', array('<5.4'));
        $this->assertMissingVersion('5.4', '<9.2', array());
    }

    public function testGetMissingVersionNotEqual()
    {
        $this->assertMissingVersion('5.4', '<>5.2', array());
        $this->assertMissingVersion('5.4', '<>5.4', array('<>5.4'));
        $this->assertMissingVersion('5.4', '<>9.2', array());
    }

    public function testGetMissingVersionNotEqualUsingBang()
    {
        $this->assertMissingVersion('5.4', '!=5.2', array());
        $this->assertMissingVersion('5.4', '!=5.4', array('!=5.4'));
        $this->assertMissingVersion('5.4', '!=9.2', array());
    }

    public function testGetMissingVersionExact()
    {
        $this->assertMissingVersion('5.4', '==5.2', array('==5.2'));
        $this->assertMissingVersion('5.4', '==5.4', array());
        $this->assertMissingVersion('5.4', '==9.2', array('==9.2'));
    }

    public function testGetMissingVersionANDConditionReturnsOnlyNonMatchingVersions()
    {
        $this->assertMissingVersion('5.4', '<5.2,>9.0', array('<5.2', '>9.0'));
        $this->assertMissingVersion('5.4', '>5.2,<9.0', array());
        $this->assertMissingVersion('5.4', '>5.2,<9.0,<2.0', array('<2.0'));
        $this->assertMissingVersion('5.4', '>5.2,<9.0,<2.0,>=9.0', array('<2.0', '>=9.0'));
        $this->assertMissingVersion('5.4', '<2.0,>=9.0', array('<2.0', '>=9.0'));
    }

    public function testGetMissingVersionANDConditionShouldIgnoreAnyWhitespace()
    {
        $this->assertMissingVersion('5.2', '5.5 , 5.4,   5.3', array('>=5.5', '>=5.4', '>=5.3'));
        $this->assertMissingVersion('5.5', '5.5 , 5.4,   5.3', array());
        $this->assertMissingVersion(' 5.2 ', '5.5 , 5.4,   5.3', array('>=5.5', '>=5.4', '>=5.3'));
        $this->assertMissingVersion(' 5.2 ', '>5.5 , <5.4,   ==5.3', array('>5.5', '==5.3'));
        $this->assertMissingVersion(' 5.2 ', '>5.5 , !=5.4,   ==5.3', array('>5.5', '==5.3'));
    }

    public function testGetMissingVersion()
    {
        $this->assertMissingVersion('5.2', '<5.2,>9.0', array('<5.2', '>9.0'));
        $this->assertMissingVersion('5.2', '<=5.2,>9.0', array('>9.0'));
        $this->assertMissingVersion('5.1', '<5.2,>9.0', array('>9.0'));
        $this->assertMissingVersion('9.1', '<5.2,>9.0', array('<5.2'));
        $this->assertMissingVersion('5.2', '>=5.2,<=9.0', array());
        $this->assertMissingVersion('9.0', '>=5.2,<=9.0', array());
        $this->assertMissingVersion('6.4', '>=5.2,<=9.0', array());
    }

    /**
     * @dataProvider getHasDepenedencyToDisabledPluginProvider
     */
    public function testHasDependencyToDisabledPlugin($expectedHasDependency, $requires)
    {
        $this->assertSame($expectedHasDependency, $this->dependency->hasDependencyToDisabledPlugin($requires));
    }

    public function getHasDepenedencyToDisabledPluginProvider()
    {
        return array(
            array($expected = false, $requires = null),
            array($expected = false, $requires = array()),
            array($expected = false, $requires = array('php' => '<5.2', 'piwik' => '<2.0')),
            array($expected = false, $requires = array('php' => '<5.2', 'piwik' => '<2.0', 'CoreHome' => '2.15.0')),
            array($expected = false, $requires = array('CoreHome' => '<2.0', 'Actions' => '>=2.15.0')),
            array($expected = true, $requires = array('php' => '<5.2', 'piwik' => '<2.0', 'FooBar' => '2.15.0')),
        );
    }

    private function missingPiwik($requiredVersion, $causedBy = null)
    {
        return $this->buildMissingDependecy('piwik', Version::VERSION, $requiredVersion, $causedBy);
    }

    private function missingPhp($requiredVersion, $causedBy = null)
    {
        return $this->buildMissingDependecy('php', $this->formatPhpVersion(), $requiredVersion, $causedBy);
    }

    private function buildMissingDependecy($name, $currentVersion, $requiredVersion, $causedBy = null)
    {
        if (is_null($causedBy)) {
            $causedBy = $requiredVersion;
        }

        return array(
            'requirement'     => $name,
            'actualVersion'   => $currentVersion,
            'requiredVersion' => $requiredVersion,
            'causedBy'        => $causedBy,
        );
    }

    /*
     * remove all the ubuntu and system text
     */
    private function formatPhpVersion()
    {
        preg_match("#^\d+(\.\d+)*#", PHP_VERSION, $phpversion);

        return $phpversion[0];
    }

    private function assertMissingDependency($requires, $expectedMissing)
    {
        $missing = $this->dependency->getMissingDependencies($requires);

        $this->assertEquals($expectedMissing, $missing);
    }

    private function assertMissingVersion($currentVersion, $requiredVersion, $expectedMissing)
    {
        $missing = $this->dependency->getMissingVersions($currentVersion, $requiredVersion);

        $this->assertEquals($expectedMissing, $missing);
    }
}