ImporterAndResultTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\MetaData\Settings\Vocabularies\Import;

use PHPUnit\Framework\TestCase;
use ILIAS\MetaData\Vocabularies\Controlled\RepositoryInterface as ControlledVocabsRepository;
use ILIAS\MetaData\Paths\PathInterface;
use ILIAS\MetaData\Paths\FactoryInterface as PathFactory;
use ILIAS\MetaData\Vocabularies\Controlled\NullRepository;
use ILIAS\MetaData\Paths\NullFactory;
use ILIAS\MetaData\Paths\BuilderInterface;
use ILIAS\MetaData\Paths\NullBuilder;
use ILIAS\MetaData\Paths\NullPath;
use ILIAS\MetaData\Vocabularies\Slots\Identifier as SlotIdentifier;
use ILIAS\MetaData\Vocabularies\Slots\HandlerInterface as SlotHandler;
use ILIAS\MetaData\Vocabularies\Slots\NullHandler as NullSlotHandler;
use ILIAS\MetaData\Vocabularies\Slots\Identifier;

class ImporterAndResultTest extends TestCase
{
    protected function getRepo(
        bool $config_error = false,
        string ...$already_existing_values
    ): ControlledVocabsRepository {
        return new class ($config_error, $already_existing_values) extends NullRepository {
            public array $created_vocabs = [];
            public array $created_values = [];

            public function __construct(
                protected bool $config_error,
                protected array $already_existing_values
            ) {
            }

            public function create(
                SlotIdentifier $slot,
                string $source
            ): string {
                if ($this->config_error) {
                    throw new \ilMDVocabulariesException('config error');
                }
                $new_id = 'new id ' . count($this->created_vocabs);
                $this->created_vocabs[] = [
                    'id' => $new_id,
                    'slot' => $slot,
                    'source' => $source
                ];
                return $new_id;
            }

            public function findAlreadyExistingValues(
                SlotIdentifier $slot,
                string ...$values
            ): \Generator {
                yield from array_intersect($this->already_existing_values, $values);
            }

            public function addValueToVocabulary(
                string $vocab_id,
                string $value,
                string $label = ''
            ): void {
                $this->created_values[] = [
                    'vocab id' => $vocab_id,
                    'value' => $value,
                    'label' => $label
                ];
            }
        };
    }

    protected function getPathFactory(): PathFactory
    {
        return new class () extends NullFactory {
            public function custom(): BuilderInterface
            {
                return new class () extends NullBuilder {
                    protected $path_string = '';

                    public function withNextStep(string $name, bool $add_as_first = false): BuilderInterface
                    {
                        $clone = clone $this;
                        $clone->path_string .= $name . ';';
                        return $clone;
                    }

                    public function withNextStepToSuperElement(bool $add_as_first = false): BuilderInterface
                    {
                        $clone = clone $this;
                        $clone->path_string .= 'SUPER;';
                        return $clone;
                    }

                    public function withRelative(bool $is_relative): BuilderInterface
                    {
                        $clone = clone $this;
                        if ($is_relative) {
                            $clone->path_string = 'RELATIVE!' . $this->path_string;
                        }
                        return $clone;
                    }

                    public function get(): PathInterface
                    {
                        if (str_contains($this->path_string, 'INVALID')) {
                            throw new \ilMDPathException('path invalid');
                        }
                        return new class ($this->path_string) extends NullPath {
                            public function __construct(protected string $path_string)
                            {
                            }

                            public function toString(): string
                            {
                                return $this->path_string;
                            }
                        };
                    }
                };
            }
        };
    }

    protected function getSlotHandler(bool $invalid_slot = false): SlotHandler
    {
        return new class ($invalid_slot) extends NullSlotHandler {
            public function __construct(protected bool $invalid_slot)
            {
            }

            public array $exposed_paths_and_conditions = [];

            public function identiferFromPathAndCondition(
                PathInterface $path_to_element,
                ?PathInterface $path_to_condition,
                ?string $condition_value
            ): SlotIdentifier {
                if ($this->invalid_slot) {
                    return SlotIdentifier::NULL;
                }
                $this->exposed_paths_and_conditions[] = [
                    'path' => $path_to_element->toString(),
                    'condition path' => $path_to_condition?->toString(),
                    'condition value' => $condition_value
                ];
                return SlotIdentifier::EDUCATIONAL_CONTEXT;
            }
        };
    }

    public function testImportMalformedXMLError(): void
    {
        $importer = new Importer(
            $this->getPathFactory(),
            $repo = $this->getRepo(),
            $this->getSlotHandler()
        );

        $xml_string = 'asbduafduhsbdjfbsjfbjdbgfd532t7hubfjxd';

        $result = $importer->import($xml_string);

        $this->assertFalse($result->wasSuccessful());
        $this->assertNotEmpty($result->getErrors());
        $this->assertEmpty($repo->created_vocabs);
        $this->assertEmpty($repo->created_values);
    }

    public function testImportInvalidXMLStructureError(): void
    {
        $importer = new Importer(
            $this->getPathFactory(),
            $repo = $this->getRepo(),
            $this->getSlotHandler()
        );

        $xml_string = <<<XML
<?xml version="1.0"?>
<something>
    <else>value</else>
</something>
XML;

        $result = $importer->import($xml_string);

        $this->assertFalse($result->wasSuccessful());
        $this->assertNotEmpty($result->getErrors());
        $this->assertEmpty($repo->created_vocabs);
        $this->assertEmpty($repo->created_values);
    }

    public function testImportInvalidPathToElementError(): void
    {
        $importer = new Importer(
            $this->getPathFactory(),
            $repo = $this->getRepo(),
            $this->getSlotHandler()
        );

        $xml_string = <<<XML
<?xml version="1.0"?>
<vocabulary>
    <appliesTo>
        <pathToElement>
            <step>step1</step>
            <step>INVALID</step>
            <step>step3</step>
        </pathToElement>
    </appliesTo>
    <source>some source</source>
    <values>
        <value>value</value>
        <value>different value</value>
        <value>third value</value>
    </values>
</vocabulary>
XML;

        $result = $importer->import($xml_string);

        $this->assertFalse($result->wasSuccessful());
        $this->assertNotEmpty($result->getErrors());
        $this->assertEmpty($repo->created_vocabs);
        $this->assertEmpty($repo->created_values);
    }

    public function testImportInvalidPathToConditionError(): void
    {
        $importer = new Importer(
            $this->getPathFactory(),
            $repo = $this->getRepo(),
            $this->getSlotHandler()
        );

        $xml_string = <<<XML
<?xml version="1.0"?>
<vocabulary>
    <appliesTo>
        <pathToElement>
            <step>step1</step>
            <step>step2</step>
        </pathToElement>
        <condition value="condition value">
            <pathToElement>
                <stepToSuper/>
                <step>INVALID</step>
                <step>step 3</step>
            </pathToElement>
        </condition>
    </appliesTo>
    <source>some source</source>
    <values>
        <value>value</value>
        <value>different value</value>
        <value>third value</value>
    </values>
</vocabulary>
XML;

        $result = $importer->import($xml_string);

        $this->assertFalse($result->wasSuccessful());
        $this->assertNotEmpty($result->getErrors());
        $this->assertEmpty($repo->created_vocabs);
        $this->assertEmpty($repo->created_values);
    }

    public function testImportInvalidSlotError(): void
    {
        $importer = new Importer(
            $this->getPathFactory(),
            $repo = $this->getRepo(),
            $this->getSlotHandler(true)
        );

        $xml_string = <<<XML
<?xml version="1.0"?>
<vocabulary>
    <appliesTo>
        <pathToElement>
            <step>step1</step>
            <step>step2</step>
        </pathToElement>
        <condition value="condition value">
            <pathToElement>
                <stepToSuper/>
                <step>step2</step>
                <step>step3</step>
            </pathToElement>
        </condition>
    </appliesTo>
    <source>some source</source>
    <values>
        <value>value</value>
        <value>different value</value>
        <value>third value</value>
    </values>
</vocabulary>
XML;

        $result = $importer->import($xml_string);

        $this->assertFalse($result->wasSuccessful());
        $this->assertNotEmpty($result->getErrors());
        $this->assertEmpty($repo->created_vocabs);
        $this->assertEmpty($repo->created_values);
    }

    public function testImportDuplicateValuesError(): void
    {
        $importer = new Importer(
            $this->getPathFactory(),
            $repo = $this->getRepo(),
            $this->getSlotHandler()
        );

        $xml_string = <<<XML
<?xml version="1.0"?>
<vocabulary>
    <appliesTo>
        <pathToElement>
            <step>step1</step>
            <step>step2</step>
        </pathToElement>
    </appliesTo>
    <source>some source</source>
    <values>
        <value>value</value>
        <value>duplicate value</value>
        <value>duplicate value</value>
    </values>
</vocabulary>
XML;

        $result = $importer->import($xml_string);

        $this->assertFalse($result->wasSuccessful());
        $this->assertNotEmpty($result->getErrors());
        $this->assertEmpty($repo->created_vocabs);
        $this->assertEmpty($repo->created_values);
    }

    public function testImportAlreadyExistingValuesError(): void
    {
        $importer = new Importer(
            $this->getPathFactory(),
            $repo = $this->getRepo(false, 'already exists', 'also already exists'),
            $this->getSlotHandler()
        );

        $xml_string = <<<XML
<?xml version="1.0"?>
<vocabulary>
    <appliesTo>
        <pathToElement>
            <step>step1</step>
            <step>step2</step>
        </pathToElement>
    </appliesTo>
    <source>some source</source>
    <values>
        <value>already exists</value>
        <value>value</value>
        <value>also already exists</value>
    </values>
</vocabulary>
XML;

        $result = $importer->import($xml_string);

        $this->assertFalse($result->wasSuccessful());
        $this->assertNotEmpty($result->getErrors());
        $this->assertEmpty($repo->created_vocabs);
        $this->assertEmpty($repo->created_values);
    }

    public function testImportInvalidVocabConfigurationError(): void
    {
        $importer = new Importer(
            $this->getPathFactory(),
            $repo = $this->getRepo(true),
            $this->getSlotHandler()
        );

        $xml_string = <<<XML
<?xml version="1.0"?>
<vocabulary>
    <appliesTo>
        <pathToElement>
            <step>step1</step>
            <step>step2</step>
            <step>step3</step>
        </pathToElement>
    </appliesTo>
    <source>some source</source>
    <values>
        <value>value</value>
        <value>different value</value>
        <value>third value</value>
    </values>
</vocabulary>
XML;

        $result = $importer->import($xml_string);

        $this->assertFalse($result->wasSuccessful());
        $this->assertNotEmpty($result->getErrors());
        $this->assertEmpty($repo->created_vocabs);
        $this->assertEmpty($repo->created_values);
    }

    public function testImport(): void
    {
        $importer = new Importer(
            $this->getPathFactory(),
            $repo = $this->getRepo(),
            $slots = $this->getSlotHandler()
        );

        $xml_string = <<<XML
<?xml version="1.0"?>
<vocabulary>
    <appliesTo>
        <pathToElement>
            <step>step1</step>
            <step>step2</step>
            <step>step3</step>
        </pathToElement>
    </appliesTo>
    <source>some source</source>
    <values>
        <value>value</value>
        <value>different value</value>
        <value>third value</value>
    </values>
</vocabulary>
XML;

        $result = $importer->import($xml_string);

        $this->assertTrue($result->wasSuccessful());
        $this->assertEmpty($result->getErrors());
        $this->assertSame(
            [[
                'id' => 'new id 0',
                'slot' => SlotIdentifier::EDUCATIONAL_CONTEXT,
                'source' => 'some source',
            ]],
            $repo->created_vocabs
        );
        $this->assertSame(
            [[
                'path' => 'step1;step2;step3;',
                'condition path' => null,
                'condition value' => null
            ]],
            $slots->exposed_paths_and_conditions
        );
        $this->assertSame(
            [
                ['vocab id' => 'new id 0', 'value' => 'value', 'label' => ''],
                ['vocab id' => 'new id 0', 'value' => 'different value', 'label' => ''],
                ['vocab id' => 'new id 0', 'value' => 'third value', 'label' => '']
            ],
            $repo->created_values
        );
    }

    public function testImportWithLabels(): void
    {
        $importer = new Importer(
            $this->getPathFactory(),
            $repo = $this->getRepo(),
            $slots = $this->getSlotHandler()
        );

        $xml_string = <<<XML
<?xml version="1.0"?>
<vocabulary>
    <appliesTo>
        <pathToElement>
            <step>step1</step>
            <step>step2</step>
            <step>step3</step>
        </pathToElement>
    </appliesTo>
    <source>some source</source>
    <values>
        <value label="label">value</value>
        <value label="different label">different value</value>
        <value label="third label">third value</value>
    </values>
</vocabulary>
XML;

        $result = $importer->import($xml_string);

        $this->assertTrue($result->wasSuccessful());
        $this->assertEmpty($result->getErrors());
        $this->assertSame(
            [[
                 'id' => 'new id 0',
                 'slot' => SlotIdentifier::EDUCATIONAL_CONTEXT,
                 'source' => 'some source',
             ]],
            $repo->created_vocabs
        );
        $this->assertSame(
            [[
                 'path' => 'step1;step2;step3;',
                 'condition path' => null,
                 'condition value' => null
             ]],
            $slots->exposed_paths_and_conditions
        );
        $this->assertSame(
            [
                ['vocab id' => 'new id 0', 'value' => 'value', 'label' => 'label'],
                ['vocab id' => 'new id 0', 'value' => 'different value', 'label' => 'different label'],
                ['vocab id' => 'new id 0', 'value' => 'third value', 'label' => 'third label']
            ],
            $repo->created_values
        );
    }

    public function testImportWithCondition(): void
    {
        $importer = new Importer(
            $this->getPathFactory(),
            $repo = $this->getRepo(),
            $slots = $this->getSlotHandler()
        );

        $xml_string = <<<XML
<?xml version="1.0"?>
<vocabulary>
    <appliesTo>
        <pathToElement>
            <step>step1</step>
            <step>step2</step>
            <step>step3</step>
        </pathToElement>
         <condition value="condition value">
            <pathToElement>
                <stepToSuper/>
                <step>condstep1</step>
                <step>condstep2</step>
            </pathToElement>
        </condition>
    </appliesTo>
    <source>some source</source>
    <values>
        <value>value</value>
        <value>different value</value>
        <value>third value</value>
    </values>
</vocabulary>
XML;

        $result = $importer->import($xml_string);

        $this->assertTrue($result->wasSuccessful());
        $this->assertEmpty($result->getErrors());
        $this->assertSame(
            [[
                 'id' => 'new id 0',
                 'slot' => SlotIdentifier::EDUCATIONAL_CONTEXT,
                 'source' => 'some source',
             ]],
            $repo->created_vocabs
        );
        $this->assertSame(
            [[
                 'path' => 'step1;step2;step3;',
                 'condition path' => 'RELATIVE!SUPER;condstep1;condstep2;',
                 'condition value' => 'condition value'
             ]],
            $slots->exposed_paths_and_conditions
        );
        $this->assertSame(
            [
                ['vocab id' => 'new id 0', 'value' => 'value', 'label' => ''],
                ['vocab id' => 'new id 0', 'value' => 'different value', 'label' => ''],
                ['vocab id' => 'new id 0', 'value' => 'third value', 'label' => '']
            ],
            $repo->created_values
        );
    }
}