Tvi\MonitorBundle\Controller\ApiController::testAction()

Complexity

Conditions	7
Paths	27

Size

Total Lines	35
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	56

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	ApiController::checkListAction()	0	32	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.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Tvi\MonitorBundle\Controller;

use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Tvi\MonitorBundle\Exception\HttpException;
use Tvi\MonitorBundle\Reporter\Api;
use Tvi\MonitorBundle\Reporter\ReporterManager;
use Tvi\MonitorBundle\Runner\RunnerManager;

/**

Missing short description in doc comment

 * @author Vladimir Turnaev <turnaev@gmail.com>
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class ApiController
{
    /**

Missing short description in doc comment

     * @var RunnerManager
     */
    protected $runnerManager;

    /**

Missing short description in doc comment

     * @var ReporterManager
     */
    protected $reporterManager;

    public function __construct(RunnerManager $runnerManager, ReporterManager $reporterManager)

Missing doc comment for function __construct()

    {
        $this->runnerManager = $runnerManager;
        $this->reporterManager = $reporterManager;
    }

    public function checkListAction(Request $request): JsonResponse

Missing doc comment for function checkListAction()

    {
        try {
            list($checks, $groups, $tags) = $this->getFilterParams($request);

            $runner = $this->runnerManager->getRunner($checks, $groups, $tags);

            $breakOnFailure = (boolean)$request->get('bof', false);
            $runner->setBreakOnFailure($breakOnFailure);

            /** @var $reporter Api */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            $reporter = $this->reporterManager->getReporter('api');

            $runner->addReporter($reporter);
            $runner->run();

            return new JsonResponse([

The opening parenthesis of a multi-line function call should be the last content on the line.

                'statusCode' => $reporter->getStatusCode(),
                'statusName' => $reporter->getStatusName(),

                'successes' => $reporter->getSuccessCount(),
                'warnings' => $reporter->getWarningCount(),
                'failures' => $reporter->getFailureCount(),
                'unknowns' => $reporter->getUnknownCount(),
                'total' => $reporter->getTotalCount(),

                'checks' => $reporter->getCheckResults(),
            ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        } catch (\Exception $e) {
            $e = new HttpException(404, $e->getMessage());

            return new JsonResponse($e->toArray(), $e->getStatusCode());
        }
    }

    public function checkAction(Request $request, string $check): JsonResponse

The parameter $request is not used and could be removed.

Missing doc comment for function checkAction()

    {
        try {
            $runner = $this->runnerManager->getRunner($check);

            /** @var $reporter Api */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            $reporter = $this->reporterManager->getReporter('api');

            $runner->addReporter($reporter);
            $runner->run($check);

            $res = $reporter->getCheckResults()[0];

            return new JsonResponse($res);
        } catch (\Exception $e) {
            $e = new HttpException(404, $e->getMessage());

            return new JsonResponse($e->toArray(), $e->getStatusCode());
        }
    }

    /**

Missing short description in doc comment

Parameter $request should have a doc-comment as per coding-style.

     * @return array [$checks, $groups, $tags],
     */
    private function getFilterParams(Request $request): array

Private method name "ApiController::getFilterParams" must be prefixed with an underscore

    {
        $checks = $request->get('check', []);
        if (\is_string($checks)) {
            $checks = $checks ? [$checks] : [];
        }

        $groups = $request->get('group', []);
        if (\is_string($groups)) {
            $groups = $groups ? [$groups] : [];
        }

        $tags = $request->get('tag', []);
        if (\is_string($tags)) {
            $tags = $tags ? [$tags] : [];
        }

        return [$checks, $groups, $tags];
    }
}