ReporterAbstract::onStopped() - Code Metrics - Inspection of "add web tests" - turnaev/monitor-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b086cb...c1a4fd )

by Vladimir

created 2018-10-04 11:31 UTC

ReporterAbstract::onStopped() A

↳ Parent: ReporterAbstract

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	0

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
eloc	0
dl	0
loc	2
ccs	0
cts	1
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?php

/**
 * This file is part of the `tvi/monitor-bundle` project.
 *
 * (c) https://github.com/turnaev/monitor-bundle/graphs/contributors
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */


namespace Tvi\MonitorBundle\Reporter;

use ZendDiagnostics\Result\FailureInterface;
use ZendDiagnostics\Result\ResultInterface;
use ZendDiagnostics\Result\SkipInterface;
use ZendDiagnostics\Result\SuccessInterface;
use ZendDiagnostics\Result\WarningInterface;
use ZendDiagnostics\Runner\Reporter\ReporterInterface;
use ZendDiagnostics\Check\CheckInterface;
use ZendDiagnostics\Result\Collection as ResultsCollection;

/**

 * @author Vladimir Turnaev <[email protected]>
 */

abstract class ReporterAbstract implements ReporterInterface
{
    public const STATUS_CODE_SUCCESS = 0;
    public const STATUS_CODE_WARNING = 100;
    public const STATUS_CODE_SKIP = 200;
    public const STATUS_CODE_UNKNOWN = 300;
    public const STATUS_CODE_FAILURE = 1000;

    public const STATUS_NAME_SUCCESS = 'SUCCESS';
    public const STATUS_NAME_WARNING = 'WARNING';
    public const STATUS_NAME_SKIP = 'SKIP';
    public const STATUS_NAME_UNKNOWN = 'UNKNOWN';
    public const STATUS_NAME_FAILURE = 'FAILURE';

    public static $STATUS_MAP = [
        self::STATUS_CODE_SUCCESS => self::STATUS_NAME_SUCCESS,
        self::STATUS_CODE_WARNING => self::STATUS_NAME_WARNING,
        self::STATUS_CODE_SKIP => self::STATUS_NAME_SKIP,
        self::STATUS_CODE_UNKNOWN => self::STATUS_NAME_UNKNOWN,
        self::STATUS_CODE_FAILURE => self::STATUS_NAME_FAILURE,
    ];

    /**
     * Total number of Checks.
     *
     * @var int
     */
    protected $totalCount = 0;

    /**
     * Has the Runner operation been aborted (stopped) ?
     *
     * @var bool
     */
    protected $stopped = false;

    /**

     * @var ResultsCollection
     */
    protected $results;

    public static function getStatusNameByCode(int $statusCode): string

    {
        return isset(self::$STATUS_MAP[$statusCode]) ? self::$STATUS_MAP[$statusCode] : self::STATUS_NAME_UNKNOWN;
    }

    /**
     * This method is called right after Reporter starts running, via Runner::run().
     *
     * @param ArrayObject $checks       A collection of Checks that will be performed

     * @param array       $runnerConfig Complete Runner configuration, obtained via Runner::getConfig()
     */

    public function onStart(\ArrayObject $checks, $runnerConfig)
    {
        $this->stopped = false;

        $this->totalCount = \count($checks);
    }

    /**
     * This method is called before each individual Check is performed. If this
     * method returns false, the Check will not be performed (will be skipped).
     *
     * @param CheckInterface $check      check instance that is about to be performed
     * @param string|null    $checkAlias The alias for the check that is about to be performed
     *
     * @return bool|void Return false to prevent check from happening
     */
    public function onBeforeRun(CheckInterface $check, $checkAlias = null)
    {
    }

    /**
     * This method is called every time a Check has been performed. If this method
     * returns false, the Runner will not perform any additional checks and stop
     * its run.
     *
     * @param CheckInterface  $check      A Check instance that has just finished running
     * @param ResultInterface $result     Result for that particular check instance
     * @param string|null     $checkAlias The alias for the check that has just finished
     *
     * @return bool|void Return false to prevent from running additional Checks
     */
    public function onAfterRun(CheckInterface $check, ResultInterface $result, $checkAlias = null)
    {
    }

    /**
     * This method is called when Runner has been aborted and could not finish the
     * whole run().
     *
     * @param ResultsCollection $results collection of Results for performed Checks
     */

    public function onStop(ResultsCollection $results)
    {
        $this->stopped = true;
    }

    /**
     * This method is called when Runner has finished its run.
     *
     * @param ResultsCollection $results collection of Results for performed Checks
     */

    public function onFinish(ResultsCollection $results)
    {
        $this->results = $results;

        // Display information that the test has been aborted.
        if ($this->stopped) {
            $this->onStopped();
        }
    }

    /**

     * @return int
     */
    public function getSuccessCount(): ?int
    {
        return $this->results ? $this->results->getSuccessCount() : null;
    }

    /**

     * @return int
     */
    public function getWarningCount(): ?int
    {
        return $this->results ? $this->results->getWarningCount() : null;
    }

    /**

     * @return int
     */
    public function getFailureCount(): ?int
    {
        return $this->results ? $this->results->getFailureCount() : null;
    }

    /**

     * @return int
     */
    public function getSkipCount(): ?int
    {
        return $this->results ? $this->results->getSkipCount() : null;
    }

    /**

     * @return int
     */
    public function getUnknownCount(): ?int
    {
        return $this->results ? $this->results->getUnknownCount() : null;
    }

    public function getTotalCount(): int

    {
        return $this->totalCount;
    }

    public function isStopped(): bool

    {
        return $this->stopped;
    }

    public function getResults(): ResultsCollection

    {
        return $this->results;
    }

    protected function onStopped()

    {
    }

    /**

     * @return array [name, code]
     */
    protected function getStatusByResul(ResultInterface $result)
    {
        switch (true) {
            case $result instanceof SuccessInterface:

                $name = self::STATUS_NAME_SUCCESS;
                $code = self::STATUS_CODE_SUCCESS;
                break;

            case $result instanceof WarningInterface:

                $name = self::STATUS_NAME_WARNING;
                $code = self::STATUS_CODE_WARNING;
                break;

            case $result instanceof SkipInterface:

                $name = self::STATUS_NAME_SKIP;
                $code = self::STATUS_CODE_SKIP;
                break;

            case $result instanceof FailureInterface:

                $name = self::STATUS_NAME_FAILURE;
                $code = self::STATUS_CODE_FAILURE;
                break;

            default:

                $name = self::STATUS_NAME_UNKNOWN;
                $code = self::STATUS_CODE_UNKNOWN;
                break;
        }

        return [$name, $code];
    }
}


1		<?php
2
3		/**
4		* This file is part of the `tvi/monitor-bundle` project.
5		*
6		* (c) https://github.com/turnaev/monitor-bundle/graphs/contributors
7		*
8		* For the full copyright and license information, please view the LICENSE.md
9		* file that was distributed with this source code.
10		*/
		0 ignored issues – show Coding Style introduced 2018-09-26 08:01 UTC by Report Bug Copy Issue Report PHP version not specified Loading history... Coding Style introduced 2018-09-26 08:01 UTC by Report Bug Copy Issue Report Missing @category tag in file comment Loading history... Coding Style introduced 2018-09-26 08:01 UTC by Report Bug Copy Issue Report Missing @package tag in file comment Loading history... Coding Style introduced 2018-09-26 08:01 UTC by Report Bug Copy Issue Report Missing @author tag in file comment Loading history... Coding Style introduced 2018-09-26 08:01 UTC by Report Bug Copy Issue Report Missing @license tag in file comment Loading history... Coding Style introduced 2018-09-26 08:01 UTC by Report Bug Copy Issue Report Missing @link tag in file comment Loading history...
11
12		namespace Tvi\MonitorBundle\Reporter;
13
14		use ZendDiagnostics\Result\FailureInterface;
15		use ZendDiagnostics\Result\ResultInterface;
16		use ZendDiagnostics\Result\SkipInterface;
17		use ZendDiagnostics\Result\SuccessInterface;
18		use ZendDiagnostics\Result\WarningInterface;
19		use ZendDiagnostics\Runner\Reporter\ReporterInterface;
20		use ZendDiagnostics\Check\CheckInterface;
21		use ZendDiagnostics\Result\Collection as ResultsCollection;
22
23		/**
		0 ignored issues – show Coding Style introduced 2018-10-01 07:39 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
24		* @author Vladimir Turnaev <[email protected]>
25		*/
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing @package tag in class comment Loading history... Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
26		abstract class ReporterAbstract implements ReporterInterface
27		{
28		public const STATUS_CODE_SUCCESS = 0;
29		public const STATUS_CODE_WARNING = 100;
30		public const STATUS_CODE_SKIP = 200;
31		public const STATUS_CODE_UNKNOWN = 300;
32		public const STATUS_CODE_FAILURE = 1000;
33
34		public const STATUS_NAME_SUCCESS = 'SUCCESS';
35		public const STATUS_NAME_WARNING = 'WARNING';
36		public const STATUS_NAME_SKIP = 'SKIP';
37		public const STATUS_NAME_UNKNOWN = 'UNKNOWN';
38		public const STATUS_NAME_FAILURE = 'FAILURE';
39
40		public static $STATUS_MAP = [
41		self::STATUS_CODE_SUCCESS => self::STATUS_NAME_SUCCESS,
42		self::STATUS_CODE_WARNING => self::STATUS_NAME_WARNING,
43		self::STATUS_CODE_SKIP => self::STATUS_NAME_SKIP,
44		self::STATUS_CODE_UNKNOWN => self::STATUS_NAME_UNKNOWN,
45		self::STATUS_CODE_FAILURE => self::STATUS_NAME_FAILURE,
46		];
47
48		/**
49		* Total number of Checks.
50		*
51		* @var int
52		*/
53		protected $totalCount = 0;
54
55		/**
56		* Has the Runner operation been aborted (stopped) ?
57		*
58		* @var bool
59		*/
60		protected $stopped = false;
61
62		/**
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
63		* @var ResultsCollection
64		*/
65		protected $results;
66
67	1	public static function getStatusNameByCode(int $statusCode): string
		0 ignored issues – show Coding Style introduced 2018-10-01 16:50 UTC by Report Bug Copy Issue Report Missing doc comment for function getStatusNameByCode() Loading history...
68		{
69	1	return isset(self::$STATUS_MAP[$statusCode]) ? self::$STATUS_MAP[$statusCode] : self::STATUS_NAME_UNKNOWN;
70		}
71
72		/**
73		* This method is called right after Reporter starts running, via Runner::run().
74		*
75		* @param ArrayObject $checks A collection of Checks that will be performed
		0 ignored issues – show Bug introduced 2018-10-03 08:48 UTC by Report Bug Copy Issue Report The type `Tvi\MonitorBundle\Reporter\ArrayObject` was not found. Did you mean `ArrayObject`? If so, make sure to prefix the type with `\`. Loading history...
76		* @param array $runnerConfig Complete Runner configuration, obtained via Runner::getConfig()
77		*/
		0 ignored issues – show Coding Style introduced 2018-10-02 10:56 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
78	1	public function onStart(\ArrayObject $checks, $runnerConfig)
79		{
80	1	$this->stopped = false;
81
82	1	$this->totalCount = \count($checks);
83	1	}
84
85		/**
86		* This method is called before each individual Check is performed. If this
87		* method returns false, the Check will not be performed (will be skipped).
88		*
89		* @param CheckInterface $check check instance that is about to be performed
90		* @param string\|null $checkAlias The alias for the check that is about to be performed
91		*
92		* @return bool\|void Return false to prevent check from happening
93		*/
94	1	public function onBeforeRun(CheckInterface $check, $checkAlias = null)
95		{
96	1	}
97
98		/**
99		* This method is called every time a Check has been performed. If this method
100		* returns false, the Runner will not perform any additional checks and stop
101		* its run.
102		*
103		* @param CheckInterface $check A Check instance that has just finished running
104		* @param ResultInterface $result Result for that particular check instance
105		* @param string\|null $checkAlias The alias for the check that has just finished
106		*
107		* @return bool\|void Return false to prevent from running additional Checks
108		*/
109		public function onAfterRun(CheckInterface $check, ResultInterface $result, $checkAlias = null)
110		{
111		}
112
113		/**
114		* This method is called when Runner has been aborted and could not finish the
115		* whole run().
116		*
117		* @param ResultsCollection $results collection of Results for performed Checks
118		*/
		0 ignored issues – show Coding Style introduced 2018-10-02 10:56 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
119		public function onStop(ResultsCollection $results)
120		{
121		$this->stopped = true;
122		}
123
124		/**
125		* This method is called when Runner has finished its run.
126		*
127		* @param ResultsCollection $results collection of Results for performed Checks
128		*/
		0 ignored issues – show Coding Style introduced 2018-10-02 10:56 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
129	8	public function onFinish(ResultsCollection $results)
130		{
131	8	$this->results = $results;
132
133		// Display information that the test has been aborted.
134	8	if ($this->stopped) {
135		$this->onStopped();
136		}
137	8	}
138
139		/**
		0 ignored issues – show Coding Style introduced 2018-10-04 11:37 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
140		* @return int
141		*/
142	1	public function getSuccessCount(): ?int
143		{
144	1	return $this->results ? $this->results->getSuccessCount() : null;
145		}
146
147		/**
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
148		* @return int
149		*/
150	1	public function getWarningCount(): ?int
151		{
152	1	return $this->results ? $this->results->getWarningCount() : null;
153		}
154
155		/**
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
156		* @return int
157		*/
158	1	public function getFailureCount(): ?int
159		{
160	1	return $this->results ? $this->results->getFailureCount() : null;
161		}
162
163		/**
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
164		* @return int
165		*/
166		public function getSkipCount(): ?int
167		{
168		return $this->results ? $this->results->getSkipCount() : null;
169		}
170
171		/**
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history...
172		* @return int
173		*/
174	1	public function getUnknownCount(): ?int
175		{
176	1	return $this->results ? $this->results->getUnknownCount() : null;
177		}
178
179	1	public function getTotalCount(): int
		0 ignored issues – show Coding Style introduced 2018-10-03 08:48 UTC by Report Bug Copy Issue Report Missing doc comment for function getTotalCount() Loading history...
180		{
181	1	return $this->totalCount;
182		}
183
184		public function isStopped(): bool
		0 ignored issues – show Coding Style introduced 2018-10-03 08:48 UTC by Report Bug Copy Issue Report Missing doc comment for function isStopped() Loading history...
185		{
186		return $this->stopped;
187		}
188
189		public function getResults(): ResultsCollection
		0 ignored issues – show Coding Style introduced 2018-10-03 08:48 UTC by Report Bug Copy Issue Report Missing doc comment for function getResults() Loading history...
190		{
191		return $this->results;
192		}
193
194		protected function onStopped()
		0 ignored issues – show Coding Style introduced 2018-10-04 11:37 UTC by Report Bug Copy Issue Report Missing doc comment for function onStopped() Loading history...
195		{
196		}
197
198		/**
		0 ignored issues – show Coding Style introduced 2018-10-04 11:37 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2018-10-01 16:50 UTC by Report Bug Copy Issue Report Parameter `$result` should have a doc-comment as per coding-style. Loading history...
199		* @return array [name, code]
200		*/
201	1	protected function getStatusByResul(ResultInterface $result)
202		{
203		switch (true) {
204	1	case $result instanceof SuccessInterface:
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
205	1	$name = self::STATUS_NAME_SUCCESS;
206	1	$code = self::STATUS_CODE_SUCCESS;
207	1	break;
208
209		case $result instanceof WarningInterface:
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
210		$name = self::STATUS_NAME_WARNING;
211		$code = self::STATUS_CODE_WARNING;
212		break;
213
214		case $result instanceof SkipInterface:
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
215		$name = self::STATUS_NAME_SKIP;
216		$code = self::STATUS_CODE_SKIP;
217		break;
218
219		case $result instanceof FailureInterface:
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
220		$name = self::STATUS_NAME_FAILURE;
221		$code = self::STATUS_CODE_FAILURE;
222		break;
223
224		default:
		0 ignored issues – show Coding Style introduced 2018-09-24 09:59 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
225		$name = self::STATUS_NAME_UNKNOWN;
226		$code = self::STATUS_CODE_UNKNOWN;
227		break;
228		}
229
230	1	return [$name, $code];
231		}
232		}
233

turnaev / monitor-bundle

Push — master ( b086cb...c1a4fd )

ReporterAbstract::onStopped() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like