Part-DB.Part-DB-server/tests/Controller/AdminPages/AbstractAdminController.php

<?php
/**
 * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
 *
 * Copyright (C) 2019 - 2020 Jan Böhmer (https://github.com/jbtronics)
 *
 * This program 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.
 *
 * This program 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 this program.  If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace App\Tests\Controller\AdminPages;

use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\DataProvider;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;

#[Group('slow')]
#[Group('DB')]
abstract class AbstractAdminController extends WebTestCase
{
    protected static string $base_path = 'not_valid';
    protected static string $entity_class = 'not valid';

    public static function readDataProvider(): \Iterator
    {
        yield ['noread', false];
        yield ['anonymous', true];
        yield ['user', true];
        yield ['admin', true];
    }

    /**
     * Tests if you can access the /new part which is used to list all entities. Checks if permissions are working
     */
    #[DataProvider('readDataProvider')]
    #[Group('slow')]
    public function testListEntries(string $user, bool $read): void
    {
        static::ensureKernelShutdown();

        //Test read access
        $client = static::createClient([], [
            'PHP_AUTH_USER' => $user,
            'PHP_AUTH_PW' => 'test',
        ]);

        $client->catchExceptions(false);
        if (false === $read) {
            $this->expectException(AccessDeniedException::class);
        }

        $client->catchExceptions(false);

        //Test read/list access by access /new overview page
        $client->request('GET', static::$base_path.'/new');
        $this->assertFalse($client->getResponse()->isRedirect());
        $this->assertSame($read, $client->getResponse()->isSuccessful(), 'Controller was not successful!');
        $this->assertSame($read, !$client->getResponse()->isForbidden(), 'Permission Checking not working!');
    }

    /**
     * Tests if it is possible to access a specific entity. Checks if permissions are working.
     * @param  string  $user
     * @param  bool  $read
     * @return void
     */
    #[DataProvider('readDataProvider')]
    #[Group('slow')]
    public function testReadEntity(string $user, bool $read): void
    {
        //Test read access
        $client = static::createClient([], [
            'PHP_AUTH_USER' => $user,
            'PHP_AUTH_PW' => 'test',
        ]);

        $client->catchExceptions(false);
        if (false === $read) {
            $this->expectException(AccessDeniedException::class);
        }

        //Test read/list access by access /new overview page
        $client->request('GET', static::$base_path.'/1/edit');
        $this->assertFalse($client->getResponse()->isRedirect());
        $this->assertSame($read, $client->getResponse()->isSuccessful(), 'Controller was not successful!');
        $this->assertSame($read, !$client->getResponse()->isForbidden(), 'Permission Checking not working!');
    }

    public static function deleteDataProvider(): \Iterator
    {
        yield ['noread', false];
        yield ['anonymous', false];
        yield ['user', true];
        yield ['admin', true];
    }

    /**
     * Tests if deleting an entity is working.
     */
    #[DataProvider('deleteDataProvider')]
    #[Group('slow')]
    public function testDeleteEntity(string $user, bool $delete): void
    {
        //Test read access
        $client = static::createClient([], [
            'PHP_AUTH_USER' => $user,
            'PHP_AUTH_PW' => 'test',
        ]);

        $client->catchExceptions(false);
        if (false === $delete) {
            $this->expectException(AccessDeniedException::class);
        }

        //Test read/list access by access /new overview page
        $client->request('DELETE', static::$base_path.'/7');

        //Page is redirected to '/new', when delete was successful
        $this->assertSame($delete, $client->getResponse()->isRedirect(static::$base_path.'/new'));
        $this->assertSame($delete, !$client->getResponse()->isForbidden(), 'Permission Checking not working!');
    }
}