kimai2/tests/Voter/ProjectVoterTest.php

<?php

/*
 * This file is part of the Kimai time-tracking app.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace App\Tests\Voter;

use App\Entity\Customer;
use App\Entity\Project;
use App\Entity\Team;
use App\Entity\User;
use App\Voter\ProjectVoter;
use PHPUnit\Framework\Attributes\CoversClass;
use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
use Symfony\Component\Security\Core\Authorization\Voter\VoterInterface;
use Symfony\Component\Security\Core\User\InMemoryUser;

#[CoversClass(ProjectVoter::class)]
class ProjectVoterTest extends AbstractVoterTestCase
{
    public function assertVote(User $user, $subject, $attribute, $result): void
    {
        $token = new UsernamePasswordToken($user, 'bar', $user->getRoles());
        $sut = $this->getVoter(ProjectVoter::class);

        if ($subject instanceof Project && null === $subject->getCustomer()) {
            $subject->setCustomer(new Customer('foo'));
        }

        $actual = $sut->vote($token, $subject, [$attribute]);
        self::assertEquals($result, $actual, \sprintf('Failed voting "%s" for User with roles %s.', $attribute, implode(', ', $user->getRoles())));
    }

    public function testVote(): void
    {
        $userNoRole = self::getUser(0, 'foo');
        $userStandard = self::getUser(1, User::ROLE_USER);
        $userTeamlead = self::getUser(2, User::ROLE_TEAMLEAD);
        $userAdmin = self::getUser(3, User::ROLE_ADMIN);
        $userSuperAdmin = self::getUser(4, User::ROLE_SUPER_ADMIN);

        $result = VoterInterface::ACCESS_GRANTED;
        foreach ([$userAdmin, $userSuperAdmin] as $user) {
            $this->assertVote($user, new Project(), 'view', $result);
            $this->assertVote($user, new Project(), 'edit', $result);
            $this->assertVote($user, new Project(), 'budget', $result);
            $this->assertVote($user, new Project(), 'delete', $result);
        }

        $team = new Team('foo');
        $team->addTeamlead($userTeamlead);
        foreach ([$userTeamlead] as $user) {
            $project = new Project();
            $team->addProject($project);
            $this->assertVote($user, $project, 'view', $result);
            $team->removeProject($project);
        }

        $userTeamlead = self::getUser(2, User::ROLE_TEAMLEAD);

        $result = VoterInterface::ACCESS_DENIED;
        foreach ([$userNoRole, $userStandard] as $user) {
            $this->assertVote($user, new Project(), 'view', $result);
            $this->assertVote($user, new Project(), 'edit', $result);
            $this->assertVote($user, new Project(), 'budget', $result);
            $this->assertVote($user, new Project(), 'delete', $result);
        }

        foreach ([$userTeamlead] as $user) {
            $this->assertVote($user, new Project(), 'view', $result);
            $this->assertVote($user, new Project(), 'edit', $result);
            $this->assertVote($user, new Project(), 'budget', $result);
            $this->assertVote($user, new Project(), 'delete', $result);
        }

        $result = VoterInterface::ACCESS_ABSTAIN;
        foreach ([$userNoRole, $userStandard, $userTeamlead] as $user) {
            $this->assertVote($user, new Project(), 'create_project', $result);
            $this->assertVote($user, new Project(), 'view_project', $result);
            $this->assertVote($user, new Project(), 'edit_project', $result);
            $this->assertVote($user, new Project(), 'budget_project', $result);
            $this->assertVote($user, new Project(), 'delete_project', $result);
            $this->assertVote($user, new \stdClass(), 'view', $result);
            $this->assertVote($user, null, 'edit', $result);
            $this->assertVote($user, $user, 'delete', $result);
        }
    }

    public function testTeamlead(): void
    {
        $team = new Team('foo');
        $user = new User();
        $user->addRole(User::ROLE_TEAMLEAD);
        $team->addTeamlead($user);

        $project = new Project();
        $customer = new Customer('foo');
        $project->setCustomer($customer);
        $customer->addTeam($team);

        $this->assertVote($user, $project, 'edit', VoterInterface::ACCESS_GRANTED);

        $project = new Project();
        $customer = new Customer('foo');
        $project->setCustomer($customer);
        $project->addTeam($team);

        $this->assertVote($user, $project, 'edit', VoterInterface::ACCESS_GRANTED);
    }

    public function testTeamMember(): void
    {
        $team = new Team('foo');
        $user = new User();
        $user->addRole(User::ROLE_USER);
        $team->addTeamlead($user);

        $project = new Project();
        $customer = new Customer('foo');
        $customer->addTeam($team);
        $project->setCustomer($customer);

        $this->assertVote($user, $project, 'edit', VoterInterface::ACCESS_GRANTED);

        $team = new Team('foo');
        $user = new User();
        $user->addRole(User::ROLE_USER);
        $team->addUser($user);

        $project = new Project();
        $customer = new Customer('foo');
        $project->addTeam($team);
        $project->setCustomer($customer);

        $this->assertVote($user, $project, 'edit', VoterInterface::ACCESS_GRANTED);
    }

    public function testAccessGrantedWhenProjectAndCustomerHaveNoTeams(): void
    {
        $project = new Project();
        $project->setCustomer(new Customer('foo'));

        $this->assertVote(new User(), $project, 'access', VoterInterface::ACCESS_GRANTED);
    }

    public function testAccessGrantedWhenProjectHasNoCustomer(): void
    {
        // checkTeamAccessProject() skips the customer chain when project->getCustomer() is null.
        $project = new Project();

        $this->assertVote(new User(), $project, 'access', VoterInterface::ACCESS_GRANTED);
    }

    public function testAccessGrantedForCanSeeAllDataDespiteRestrictiveTeams(): void
    {
        $project = new Project();
        $customer = new Customer('foo');
        $customer->addTeam(new Team('customerTeam'));
        $project->setCustomer($customer);
        $project->addTeam(new Team('projectTeam'));

        $user = new User();
        $user->initCanSeeAllData(true);

        $this->assertVote($user, $project, 'access', VoterInterface::ACCESS_GRANTED);
    }

    public function testAccessGrantedWhenUserMemberOfCustomerTeamAndNoProjectTeams(): void
    {
        $customerTeam = new Team('customerTeam');
        $customer = new Customer('foo');
        $customer->addTeam($customerTeam);

        $project = new Project();
        $project->setCustomer($customer);

        $user = new User();
        $customerTeam->addUser($user);

        $this->assertVote($user, $project, 'access', VoterInterface::ACCESS_GRANTED);
    }

    public function testAccessGrantedWhenUserMemberOfProjectTeamAndNoCustomerTeams(): void
    {
        $project = new Project();
        $project->setCustomer(new Customer('foo'));
        $projectTeam = new Team('projectTeam');
        $project->addTeam($projectTeam);

        $user = new User();
        $projectTeam->addUser($user);

        $this->assertVote($user, $project, 'access', VoterInterface::ACCESS_GRANTED);
    }

    public function testAccessGrantedWhenUserMemberOfBothCustomerAndProjectTeams(): void
    {
        $customerTeam = new Team('customerTeam');
        $customer = new Customer('foo');
        $customer->addTeam($customerTeam);

        $project = new Project();
        $project->setCustomer($customer);
        $projectTeam = new Team('projectTeam');
        $project->addTeam($projectTeam);

        $user = new User();
        $customerTeam->addUser($user);
        $projectTeam->addUser($user);

        $this->assertVote($user, $project, 'access', VoterInterface::ACCESS_GRANTED);
    }

    public function testAccessDeniedWhenCustomerTeamBlocks(): void
    {
        $customer = new Customer('foo');
        $customer->addTeam(new Team('customerTeam'));

        $project = new Project();
        $project->setCustomer($customer);
        // project has no teams of its own — would otherwise be permissive
        $this->assertVote(new User(), $project, 'access', VoterInterface::ACCESS_DENIED);
    }

    public function testAccessDeniedWhenCustomerOkButProjectTeamBlocks(): void
    {
        $customerTeam = new Team('customerTeam');
        $customer = new Customer('foo');
        $customer->addTeam($customerTeam);

        $project = new Project();
        $project->setCustomer($customer);
        $project->addTeam(new Team('projectTeam'));

        $user = new User();
        $customerTeam->addUser($user);

        $this->assertVote($user, $project, 'access', VoterInterface::ACCESS_DENIED);
    }

    public function testAccessDeniedWhenProjectTeamBlocksAndCustomerHasNoTeams(): void
    {
        $project = new Project();
        $project->setCustomer(new Customer('foo'));
        $project->addTeam(new Team('projectTeam'));

        $this->assertVote(new User(), $project, 'access', VoterInterface::ACCESS_DENIED);
    }

    public function testAccessDeniedForUserInUnrelatedTeam(): void
    {
        $unrelated = new Team('unrelated');
        $user = new User();
        $unrelated->addTeamlead($user);

        $customer = new Customer('foo');
        $customer->addTeam(new Team('customerTeam'));

        $project = new Project();
        $project->setCustomer($customer);

        $this->assertVote($user, $project, 'access', VoterInterface::ACCESS_DENIED);
    }

    public function testAccessDeniedForNonUserToken(): void
    {
        $project = new Project();
        $token = new UsernamePasswordToken(new InMemoryUser('anon', null), 'bar', []);
        $sut = $this->getVoter(ProjectVoter::class);

        self::assertEquals(VoterInterface::ACCESS_DENIED, $sut->vote($token, $project, ['access']));
    }
}