File: ConfigFeatureFlagStorageTest.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 (172 lines) | stat: -rw-r--r-- 5,896 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
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
<?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\Plugins\FeatureFlags\tests\Unit\Storage;

use PHPUnit\Framework\TestCase;
use Piwik\Config;
use Piwik\Plugins\FeatureFlags\FeatureFlagInterface;
use Piwik\Plugins\FeatureFlags\Storage\ConfigFeatureFlagStorage;
use Piwik\Tests\Framework\Mock\FakeConfig;

class ConfigFeatureFlagStorageTest extends TestCase
{
    public function testIsFeatureActiveReturnsFalseIfConfigIsMissing(): void
    {
        $configMock = $this->createMock(Config::class);
        $configMock->method('__get')->willThrowException(new \Exception());

        $sut = new ConfigFeatureFlagStorage($configMock);
        $mockFeature = $this->createMock(FeatureFlagInterface::class);

        $this->assertFalse($sut->isFeatureActive($mockFeature));
    }

    public function testIsFeatureActiveReturnsNullIfFeatureIsntConfigured(): void
    {
        $configMock = $this->createMock(Config::class);
        $configMock->method('__get')->willReturn([
            'SomeOther_feature' => 'enabled',
            'AnotherOne_feature' => 'disabled',
        ]);

        $sut = new ConfigFeatureFlagStorage($configMock);
        $mockFeature = $this->createMock(FeatureFlagInterface::class);
        $mockFeature->method('getName')->willReturn('NotSet');

        $this->assertNull($sut->isFeatureActive($mockFeature));
    }

    public function testIsFeatureActiveReturnsTrueIfFeatureIsConfiguredAndEnabled(): void
    {
        $configMock = $this->createMock(Config::class);
        $configMock->method('__get')->willReturn([
            'Other_feature' => 'disabled',
            'UnitTest_feature' => 'enabled',
        ]);

        $sut = new ConfigFeatureFlagStorage($configMock);
        $mockFeature = $this->createMock(FeatureFlagInterface::class);
        $mockFeature->method('getName')->willReturn('UnitTest');

        $this->assertTrue($sut->isFeatureActive($mockFeature));
    }

    public function testIsFeatureActiveReturnsFalseIfFeatureIsConfiguredButNotEnabled(): void
    {
        $configMock = $this->createMock(Config::class);
        $configMock->method('__get')->willReturn([
            'Other_feature' => 'disabled',
            'UnitTest_feature' => 'disabled',
        ]);

        $sut = new ConfigFeatureFlagStorage($configMock);
        $mockFeature = $this->createMock(FeatureFlagInterface::class);
        $mockFeature->method('getName')->willReturn('UnitTest');

        $this->assertFalse($sut->isFeatureActive($mockFeature));
    }

    public function testDisableFeatureFlagDoesntUpdateIfFeatureDoesntExists(): void
    {
        $configMock = $this->createMock(Config::class);
        $configMock->expects($this->never())->method('__set');
        $configMock->expects($this->never())->method('forceSave');

        $mockFeature = $this->createMock(FeatureFlagInterface::class);

        $sut = new ConfigFeatureFlagStorage($configMock);
        $sut->disableFeatureFlag($mockFeature);
    }

    public function testDisableFeatureFlagUpdatesConfigAndForcesSaveOfConfig(): void
    {
        $configMock = $this->getMockBuilder(FakeConfig::class)
            ->setMethodsExcept(['__get', '__set', '__construct'])
            ->setConstructorArgs([
                'configValues' => [
                    'FeatureFlags' =>
                    [
                        'TestFeature_feature' => 'enabled',
                    ],
                ],
            ])
            ->getMock();

        $configMock->expects($this->once())->method('forceSave');

        $mockFeature = $this->createMock(FeatureFlagInterface::class);
        $mockFeature->method('getName')->willReturn('TestFeature');

        $sut = new ConfigFeatureFlagStorage($configMock);
        $sut->disableFeatureFlag($mockFeature);

        $this->assertEquals(
            [
                'TestFeature_feature' => 'disabled',
            ],
            $configMock->FeatureFlags
        );
    }

    public function testEnableFeatureFlagUpdatesConfig(): void
    {
        $configMock = $this->getMockBuilder(FakeConfig::class)
            ->setMethodsExcept(['__get', '__set', '__construct'])
            ->setConstructorArgs([
                'configValues' => [],
            ])
            ->getMock();

        $configMock->expects($this->once())->method('forceSave');

        $mockFeature = $this->createMock(FeatureFlagInterface::class);
        $mockFeature->method('getName')->willReturn('TestFeature');

        $sut = new ConfigFeatureFlagStorage($configMock);
        $sut->enableFeatureFlag($mockFeature);

        $this->assertEquals(
            [
                'TestFeature_feature' => 'enabled',
            ],
            $configMock->FeatureFlags
        );
    }

    public function testDeleteFeatureDoesNothingIfFeatureDoesntExist(): void
    {
        $configMock = $this->createMock(Config::class);
        $configMock->expects($this->never())->method('forceSave');

        $sut = new ConfigFeatureFlagStorage($configMock);
        $sut->deleteFeatureFlag('UnknownFeature');
    }

    public function testDeleteFeatureRemovesFlagFromConfig(): void
    {
        $configMock = $this->getMockBuilder(FakeConfig::class)
            ->setMethodsExcept(['__get', '__set', '__construct'])
            ->setConstructorArgs([
                'configValues' => [
                    'FeatureFlags' =>
                        [
                            'TestFeature_feature' => 'enabled',
                        ],
                ],
            ])
            ->getMock();
        $configMock->expects($this->once())->method('forceSave');

        $sut = new ConfigFeatureFlagStorage($configMock);
        $sut->deleteFeatureFlag('TestFeature');

        $this->assertEquals([], $configMock->FeatureFlags);
    }
}