osu-web / tests / Models / ContestTest.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.

declare(strict_types=1);

namespace Tests\Models;

use App\Exceptions\InvariantException;
use App\Models\Beatmap;
use App\Models\Beatmapset;
use App\Models\Contest;
use App\Models\ContestEntry;
use App\Models\Multiplayer\PlaylistItem;
use App\Models\Multiplayer\Room;
use App\Models\Multiplayer\ScoreLink as MultiplayerScoreLink;
use App\Models\Multiplayer\UserScoreAggregate;
use App\Models\User;
use Carbon\Carbon;
use Tests\TestCase;

class ContestTest extends TestCase
{
    /**
     * @dataProvider dataProviderForTestAssertVoteRequirementPlaylistBeatmapsets
     */
    public function testAssertVoteRequirementPlaylistBeatmapsets(
        bool $loggedIn,
        bool $played,
        bool $passed,
        ?bool $mustPass,
        bool $canVote
    ): void {
        $beatmapsets = Beatmapset::factory()->count(5)->create();
        $beatmaps = [];
        foreach ($beatmapsets as $beatmapset) {
            $beatmapsetId = $beatmapset->getKey();
            for ($i = 0; $i < 2; $i++) {
                $beatmaps[] = Beatmap::factory()->create(['beatmapset_id' => $beatmapsetId]);
            }
        }
        // extra beatmap
        Beatmap::factory()->create();

        $rooms = Room::factory()->count(2)->create();
        foreach ($rooms as $i => $room) {
            foreach ($beatmapsets as $beatmapset) {
                $playlistItems[] = PlaylistItem::factory()->create([
                    'room_id' => $room,
                    'beatmap_id' => $beatmapset->beatmaps[$i],
                ]);
            }
        }
        $contest = Contest::factory()->create([
            'extra_options' => [
                'requirement' => [
                    'must_pass' => $mustPass,
                    'name' => 'playlist_beatmapsets',
                    'room_ids' => array_column($rooms->all(), 'id'),
                ],
            ],
        ]);
        $entries = ContestEntry::factory()->count(2)->create(['contest_id' => $contest->getKey()]);

        $user = $loggedIn ? User::factory()->create() : null;

        if ($loggedIn && $played) {
            $userId = $user->getKey();
            $endedAt = json_time(Carbon::now());
            foreach ($beatmapsets as $beatmapset) {
                $room = array_rand_val($rooms);
                $playlistItem = $room
                    ->playlist()
                    ->whereIn('beatmap_id', array_column($beatmapset->beatmaps->all(), 'beatmap_id'))
                    ->first();

                MultiplayerScoreLink::factory()->state([
                    'playlist_item_id' => $playlistItem,
                    'user_id' => $userId,
                ])->completed([
                    'ended_at' => $endedAt,
                    'passed' => $passed,
                ])->create();
            }
            foreach ($rooms as $room) {
                UserScoreAggregate::lookupOrDefault($user, $room)->recalculate();
            }
        }

        if (!$canVote) {
            $this->expectException(InvariantException::class);
        }

        $contest->assertVoteRequirement($user);

        if ($canVote) {
            $this->assertTrue(true, 'no exception');
        }
    }

    public function testAssertVoteRequirementNoRequirement(): void
    {
        $contest = Contest::factory()->create();
        $entry = ContestEntry::factory()->create(['contest_id' => $contest->getKey()]);
        $user = User::factory()->create();

        $contest->assertVoteRequirement($user, $entry);
        $this->assertTrue(true, 'no exception');
    }

    /**
     * @dataProvider dataProviderForTestShowEntryUser
     */
    public function testShowEntryUser(bool $showVotes, ?bool $showEntryUserOption, bool $result): void
    {
        $extraOptions = $showEntryUserOption === null
            ? null
            : ['show_entry_user' => $showEntryUserOption];
        $contest = Contest::factory()->create([
            'show_votes' => $showVotes,
            'extra_options' => $extraOptions,
        ]);
        $this->assertSame($result, $contest->showEntryUser());
    }

    public static function dataProviderForTestAssertVoteRequirementPlaylistBeatmapsets(): array
    {
        return [
            // when passing is required
            [true, true, true, true, true],
            [true, true, false, true, false],
            [true, false, false, true, false],
            [false, false, false, true, false],
            // when passing is not specified (default required)
            [true, true, true, null, true],
            [true, true, false, null, false],
            [true, false, false, null, false],
            [false, false, false, null, false],
            // when passing is not required
            [true, true, true, false, true],
            [true, true, false, false, true],
            [true, false, false, false, false],
            [false, false, false, false, false],
        ];
    }

    public static function dataProviderForTestShowEntryUser(): array
    {
        return [
            [false, null, false],
            [true, null, true],
            [false, false, false],
            [true, false, true],
            [false, true, true],
            [true, true, true],
        ];
    }
}