AbstractBaseReporter::getConfiguration() - Code Metrics - Inspection of "When tests are focused via DSL, exit with a non-ze..." - peridot-php/peridot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#204)

by Erin

created 2017-01-09 01:02 UTC

AbstractBaseReporter::getConfiguration() A

↳ Parent: AbstractBaseReporter

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
namespace Peridot\Reporter;

use Evenement\EventEmitterInterface;
use Peridot\Configuration;
use Peridot\Core\HasEventEmitterTrait;
use Peridot\Core\Test;
use Peridot\Core\TestInterface;
use Peridot\Core\TestResult;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Output\StreamOutput;

/**
 * The base class for all Peridot reporters. Sits on top of an OutputInterface
 * and an EventEmitter in order to report Peridot results.
 *
 * @package Peridot\Reporter
 */
abstract class AbstractBaseReporter implements ReporterInterface
{
    use HasEventEmitterTrait;

    /**
     * @var \Peridot\Configuration
     */
    protected $configuration;

    /**
     * @var \Symfony\Component\Console\Output\OutputInterface
     */
    protected $output;

    /**
     * @var array
     */
    protected $errors = [];

    /**
     * @var int
     */
    protected $passing = 0;

    /**
     * @var int
     */
    protected $pending = 0;

    /**
     * @var double|integer
     */
    protected $time;

    /**
     * Maps color names to left and right color sequences.
     *
     * @var array
     */
    protected $colors = array(
        'white' => ['left' => "\033[37m", 'right' => "\033[39m"],
        'success' => ['left' => "\033[32m", 'right' => "\033[39m"],
        'error' => ['left' => "\033[31m", 'right' => "\033[39m"],
        'warning' => ['left' => "\033[33m", 'right' => "\033[39m"],
        'muted' => ['left' => "\033[90m", 'right' => "\033[0m"],
        'pending' => ['left' => "\033[36m", 'right' => "\033[39m"],
    );

    /**
     * Maps symbol names to symbols
     *
     * @var array
     */
    protected $symbols = array(
        'check' => '✓'
    );

    /**
     * @param Configuration $configuration
     * @param OutputInterface $output
     * @param EventEmitterInterface $eventEmitter
     */
    public function __construct(
        Configuration $configuration,
        OutputInterface $output,
        EventEmitterInterface $eventEmitter
    ) {
        $this->configuration = $configuration;
        $this->output = $output;
        $this->eventEmitter = $eventEmitter;

        $this->registerSymbols();

        $this->registerEvents();

        $this->init();
    }

    /**
     * Given a color name, colorize the provided text in that
     * color
     *
     * @param $key
     * @param $text
     * @return string
     */
    public function color($key, $text)
    {
        $colorsEnabled = $this->configuration->areColorsEnabled() && $this->hasColorSupport();
        $colorsEnabledExplicit = $this->configuration->areColorsEnabledExplicit();

        if (!$colorsEnabled && !$colorsEnabledExplicit) {
            return $text;
        }

        $color = $this->colors[$key];

        return sprintf("%s%s%s", $color['left'], $text, $color['right']);
    }

    /**
     * Fetch a symbol by name
     *
     * @param $name
     * @return string
     */
    public function symbol($name)
    {
        return $this->symbols[$name];
    }

    /**
     * Return the OutputInterface associated with the Reporter
     *
     * @return \Symfony\Component\Console\Output\OutputInterface
     */
    public function getOutput()
    {
        return $this->output;
    }

    /**
     * Return the Configuration associated with the Reporter
     *
     * @return \Peridot\Configuration
     */
    public function getConfiguration()
    {
        return $this->configuration;
    }

    /**
     * Set the run time to report.
     *
     * @param float $time
     */
    public function setTime($time)
    {
        $this->time = $time;
    }

    /**
     * Get the run time to report.
     *
     * @return float
     */
    public function getTime()
    {
        return $this->time;
    }

    /**
     * Output result footer
     */
    public function footer()
    {
        $this->output->write($this->color('success', sprintf("\n  %d passing", $this->passing)));
        $this->output->writeln(sprintf($this->color('muted', " (%s)"), \PHP_Timer::secondsToTimeString($this->getTime())));
        if (! empty($this->errors)) {
            $this->output->writeln($this->color('error', sprintf("  %d failing", count($this->errors))));
        }
        if ($this->pending) {
            $this->output->writeln($this->color('pending', sprintf("  %d pending", $this->pending)));
        }
        $this->output->writeln("");
        $errorCount = count($this->errors);
        for ($i = 0; $i < $errorCount; $i++) {
            list($test, $error) = $this->errors[$i];
            $this->outputError($i + 1, $test, $error);
            $this->output->writeln('');
        }
    }

    /**
     * Output result warnings
     *
     * @param TestResult $result
     */
    public function warnings(TestResult $result)
    {
        if ($result->isFocusedByDsl()) {
            $this->output->writeln($this->color('warning', 'WARNING: Tests have been focused programmatically.'));
        }
    }

    /**
     * Output a test failure.
     *
     * @param int $errorNumber
     * @param TestInterface $test
     * @param $exception - an exception like interface with ->getMessage(), ->getTrace()
     */
    protected function outputError($errorNumber, TestInterface $test, $exception)
    {
        $this->output->writeln(sprintf("  %d)%s:", $errorNumber, $test->getTitle()));

        $message = sprintf("     %s", str_replace(PHP_EOL, PHP_EOL . "     ", $exception->getMessage()));
        $this->output->writeln($this->color('error', $message));

        $location = sprintf('     at %s:%d', $exception->getFile(), $exception->getLine());
        $this->output->writeln($location);

        $this->outputTrace($exception->getTrace());
    }

    /**
     * Output a stack trace.
     *
     * @param array $trace
     */
    protected function outputTrace(array $trace)
    {
        foreach ($trace as $index => $entry) {
            if (isset($entry['class'])) {
                $function = $entry['class'] . $entry['type'] . $entry['function'];
            } else {
                $function = $entry['function'];
            }

            if (strncmp($function, 'Peridot\\', 8) === 0) {
                break;
            }

            $this->output->writeln($this->color('muted', $this->renderTraceEntry($index, $entry, $function)));
        }
    }

    /**
     * Determine if colorized output is supported by the reporters output.
     * Taken from Symfony's console output with some slight modifications
     * to use the reporter's output stream
     *
     * @return bool
     */
    protected function hasColorSupport()
    {
        if ($this->isOnWindows()) {
            return $this->hasAnsiSupport();
        }

        return $this->hasTty();
    }

    /**
     * Register reporter symbols, additionally checking OS compatibility.
     */
    protected function registerSymbols()
    {
        //update symbols for windows
        if ($this->isOnWindows()) {
            $this->symbols['check'] = chr(251);
        }
    }

    /**
     * Return true if reporter is being used on windows
     *
     * @return bool
     */
    protected function isOnWindows()
    {
        return DIRECTORY_SEPARATOR == '\\';
    }

    /**
     * Register events tracking state relevant to all reporters.
     */
    private function registerEvents()
    {
        $this->eventEmitter->on('runner.end', [$this, 'setTime']);

        $this->eventEmitter->on('test.failed', function (Test $test, $e) {
            $this->errors[] = [$test, $e];
        });

        $this->eventEmitter->on('test.passed', function () {
            $this->passing++;
        });

        $this->eventEmitter->on('test.pending', function () {
            $this->pending++;
        });
    }

    /**
     * Determine if the terminal has ansicon support
     *
     * @return bool
     */
    private function hasAnsiSupport()
    {
        return false !== getenv('ANSICON') || 'ON' === getenv('ConEmuANSI');
    }

    /**
     * Determine if reporter is reporting to a tty terminal.
     *
     * @return bool
     */
    private function hasTty()
    {
        if (! $this->output instanceof StreamOutput) {
            return false;
        }

        if (getenv("PERIDOT_TTY")) {
            return true;
        }

        return $this->isTtyTerminal($this->output);
    }

    /**
     * See if stream output is a tty terminal.
     *
     * @return bool
     */
    private function isTtyTerminal(StreamOutput $output)
    {
        $tty = function_exists('posix_isatty') && @posix_isatty($output->getStream());
        if ($tty) {
            putenv("PERIDOT_TTY=1");
        }
        return $tty;
    }

    /**
     * Initialize reporter. Setup and listen for events
     *
     * @return void
     */
    abstract public function init();

    private function renderTraceEntry($index, array $entry, $function)
    {
        if (isset($entry['file'])) {
            $location = sprintf(' (%s:%d)', $entry['file'], $entry['line']);
        } else {
            $location = '';
        }

        return sprintf('       #%d %s%s', $index, $function, $location);
    }
}


1			<?php
2			namespace Peridot\Reporter;
3
4			use Evenement\EventEmitterInterface;
5			use Peridot\Configuration;
6			use Peridot\Core\HasEventEmitterTrait;
7			use Peridot\Core\Test;
8			use Peridot\Core\TestInterface;
9			use Peridot\Core\TestResult;
10			use Symfony\Component\Console\Output\OutputInterface;
11			use Symfony\Component\Console\Output\StreamOutput;
12
13			/**
14			* The base class for all Peridot reporters. Sits on top of an OutputInterface
15			* and an EventEmitter in order to report Peridot results.
16			*
17			* @package Peridot\Reporter
18			*/
19			abstract class AbstractBaseReporter implements ReporterInterface
20			{
21			use HasEventEmitterTrait;
22
23			/**
24			* @var \Peridot\Configuration
25			*/
26			protected $configuration;
27
28			/**
29			* @var \Symfony\Component\Console\Output\OutputInterface
30			*/
31			protected $output;
32
33			/**
34			* @var array
35			*/
36			protected $errors = [];
37
38			/**
39			* @var int
40			*/
41			protected $passing = 0;
42
43			/**
44			* @var int
45			*/
46			protected $pending = 0;
47
48			/**
49			* @var double\|integer
50			*/
51			protected $time;
52
53			/**
54			* Maps color names to left and right color sequences.
55			*
56			* @var array
57			*/
58			protected $colors = array(
59			'white' => ['left' => "\033[37m", 'right' => "\033[39m"],
60			'success' => ['left' => "\033[32m", 'right' => "\033[39m"],
61			'error' => ['left' => "\033[31m", 'right' => "\033[39m"],
62			'warning' => ['left' => "\033[33m", 'right' => "\033[39m"],
63			'muted' => ['left' => "\033[90m", 'right' => "\033[0m"],
64			'pending' => ['left' => "\033[36m", 'right' => "\033[39m"],
65			);
66
67			/**
68			* Maps symbol names to symbols
69			*
70			* @var array
71			*/
72			protected $symbols = array(
73			'check' => '✓'
74			);
75
76			/**
77			* @param Configuration $configuration
78			* @param OutputInterface $output
79			* @param EventEmitterInterface $eventEmitter
80			*/
81			public function __construct(
82			Configuration $configuration,
83			OutputInterface $output,
84			EventEmitterInterface $eventEmitter
85			) {
86			$this->configuration = $configuration;
87			$this->output = $output;
88			$this->eventEmitter = $eventEmitter;
89
90			$this->registerSymbols();
91
92			$this->registerEvents();
93
94			$this->init();
95			}
96
97			/**
98			* Given a color name, colorize the provided text in that
99			* color
100			*
101			* @param $key
102			* @param $text
103			* @return string
104			*/
105			public function color($key, $text)
106			{
107			$colorsEnabled = $this->configuration->areColorsEnabled() && $this->hasColorSupport();
108			$colorsEnabledExplicit = $this->configuration->areColorsEnabledExplicit();
109
110			if (!$colorsEnabled && !$colorsEnabledExplicit) {
111			return $text;
112			}
113
114			$color = $this->colors[$key];
115
116			return sprintf("%s%s%s", $color['left'], $text, $color['right']);
117			}
118
119			/**
120			* Fetch a symbol by name
121			*
122			* @param $name
123			* @return string
124			*/
125			public function symbol($name)
126			{
127			return $this->symbols[$name];
128			}
129
130			/**
131			* Return the OutputInterface associated with the Reporter
132			*
133			* @return \Symfony\Component\Console\Output\OutputInterface
134			*/
135			public function getOutput()
136			{
137			return $this->output;
138			}
139
140			/**
141			* Return the Configuration associated with the Reporter
142			*
143			* @return \Peridot\Configuration
144			*/
145			public function getConfiguration()
146			{
147			return $this->configuration;
148			}
149
150			/**
151			* Set the run time to report.
152			*
153			* @param float $time
154			*/
155			public function setTime($time)
156			{
157			$this->time = $time;
158			}
159
160			/**
161			* Get the run time to report.
162			*
163			* @return float
164			*/
165			public function getTime()
166			{
167			return $this->time;
168			}
169
170			/**
171			* Output result footer
172			*/
173			public function footer()
174			{
175			$this->output->write($this->color('success', sprintf("\n %d passing", $this->passing)));
176			$this->output->writeln(sprintf($this->color('muted', " (%s)"), \PHP_Timer::secondsToTimeString($this->getTime())));
177			if (! empty($this->errors)) {
178			$this->output->writeln($this->color('error', sprintf(" %d failing", count($this->errors))));
179			}
180			if ($this->pending) {
181			$this->output->writeln($this->color('pending', sprintf(" %d pending", $this->pending)));
182			}
183			$this->output->writeln("");
184			$errorCount = count($this->errors);
185			for ($i = 0; $i < $errorCount; $i++) {
186			list($test, $error) = $this->errors[$i];
187			$this->outputError($i + 1, $test, $error);
188			$this->output->writeln('');
189			}
190			}
191
192			/**
193			* Output result warnings
194			*
195			* @param TestResult $result
196			*/
197			public function warnings(TestResult $result)
198			{
199			if ($result->isFocusedByDsl()) {
200			$this->output->writeln($this->color('warning', 'WARNING: Tests have been focused programmatically.'));
201			}
202			}
203
204			/**
205			* Output a test failure.
206			*
207			* @param int $errorNumber
208			* @param TestInterface $test
209			* @param $exception - an exception like interface with ->getMessage(), ->getTrace()
210			*/
211			protected function outputError($errorNumber, TestInterface $test, $exception)
212			{
213			$this->output->writeln(sprintf(" %d)%s:", $errorNumber, $test->getTitle()));
214
215			$message = sprintf(" %s", str_replace(PHP_EOL, PHP_EOL . " ", $exception->getMessage()));
216			$this->output->writeln($this->color('error', $message));
217
218			$location = sprintf(' at %s:%d', $exception->getFile(), $exception->getLine());
219			$this->output->writeln($location);
220
221			$this->outputTrace($exception->getTrace());
222			}
223
224			/**
225			* Output a stack trace.
226			*
227			* @param array $trace
228			*/
229			protected function outputTrace(array $trace)
230			{
231			foreach ($trace as $index => $entry) {
232			if (isset($entry['class'])) {
233			$function = $entry['class'] . $entry['type'] . $entry['function'];
234			} else {
235			$function = $entry['function'];
236			}
237
238			if (strncmp($function, 'Peridot\\', 8) === 0) {
239			break;
240			}
241
242			$this->output->writeln($this->color('muted', $this->renderTraceEntry($index, $entry, $function)));
243			}
244			}
245
246			/**
247			* Determine if colorized output is supported by the reporters output.
248			* Taken from Symfony's console output with some slight modifications
249			* to use the reporter's output stream
250			*
251			* @return bool
252			*/
253			protected function hasColorSupport()
254			{
255			if ($this->isOnWindows()) {
256			return $this->hasAnsiSupport();
257			}
258
259			return $this->hasTty();
260			}
261
262			/**
263			* Register reporter symbols, additionally checking OS compatibility.
264			*/
265			protected function registerSymbols()
266			{
267			//update symbols for windows
268			if ($this->isOnWindows()) {
269			$this->symbols['check'] = chr(251);
270			}
271			}
272
273			/**
274			* Return true if reporter is being used on windows
275			*
276			* @return bool
277			*/
278			protected function isOnWindows()
279			{
280			return DIRECTORY_SEPARATOR == '\\';
281			}
282
283			/**
284			* Register events tracking state relevant to all reporters.
285			*/
286			private function registerEvents()
287			{
288			$this->eventEmitter->on('runner.end', [$this, 'setTime']);
289
290			$this->eventEmitter->on('test.failed', function (Test $test, $e) {
291			$this->errors[] = [$test, $e];
292			});
293
294			$this->eventEmitter->on('test.passed', function () {
295			$this->passing++;
296			});
297
298			$this->eventEmitter->on('test.pending', function () {
299			$this->pending++;
300			});
301			}
302
303			/**
304			* Determine if the terminal has ansicon support
305			*
306			* @return bool
307			*/
308			private function hasAnsiSupport()
309			{
310			return false !== getenv('ANSICON') \|\| 'ON' === getenv('ConEmuANSI');
311			}
312
313			/**
314			* Determine if reporter is reporting to a tty terminal.
315			*
316			* @return bool
317			*/
318			private function hasTty()
319			{
320			if (! $this->output instanceof StreamOutput) {
321			return false;
322			}
323
324			if (getenv("PERIDOT_TTY")) {
325			return true;
326			}
327
328			return $this->isTtyTerminal($this->output);
329			}
330
331			/**
332			* See if stream output is a tty terminal.
333			*
334			* @return bool
335			*/
336			private function isTtyTerminal(StreamOutput $output)
337			{
338			$tty = function_exists('posix_isatty') && @posix_isatty($output->getStream());
339			if ($tty) {
340			putenv("PERIDOT_TTY=1");
341			}
342			return $tty;
343			}
344
345			/**
346			* Initialize reporter. Setup and listen for events
347			*
348			* @return void
349			*/
350			abstract public function init();
351
352			private function renderTraceEntry($index, array $entry, $function)
353			{
354			if (isset($entry['file'])) {
355			$location = sprintf(' (%s:%d)', $entry['file'], $entry['line']);
356			} else {
357			$location = '';
358			}
359
360			return sprintf(' #%d %s%s', $index, $function, $location);
361			}
362			}
363

peridot-php / peridot

Pull Request — master (#204)

AbstractBaseReporter::getConfiguration() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like