Liip\MonitorBundle\Controller\HealthCheckController

Complexity

Total Complexity

24

Size/Duplication

Total Lines	244
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes	12
Bugs	2	Features	4

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
B	indexAction()	0	29	1
A	listAction()	0	12	2
A	listAllAction()	0	12	3
A	listGroupsAction()	0	6	1
A	runAllChecksAction()	0	9	1
A	runAllChecksHttpStatusAction()	0	9	2
A	runSingleCheckHttpStatusAction()	0	9	2
A	runSingleCheckAction()	0	6	1
A	runTests()	0	19	2
A	statusIsNotOK()	0	4	1
A	logTestStatus()	0	11	2
A	getRunner()	0	12	2
A	getGroup()	0	4	2

<?php

namespace Liip\MonitorBundle\Controller;

use Liip\MonitorBundle\Helper\ArrayReporter;
use Liip\MonitorBundle\Helper\RunnerManager;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Liip\MonitorBundle\Runner;
use Liip\MonitorBundle\Helper\PathHelper;

class HealthCheckController
{
    protected $runnerManager;
    protected $pathHelper;
    protected $template;

    /**
     * @var Psr\Log\LoggerInterface $log
     */
    protected $log;

    /**
     * @param RunnerManager $runnerManager
     * @param PathHelper    $pathHelper
     * @param               $template
     */
    public function __construct(RunnerManager $runnerManager, PathHelper $pathHelper, $template, LoggerInterface $log = null)
    {
        $this->runnerManager = $runnerManager;
        $this->pathHelper = $pathHelper;
        $this->template = $template;
        if ($log === null) {
            $log = new NullLogger();
        }
        $this->log = $log;

It seems like $log of type object<Psr\Log\LoggerInterface> is incompatible with the declared type object<Liip\MonitorBundle\Controller\Psr\Log\LoggerInterface> of property $log.

    }

    /**
     * @param \Symfony\Component\HttpFoundation\Request $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function indexAction(Request $request)
    {
        $group = $this->getGroup($request);

        $urls = $this->pathHelper->getRoutesJs(array(
            'liip_monitor_run_all_checks' => array('group' => $group),
            'liip_monitor_run_single_check' => array('checkId' => 'replaceme', 'group' => $group),
        ));

        $css = $this->pathHelper->getStyleTags(array(
            'bundles/liipmonitor/css/bootstrap/css/bootstrap.min.css',
            'bundles/liipmonitor/css/style.css',
        ));

        $javascript = $this->pathHelper->getScriptTags(array(
            'bundles/liipmonitor/javascript/jquery-1.7.1.min.js',
            'bundles/liipmonitor/javascript/ember-0.9.5.min.js',
            'bundles/liipmonitor/javascript/app.js',
        ));

        // this is a hack to make the bundle template agnostic.
        // URL generation for Assets and Routes is still handled by the framework.
        ob_start();
        include $this->template;
        $content = ob_get_clean();

        $this->log->debug('HealthCheckController | index');
        return new Response($content, 200, array('Content-Type' => 'text/html'));
    }

    /**
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function listAction(Request $request)
    {
        $ret = array();

        $runner = $this->getRunner($request);

        foreach ($runner->getChecks() as $alias => $check) {
            $ret[] = $alias;
        }

        return new JsonResponse($ret);
    }

    /**
     * @return JsonResponse
     */
    public function listAllAction()
    {
        $allChecks = array();

        foreach ($this->runnerManager->getRunners() as $group => $runner) {
            foreach ($runner->getChecks() as $alias => $check) {
                $allChecks[$group][] = $alias;
            }
        }

        return new JsonResponse($allChecks);
    }

    /**
     * @return JsonResponse
     */
    public function listGroupsAction()
    {
        $groups = $this->runnerManager->getGroups();

        return new JsonResponse($groups);
    }

    /**
     * @param Request $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function runAllChecksAction(Request $request)
    {
        $report = $this->runTests($request);

        return new JsonResponse(array(
            'checks' => $report->getResults(),
            'globalStatus' => $report->getGlobalStatus(),
        ));
    }

    /**
     * @param Request $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function runAllChecksHttpStatusAction(Request $request)
    {
        $report = $this->runTests($request);

        return new Response(
            '',
            ($report->getGlobalStatus() === ArrayReporter::STATUS_OK ? 200 : 502)
        );
    }

    /**
     * @param string  $checkId
     * @param Request $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function runSingleCheckHttpStatusAction($checkId, Request $request)
    {
        $report = $this->runTests($request, $checkId);

        return new Response(
            '',
            ($report->getGlobalStatus() === ArrayReporter::STATUS_OK ? 200 : 502)
        );
    }

    /**
     * @param string  $checkId
     * @param Request $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function runSingleCheckAction($checkId, Request $request)
    {
        $results = $this->runTests($request, $checkId)->getResults();

        return new JsonResponse($results[0]);
    }

    /**
     * @param Request     $request
     * @param string|null $checkId
     *
     * @return ArrayReporter
     */
    protected function runTests(Request $request, $checkId = null)
    {
        $reporters = $request->query->get('reporters', array());

        if (!is_array($reporters)) {
            $reporters = array($reporters);
        }

        $reporter = new ArrayReporter();

        $runner = $this->getRunner($request);

        $runner->addReporter($reporter);
        $runner->useAdditionalReporters($reporters);
        $runner->run($checkId);

        $this->logTestStatus($reporter->getGlobalStatus() === ArrayReporter::STATUS_OK, $reporter);
        return $reporter;
    }

    private function statusIsNotOK(array $resultItem)
    {
        return $resultItem['status'] !== 0;
    }

    /**
     * Send results to the Log.
     *
     * @param boolean       $isOK     Did all the checks all returned OK?
     * @param ArrayReporter $reporter Details of the tests
     *
     * @return void
     */
    private function logTestStatus($isOK, ArrayReporter $reporter)
    {
        if ($isOK) {
            $this->log->debug('HealthCheckController | runTests, OK');
            return;
        }

        $failures = array_filter($reporter->getResults(), array($this, 'statusIsNotOK'));
        $jsonStr = json_encode($failures);
        $this->log->alert('HealthCheckController | runTests, FAILURE | ' . $jsonStr);
    }

    /**
     * @param Request $request
     *
     * @return Runner
     *
     * @throws \Exception
     */
    private function getRunner(Request $request)
    {
        $group = $this->getGroup($request);

        $runner = $this->runnerManager->getRunner($group);

        if ($runner) {
            return $runner;
        }

        throw new \RuntimeException(sprintf('Unknown check group "%s"', $group));
    }

    /**
     * @param Request $request
     *
     * @return string
     */
    private function getGroup(Request $request)
    {
        return $request->query->get('group') ?: $this->runnerManager->getDefaultGroup();
    }
}