Laravel-Backpack / CRUD

tests/Unit/CrudPanel/CrudPanelReadTest.php

<?php

namespace Backpack\CRUD\Tests\Unit\CrudPanel;

use Backpack\CRUD\Tests\config\Models\Article;
use Backpack\CRUD\Tests\config\Models\Role;
use Backpack\CRUD\Tests\config\Models\User;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;

/**
 * @covers Backpack\CRUD\app\Library\CrudPanel\Traits\Read
 * @covers Backpack\CRUD\app\Library\CrudPanel\CrudPanel
 */
class CrudPanelReadTest extends \Backpack\CRUD\Tests\config\CrudPanel\BaseDBCrudPanel
{
    private $relationshipColumn = [
        'name' => 'user_id',
        'type' => 'select',
        'entity' => 'user',
        'attribute' => 'name',
    ];

    private $relationshipMultipleColumn = [

The private property $relationshipMultipleColumn is not used, and could be removed.

        'name' => 'roles',
        'type' => 'select',
        'entity' => 'roles',
        'attribute' => 'name',
        'model' => Role::class,
    ];

    private $nonRelationshipColumn = [
        'name' => 'field1',
        'label' => 'Field1',
    ];

    private $articleFieldsArray = [
        [
            'name' => 'content',
            'label' => 'The Content',
            'type' => 'text',
        ],
        [
            'name' => 'metas',
            'label' => 'Metas',
        ],
        [
            'name' => 'tags',
        ],
        [
            'name' => 'extras',
        ],
    ];

    private $expectedCreateFormArticleFieldsArray = [
        'content' => [
            'name' => 'content',
            'label' => 'The Content',
            'type' => 'text',
            'entity' => false,
        ],
        'metas' => [
            'name' => 'metas',
            'label' => 'Metas',
            'type' => 'text',
            'entity' => false,
        ],
        'tags' => [
            'name' => 'tags',
            'label' => 'Tags',
            'type' => 'text',
            'entity' => false,
        ],
        'extras' => [
            'name' => 'extras',
            'label' => 'Extras',
            'type' => 'text',
            'entity' => false,
        ],
    ];

    private $expectedUpdateFormArticleFieldsArray = [
        'content' => [
            'name' => 'content',
            'label' => 'The Content',
            'type' => 'text',
            'value' => 'Some Content',
            'entity' => false,
        ],
        'metas' => [
            'name' => 'metas',
            'label' => 'Metas',
            'type' => 'text',
            'value' => '{"meta_title":"Meta Title Value","meta_description":"Meta Description Value"}',
            'entity' => false,
        ],
        'tags' => [
            'name' => 'tags',
            'label' => 'Tags',
            'type' => 'text',
            'value' => '{"tags":["tag1","tag2","tag3"]}',
            'entity' => false,
        ],
        'extras' => [
            'name' => 'extras',
            'label' => 'Extras',
            'type' => 'text',
            'value' => '{"extra_details":["detail1","detail2","detail3"]}',
            'entity' => false,
        ],
        'id' => [
            'name' => 'id',
            'type' => 'hidden',
            'value' => 1,
        ],
    ];

    private $uploadField = [
        'name' => 'image',
        'label' => 'Image',
        'type' => 'upload',
        'upload' => true,
    ];

    private $multipleUploadField = [
        'name' => 'photos',
        'label' => 'Photos',
        'type' => 'upload_multiple',
        'upload' => true,
    ];

    private $defaultPaginator = [[10, 20, 30], ['t1', 't2', 't3']];

    public function testGetEntry()
    {
        $this->crudPanel->setModel(User::class);
        $user = User::find(1);

        $entry = $this->crudPanel->getEntry($user->id);

The property id does not seem to exist on Illuminate\Database\Eloquent\PendingHasThroughRelationship.

        $this->assertEquals($user, $entry);
    }

    public function testGetEntryWithFakes()
    {
        $this->markTestIncomplete('Not correctly implemented');

        $this->crudPanel->setModel(Article::class);
        $article = Article::find(1);

        $entry = $this->crudPanel->getEntry($article->id);

        // TODO: the withFakes call is needed for this to work. the state of the model should not be changed by the
        //       getEntry method. the transformation of the fakes columns should be kept in a different crud panel
        //       attribute or, at most, the getEntry method should be renamed.
        $article->withFakes();

        $this->assertEquals($article, $entry);
    }

    public function testGetEntryExists()
    {
        $this->crudPanel->setModel(User::class);
        $userEntry = $this->crudPanel->getEntry(1);

        $this->assertInstanceOf(User::class, $userEntry);

        $this->crudPanel->setModel(Article::class);
        $articleEntry = $this->crudPanel->getEntry(1);

        $this->assertInstanceOf(Article::class, $articleEntry);
    }

    public function testGetEntryUnknownId()
    {
        $this->expectException(ModelNotFoundException::class);

        $this->crudPanel->setModel(User::class);

        $unknownId = DB::getPdo()->lastInsertId() + 2;
        $this->crudPanel->getEntry($unknownId);
    }

    public function testAutoEagerLoadRelationshipColumns()
    {
        $this->crudPanel->setModel(Article::class);
        $this->crudPanel->setOperation('list');
        $this->crudPanel->addColumn($this->relationshipColumn);

        $this->crudPanel->autoEagerLoadRelationshipColumns();

        $this->assertArrayHasKey('user', $this->crudPanel->query->getEagerLoads());
    }

    public function testAutoEagerLoadRelationshipColumnsNoRelationships()
    {
        $this->crudPanel->setModel(Article::class);
        $this->crudPanel->addColumn($this->nonRelationshipColumn);

        $this->crudPanel->autoEagerLoadRelationshipColumns();

        $this->assertEmpty($this->crudPanel->query->getEagerLoads());
    }

    public function testGetEntries()
    {
        $this->crudPanel->setModel(User::class);

        $entries = $this->crudPanel->getEntries();

        $this->assertInstanceOf(Collection::class, $entries);
        $this->assertEquals(2, $entries->count());
        $this->assertEquals(User::find(1), $entries->first());
    }

    public function testGetEntriesWithFakes()
    {
        $this->markTestIncomplete('Not correctly implemented');

        $this->crudPanel->setModel(Article::class);

        $entries = $this->crudPanel->getEntries();

        // TODO: the getEntries method automatically adds fakes. the state of the models should not be changed by the
        //       getEntries method. at most, the getEntries method should be renamed.
        $this->assertInstanceOf(Collection::class, $entries);
        $this->assertEquals(1, $entries->count());
        $this->assertEquals(Article::find(1), $entries->first());
    }

    public function testGetFieldsCreateForm()
    {
        $this->crudPanel->addFields($this->articleFieldsArray);

        // TODO: update method documentation. the $form parameter does not default to 'both'.
        $fields = $this->crudPanel->getFields('create');

The call to Backpack\CRUD\app\Library\CrudPanel\CrudPanel::getFields() has too many arguments starting with 'create'.

        $this->assertEquals($this->expectedCreateFormArticleFieldsArray, $fields);
    }

    public function testGetFieldsUpdateForm()
    {
        $this->crudPanel->setModel(Article::class);

        $this->crudPanel->setOperation('update');
        $this->crudPanel->addFields($this->articleFieldsArray);

        // TODO: update method documentation. the $form parameter does not default to 'both'.
        $fields = $this->crudPanel->getUpdateFields(1);

        $this->assertEquals($this->expectedUpdateFormArticleFieldsArray, $fields);
    }

    public function testHasUploadFieldsCreateForm()
    {
        $this->crudPanel->addField($this->uploadField, 'create');

The call to Backpack\CRUD\app\Library\CrudPanel\CrudPanel::addField() has too many arguments starting with 'create'.

        // TODO: update method documentation. the $form parameter does not default to 'both'.
        $hasUploadFields = $this->crudPanel->hasUploadFields('create');

The call to Backpack\CRUD\app\Library\CrudPanel\CrudPanel::hasUploadFields() has too many arguments starting with 'create'.

        $this->assertTrue($hasUploadFields);
    }

    public function testHasMultipleUploadFieldsCreateForm()
    {
        $this->crudPanel->addField($this->multipleUploadField, 'create');

The call to Backpack\CRUD\app\Library\CrudPanel\CrudPanel::addField() has too many arguments starting with 'create'.

        // TODO: update method documentation. the $form parameter does not default to 'both'.
        $hasMultipleUploadFields = $this->crudPanel->hasUploadFields('create');

The call to Backpack\CRUD\app\Library\CrudPanel\CrudPanel::hasUploadFields() has too many arguments starting with 'create'.

        $this->assertTrue($hasMultipleUploadFields);
    }

    public function testHasUploadFieldsUpdateForm()
    {
        $this->crudPanel->setModel(Article::class);
        $this->crudPanel->addField($this->uploadField, 'update');

The call to Backpack\CRUD\app\Library\CrudPanel\CrudPanel::addField() has too many arguments starting with 'update'.

        // TODO: update method documentation. the $form parameter does not default to 'both'.
        $hasUploadFields = $this->crudPanel->hasUploadFields('update', 1);

The call to Backpack\CRUD\app\Library\CrudPanel\CrudPanel::hasUploadFields() has too many arguments starting with 'update'.

        $this->assertTrue($hasUploadFields);
    }

    public function testEnableDetailsRow()
    {
        if (! backpack_pro()) {
            $this->expectException(\Backpack\CRUD\app\Exceptions\BackpackProRequiredException::class);
        }

        $this->crudPanel->setOperation('create');
        $this->crudPanel->enableDetailsRow();

        $this->assertTrue($this->crudPanel->getOperationSetting('detailsRow'));
    }

    public function testDisableDetailsRow()
    {
        $this->crudPanel->setOperation('list');
        $this->crudPanel->disableDetailsRow();

        $this->assertFalse($this->crudPanel->get('list.detailsRow'));
    }

    public function testSetDefaultPageLength()
    {
        $pageLength = 20;
        $this->crudPanel->setDefaultPageLength($pageLength);

        $this->assertEquals($pageLength, $this->crudPanel->getDefaultPageLength());
    }

    public function testGetDefaultPageLength()
    {
        $defaultPageLength = $this->crudPanel->getDefaultPageLength();

        $this->assertEquals(25, $defaultPageLength);
    }

    public function testEnableExportButtons()
    {
        if (! backpack_pro()) {
            $this->expectException(\Backpack\CRUD\app\Exceptions\BackpackProRequiredException::class);
        }

        $this->crudPanel->enableExportButtons();
        $this->assertTrue($this->crudPanel->exportButtons());
    }

    public function testGetExportButtons()
    {
        $exportButtons = $this->crudPanel->exportButtons();

        $this->assertFalse($exportButtons);
    }

    public function testGetRelatedEntriesAttributesFromBelongsToMany()
    {
        $this->crudPanel->setModel(User::class);
        $this->crudPanel->setOperation('list');
        $user = $this->crudPanel->getModel()->where('id', 2)->first();
        $entries = $this->crudPanel->getRelatedEntriesAttributes($user, 'roles', 'name');
        $this->assertEquals([1 => 'admin', 2 => 'user'], $entries);
    }

    public function testGetRelatedEntriesAttributesFromBelongsToManyWithAccessor()
    {
        $this->crudPanel->setModel(User::class);
        $this->crudPanel->setOperation('list');
        $user = $this->crudPanel->getModel()->where('id', 2)->first();
        $entries = $this->crudPanel->getRelatedEntriesAttributes($user, 'roles', 'role_name');
        $this->assertEquals([1 => 'admin++', 2 => 'user++'], $entries);
    }

    public function testGetRelatedEntriesAttributesFromHasMany()
    {
        $this->crudPanel->setModel(User::class);
        $this->crudPanel->setOperation('list');
        $user = $this->crudPanel->getModel()->first();
        $entries = $this->crudPanel->getRelatedEntriesAttributes($user, 'articles', 'content');
        $this->assertCount(1, $entries);
    }

    public function testGetRelatedEntriesAttributesFromHasManyWithAccessor()
    {
        $this->crudPanel->setModel(User::class);
        $this->crudPanel->setOperation('list');
        $user = $this->crudPanel->getModel()->first();
        $entries = $this->crudPanel->getRelatedEntriesAttributes($user, 'articles', 'content_composed');
        $this->assertCount(1, $entries);
    }

    public function testGetRelatedEntriesAttributesFromBelongsTo()
    {
        $this->crudPanel->setModel(Article::class);
        $this->crudPanel->setOperation('list');
        $article = $this->crudPanel->getModel()->first();
        $entries = $this->crudPanel->getRelatedEntriesAttributes($article, 'user', 'name');
        $this->assertCount(1, $entries);
    }

    public function testGetRelatedEntriesAttributesFromBelongsToWithAccessor()
    {
        $this->crudPanel->setModel(Article::class);
        $this->crudPanel->setOperation('list');
        $article = $this->crudPanel->getModel()->first();
        $entries = $this->crudPanel->getRelatedEntriesAttributes($article, 'user', 'name_composed');
        $this->assertCount(1, $entries);
    }

    public function testGetRelatedEntriesAttributesFromHasOne()
    {
        $this->crudPanel->setModel(User::class);
        $this->crudPanel->setOperation('list');
        $user = $this->crudPanel->getModel()->first();
        $entries = $this->crudPanel->getRelatedEntriesAttributes($user, 'accountDetails', 'nickname');
        $this->assertCount(1, $entries);
    }

    public function testGetRelatedEntriesAttributesFromHasOneWithAccessor()
    {
        $this->crudPanel->setModel(User::class);
        $this->crudPanel->setOperation('list');
        $user = $this->crudPanel->getModel()->first();
        $entries = $this->crudPanel->getRelatedEntriesAttributes($user, 'accountDetails', 'nickname_composed');
        $this->assertCount(1, $entries);
    }

    /**
     * Tests define paginator length with single array [20, 30, 40].
     */
    public function testCrudPanelChangePaginatorLengthSingleArrayNoLabels()
    {
        $this->crudPanel->setModel(User::class);
        $this->crudPanel->setOperation('list');
        $this->crudPanel->setPageLengthMenu([20, 30, 40]);
        $this->assertCount(2, $this->crudPanel->getOperationSetting('pageLengthMenu'));

It seems like $this->crudPanel->getOperationSetting('pageLengthMenu') can also be of type null; however, parameter $haystack of PHPUnit\Framework\Assert::assertCount() does only seem to accept Countable|iterable, maybe add an additional type check?

        $this->assertTrue(in_array(40, $this->crudPanel->getOperationSetting('pageLengthMenu')[0]));
        $this->assertTrue(in_array(40, $this->crudPanel->getOperationSetting('pageLengthMenu')[1]));
    }

    /**
     * Tests define paginator length with single array [20 => 'v', 30 => 't', 40 => 'q'].
     */
    public function testCrudPanelChangePaginatorLengthSingleArrayWithLabels()
    {
        $this->crudPanel->setModel(User::class);
        $this->crudPanel->setOperation('list');
        $this->crudPanel->setPageLengthMenu([20 => 'v', 30 => 't', 40 => 'q']);
        $this->assertCount(2, $this->crudPanel->getOperationSetting('pageLengthMenu'));

It seems like $this->crudPanel->getOperationSetting('pageLengthMenu') can also be of type null; however, parameter $haystack of PHPUnit\Framework\Assert::assertCount() does only seem to accept Countable|iterable, maybe add an additional type check?

        $this->assertTrue(in_array(40, $this->crudPanel->getOperationSetting('pageLengthMenu')[0]));
        $this->assertEquals($this->crudPanel->getOperationSetting('pageLengthMenu')[1], ['v', 't', 'q']);
    }

    /**
     * Tests define paginator length with and 'all' options as -1 as defined in previous versions of BP.
     */
    public function testCrudPanelPaginatorWithAllAsOption()
    {
        $this->crudPanel->setModel(User::class);
        $this->crudPanel->setOperation('list');
        $this->crudPanel->setPageLengthMenu([-1 => 'All']);
        $this->assertCount(2, $this->crudPanel->getOperationSetting('pageLengthMenu'));

It seems like $this->crudPanel->getOperationSetting('pageLengthMenu') can also be of type null; however, parameter $haystack of PHPUnit\Framework\Assert::assertCount() does only seem to accept Countable|iterable, maybe add an additional type check?

        $this->assertTrue(in_array(-1, $this->crudPanel->getOperationSetting('pageLengthMenu')[0]));

        $this->crudPanel->setPageLengthMenu([-1, 1]);
        $this->assertCount(2, $this->crudPanel->getOperationSetting('pageLengthMenu'));
        $this->assertTrue(in_array(-1, $this->crudPanel->getOperationSetting('pageLengthMenu')[0]));

        $this->crudPanel->setPageLengthMenu(-1);
        $this->assertCount(2, $this->crudPanel->getOperationSetting('pageLengthMenu'));
        $this->assertTrue(in_array(-1, $this->crudPanel->getOperationSetting('pageLengthMenu')[0]));
    }

    /**
     * Tests if paginator aborts when 0 is provided as key.
     */
    public function testCrudPanelPaginatorWithZeroAsOption()
    {
        $this->crudPanel->setModel(User::class);
        $this->crudPanel->setOperation('list');

        try {
            $this->crudPanel->setPageLengthMenu([0 => 'v', 30 => 't', 40 => 'q']);
        } catch (\Throwable $a) {

Consider adding a comment why this CATCH block is empty.

        }

        $this->assertEquals(500, $a->getStatusCode());

The variable $a does not seem to be defined for all execution paths leading up to this point.

        try {
            $this->crudPanel->setPageLengthMenu([0, 1]);
        } catch (\Throwable $b) {

Consider adding a comment why this CATCH block is empty.

        }

        $this->assertEquals(500, $b->getStatusCode());

The variable $b does not seem to be defined for all execution paths leading up to this point.

        try {
            $this->crudPanel->setPageLengthMenu(0);
        } catch (\Throwable $c) {

Consider adding a comment why this CATCH block is empty.

        }

        $this->assertEquals(500, $c->getStatusCode());

The variable $c does not seem to be defined for all execution paths leading up to this point.

        try {
            $this->crudPanel->setPageLengthMenu([[0, 1]]);
        } catch (\Throwable $d) {

Consider adding a comment why this CATCH block is empty.

        }

        $this->assertEquals(500, $d->getStatusCode());

The variable $d does not seem to be defined for all execution paths leading up to this point.

    }

    /**
     * Tests define paginator length with multi array [[20, 30, 40],['v', 't', 'q']].
     */
    public function testCrudPanelChangePaginatorLengthMultiArrayWithLabels()
    {
        $this->crudPanel->setModel(User::class);
        $this->crudPanel->setOperation('list');
        $this->crudPanel->setPageLengthMenu([[20, 30, 40], ['v', 't', 'q']]);
        $this->assertCount(2, $this->crudPanel->getOperationSetting('pageLengthMenu'));

It seems like $this->crudPanel->getOperationSetting('pageLengthMenu') can also be of type null; however, parameter $haystack of PHPUnit\Framework\Assert::assertCount() does only seem to accept Countable|iterable, maybe add an additional type check?

        $this->assertTrue(in_array(40, $this->crudPanel->getOperationSetting('pageLengthMenu')[0]));
        $this->assertEquals($this->crudPanel->getOperationSetting('pageLengthMenu')[1], ['v', 't', 'q']);
    }

    /**
     * Tests define paginator length with multi array [[20, 30, 40]].
     */
    public function testCrudPanelChangePaginatorLengthMultiArrayNoLabels()
    {
        $this->crudPanel->setModel(User::class);
        $this->crudPanel->setOperation('list');
        $this->crudPanel->setPageLengthMenu([[20, 30, 40]]);
        $this->assertCount(2, $this->crudPanel->getOperationSetting('pageLengthMenu'));

It seems like $this->crudPanel->getOperationSetting('pageLengthMenu') can also be of type null; however, parameter $haystack of PHPUnit\Framework\Assert::assertCount() does only seem to accept Countable|iterable, maybe add an additional type check?

        $this->assertTrue(in_array(40, $this->crudPanel->getOperationSetting('pageLengthMenu')[0]));
        $this->assertTrue(in_array(40, $this->crudPanel->getOperationSetting('pageLengthMenu')[1]));
    }

    /**
     * Tests define paginator length with single value 40.
     */
    public function testCrudPanelChangePaginatorLengthWithSingleValue()
    {
        $this->crudPanel->setModel(User::class);
        $this->crudPanel->setOperation('list');
        $this->crudPanel->setPageLengthMenu(40);
        $this->assertCount(2, $this->crudPanel->getOperationSetting('pageLengthMenu'));

It seems like $this->crudPanel->getOperationSetting('pageLengthMenu') can also be of type null; however, parameter $haystack of PHPUnit\Framework\Assert::assertCount() does only seem to accept Countable|iterable, maybe add an additional type check?

        $this->assertTrue(in_array(40, $this->crudPanel->getOperationSetting('pageLengthMenu')[0]));
        $this->assertTrue(in_array(40, $this->crudPanel->getOperationSetting('pageLengthMenu')[1]));
    }

    /**
     * Tests if table paginator adds default option non-existent at time in the paginator.
     */
    public function testCrudPanelPaginatorAddsDefaultOptionNonExistent()
    {
        $this->crudPanel->setModel(User::class);
        $this->crudPanel->setOperation('list');
        $this->crudPanel->setDefaultPageLength(25);
        $this->crudPanel->setPageLengthMenu($this->defaultPaginator);

        $this->assertCount(2, $this->crudPanel->getPageLengthMenu());
        $this->assertCount(4, $this->crudPanel->getOperationSetting('pageLengthMenu')[0]);
        $this->assertTrue(in_array(25, $this->crudPanel->getOperationSetting('pageLengthMenu')[0]));
        $this->assertEquals(array_values($this->crudPanel->getPageLengthMenu()[0]), [10, 20, 25, 30]);
        $this->assertEquals(array_values($this->crudPanel->getPageLengthMenu()[1]), ['t1', 't2', 25, 't3']);
    }

    /**
     * Tests if table paginator adds default option existent.
     */
    public function testCrudPanelPaginatorAddsDefaultOptionExistent()
    {
        $this->crudPanel->setModel(User::class);
        $this->crudPanel->setOperation('list');

        $this->crudPanel->setPageLengthMenu($this->defaultPaginator);
        $this->crudPanel->setDefaultPageLength(20);
        $this->assertCount(2, $this->crudPanel->getPageLengthMenu());
        $this->assertCount(3, $this->crudPanel->getOperationSetting('pageLengthMenu')[0]);
        $this->assertTrue(in_array(10, $this->crudPanel->getOperationSetting('pageLengthMenu')[0]));
        $this->assertEquals(array_values($this->crudPanel->getPageLengthMenu()[0])[0], 10);
    }
}