SaveOnFailure::clear_directory() - Code Metrics - Inspection of "PHP CS Fixer with code style updates" - OpenBuildings/phpunit-spiderling - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#8)

by Haralan

created 2017-03-22 00:55 UTC

SaveOnFailure::clear_directory() A

↳ Parent: SaveOnFailure

Complexity

Conditions	4
Paths	3

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	4

Importance

Changes

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

<?php

namespace Openbuildings\PHPUnitSpiderling;

class SaveOnFailure implements \PHPUnit\Framework\TestListener
{
    /**
     * Convert an attribute strigng from a relative to absolute, by providing a base_url.
     *
     * @param string $attribute name of the attribute, e.g. src, href
     * @param string $content   the string where to do the change
     * @param string $base_url
     *
     * @return string
     */
    public static function to_absolute_attribute($attribute, $content, $base_url = null)
    {
        return preg_replace('/('.$attribute.'=[\'"])\//', '$1'.rtrim($base_url, '/').'/', $content);
    }

    /**
     * Check if a directory does not exist, create it, otherwise check if it is writable.
     *
     * @param string $directory
     *
     * @throws Exception If directory is not writable
     */
    public static function autocreate_directory($directory)
    {
        if (!file_exists($directory)) {
            mkdir($directory, 0777, true);
        }

        if (!is_writable($directory)) {
            throw new \Exception("Directory \"{$directory}\" is not writable");
        }
    }

    /**
     * Delete all the files from a directory.
     *
     * @param string $directory
     */
    public static function clear_directory($directory)
    {
        foreach (scandir($directory) as $file) {
            if ($file !== '.' and $file !== '..') {
                unlink($directory.$file);
            }
        }
    }

    /**
     * Execute a php script and get the output of that script as a string, optionally pass variables as an associative array to be converted to local variables inside of the file.
     *
     * @param string $filename
     * @param array  $data
     *
     * @return string
     */
    public static function render_file($filename, array $data = [])
    {
        extract($data, EXTR_SKIP);

        ob_start();
        include $filename;

        return ob_get_clean();
    }

    protected $_directory;
    protected $_base_url;

    public function __construct($directory, $base_url)
    {
        if (!$directory) {
            throw new \Exception('You must set a directory to output errors to');
        }

        $this->_directory = rtrim($directory, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
        $this->_base_url = $base_url;

        self::autocreate_directory($directory);
        self::clear_directory($directory);
    }

    /**
     * Save the current content of the driver into an html file. Add javascript errors, messages and a title to the html content.
     *
     * @param \Openbuildings\Spiderling\Driver $driver
     * @param string                           $filename
     * @param string                           $title
     */
    public function save_driver_content(\Openbuildings\Spiderling\Driver $driver, $filename, $title)
    {
        $content = $driver->content();

        foreach (['href', 'action', 'src'] as $attribute) {
            $content = self::to_absolute_attribute($attribute, $content, $this->_base_url);
        }

        $testview = self::render_file(__DIR__.'/../assets/error-page.php', [
            'url' => $driver->current_url(),
            'title' => $title,
            'javascript_errors' => $driver->javascript_errors(),
            'javascript_messages' => $driver->javascript_messages(),
        ]);

        $page_content = str_replace('</body>', $testview.'</body>', $content);

        file_put_contents($this->_directory."/$filename.html", $page_content);

        try {
            $driver->screenshot($this->_directory."/$filename.png");
        } catch (\Openbuildings\Spiderling\Exception_Notimplemented $e) {

        }
    }

    /**
     * Implement PHPUnit\Framework\TestListener, save driver content if there was an error.
     *
     * @param \PHPUnit\Framework\Test $test
     * @param \Exception              $exception
     * @param int                     $time
     */
    public function addError(\PHPUnit\Framework\Test $test, \Exception $exception, $time)
    {
        if ($test instanceof TestCase and $test->is_driver_active() and $test->driver()->is_page_active()) {
            $this->save_driver_content(
                $test->driver(),
                get_class($test).'_'.$test->getName(false),
                $exception->getMessage()
            );
        }
    }

    /**
     * Implement PHPUnit\Framework\TestListener, save driver content if there was an error.
     *
     * @param \PHPUnit\Framework\Test                 $test
     * @param \PHPUnit\Framework\AssertionFailedError $failure
     * @param int                                     $time
     */
    public function addFailure(\PHPUnit\Framework\Test $test, \PHPUnit\Framework\AssertionFailedError $failure, $time)
    {
        if ($test instanceof TestCase and $test->is_driver_active() and $test->driver()->is_page_active()) {
            $this->save_driver_content(
                $test->driver(),
                get_class($test).'_'.$test->getName(false),
                $failure->getMessage()
            );
        }
    }

    // @codeCoverageIgnoreStart
    public function addWarning(\PHPUnit\Framework\Test $test, \PHPUnit\Framework\Warning $e, $time)
    {
    }

    public function addRiskyTest(\PHPUnit\Framework\Test $test, \Exception $e, $time)
    {
    }

    public function addIncompleteTest(\PHPUnit\Framework\Test $test, \Exception $e, $time)
    {
    }

    public function addSkippedTest(\PHPUnit\Framework\Test $test, \Exception $e, $time)
    {
    }

    public function startTest(\PHPUnit\Framework\Test $test)
    {
    }

    public function endTest(\PHPUnit\Framework\Test $test, $time)
    {
    }

    public function startTestSuite(\PHPUnit\Framework\TestSuite $suite)
    {
    }

    public function endTestSuite(\PHPUnit\Framework\TestSuite $suite)
    {
    }

    // @codeCoverageIgnoreEnd
}


1		<?php
2
3		namespace Openbuildings\PHPUnitSpiderling;
4
5		class SaveOnFailure implements \PHPUnit\Framework\TestListener
6		{
7		/**
8		* Convert an attribute strigng from a relative to absolute, by providing a base_url.
9		*
10		* @param string $attribute name of the attribute, e.g. src, href
11		* @param string $content the string where to do the change
12		* @param string $base_url
13		*
14		* @return string
15		*/
16	8	public static function to_absolute_attribute($attribute, $content, $base_url = null)
17		{
18	8	return preg_replace('/('.$attribute.'=[\'"])\//', '$1'.rtrim($base_url, '/').'/', $content);
19		}
20
21		/**
22		* Check if a directory does not exist, create it, otherwise check if it is writable.
23		*
24		* @param string $directory
25		*
26		* @throws Exception If directory is not writable
27		*/
28	2	public static function autocreate_directory($directory)
29		{
30	2	if (!file_exists($directory)) {
31	2	mkdir($directory, 0777, true);
32		}
33
34	2	if (!is_writable($directory)) {
35		throw new \Exception("Directory \"{$directory}\" is not writable");
36		}
37	2	}
38
39		/**
40		* Delete all the files from a directory.
41		*
42		* @param string $directory
43		*/
44	2	public static function clear_directory($directory)
45		{
46	2	foreach (scandir($directory) as $file) {
47	2	if ($file !== '.' and $file !== '..') {
48	1	unlink($directory.$file);
49		}
50		}
51	2	}
52
53		/**
54		* Execute a php script and get the output of that script as a string, optionally pass variables as an associative array to be converted to local variables inside of the file.
55		*
56		* @param string $filename
57		* @param array $data
58		*
59		* @return string
60		*/
61	1	public static function render_file($filename, array $data = [])
62		{
63	1	extract($data, EXTR_SKIP);
64
65	1	ob_start();
66	1	include $filename;
67
68	1	return ob_get_clean();
69		}
70
71		protected $_directory;
72		protected $_base_url;
73
74	1	public function __construct($directory, $base_url)
75		{
76	1	if (!$directory) {
77		throw new \Exception('You must set a directory to output errors to');
78		}
79
80	1	$this->_directory = rtrim($directory, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR;
81	1	$this->_base_url = $base_url;
82
83	1	self::autocreate_directory($directory);
84	1	self::clear_directory($directory);
85	1	}
86
87		/**
88		* Save the current content of the driver into an html file. Add javascript errors, messages and a title to the html content.
89		*
90		* @param \Openbuildings\Spiderling\Driver $driver
91		* @param string $filename
92		* @param string $title
93		*/
94	1	public function save_driver_content(\Openbuildings\Spiderling\Driver $driver, $filename, $title)
95		{
96	1	$content = $driver->content();
97
98	1	foreach (['href', 'action', 'src'] as $attribute) {
99	1	$content = self::to_absolute_attribute($attribute, $content, $this->_base_url);
100		}
101
102	1	$testview = self::render_file(__DIR__.'/../assets/error-page.php', [
103	1	'url' => $driver->current_url(),
104	1	'title' => $title,
105	1	'javascript_errors' => $driver->javascript_errors(),
106	1	'javascript_messages' => $driver->javascript_messages(),
107		]);
108
109	1	$page_content = str_replace('</body>', $testview.'</body>', $content);
110
111	1	file_put_contents($this->_directory."/$filename.html", $page_content);
112
113		try {
114	1	$driver->screenshot($this->_directory."/$filename.png");
115		} catch (\Openbuildings\Spiderling\Exception_Notimplemented $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-03-22 00:43 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
116		}
117	1	}
118
119		/**
120		* Implement PHPUnit\Framework\TestListener, save driver content if there was an error.
121		*
122		* @param \PHPUnit\Framework\Test $test
123		* @param \Exception $exception
124		* @param int $time
125		*/
126	1	public function addError(\PHPUnit\Framework\Test $test, \Exception $exception, $time)
127		{
128	1	if ($test instanceof TestCase and $test->is_driver_active() and $test->driver()->is_page_active()) {
129	1	$this->save_driver_content(
130	1	$test->driver(),
131	1	get_class($test).'_'.$test->getName(false),
132	1	$exception->getMessage()
133		);
134		}
135	1	}
136
137		/**
138		* Implement PHPUnit\Framework\TestListener, save driver content if there was an error.
139		*
140		* @param \PHPUnit\Framework\Test $test
141		* @param \PHPUnit\Framework\AssertionFailedError $failure
142		* @param int $time
143		*/
144	1	public function addFailure(\PHPUnit\Framework\Test $test, \PHPUnit\Framework\AssertionFailedError $failure, $time)
145		{
146	1	if ($test instanceof TestCase and $test->is_driver_active() and $test->driver()->is_page_active()) {
147	1	$this->save_driver_content(
148	1	$test->driver(),
149	1	get_class($test).'_'.$test->getName(false),
150	1	$failure->getMessage()
151		);
152		}
153	1	}
154
155		// @codeCoverageIgnoreStart
156		public function addWarning(\PHPUnit\Framework\Test $test, \PHPUnit\Framework\Warning $e, $time)
157		{
158		}
159
160		public function addRiskyTest(\PHPUnit\Framework\Test $test, \Exception $e, $time)
161		{
162		}
163
164		public function addIncompleteTest(\PHPUnit\Framework\Test $test, \Exception $e, $time)
165		{
166		}
167
168		public function addSkippedTest(\PHPUnit\Framework\Test $test, \Exception $e, $time)
169		{
170		}
171
172		public function startTest(\PHPUnit\Framework\Test $test)
173		{
174		}
175
176		public function endTest(\PHPUnit\Framework\Test $test, $time)
177		{
178		}
179
180		public function startTestSuite(\PHPUnit\Framework\TestSuite $suite)
181		{
182		}
183
184		public function endTestSuite(\PHPUnit\Framework\TestSuite $suite)
185		{
186		}
187
188		// @codeCoverageIgnoreEnd
189		}
190

OpenBuildings / phpunit-spiderling

Pull Request — master (#8)

SaveOnFailure::clear_directory() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like