CreditWorkLogCest

Complexity

Total Complexity

14

Size/Duplication

Total Lines	195
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	view()	0	4	1
A	index()	0	4	1
A	fixtures()	0	6	1
A	authToken()	0	3	1
A	indexDataProvider()	0	8	1
A	viewDataProvider()	0	9	1
A	create()	0	11	2
A	permission()	0	12	1
A	updateDataProvider()	0	9	1
A	recordJsonType()	0	4	1
A	createDataProvider()	0	25	1
A	getRoutePattern()	0	3	1
A	update()	0	4	1

<?php

use app\fixtures\{CreditWorkLogFixture, OauthAccessTokensFixture};
use Codeception\{Example, Util\HttpCode};
use roaresearch\yii2\roa\test\AbstractResourceCest;

/**
 * Cest to stage resource.
 *
 * @author Carlos (neverabe) Llamosas <carlos@invernaderolabs.com>
 */
class CreditWorkLogCest extends AbstractResourceCest
{
    protected function authToken(ApiTester $I)
    {
        $I->amBearerAuthenticated(OauthAccessTokensFixture::SIMPLE_TOKEN);
    }

    /**
     * @depends CreditCest:fixtures
     */
    public function fixtures(ApiTester $I)
    {
        $I->haveFixtures([
            'credit_worklog' => [
                'class' => CreditWorkLogFixture::class,
                'depends' => [],
            ]
        ]);
    }

    /**
     * @param  ApiTester $I
     * @param  Example $example
     * @dataprovider indexDataProvider
     * @depends fixtures
     * @before authToken
     */
    public function index(ApiTester $I, Example $example)
    {
        $I->wantTo('Retrieve list of Credit Worklog records.');
        $this->internalIndex($I, $example);
    }

    /**
     * @return array<string,array> for test `index()`.
     */
    protected function indexDataProvider()
    {
        return [
            'list' => [
                'url' => '/v1/credit/4/worklog',
                'httpCode' => HttpCode::OK,
                'headers' => [
                    'X-Pagination-Total-Count' => 4,
                ],
            ],
        ];
    }

    /**
     * @param  ApiTester $I
     * @param  Example $example
     * @dataprovider viewDataProvider
     * @depends fixtures
     * @before authToken
     */
    public function view(ApiTester $I, Example $example)
    {
        $I->wantTo('Retrieve Credit Worklog single record.');
        $this->internalView($I, $example);
    }

    /**
     * @return array<string,array<string,string>> data for test `view()`.
     */
    protected function viewDataProvider()
    {
        return [
            'single record' => [
                'url' => '/v1/credit/1/worklog/1',
                'data' => [
                    'expand' => 'process',
                ],
                'httpCode' => HttpCode::OK,
            ],
        ];
    }

    /**
     * @param  ApiTester $I
     * @param  Example $example
     * @dataprovider createDataProvider
     * @depends fixtures
     * @before authToken
     */
    public function create(ApiTester $I, Example $example)
    {
        $I->wantTo('Create a Credit Worklog record.');
        $this->internalCreate($I, $example);
        ($example['grabRecord']) ?
        $record = $I->grabRecord(

The assignment to $record is dead and can be removed.

            'app\models\CreditWorkLog',
            [
                'comment' => $example['data']['comment']
            ]
        ) : '';
    }

    /**
     * @return array<string,array> data for test `create()`.
     */
    protected function createDataProvider()
    {
        return [
            'create worklog' => [
                'grabRecord' => true,
                'urlParams' => [
                    'process_id' => 1
                ],
                'data' => [
                    'stage_id' => 5,
                    'comment' => 'Stage changed'
                ],
                'httpCode' => HttpCode::CREATED,
            ],
            'unprocessable worklog' => [
                'grabRecord' => false,
                'urlParams' => [
                    'process_id' => 1
                ],
                'data' => [
                    'stage_id' => 1
                ],
                'httpCode' => HttpCode::UNPROCESSABLE_ENTITY,
                'validationErrors' => [
                    'stage_id' => 'There is no transition for the current stage',
                ],
            ],
        ];
    }

    /**
     * @param  ApiTester $I
     * @depends create
     * @before authToken
     */
    public function permission(ApiTester $I)
    {
        $auth = Yii::$app->authManager;
        $adminRole = $auth->getRole('admin');
        $I->sendPOST('/v1/credit/1/worklog', ['stage_id' => 7]);
        $I->seeResponseCodeIs(HttpCode::FORBIDDEN);

        $auth->assign($adminRole, 1);
        $I->sendPOST('/v1/credit/1/worklog', ['stage_id' => 7]);
        $I->seeResponseCodeIs(HttpCode::CREATED);

        $auth->revoke($adminRole, 1);
    }

    /**
     * @param  ApiTester $I
     * @param  Example $example
     * @dataprovider updateDataProvider
     * @depends create
     * @before authToken
     */
    public function update(ApiTester $I, Example $example)
    {
        $I->wantTo('Update a Credit Worklog record.');
        $this->internalUpdate($I, $example);
    }

    /**
     * @return array<string,array> data for test `update()`.
     */
    protected function updateDataProvider()
    {
        return [
            'update credit 1' => [
                'url' => '/v1/credit/1/worklog/1',
                'data' => [
                    'stage_id' => 3
                ],
                'httpCode' => HttpCode::OK,
            ],
        ];
    }

    /**
     * @inheritdoc
     */
    protected function recordJsonType(): array
    {
        return [
            'id' => 'integer:>0',
        ];
    }

    /**
     * @inheritdoc
     */
    protected function getRoutePattern(): string
    {
        return 'v1/credit/<process_id:\d+>/worklog';
    }
}