gnu-social/tests/Util/NicknameTest.php

<?php

// {{{ License
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social.  If not, see <http://www.gnu.org/licenses/>.
// }}}

namespace App\Tests\Util;

use App\Entity\GSActor;
use App\Util\Common;
use App\Util\Exception\NicknameEmptyException;
use App\Util\Exception\NicknameInvalidException;
use App\Util\Exception\NicknameReservedException;
use App\Util\Exception\NicknameTakenException;
use App\Util\Exception\NicknameTooLongException;
use App\Util\Exception\NicknameTooShortException;
use App\Util\GNUsocialTestCase;
use App\Util\Nickname;
use Jchook\AssertThrows\AssertThrows;
use Symfony\Component\DependencyInjection\ParameterBag\ContainerBagInterface;

class NicknameTest extends GNUsocialTestCase
{
    use AssertThrows;

    public function testNormalize()
    {
        $conf = ['nickname' => ['min_length' => 4, 'reserved' => ['this_nickname_is_reserved']]];
        $cb   = $this->createMock(ContainerBagInterface::class);
        static::assertTrue($cb instanceof ContainerBagInterface);
        $cb->method('get')
           ->willReturnMap([['gnusocial', $conf], ['gnusocial_defaults', $conf]]);
        Common::setupConfig($cb);

        static::assertThrows(NicknameTooLongException::class, fn () => Nickname::normalize(serialize(random_bytes(128)), check_already_used: false));
        static::assertSame('foobar', Nickname::normalize('foobar', check_already_used: false));
        static::assertSame('foobar', Nickname::normalize('  foobar  ', check_already_used: false));
        static::assertSame('foobar', Nickname::normalize('foo_bar', check_already_used: false));
        static::assertSame('foobar', Nickname::normalize('FooBar', check_already_used: false));
        static::assertThrows(NicknameTooShortException::class, fn () => Nickname::normalize('foo', check_already_used: false));
        static::assertThrows(NicknameEmptyException::class,    fn () => Nickname::normalize('', check_already_used: false));
        static::assertThrows(NicknameInvalidException::class,  fn () => Nickname::normalize('FóóBár', check_already_used: false));
        static::assertThrows(NicknameReservedException::class, fn () => Nickname::normalize('this_nickname_is_reserved', check_already_used: false));

        static::bootKernel();
        static::assertSame('foobar', Nickname::normalize('foobar', check_already_used: true));
        static::assertThrows(NicknameTakenException::class, fn () => Nickname::normalize('taken_user', check_already_used: true));
    }

    public function testIsValid()
    {
        static::assertTrue(Nickname::isValid('nick', check_already_used: false));
        static::assertFalse(Nickname::isValid('', check_already_used: false));
    }

    public function testIsCanonical()
    {
        static::assertTrue(Nickname::isCanonical('foo'));
        static::assertFalse(Nickname::isCanonical('fóó'));
    }

    public function testIsReserved()
    {
        $conf = ['nickname' => ['min_length' => 4, 'reserved' => ['this_nickname_is_reserved']]];
        $cb   = $this->createMock(ContainerBagInterface::class);
        static::assertTrue($cb instanceof ContainerBagInterface);
        $cb->method('get')->willReturnMap([['gnusocial', $conf], ['gnusocial_defaults', $conf]]);
        Common::setupConfig($cb);
        static::assertTrue(Nickname::isReserved('this_nickname_is_reserved'));
        static::assertFalse(Nickname::isReserved('this_nickname_is_not_reserved'));

        $conf = ['nickname' => ['min_length' => 4, 'reserved' => []]];
        $cb   = $this->createMock(ContainerBagInterface::class);
        $cb->method('get')->willReturnMap([['gnusocial', $conf], ['gnusocial_defaults', $conf]]);
        Common::setupConfig($cb);
        static::assertFalse(Nickname::isReserved('this_nickname_is_reserved'));
    }

    public function testCheckTaken()
    {
        static::bootKernel();

        static::assertNull(Nickname::checkTaken('not_taken_user'));
        static::assertTrue(Nickname::checkTaken('taken_user') instanceof GSActor);
        static::assertNull(Nickname::checkTaken('not_taken_group'));
        static::assertTrue(Nickname::checkTaken('taken_group') instanceof GSActor);
    }
}