Writer::getSuiteRoot() - Code Metrics - Inspection of "Fix issue 199, prevent empty line attributes in XM..." - brianium/paratest - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#223)

by Michael

created 2016-10-29 17:13 UTC

Writer::getSuiteRoot() A

↳ Parent: Writer

Complexity

Conditions	3
Paths	3

Size

Total Lines	15
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	15
ccs	12
cts	12
cp	1
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	11
nc	3
nop	1
crap	3

<?php
namespace ParaTest\Logging\JUnit;

use ParaTest\Logging\LogInterpreter;

class Writer
{
    /**
     * The name attribute of the testsuite being
     * written
     *
     * @var string
     */
    protected $name;

    /**
     * @var \ParaTest\Logging\LogInterpreter
     */
    protected $interpreter;

    /**
     * @var \DOMDocument
     */
    protected $document;

    /**
     * A pattern for matching testsuite attributes
     *
     * @var string
     */
    protected static $suiteAttrs = '/name|(?:test|assertion|failure|error)s|time|file/';

    /**
     * A pattern for matching testcase attrs
     *
     * @var string
     */
    protected static $caseAttrs = '/name|class|file|line|assertions|time/';

    /**
     * A default suite to ease flattening of
     * suite structures
     *
     * @var array
     */
    protected static $defaultSuite = array(
                                        'tests' => 0,
                                        'assertions' => 0,
                                        'failures' => 0,
                                        'errors' => 0,
                                        'time' => 0
                                    );

    public function __construct(LogInterpreter $interpreter, $name = '')
    {
        $this->name = $name;
        $this->interpreter = $interpreter;
        $this->document = new \DOMDocument("1.0", "UTF-8");
        $this->document->formatOutput = true;
    }

    /**
     * Get the name of the root suite being written
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Returns the xml structure the writer
     * will use
     *
     * @return string
     */
    public function getXml()
    {
        $suites = $this->interpreter->flattenCases();
        $root = $this->getSuiteRoot($suites);
        foreach ($suites as $suite) {
            $snode = $this->appendSuite($root, $suite);
            foreach ($suite->cases as $case) {
                $cnode = $this->appendCase($snode, $case);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            }
        }
        return $this->document->saveXML();
    }

    /**
     * Write the xml structure to a file path
     *
     * @param $path
     */
    public function write($path)
    {
        file_put_contents($path, $this->getXml());
    }

    /**
     * Append a testsuite node to the given
     * root element
     *
     * @param $root
     * @param TestSuite $suite
     * @return \DOMElement
     */
    protected function appendSuite($root, TestSuite $suite)
    {
        $suiteNode = $this->document->createElement("testsuite");
        $vars = get_object_vars($suite);
        foreach ($vars as $name => $value) {
            if (preg_match(static::$suiteAttrs, $name)) {
                $suiteNode->setAttribute($name, $value);
            }
        }
        $root->appendChild($suiteNode);
        return $suiteNode;
    }

    /**
     * Append a testcase node to the given testsuite
     * node
     *
     * @param $suiteNode
     * @param TestCase $case
     * @return \DOMElement
     */
    protected function appendCase($suiteNode, TestCase $case)
    {
        $caseNode = $this->document->createElement("testcase");
        $vars = get_object_vars($case);
        foreach ($vars as $name => $value) {
            if (preg_match(static::$caseAttrs, $name)) {
                if ($this->isEmptyLineAttribute($name, $value)) {
                    continue;
                }
                $caseNode->setAttribute($name, $value);
            }
        }
        $suiteNode->appendChild($caseNode);
        $this->appendDefects($caseNode, $case->failures, 'failure');
        $this->appendDefects($caseNode, $case->errors, 'error');
        return $caseNode;
    }

    /**
     * Append error or failure nodes to the given testcase node
     *
     * @param $caseNode
     * @param $defects
     * @param $type
     */
    protected function appendDefects($caseNode, $defects, $type)
    {
        foreach ($defects as $defect) {
            $defectNode = $this->document->createElement($type, htmlentities($defect['text']) . "\n");
            $defectNode->setAttribute('type', $defect['type']);
            $caseNode->appendChild($defectNode);
        }
    }

    /**
     * Get the root level testsuite node
     *
     * @param $suites
     * @return \DOMElement
     */
    protected function getSuiteRoot($suites)
    {
        $testsuites = $this->document->createElement("testsuites");
        $this->document->appendChild($testsuites);
        if (sizeof($suites) == 1) {
            return $testsuites;
        }
        $rootSuite = $this->document->createElement('testsuite');
        $attrs = $this->getSuiteRootAttributes($suites);
        foreach ($attrs as $attr => $value) {
            $rootSuite->setAttribute($attr, $value);
        }
        $testsuites->appendChild($rootSuite);
        return $rootSuite;
    }

    /**
     * Get the attributes used on the root testsuite
     * node
     *
     * @param $suites
     * @return mixed
     */
    protected function getSuiteRootAttributes($suites)
    {
        return array_reduce($suites, function ($result, $suite) {
            $result['tests'] += $suite->tests;
            $result['assertions'] += $suite->assertions;
            $result['failures'] += $suite->failures;
            $result['errors'] += $suite->errors;
            $result['time'] += $suite->time;
            return $result;
        }, array_merge(array('name' => $this->name), self::$defaultSuite));
    }

    /**
     * Prevent writing empty "line" XML attributes which could break parsers.
     * @param string $name
     * @param mixed $value
     * @return bool
     */
    private function isEmptyLineAttribute($name, $value)
    {
        return $name === 'line' && empty($value);
    }
}


1		<?php
2		namespace ParaTest\Logging\JUnit;
3
4		use ParaTest\Logging\LogInterpreter;
5
6		class Writer
7		{
8		/**
9		* The name attribute of the testsuite being
10		* written
11		*
12		* @var string
13		*/
14		protected $name;
15
16		/**
17		* @var \ParaTest\Logging\LogInterpreter
18		*/
19		protected $interpreter;
20
21		/**
22		* @var \DOMDocument
23		*/
24		protected $document;
25
26		/**
27		* A pattern for matching testsuite attributes
28		*
29		* @var string
30		*/
31		protected static $suiteAttrs = '/name\|(?:test\|assertion\|failure\|error)s\|time\|file/';
32
33		/**
34		* A pattern for matching testcase attrs
35		*
36		* @var string
37		*/
38		protected static $caseAttrs = '/name\|class\|file\|line\|assertions\|time/';
39
40		/**
41		* A default suite to ease flattening of
42		* suite structures
43		*
44		* @var array
45		*/
46		protected static $defaultSuite = array(
47		'tests' => 0,
48		'assertions' => 0,
49		'failures' => 0,
50		'errors' => 0,
51		'time' => 0
52		);
53
54	6	public function __construct(LogInterpreter $interpreter, $name = '')
55		{
56	6	$this->name = $name;
57	6	$this->interpreter = $interpreter;
58	6	$this->document = new \DOMDocument("1.0", "UTF-8");
59	6	$this->document->formatOutput = true;
60	6	}
61
62		/**
63		* Get the name of the root suite being written
64		*
65		* @return string
66		*/
67	1	public function getName()
68		{
69	1	return $this->name;
70		}
71
72		/**
73		* Returns the xml structure the writer
74		* will use
75		*
76		* @return string
77		*/
78	5	public function getXml()
79		{
80	5	$suites = $this->interpreter->flattenCases();
81	5	$root = $this->getSuiteRoot($suites);
82	5	foreach ($suites as $suite) {
83	5	$snode = $this->appendSuite($root, $suite);
84	5	foreach ($suite->cases as $case) {
85	5	$cnode = $this->appendCase($snode, $case);
		0 ignored issues – show Unused Code introduced 2015-12-02 18:19 UTC by Report Bug Copy Issue Report `$cnode` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
86	5	}
87	5	}
88	5	return $this->document->saveXML();
89		}
90
91		/**
92		* Write the xml structure to a file path
93		*
94		* @param $path
95		*/
96	2	public function write($path)
97		{
98	2	file_put_contents($path, $this->getXml());
99	2	}
100
101		/**
102		* Append a testsuite node to the given
103		* root element
104		*
105		* @param $root
106		* @param TestSuite $suite
107		* @return \DOMElement
108		*/
109	5	protected function appendSuite($root, TestSuite $suite)
110		{
111	5	$suiteNode = $this->document->createElement("testsuite");
112	5	$vars = get_object_vars($suite);
113	5	foreach ($vars as $name => $value) {
114	5	if (preg_match(static::$suiteAttrs, $name)) {
115	5	$suiteNode->setAttribute($name, $value);
116	5	}
117	5	}
118	5	$root->appendChild($suiteNode);
119	5	return $suiteNode;
120		}
121
122		/**
123		* Append a testcase node to the given testsuite
124		* node
125		*
126		* @param $suiteNode
127		* @param TestCase $case
128		* @return \DOMElement
129		*/
130	5	protected function appendCase($suiteNode, TestCase $case)
131		{
132	5	$caseNode = $this->document->createElement("testcase");
133	5	$vars = get_object_vars($case);
134	5	foreach ($vars as $name => $value) {
135	5	if (preg_match(static::$caseAttrs, $name)) {
136	5	if ($this->isEmptyLineAttribute($name, $value)) {
137	1	continue;
138		}
139	5	$caseNode->setAttribute($name, $value);
140	5	}
141	5	}
142	5	$suiteNode->appendChild($caseNode);
143	5	$this->appendDefects($caseNode, $case->failures, 'failure');
144	5	$this->appendDefects($caseNode, $case->errors, 'error');
145	5	return $caseNode;
146		}
147
148		/**
149		* Append error or failure nodes to the given testcase node
150		*
151		* @param $caseNode
152		* @param $defects
153		* @param $type
154		*/
155	5	protected function appendDefects($caseNode, $defects, $type)
156		{
157	5	foreach ($defects as $defect) {
158	3	$defectNode = $this->document->createElement($type, htmlentities($defect['text']) . "\n");
159	3	$defectNode->setAttribute('type', $defect['type']);
160	3	$caseNode->appendChild($defectNode);
161	5	}
162	5	}
163
164		/**
165		* Get the root level testsuite node
166		*
167		* @param $suites
168		* @return \DOMElement
169		*/
170	5	protected function getSuiteRoot($suites)
171		{
172	5	$testsuites = $this->document->createElement("testsuites");
173	5	$this->document->appendChild($testsuites);
174	5	if (sizeof($suites) == 1) {
175	2	return $testsuites;
176		}
177	3	$rootSuite = $this->document->createElement('testsuite');
178	3	$attrs = $this->getSuiteRootAttributes($suites);
179	3	foreach ($attrs as $attr => $value) {
180	3	$rootSuite->setAttribute($attr, $value);
181	3	}
182	3	$testsuites->appendChild($rootSuite);
183	3	return $rootSuite;
184		}
185
186		/**
187		* Get the attributes used on the root testsuite
188		* node
189		*
190		* @param $suites
191		* @return mixed
192		*/
193		protected function getSuiteRootAttributes($suites)
194		{
195	3	return array_reduce($suites, function ($result, $suite) {
196	3	$result['tests'] += $suite->tests;
197	3	$result['assertions'] += $suite->assertions;
198	3	$result['failures'] += $suite->failures;
199	3	$result['errors'] += $suite->errors;
200	3	$result['time'] += $suite->time;
201	3	return $result;
202	3	}, array_merge(array('name' => $this->name), self::$defaultSuite));
203		}
204
205		/**
206		* Prevent writing empty "line" XML attributes which could break parsers.
207		* @param string $name
208		* @param mixed $value
209		* @return bool
210		*/
211	5	private function isEmptyLineAttribute($name, $value)
212		{
213	5	return $name === 'line' && empty($value);
214		}
215		}
216

brianium / paratest

Pull Request — master (#223)

Writer::getSuiteRoot() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like