File: AllowedEmailDomainTest.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 (134 lines) | stat: -rw-r--r-- 4,344 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
<?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\UsersManager\tests\Integration\Validators;

use Piwik\Plugins\UsersManager\SystemSettings;
use Piwik\Plugins\UsersManager\Validators\AllowedEmailDomain;
use Piwik\Plugins\UsersManager\API;
use Piwik\Tests\Framework\Fixture;
use Piwik\Tests\Framework\TestCase\IntegrationTestCase;

/**
 * @group Login
 * @group AllowedEmailDomainTest
 * @group Plugins
 */
class AllowedEmailDomainTest extends IntegrationTestCase
{
    /**
     * @var AllowedEmailDomain
     */
    private $validator;

    /**
     * @var SystemSettings
     */
    private $settings;

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

        Fixture::createWebsite('2023-01-01 00:00:00');

        $this->settings = new SystemSettings();
        $this->validator = new AllowedEmailDomain($this->settings);
    }

    public function tearDown(): void
    {
        Fixture::resetTranslations();

        parent::tearDown();
    }

    /**
     * @dataProvider  getDataDomainFromEmail
     */
    public function testGetDomainFromEmail($expected, $email)
    {
        $this->assertSame($expected, $this->validator->getDomainFromEmail($email));
    }

    public function getDataDomainFromEmail()
    {
        return [
            ['matomo.org', 'foobar@matomo.org'],
            ['foo.matomo.co.uk', 'foobar@foo.matomo.co.uk'],
            ['mo.org', 'foobar@mato@mo.org'],
            ['mo.org', '   foobar @ mato  @  mo.org '],
            ['', 'foobar'],
            ['', ''],
            ['', null],
        ];
    }

    /**
     * @dataProvider  getDataDoesEmailEndWithAValidDomain
     */
    public function testDoesEmailEndWithAValidDomain($expected, $email, $domains)
    {
        $this->assertSame($expected, $this->validator->doesEmailEndWithAValidDomain($email, $domains));
    }

    public function getDataDoesEmailEndWithAValidDomain()
    {
        return [
            [false, 'foobar@matomo.org', []],
            [false, 'foobar@matomo.org', [false, null, '']],
            [true, 'foobar@matomo.org', ['matomo.org']],
            [false, 'foobar@matomo.fr', ['matomo.com', 'matomo.org', 'matomo.de']],
            [true, 'foobar@maToMo.dE', ['matomo.com', 'matomo.org', 'mAtOmo.De']],
            [true, 'foobar@maToMo.dE', ['example.org', 'mAtOmo.De']],
        ];
    }

    public function testGetEmailDomainsInUseNoUsersConfigured()
    {
        $this->assertSame([], $this->validator->getEmailDomainsInUse());
    }

    public function testGetEmailDomainsInUseUsersAddedAndInvited()
    {
        $userApi = API::getInstance();
        $userApi->addUser('foo1', 'foo' . time(), 'foobar@matomo.org');
        $userApi->addUser('foo2', 'foo' . time(), 'foobar2@matomo.org');
        $userApi->inviteUser('foo3', 'foobar@matomo.com', 1);
        $userApi->inviteUser('foo4', 'foobar3@matomo.org', 1);
        $userApi->inviteUser('foo5', 'foobar@example.com', 1);
        $userApi->addUser('foo6', 'foo' . time(), 'foobar2@example.org');

        $this->assertEquals([
            'example.com', 'example.org', 'matomo.com', 'matomo.org',
        ], $this->validator->getEmailDomainsInUse());
    }

    public function testValidateNoDomainsConfiguredMeansAllDomainsAllowed()
    {
        $this->assertNull($this->validator->validate('foobar@matomo.org'));
        $this->assertNull($this->validator->validate('foobar@mAtomo.org'));
        $this->assertNull($this->validator->validate('foobar@eXaMPle.com'));
    }

    public function testValidateEmailsAllowed()
    {
        $this->settings->allowedEmailDomains->setValue(['MaToMo.Org', 'example.COM']);
        $this->assertNull($this->validator->validate('foobar@mAtomo.org'));
        $this->assertNull($this->validator->validate('foobar@eXaMPle.com'));
    }

    public function testValidateNoEmailsAllowedDomainsAreConfigured()
    {
        Fixture::loadAllTranslations();
        $this->expectExceptionMessage('The email "foobar@matomo.com" cannot be used, as only emails with the domains "matomo.org, example.com" are allowed.');
        $this->settings->allowedEmailDomains->setValue(['matomo.org', 'example.com']);
        $this->validator->validate('foobar@matomo.com');
    }
}