oms-Admin/tests/Controller/Api/ApiControllerPermissionTrait.php

<?php
/**
 * Jingga
 *
 * PHP Version 8.2
 *
 * @package   tests
 * @copyright Dennis Eichhorn
 * @license   OMS License 2.2
 * @version   1.0.0
 * @link      https://jingga.app
 */
declare(strict_types=1);

namespace Modules\Admin\tests\Controller\Api;

use phpOMS\Account\PermissionOwner;
use phpOMS\Account\PermissionType;
use phpOMS\Message\Http\HttpRequest;
use phpOMS\Message\Http\HttpResponse;
use phpOMS\Message\Http\RequestStatusCode;

trait ApiControllerPermissionTrait
{
    /**
     * @covers \Modules\Admin\Controller\ApiController
     */
    #[\PHPUnit\Framework\Attributes\Group('module')]
    #[\PHPUnit\Framework\Attributes\TestDox('A permission can be added to a user group')]
    public function testApiAddGroupPermission() : void
    {
        $response = new HttpResponse();
        $request  = new HttpRequest();

        $request->header->account = 1;
        $request->setData('permissionowner', PermissionOwner::GROUP);
        $request->setData('permissionref', 1);

        $this->module->apiAddGroupPermission($request, $response);
        self::assertEquals('ok', $response->getData('')['status']);
        self::assertGreaterThan(0, $response->getDataArray('')['response']->id);
    }

    /**
     * @covers \Modules\Admin\Controller\ApiController
     */
    #[\PHPUnit\Framework\Attributes\Group('module')]
    public function testApiAddGroupPermissionToAdmin() : void
    {
        $response = new HttpResponse();
        $request  = new HttpRequest();

        $request->header->account = 1;
        $request->setData('permissionowner', PermissionOwner::GROUP);
        $request->setData('permissionref', 3);

        $this->module->apiAddGroupPermission($request, $response);
        self::assertEquals('warning', $response->getData('')['status']);
    }

    /**
     * @covers \Modules\Admin\Controller\ApiController
     */
    #[\PHPUnit\Framework\Attributes\Group('module')]
    #[\PHPUnit\Framework\Attributes\TestDox('A group permission can be returned')]
    public function testApiGroupPermissionGet() : void
    {
        $response = new HttpResponse();
        $request  = new HttpRequest();

        $request->header->account = 1;
        $request->setData('id', '2');

        $this->module->apiGroupPermissionGet($request, $response);

        self::assertGreaterThan(0, $response->getDataArray('')['response']->getGroup());
        self::assertGreaterThan(0, $response->getDataArray('')['response']->id);
    }

    /**
     * @covers \Modules\Admin\Controller\ApiController
     */
    #[\PHPUnit\Framework\Attributes\Group('module')]
    #[\PHPUnit\Framework\Attributes\TestDox('A user group permission can be created and deleted')]
    public function testApiGroupPermissionCreateDelete() : void
    {
        $response = new HttpResponse();
        $request  = new HttpRequest();

        $request->header->account = 1;
        $request->setData('permissionowner', PermissionOwner::GROUP);
        $request->setData('permissionref', 1);

        $this->module->apiAddGroupPermission($request, $response);
        self::assertEquals('ok', $response->getData('')['status']);
        self::assertGreaterThan(0, $response->getDataArray('')['response']->id);

        // test delete
        $request->setData('id', $response->getDataArray('')['response']->id);
        $this->module->apiGroupPermissionDelete($request, $response);

        self::assertGreaterThan(0, $response->getDataArray('')['response']->id);
    }

    /**
     * @covers \Modules\Admin\Controller\ApiController
     */
    #[\PHPUnit\Framework\Attributes\Group('module')]
    #[\PHPUnit\Framework\Attributes\TestDox('A permission with missing data cannot be added to a user group')]
    public function testApiAddGroupPermissionInvalidData() : void
    {
        $response = new HttpResponse();
        $request  = new HttpRequest();

        $request->header->account = 1;
        $request->setData('permissionowner', PermissionOwner::GROUP);

        $this->module->apiAddGroupPermission($request, $response);
        self::assertEquals(RequestStatusCode::R_400, $response->header->status);
    }

    /**
     * @covers \Modules\Admin\Controller\ApiController
     */
    #[\PHPUnit\Framework\Attributes\Group('module')]
    #[\PHPUnit\Framework\Attributes\TestDox('A invalid permission type cannot be added to a user group')]
    public function testApiAddGroupPermissionInvalidType() : void
    {
        $response = new HttpResponse();
        $request  = new HttpRequest();

        $request->header->account = 1;
        $request->setData('permissionowner', PermissionOwner::ACCOUNT);
        $request->setData('permissionref', 1);

        $this->module->apiAddGroupPermission($request, $response);
        self::assertEquals(RequestStatusCode::R_400, $response->header->status);
    }

    /**
     * @covers \Modules\Admin\Controller\ApiController
     */
    #[\PHPUnit\Framework\Attributes\Group('module')]
    #[\PHPUnit\Framework\Attributes\TestDox('A user group permission can be updated')]
    public function testApiGroupPermissionUpdate() : void
    {
        $response = new HttpResponse();
        $request  = new HttpRequest();

        $request->header->account = 1;
        $request->setData('id', 1);
        $request->setData('permissionread', PermissionType::READ);

        $this->module->apiGroupPermissionUpdate($request, $response);

        self::assertEquals(PermissionType::READ, $response->getDataArray('')['response']->getPermission());
        self::assertGreaterThan(0, $response->getDataArray('')['response']->id);

        $request->setData('permissioncreate', PermissionType::CREATE);
        $request->setData('permissionupdate', PermissionType::MODIFY);
        $request->setData('permissiondelete', PermissionType::DELETE);
        $request->setData('permissionpermission', PermissionType::PERMISSION);

        $this->module->apiGroupPermissionUpdate($request, $response);
    }

    /**
     * @covers \Modules\Admin\Controller\ApiController
     */
    #[\PHPUnit\Framework\Attributes\Group('module')]
    #[\PHPUnit\Framework\Attributes\TestDox('A permission can be added to a user')]
    public function testApiAddAccountPermission() : void
    {
        $response = new HttpResponse();
        $request  = new HttpRequest();

        $request->header->account = 1;
        $request->setData('permissionowner', PermissionOwner::ACCOUNT);
        $request->setData('permissionref', 1);

        $this->module->apiAddAccountPermission($request, $response);
        self::assertEquals('ok', $response->getData('')['status']);
        self::assertGreaterThan(0, $response->getDataArray('')['response']->id);
    }

    /**
     * @covers \Modules\Admin\Controller\ApiController
     */
    #[\PHPUnit\Framework\Attributes\Group('module')]
    #[\PHPUnit\Framework\Attributes\TestDox('A user permission can be returned')]
    public function testApiAccountPermissionGet() : void
    {
        $response = new HttpResponse();
        $request  = new HttpRequest();

        $request->header->account = 1;
        $request->setData('id', '1');

        $this->module->apiAccountPermissionGet($request, $response);

        self::assertEquals(1, $response->getDataArray('')['response']->getAccount());
        self::assertGreaterThan(0, $response->getDataArray('')['response']->id);
    }

    /**
     * @covers \Modules\Admin\Controller\ApiController
     */
    #[\PHPUnit\Framework\Attributes\Group('module')]
    #[\PHPUnit\Framework\Attributes\TestDox('A user permission can be created and deleted')]
    public function testApiAccountPermissionCreateDelete() : void
    {
        $response = new HttpResponse();
        $request  = new HttpRequest();

        $request->header->account = 1;
        $request->setData('permissionowner', PermissionOwner::ACCOUNT);
        $request->setData('permissionref', 1);

        $this->module->apiAddAccountPermission($request, $response);
        self::assertEquals('ok', $response->getData('')['status']);
        self::assertGreaterThan(0, $response->getDataArray('')['response']->id);

        // test delete
        $request->setData('id', $response->getDataArray('')['response']->id);
        $this->module->apiAccountPermissionDelete($request, $response);

        self::assertGreaterThan(0, $response->getDataArray('')['response']->id);
    }

    /**
     * @covers \Modules\Admin\Controller\ApiController
     */
    #[\PHPUnit\Framework\Attributes\Group('module')]
    #[\PHPUnit\Framework\Attributes\TestDox('A permission with missing data cannot be added to a user')]
    public function testApiAddAccountPermissionInvalidData() : void
    {
        $response = new HttpResponse();
        $request  = new HttpRequest();

        $request->header->account = 1;
        $request->setData('permissionowner', PermissionOwner::ACCOUNT);

        $this->module->apiAddAccountPermission($request, $response);
        self::assertEquals(RequestStatusCode::R_400, $response->header->status);
    }

    /**
     * @covers \Modules\Admin\Controller\ApiController
     */
    #[\PHPUnit\Framework\Attributes\Group('module')]
    #[\PHPUnit\Framework\Attributes\TestDox('A invalid permission type cannot be added to a user')]
    public function testApiAddAccountPermissionInvalidType() : void
    {
        $response = new HttpResponse();
        $request  = new HttpRequest();

        $request->header->account = 1;
        $request->setData('permissionowner', PermissionOwner::GROUP);
        $request->setData('permissionref', 1);

        $this->module->apiAddAccountPermission($request, $response);
        self::assertEquals(RequestStatusCode::R_400, $response->header->status);
    }

    /**
     * @covers \Modules\Admin\Controller\ApiController
     */
    #[\PHPUnit\Framework\Attributes\Group('module')]
    #[\PHPUnit\Framework\Attributes\TestDox('A user permission can be updated')]
    public function testApiAccountPermissionUpdate() : void
    {
        $response = new HttpResponse();
        $request  = new HttpRequest();

        $request->header->account = 1;
        $request->setData('id', 1);
        $request->setData('permissionread', PermissionType::READ);

        $this->module->apiAccountPermissionUpdate($request, $response);

        self::assertEquals(PermissionType::READ, $response->getDataArray('')['response']->getPermission());
        self::assertGreaterThan(0, $response->getDataArray('')['response']->id);
    }
}