ilUITestRailExampleTestCasesObjective Class Reference

Inheritance diagram for ilUITestRailExampleTestCasesObjective:

Collaboration diagram for ilUITestRailExampleTestCasesObjective:

Public Member Functions
	__construct (protected bool $only_new_cases)
	getArtifactName ()
	getPreconditions (Setup\Environment $environment)
	achieve (Setup\Environment $environment)
	build ()
	buildIn (Setup\Environment $env)

Protected Member Functions
	getPath ()

Private Attributes
const	TESTCASEWRITER = 'ui.testrail.xmlwriter'
const	FILENAME_UPDATE = 'testcases_update.xml'
const	FILENAME_NEW = 'testcases_new.xml'

Detailed Description

Definition at line 25 of file class.ilUITestRailExampleTestCasesObjective.php.

Constructor & Destructor Documentation

__construct()

ilUITestRailExampleTestCasesObjective::__construct

(

protected bool

$only_new_cases

)

Definition at line 31 of file class.ilUITestRailExampleTestCasesObjective.php.

      {
    }

Member Function Documentation

achieve()

ilUITestRailExampleTestCasesObjective::achieve

(

Setup\Environment

$environment

)

Definition at line 53 of file class.ilUITestRailExampleTestCasesObjective.php.

References $GLOBALS, $path, and ILIAS\Setup\Environment\getResource().

                                                           : 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;
    }

Here is the call graph for this function:

build()

ilUITestRailExampleTestCasesObjective::build

(

)

Definition at line 75 of file class.ilUITestRailExampleTestCasesObjective.php.

                           : Setup\Artifact
    {
    }

buildIn()

ilUITestRailExampleTestCasesObjective::buildIn

(

Setup\Environment

$env

)

Definition at line 79 of file class.ilUITestRailExampleTestCasesObjective.php.

References $data, $path, and ilKitchenSinkDataCollectedObjective\ROOT_FACTORY_PATH.

                                                   : 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());
    }

getArtifactName()

ilUITestRailExampleTestCasesObjective::getArtifactName

(

)

Definition at line 36 of file class.ilUITestRailExampleTestCasesObjective.php.

Referenced by getPath().

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

Here is the caller graph for this function:

getPath()

ilUITestRailExampleTestCasesObjective::getPath ( )

protected

Definition at line 48 of file class.ilUITestRailExampleTestCasesObjective.php.

References getArtifactName().

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

Here is the call graph for this function:

getPreconditions()

ilUITestRailExampleTestCasesObjective::getPreconditions

(

Setup\Environment

$environment

)

Definition at line 41 of file class.ilUITestRailExampleTestCasesObjective.php.

                                                                    : array
    {
        return [
            new \ilComponentFactoryExistsObjective()
        ];
    }

Field Documentation

FILENAME_NEW

const ilUITestRailExampleTestCasesObjective::FILENAME_NEW = 'testcases_new.xml'

private

Definition at line 29 of file class.ilUITestRailExampleTestCasesObjective.php.

FILENAME_UPDATE

const ilUITestRailExampleTestCasesObjective::FILENAME_UPDATE = 'testcases_update.xml'

private

Definition at line 28 of file class.ilUITestRailExampleTestCasesObjective.php.

TESTCASEWRITER

const ilUITestRailExampleTestCasesObjective::TESTCASEWRITER = 'ui.testrail.xmlwriter'

private

Definition at line 27 of file class.ilUITestRailExampleTestCasesObjective.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/Style/classes/Setup/class.ilUITestRailExampleTestCasesObjective.php