Writer::appendDefects() - Code Metrics - Inspection of "Attempt at fixing failed build on Travis CI" - brianium/paratest - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#204)

unknown

created 2016-05-08 15:16 UTC

Writer::appendDefects() A

↳ Parent: Writer

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	8
ccs	7
cts	7
cp	1
rs	9.4285
cc	2
eloc	5
nc	2
nop	3
crap	2

<?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)) {
                $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));
    }
}


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	5	public function __construct(LogInterpreter $interpreter, $name = '')
55		{
56	5	$this->name = $name;
57	5	$this->interpreter = $interpreter;
58	5	$this->document = new \DOMDocument("1.0", "UTF-8");
59	5	$this->document->formatOutput = true;
60	5	}
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	4	public function getXml()
79		{
80	4	$suites = $this->interpreter->flattenCases();
81	4	$root = $this->getSuiteRoot($suites);
82	4	foreach ($suites as $suite) {
83	4	$snode = $this->appendSuite($root, $suite);
84	4	foreach ($suite->cases as $case) {
85	4	$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	4	}
87	4	}
88	4	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	4	protected function appendSuite($root, TestSuite $suite)
110		{
111	4	$suiteNode = $this->document->createElement("testsuite");
112	4	$vars = get_object_vars($suite);
113	4	foreach ($vars as $name => $value) {
114	4	if (preg_match(static::$suiteAttrs, $name)) {
115	4	$suiteNode->setAttribute($name, $value);
116	4	}
117	4	}
118	4	$root->appendChild($suiteNode);
119	4	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	4	protected function appendCase($suiteNode, TestCase $case)
131		{
132	4	$caseNode = $this->document->createElement("testcase");
133	4	$vars = get_object_vars($case);
134	4	foreach ($vars as $name => $value) {
135	4	if (preg_match(static::$caseAttrs, $name)) {
136	4	$caseNode->setAttribute($name, $value);
137	4	}
138	4	}
139	4	$suiteNode->appendChild($caseNode);
140	4	$this->appendDefects($caseNode, $case->failures, 'failure');
141	4	$this->appendDefects($caseNode, $case->errors, 'error');
142	4	return $caseNode;
143		}
144
145		/**
146		* Append error or failure nodes to the given testcase node
147		*
148		* @param $caseNode
149		* @param $defects
150		* @param $type
151		*/
152	4	protected function appendDefects($caseNode, $defects, $type)
153		{
154	4	foreach ($defects as $defect) {
155	2	$defectNode = $this->document->createElement($type, htmlentities($defect['text']) . "\n");
156	2	$defectNode->setAttribute('type', $defect['type']);
157	2	$caseNode->appendChild($defectNode);
158	4	}
159	4	}
160
161		/**
162		* Get the root level testsuite node
163		*
164		* @param $suites
165		* @return \DOMElement
166		*/
167	4	protected function getSuiteRoot($suites)
168		{
169	4	$testsuites = $this->document->createElement("testsuites");
170	4	$this->document->appendChild($testsuites);
171	4	if (sizeof($suites) == 1) {
172	2	return $testsuites;
173		}
174	2	$rootSuite = $this->document->createElement('testsuite');
175	2	$attrs = $this->getSuiteRootAttributes($suites);
176	2	foreach ($attrs as $attr => $value) {
177	2	$rootSuite->setAttribute($attr, $value);
178	2	}
179	2	$testsuites->appendChild($rootSuite);
180	2	return $rootSuite;
181		}
182
183		/**
184		* Get the attributes used on the root testsuite
185		* node
186		*
187		* @param $suites
188		* @return mixed
189		*/
190	2	protected function getSuiteRootAttributes($suites)
191		{
192	2	return array_reduce($suites, function ($result, $suite) {
193	2	$result['tests'] += $suite->tests;
194	2	$result['assertions'] += $suite->assertions;
195	2	$result['failures'] += $suite->failures;
196	2	$result['errors'] += $suite->errors;
197	2	$result['time'] += $suite->time;
198	2	return $result;
199	2	}, array_merge(array('name' => $this->name), self::$defaultSuite));
200		}
201		}
202

brianium / paratest

Pull Request — master (#204)

Writer::appendDefects() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like