osu-web / tests / Controllers / UsersControllerTest.php

<?php

// Copyright (c) ppy Pty Ltd <[e-mail]>. Licensed under the GNU Affero General Public License v3.0.
// See the LICENCE file in the repository root for full licence text.

namespace Tests\Controllers;

use App\Models\Country;
use App\Models\User;
use Tests\TestCase;

class UsersControllerTest extends TestCase
{
    public function testIndexForApi()
    {
        $user = User::factory()->create();
        $userB = User::factory()->create();

        $this->actAsScopedUser($user, ['*']);

        $this
            ->get(route('api.users.index', ['ids' => [$user->getKey(), $userB->getKey()]]))
            ->assertSuccessful()
            ->assertJsonPath('users.0.id', $user->getKey())
            ->assertJsonPath('users.1.id', $userB->getKey());
    }

    /**
     * Checks whether an OK status is returned when the
     * profile order update request is valid.
     */
    public function testStore()
    {
        $previousCount = User::count();

        $locale = array_rand_val($GLOBALS['cfg']['app']['available_locales']);

        $this->expectCountChange(fn () => User::count(), 1);
        $this
            ->json('POST', route('users.store'), [
                'user' => [
                    'username' => 'user1',
                    'user_email' => '[e-mail]',
                    'password' => 'hunter22',
                ],
            ], [
                'accept-language' => $locale,
                'user-agent' => $GLOBALS['cfg']['osu']['client']['user_agent'],
            ])->assertJsonFragment([
                'username' => 'user1',
                'country_code' => Country::UNKNOWN,
            ]);

        $user = User::where('username', 'user1')->first();
        $this->assertSame($locale, $user->user_lang);
    }

    public function testStoreRegModeWebOnly()
    {
        config_set('osu.user.registration_mode.client', false);
        config_set('osu.user.registration_mode.web', true);
        $this->expectCountChange(fn () => User::count(), 0);

        $this
            ->json('POST', route('users.store'), [
                'user' => [
                    'username' => 'user1',
                    'user_email' => '[e-mail]',
                    'password' => 'hunter22',
                ],
            ], [
                'HTTP_USER_AGENT' => $GLOBALS['cfg']['osu']['client']['user_agent'],
            ])->assertStatus(403)
            ->assertJsonFragment([
                'error' => osu_trans('users.store.from_web'),
            ]);
    }

    /**
     * Passing check=1 only validates user and not create.
     */
    public function testStoreDryRunValid()
    {
        $previousCount = User::count();

        $this
            ->json('POST', route('users.store'), [
                'check' => '1',
                'user' => [
                    'username' => 'user1',
                    'user_email' => '[e-mail]',
                    'password' => 'hunter22',
                ],
            ], [
                'HTTP_USER_AGENT' => $GLOBALS['cfg']['osu']['client']['user_agent'],
            ])->assertSuccessful();

        $this->assertSame($previousCount, User::count());
    }

    /**
     * Invalid parameter returns 422.
     */
    public function testStoreInvalid()
    {
        $previousCount = User::count();

        $this
            ->json('POST', route('users.store'), [
                'check' => '1',
                'user' => [
                    'username' => '',
                    'user_email' => '[e-mail]',
                    'password' => 'hunter22',
                ],
            ], [
                'HTTP_USER_AGENT' => $GLOBALS['cfg']['osu']['client']['user_agent'],
            ])->assertStatus(422)
            ->assertJsonFragment([
                'form_error' => ['user' => ['username' => ['Username is required.']]],
            ]);

        $this
            ->json('POST', route('users.store'), [
                'user' => [
                    'username' => '',
                    'user_email' => '[e-mail]',
                    'password' => 'hunter22',
                ],
            ], [
                'HTTP_USER_AGENT' => $GLOBALS['cfg']['osu']['client']['user_agent'],
            ])->assertStatus(422)
            ->assertJsonFragment([
                'form_error' => ['user' => ['username' => ['Username is required.']]],
            ]);

        $this->assertSame($previousCount, User::count());
    }

    public function testStoreWebRegModeClientOnly()
    {
        config_set('osu.user.registration_mode.client', true);
        config_set('osu.user.registration_mode.web', false);

        $this->expectCountChange(fn () => User::count(), 0);

        $this->post(route('users.store'), [
                'user' => [
                    'username' => 'user1',
                    'user_email' => '[e-mail]',
                    'password' => 'hunter22',
                ],
            ])->assertStatus(403)
            ->assertJsonFragment([
                'error' => osu_trans('users.store.from_client'),
            ]);
    }

    public function testStoreWeb(): void
    {
        config_set('osu.user.registration_mode.web', true);
        $this->expectCountChange(fn () => User::count(), 1);

        $this->post(route('users.store-web'), [
            'user' => [
                'username' => 'user1',
                'user_email' => '[e-mail]',
                'user_email_confirmation' => '[e-mail]',
                'password' => 'hunter22',
                'password_confirmation' => 'hunter22',
            ],
        ])->assertRedirect(route('home'));
    }

    /**
     * @dataProvider dataProviderForStoreWebInvalidParams
     */
    public function testStoreWebInvalidParams($username, $email, $emailConfirmation, $password, $passwordConfirmation): void
    {
        config_set('osu.user.registration_mode.web', true);
        $this->expectCountChange(fn () => User::count(), 0);

        $this->post(route('users.store-web'), [
                'user' => [
                    'username' => $username,
                    'user_email' => $email,
                    'user_email_confirmation' => $emailConfirmation,
                    'password' => $password,
                    'password_confirmation' => $passwordConfirmation,
                ],
            ])->assertStatus(422);
    }

    public function testStoreWebLoggedIn(): void
    {
        config_set('osu.user.registration_mode.web', true);
        $user = User::factory()->create();

        $this->expectCountChange(fn () => User::count(), 0);

        $this->actingAsVerified($user)->post(route('users.store-web'), [
            'user' => [
                'username' => 'user1',
                'user_email' => '[e-mail]',
                'user_email_confirmation' => '[e-mail]',
                'password' => 'hunter22',
                'password_confirmation' => 'hunter22',
            ],
        ])->assertRedirect('/');
    }

    public function testStoreWithCountry()
    {
        $country = Country::inRandomOrder()->first() ?? Country::factory()->create();

        $previousCount = User::count();

        $this
            ->json('POST', route('users.store'), [
                'user' => [
                    'username' => 'user1',
                    'user_email' => '[e-mail]',
                    'password' => 'hunter22',
                ],
            ], [
                'HTTP_USER_AGENT' => $GLOBALS['cfg']['osu']['client']['user_agent'],
                'HTTP_CF_IPCOUNTRY' => $country->getKey(),
            ])->assertJsonFragment([
                'username' => 'user1',
                'country' => [
                    'code' => $country->getKey(),
                    'name' => $country->name,
                ],
            ]);

        $this->assertSame($previousCount + 1, User::count());
    }

    /**
     * Disable registration for logged in user.
     */
    public function testStoreLoggedIn()
    {
        $user = User::factory()->create();

        $previousCount = User::count();

        $this
            ->actingAsVerified($user)
            ->json('POST', route('users.store'), [
                'user' => [
                    'username' => 'user1',
                    'user_email' => '[e-mail]',
                    'password' => 'hunter22',
                ],
            ], [
                'HTTP_USER_AGENT' => $GLOBALS['cfg']['osu']['client']['user_agent'],
            ])->assertStatus(302);

        $this->assertSame($previousCount, User::count());
    }

    public function testPreviousUsernameShouldRedirect()
    {
        $oldUsername = 'potato';
        $newUsername = 'carrot';

        /** @var User $user */
        $user = User::factory()->create([
            'osu_subscriptionexpiry' => now()->addDays(),
            'username' => $oldUsername,
            'username_clean' => $oldUsername,
        ]);
        $user->changeUsername($newUsername, 'paid');

        $this
            ->get(route('users.show', ['user' => $oldUsername]))
            ->assertRedirect(route('users.show', ['user' => $user->getKey(), 'mode' => null]));
    }

    public function testPreviousUsernameTakenShouldNotRedirect()
    {
        $oldUsername = 'potato';
        $newUsername = 'carrot';

        /** @var User $user1 */
        $user1 = User::factory()->create([
            'osu_subscriptionexpiry' => now()->addDays(),
            'username' => $oldUsername,
            'username_clean' => $oldUsername,
        ]);
        $user1->changeUsername($newUsername, 'paid');

        $user2 = User::factory()->create([
            'username' => $oldUsername,
            'username_clean' => $oldUsername,
        ]);

        $this
            ->get(route('users.show', ['user' => $oldUsername]))
            ->assertRedirect(route('users.show', ['user' => $user2->getKey(), 'mode' => null]));
    }

    public function testUsernameRedirectToId()
    {
        $user = User::factory()->create();

        $this
            ->get(route('users.show', ['user' => $user->username]))
            ->assertRedirect(route('users.show', ['user' => $user->getKey()]));
    }

    public function testUsernameAtPrefixedRedirectToId()
    {
        $user = User::factory()->create();

        $this
            ->get(route('users.show', ['user' => "@{$user->username}"]))
            ->assertRedirect(route('users.show', ['user' => $user->getKey()]));
    }

    public function testUsernameRedirectToIdForApi()
    {
        $user = User::factory()->create();

        $this->actAsScopedUser($user, ['public']);

        $this
            ->get(route('api.users.show', ['user' => $user->username]))
            ->assertSuccessful();
    }

    public function testUsernameAtPrefixedRedirectToIdForApi()
    {
        $user = User::factory()->create();

        $this->actAsScopedUser($user, ['public']);

        $this
            ->get(route('api.users.show', ['user' => "@{$user->username}"]))
            ->assertSuccessful();
    }

    public static function dataProviderForStoreWebInvalidParams(): array
    {
        return [
            ['user1', '[e-mail]', '[e-mail]', 'short', 'short'],
            ['user1', '[e-mail]', '[e-mail]', '', ''],
            ['user1', '[e-mail]', '[e-mail]', 'userpassword', 'userpassword1'],
            ['user1', '[e-mail]', '[e-mail]', 'userpassword', null],
            ['user1', '[e-mail]', '[e-mail]', null, null],

            ['user1', 'notemail@.com', 'notemail@.com', 'userpassword', 'userpassword'],
            ['user1', '', '', 'userpassword', 'userpassword'],
            ['user1', '[e-mail]', '[e-mail]', 'userpassword', 'userpassword'],
            ['user1', '[e-mail]', null, 'userpassword', 'userpassword'],
            ['user1', null, null, 'userpassword', 'userpassword'],

            [null, '[e-mail]', '[e-mail]', 'userpassword', 'userpassword'],
            ['', '[e-mail]', '[e-mail]', 'userpassword', 'userpassword'],
            [null, '[e-mail]', '[e-mail]', null, null],
            [null, null, null, 'userpassword', 'userpassword'],
        ];
    }

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

        Country::factory()->fallback()->create();
    }
}