class.ilUITestRailExampleTestCasesObjective.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Setup;
use ILIAS\DI;
use ILIAS\UI\Implementation\Crawler as Crawler;

class ilUITestRailExampleTestCasesObjective extends Setup\Artifact\BuildArtifactObjective
{
    private const TESTCASEWRITER = 'ui.testrail.xmlwriter';
    private const FILENAME_UPDATE = 'testcases_update.xml';
    private const FILENAME_NEW = 'testcases_new.xml';

    public function __construct(
        protected bool $only_new_cases
    ) {
    }

    public function getArtifactName(): string
    {
        return ($this->only_new_cases) ? self::FILENAME_NEW : self::FILENAME_UPDATE;
    }

    public function getPreconditions(Setup\Environment $environment): array
    {
        return [
            new \ilComponentFactoryExistsObjective()
        ];
    }

    protected function getPath(): string
    {
        return Setup\Artifact\BuildArtifactObjective::ARTIFACTS . "/" . $this->getArtifactName();
    }

    public function achieve(Setup\Environment $environment): Setup\Environment
    {
        $component_factory = $environment->getResource(Setup\Environment::RESOURCE_COMPONENT_FACTORY);
        $plugin_admin = $environment->getResource(Setup\Environment::RESOURCE_PLUGIN_ADMIN);

        $ORIG_DIC = $GLOBALS["DIC"];
        $GLOBALS["DIC"] = new DI\Container();
        $GLOBALS["DIC"]["component.factory"] = $component_factory;
        $GLOBALS["DIC"]["ilPluginAdmin"] = $plugin_admin;

        $path = 'components/ILIAS/Style/classes/Setup/templates/testrail.case.xml';
        $tpl = new ilTemplate($path, true, true);
        $parser = new Crawler\ExamplesYamlParser();
        $testcases = new TestRailXMLWriter($tpl, $parser, $this->only_new_cases);

        $environment = $environment->withResource(self::TESTCASEWRITER, $testcases);

        parent::achieve($environment);
        $GLOBALS["DIC"] = $ORIG_DIC;
        return $environment;
    }

    public function build(): Setup\Artifact
    {
    }

    public function buildIn(Setup\Environment $env): Setup\Artifact
    {
        $crawler = new Crawler\FactoriesCrawler();
        $data = $crawler->crawlFactory(ilKitchenSinkDataCollectedObjective::ROOT_FACTORY_PATH);

        $sorted = [];
        foreach ($data as $entry) {
            $path = explode('/', $entry->getPath());
            if (end($path) === 'Factory') {
                continue;
            }
            $path = array_slice($path, 3);
            $section = array_shift($path);
            $section = array_shift($path);
            $section = array_shift($path);
            if (! array_key_exists($section, $sorted)) {
                $sorted[$section] = [];
            }
            $path = array_slice($path, 0, -1);
            $path[] = $entry->getTitle();
            $sorted[$section][] = [implode('/', $path), $entry];
        }
        ksort($sorted);

        $writer = $env->getResource(self::TESTCASEWRITER)
            ->withData($sorted);
        return new Setup\Artifact\XMLArtifact($writer->getXML());
    }
}