Collaboration diagram for TestRailXMLWriter:

Public Member Functions
	__construct (protected \ilTemplate $case_tpl, protected ExamplesYamlParser $parser, protected bool $only_new_cases)

	getXML ()

	withData (array $data)

	addSection (SimpleXMLElement $xml_parent_node, string $name, string $description='',)

Protected Member Functions
	addCase (SimpleXMLElement $xml_parent_node, string $id, string $title, string $preconditions, string $steps, string $expected,)

	initUISection ()

	addComponentCases (SimpleXMLElement $xml_parent_node, string $section, string $component_name, ComponentEntry $entry,)

	getTemplate ()

	getBlockContents (string $block)

	getClickpath (ComponentEntry $entry)

	getCaseId (string $component_path, string $subkey)

	getExpectedExamples (array $examples)

Protected Attributes
const	SHOW = 'show'

const	VALIDATE = 'validate'

const	BASE = 'UIBASE'

const	OPEN = 'open'

const	PREPARE = 'prepare'

SimpleXMLElement	$xml

int	$no_found_ids = 0

int	$no_expexted_ids = 0

int	$no_new_ids = 0

int	$no_components = 2

array	$expected_by_caseids = []

Detailed Description

Definition at line 26 of file TestRailXMLWriter.php.

Constructor & Destructor Documentation

◆ __construct()

TestRailXMLWriter::__construct	(	protected \ilTemplate	$case_tpl,
		protected ExamplesYamlParser	$parser,
		protected bool	$only_new_cases
	)

Definition at line 44 of file TestRailXMLWriter.php.

      {
        $this->xml = new SimpleXMLElement('<?xml version="1.0"?><sections></sections>');
        foreach (self::$CASEIDS as $k => $v) {
            $this->no_expexted_ids += count($v);
            $this->expected_by_caseids = array_merge($this->expected_by_caseids, array_values($v));
        }
    }

Member Function Documentation

◆ addCase()

TestRailXMLWriter::addCase	(	SimpleXMLElement	$xml_parent_node,
		string	$id,
		string	$title,
		string	$preconditions,
		string	$steps,
		string	$expected
	)

protected

Definition at line 101 of file TestRailXMLWriter.php.

     : SimpleXMLElement {
        $xml_case = $xml_parent_node->addChild('case');
        $xml_case->addChild('id', $id);
        $xml_case->addChild('title', $title);
        $xml_case->addChild('template', 'Test Case');
        $xml_case->addChild('type', 'Other');
        $xml_case->addChild('priority', '4 - Must Test');
        $xml_cust = $xml_case->addChild('custom');
        $xml_cust->addChild('preconds', "\n" . trim($preconditions) . "\n");
        $xml_cust->addChild('steps', "\n" . trim($steps) . "\n");
        $xml_cust->addChild('expected', "\n" . trim($expected) . "\n");
        return $xml_parent_node;
    }

◆ addComponentCases()

TestRailXMLWriter::addComponentCases	(	SimpleXMLElement	$xml_parent_node,
		string	$section,
		string	$component_name,
		ComponentEntry	$entry
	)

protected

Definition at line 157 of file TestRailXMLWriter.php.

     : void {
 
        $preconditions = $this->getBlockContents('preconditions');
 
        list($build, $case_id) = $this->getCaseId($section . '/' . $component_name, self::SHOW);
        if ($build) {
            $steps = $this->getTemplate();
            $steps->setCurrentBlock('steps_show');
            $steps->setVariable('SECTION', $section);
            $steps->setVariable('CLICKPATH', $this->getClickpath($entry));
            $steps->setVariable('TITLE', $entry->getTitle());
            $steps->parseCurrentBlock();
            $steps = $steps->get();
 
            $expected = $this->getTemplate();
            $expected_examples = $this->getExpectedExamples($entry->getExamples());
            $expected->setVariable('EXAMPLE_COUNTER', (string) count($entry->getExamples()));
            $expected->setVariable('EXPECTED', $expected_examples);
            $expected = $expected->get();
            $this->addCase(
                $xml_parent_node,
                $case_id,
                $section . ' - ' . $component_name . ': ' . self::SHOW,
                $preconditions,
                $steps,
                $expected
            );
        }
 
        list($build, $case_id) = $this->getCaseId($section . '/' . $component_name, self::VALIDATE);
        if ($build) {
            $steps = $this->getTemplate();
            $steps->setCurrentBlock('steps_validate');
            $steps->setVariable('SECTION', $section);
            $steps->setVariable('CLICKPATH', $this->getClickpath($entry));
            $steps->setVariable('TITLE', $entry->getTitle());
            $steps->parseCurrentBlock();
            $steps = $steps->get();
 
            $expected = $this->getBlockContents('expected_validate');
 
            $this->addCase(
                $xml_parent_node,
                $case_id,
                $section . ' - ' . $component_name . ': ' . self::VALIDATE,
                $preconditions,
                $steps,
                $expected
            );
        }
    }

Referenced by withData().

Here is the caller graph for this function:

◆ addSection()

TestRailXMLWriter::addSection	(	SimpleXMLElement	$xml_parent_node,
		string	$name,
		string	$description = `''`
	)

Definition at line 90 of file TestRailXMLWriter.php.

     : SimpleXMLElement {
        $xml_section = $xml_parent_node->addChild('section');
        $xml_section->addChild('name', $name);
        $xml_section->addChild('description', $description);
        return $xml_section;
    }

◆ getBlockContents()

TestRailXMLWriter::getBlockContents ( string $block )

protected

Definition at line 219 of file TestRailXMLWriter.php.

                                                      : string
    {
        $contents = $this->getTemplate();
        $contents->touchBlock($block);
        return "\n" . trim($contents->get()) . "\n";
    }

◆ getCaseId()

TestRailXMLWriter::getCaseId	(	string	$component_path,
		string	$subkey
	)

protected

Definition at line 233 of file TestRailXMLWriter.php.

                                                                        : array
    {
        $case_id = '';
        if (array_key_exists($component_path, self::$CASEIDS)
            && array_key_exists($subkey, self::$CASEIDS[$component_path])
        ) {
            $case_id = self::$CASEIDS[$component_path][$subkey];
            $this->no_found_ids += 1;
            print "\n caseId for: $component_path ($subkey)";
            unset(
                $this->expected_by_caseids[
                    array_search($case_id, $this->expected_by_caseids)
                ]
            );
        } else {
            $this->no_new_ids += 1;
            print "\n no caseId for: $component_path ($subkey)";
        }
 
        $build = ($case_id === '' && $this->only_new_cases)
            || ($case_id !== '' && !$this->only_new_cases);
 
        return [$build, $case_id];
    }

◆ getClickpath()

TestRailXMLWriter::getClickpath ( ComponentEntry $entry )

protected

Definition at line 226 of file TestRailXMLWriter.php.

                                                          : string
    {
        $clickpath = array_slice(explode('/', $entry->getPath()), 4, -1);
        $clickpath[] = $entry->getTitle();
        return implode(' -> ', $clickpath);
    }

References ILIAS\UI\Implementation\Crawler\Entry\ComponentEntry\getPath(), and ILIAS\UI\Implementation\Crawler\Entry\ComponentEntry\getTitle().

Here is the call graph for this function:

◆ getExpectedExamples()

TestRailXMLWriter::getExpectedExamples ( array $examples )

protected

Definition at line 258 of file TestRailXMLWriter.php.

                                                           : string
    {
        $expected_show = '';
        foreach (array_keys($examples) as $idx => $example) {
            $expected_show = $expected_show . "\n**" . $idx + 1 . '. ' . ucfirst(str_replace('_', ' ', $example)) . '**';
            $docs = $this->parser->parseYamlStringArrayFromFile($examples[$example]);
            if (array_key_exists('expected output', $docs)) {
                $expected_show .= "\n" . $docs['expected output'] . "\n";
            }
        }
        return $expected_show;
    }

◆ getTemplate()

TestRailXMLWriter::getTemplate ( )

protected

Definition at line 214 of file TestRailXMLWriter.php.

                                    : ilTemplate
    {
        return clone $this->case_tpl;
    }

◆ getXML()

TestRailXMLWriter::getXML ( )

Definition at line 56 of file TestRailXMLWriter.php.

                            : SimpleXMLElement
    {
        print "\n found " . $this->no_components . ' components/cases';
        print "\n update for " . $this->no_found_ids . ' of ' . $this->no_expexted_ids . ' known IDs';
        print "\n new cases: " . $this->no_new_ids;
        print "\n known ids unaccounted for: " . implode(',', $this->expected_by_caseids);
        print "\n";
        return $this->xml;
    }

References $no_new_ids, and $xml.

◆ initUISection()

TestRailXMLWriter::initUISection ( )

protected

Definition at line 122 of file TestRailXMLWriter.php.

                                      : SimpleXMLElement
    {
        $xml_section = $this->addSection(
            $this->xml,
            $this->getBlockContents('suite_title'),
            $this->getBlockContents('suite_description')
        );
        $xml_cases = $xml_section->addChild('cases');
 
        list($build, $case_id) = $this->getCaseId(self::BASE, self::OPEN);
        if ($build) {
            $this->addCase(
                $xml_cases,
                $case_id,
                $this->getBlockContents('suite_case_open_title'),
                $this->getBlockContents('suite_case_open_precond'),
                $this->getBlockContents('suite_case_open_steps'),
                $this->getBlockContents('suite_case_open_expected')
            );
        }
        list($build, $case_id) = $this->getCaseId(self::BASE, self::PREPARE);
        if ($build) {
            $this->addCase(
                $xml_cases,
                $case_id,
                $this->getBlockContents('suite_case_validate_title'),
                $this->getBlockContents('suite_case_validate_precond'),
                $this->getBlockContents('suite_case_validate_steps'),
                $this->getBlockContents('suite_case_validate_expected')
            );
        }
 
        return $xml_section;
    }

◆ withData()

TestRailXMLWriter::withData ( array $data )

Parameters

<string,array> $data

Definition at line 69 of file TestRailXMLWriter.php.

                                         : self
    {
        $xml_sections = $this
            ->initUISection()
            ->addChild('sections');
 
        foreach ($data as $section => $components) {
            $xml_cases = $this
                ->addSection($xml_sections, $section, '')
                ->addChild('cases');
 
            foreach ($components as $component) {
                list($component_name, $entry) = $component;
                $this->no_components += 2;
                $this->addComponentCases($xml_cases, $section, $component_name, $entry);
            }
        }
 
        return $this;
    }

References $components, $data, and addComponentCases().

Here is the call graph for this function:

Field Documentation

◆ $expected_by_caseids

array TestRailXMLWriter::$expected_by_caseids = []

protected

Definition at line 42 of file TestRailXMLWriter.php.

◆ $no_components

int TestRailXMLWriter::$no_components = 2

protected

Definition at line 40 of file TestRailXMLWriter.php.

◆ $no_expexted_ids

int TestRailXMLWriter::$no_expexted_ids = 0

protected

Definition at line 38 of file TestRailXMLWriter.php.

◆ $no_found_ids

int TestRailXMLWriter::$no_found_ids = 0

protected

Definition at line 37 of file TestRailXMLWriter.php.

◆ $no_new_ids

int TestRailXMLWriter::$no_new_ids = 0

protected

Definition at line 39 of file TestRailXMLWriter.php.

Referenced by getXML().

◆ $xml

SimpleXMLElement TestRailXMLWriter::$xml

protected

Definition at line 35 of file TestRailXMLWriter.php.

Referenced by getXML().

◆ BASE

const TestRailXMLWriter::BASE = 'UIBASE'

protected

Definition at line 31 of file TestRailXMLWriter.php.

◆ OPEN

const TestRailXMLWriter::OPEN = 'open'

protected

Definition at line 32 of file TestRailXMLWriter.php.

◆ PREPARE

const TestRailXMLWriter::PREPARE = 'prepare'

protected

Definition at line 33 of file TestRailXMLWriter.php.

◆ SHOW

const TestRailXMLWriter::SHOW = 'show'

protected

Definition at line 29 of file TestRailXMLWriter.php.

◆ VALIDATE

const TestRailXMLWriter::VALIDATE = 'validate'

protected

Definition at line 30 of file TestRailXMLWriter.php.

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

components/ILIAS/Style/classes/Setup/TestRailXMLWriter.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCase()

◆ addComponentCases()

◆ addSection()

◆ getBlockContents()

◆ getCaseId()

◆ getClickpath()

◆ getExpectedExamples()

◆ getTemplate()

◆ getXML()

◆ initUISection()

◆ withData()

Field Documentation

◆ $expected_by_caseids

◆ $no_components

◆ $no_expexted_ids

◆ $no_found_ids

◆ $no_new_ids

◆ $xml

◆ BASE

◆ OPEN

◆ PREPARE

◆ SHOW

◆ VALIDATE