ComponentEntryDescriptionTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

require_once("vendor/composer/vendor/autoload.php");
include_once("components/ILIAS/UI/tests/Crawler/Fixture/Fixture.php");

use ILIAS\UI\Implementation\Crawler as Crawler;
use ILIAS\UI\Implementation\Crawler\Entry as Entry;
use PHPUnit\Framework\TestCase;

class ComponentEntryDescriptionTest extends TestCase
{
    protected array $empty_description_array = [
        "purpose" => "",
        "composition" => "",
        "effect" => "",
        "rivals" => []
    ];

    protected array $invalid_categories1_array = [
        "purpose",
        "wrong"
    ];

    protected array $invalid_categories2_array = [
        "purpose" => "",
        "wrong" => ""
    ];

    protected array $invalid_category_item_array = [
        "purpose" => "Correct",
        "composition" => ["Wrong"]
    ];

    protected array $invalid_category_value_array = [
        "purpose" => "Correct",
        "rivals" => [["wrong"]]
    ];

    protected array $correct_description1_array = [
        "purpose" => "Purpose Description",
        "composition" => "Composition Description",
        "effect" => "Effect Description",
        "rivals" => ["Element 1" => "Rival 1", "Element 2" => "Rival 2"]
    ];

    protected array $correct_description2_array = [
        "purpose" => "Purpose Description"
    ];

    protected array $correct_description2_array_return = [
        "purpose" => "Purpose Description",
        "composition" => "",
        "effect" => "",
        "rivals" => []
    ];

    protected Crawler\EntriesYamlParser $parser;
    protected ProperEntryFixture $proper_entry;

    protected function setUp(): void
    {
        $this->parser = new Crawler\EntriesYamlParser();
        $this->proper_entry = new ProperEntryFixture();
    }

    public function testEmptyDescription(): void
    {
        $description = new Entry\ComponentEntryDescription();
        $this->assertEquals($this->empty_description_array, $description->getDescription());

        $description = new Entry\ComponentEntryDescription(array());
        $this->assertEquals($this->empty_description_array, $description->getDescription());
    }
    public function testInvalidDescription(): void
    {
        $this->expectException(TypeError::class);
        new Entry\ComponentEntryDescription(null);

        $this->expectException(TypeError::class);
        new Entry\ComponentEntryDescription('desc1');
    }
    public function testInvalidCategories1(): void
    {
        try {
            new Entry\ComponentEntryDescription($this->invalid_categories1_array);
            $this->assertFalse("This should not happen");
        } catch (Crawler\Exception\CrawlerException $e) {
            $this->assertEquals(Crawler\Exception\CrawlerException::INVALID_INDEX, $e->getCode());
        }
    }
    public function testInvalidCategories2(): void
    {
        try {
            new Entry\ComponentEntryDescription($this->invalid_categories2_array);
            $this->assertFalse("This should not happen");
        } catch (Crawler\Exception\CrawlerException $e) {
            $this->assertEquals(Crawler\Exception\CrawlerException::INVALID_INDEX, $e->getCode());
        }
    }
    public function testInvalidCategoryItem(): void
    {
        try {
            new Entry\ComponentEntryDescription($this->invalid_category_item_array);
            $this->assertFalse("This should not happen");
        } catch (Crawler\Exception\CrawlerException $e) {
            $this->assertEquals(Crawler\Exception\CrawlerException::STRING_EXPECTED, $e->getCode());
        }
    }
    public function testInvalidCategoryValue(): void
    {
        try {
            new Entry\ComponentEntryDescription($this->invalid_category_value_array);
            $this->assertFalse("This should not happen");
        } catch (Crawler\Exception\CrawlerException $e) {
            $this->assertEquals(Crawler\Exception\CrawlerException::STRING_EXPECTED, $e->getCode());
        }
    }
    public function testCorrectDescription1(): void
    {
        $description = new Entry\ComponentEntryDescription($this->correct_description1_array);
        $this->assertEquals($this->correct_description1_array, $description->getDescription());
    }

    public function testCorrectDescription2(): void
    {
        $description = new Entry\ComponentEntryDescription($this->correct_description2_array);
        $this->assertEquals($this->correct_description2_array_return, $description->getDescription());
    }

    public function testParseProperEntryToArray(): void
    {
        $entry = $this->parser->parseArrayFromFile("components/ILIAS/UI/tests/Crawler/Fixture/ProperEntry.php")[0];

        $entry["description"]['composition'] = "";
        $entry["description"]['effect'] = "";

        $description = new Entry\ComponentEntryDescription($entry["description"]);

        $this->assertEquals($description->getDescription(), $entry["description"]);
    }
}