Part-DB.Part-DB-server/tests/Entity/Base/AbstractStructuralDBElementTest.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\Entity\Base;

use App\Entity\Attachments\AttachmentType;
use App\Entity\Parts\Category;
use InvalidArgumentException;
use PHPUnit\Framework\TestCase;

/**
 * Test StructuralDBElement entities.
 * Note: Because StructuralDBElement is abstract we use AttachmentType here as a placeholder.
 */
class AbstractStructuralDBElementTest extends TestCase
{
    protected AttachmentType $root;
    protected AttachmentType $child1;
    protected AttachmentType $child2;
    protected AttachmentType $child3;
    protected AttachmentType $child1_1;
    protected AttachmentType $child1_2;

    protected function setUp(): void
    {
        // TODO: Change the autogenerated stub

        //Build a simple hierachy
        $this->root = new AttachmentType();
        $this->root->setName('root')->setParent(null);
        $this->child1 = new AttachmentType();
        $this->child1->setParent($this->root)->setName('child1');
        $this->child2 = new AttachmentType();
        $this->child2->setName('child2')->setParent($this->root);
        $this->child3 = new AttachmentType();
        $this->child3->setName('child3')->setParent($this->root);
        $this->child1_1 = new AttachmentType();
        $this->child1_1->setName('child1_1')->setParent($this->child1);
        $this->child1_2 = new AttachmentType();
        $this->child1_2->setName('child1_2')->setParent($this->child1);
    }

    public function testSetParent(): void
    {
        $el1 = new AttachmentType();
        $el2 = new AttachmentType();

        $el2->setParent($el1);

        //Check if parent was set correctly
        $this->assertSame($el1, $el2->getParent());
        //El2 must now be a child of el1
        $this->assertTrue($el1->getChildren()->contains($el2));
    }

    public function testAddChild(): void
    {
        $el1 = new AttachmentType();
        $el2 = new AttachmentType();

        $el1->addChild($el2);

        //Check if parent was set correctly
        $this->assertSame($el1, $el2->getParent());
        //El2 must now be a child of el1
        $this->assertTrue($el1->getChildren()->contains($el2));
    }

    public function testIsRoot(): void
    {
        $this->assertTrue($this->root->isRoot());
        $this->assertFalse($this->child1->isRoot());
        $this->assertFalse($this->child1_2->isRoot());
    }

    public function testIsChildOf(): void
    {
        //Root must not be the child of any other node
        $this->assertFalse($this->root->isChildOf($this->child1));
        $this->assertFalse($this->root->isChildOf($this->root));

        //Check for direct parents
        $this->assertTrue($this->child1->isChildOf($this->root));
        $this->assertTrue($this->child1_2->isChildOf($this->child1));

        //Check for inheritance
        $this->assertTrue($this->child1_2->isChildOf($this->root));
    }

    public function testChildOfDifferentClasses(): void
    {
        $this->expectException(InvalidArgumentException::class);
        $category = new Category();
        $this->root->isChildOf($category);
    }

    public function testChildOfExtendedClass(): void
    {
        //Doctrine extends the entities for proxy classes so the isChildOf mus also work for inheritance types
        $inheritance = new class() extends AttachmentType {
        };
        $inheritance->setParent($this->root);
        $this->assertTrue($inheritance->isChildOf($this->root));
        $this->assertFalse($this->root->isChildOf($inheritance));
    }

    public function testGetLevel(): void
    {
        $this->assertSame(0, $this->root->getLevel());
        $this->assertSame(1, $this->child1->getLevel());
        $this->assertSame(1, $this->child2->getLevel());
        $this->assertSame(2, $this->child1_2->getLevel());
        $this->assertSame(2, $this->child1_1->getLevel());
    }

    public function testGetFullPath(): void
    {
        $this->assertSame('root/child1/child1_1', $this->child1_1->getFullPath('/'));
        $this->assertSame('root#child2', $this->child2->getFullPath('#'));
    }

    public function testGetPathArray(): void
    {
        $this->assertSame([$this->root, $this->child1, $this->child1_1], $this->child1_1->getPathArray());
        $this->assertSame([$this->root, $this->child1], $this->child1->getPathArray());
        $this->assertSame([$this->root], $this->root->getPathArray());
    }

    public function testGetSubelements(): void
    {
        $this->assertSame([$this->child1, $this->child2, $this->child3], $this->root->getSubelements()->toArray());
        $this->assertSame([$this->child1_1, $this->child1_2], $this->child1->getSubelements()->toArray());
        $this->assertSame([], $this->child1_1->getSubelements()->toArray());

        //If an element is set as its own parent, it should not be returned as a subelement
        $this->child1->setParent($this->child1);
        $this->assertSame([], $this->child1->getSubelements()->toArray());
    }
}