Merge pull request #73 from kbond/extra-reporters

Added ability to define extra reporters for use in command/controller

Author: kbond

Command/HealthCheckCommand.php

@@ -4,6 +4,7 @@
 
 use Liip\MonitorBundle\Helper\ConsoleReporter;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
@@ -21,6 +22,12 @@ protected function configure()
                     InputArgument::OPTIONAL,
                     'The name of the service to be used to perform the health check.'
                 ),
+                new InputOption(
+                    'reporter',
+                    InputOption::VALUE_IS_ARRAY,
+                    'Additional reporters to run.',
+                    array()
+                )
             ));
     }
 
@@ -29,6 +36,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $checkName = $input->getArgument('checkName');
         $runner = $this->getContainer()->get('liip_monitor.runner');
         $runner->addReporter(new ConsoleReporter($output));
+        $runner->useAdditionalReporters($input->getOption('reporter'));
 
         if (0 === count($runner->getChecks())) {
             $output->writeln('<error>No checks configured.</error>');

Controller/HealthCheckController.php

@@ -6,7 +6,7 @@
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use ZendDiagnostics\Runner\Runner;
+use Liip\MonitorBundle\Runner;
 use Liip\MonitorBundle\Helper\PathHelper;
 
 class HealthCheckController
@@ -70,11 +70,12 @@ public function listAction()
     }
 
     /**
+     * @param  Request                                    $request
      * @return \Symfony\Component\HttpFoundation\Response
      */
-    public function runAllChecksAction()
+    public function runAllChecksAction(Request $request)
     {
-        $report = $this->runTests();
+        $report = $this->runTests($request);
 
         return new JsonResponse(array(
             'checks' => $report->getResults(),
@@ -84,23 +85,32 @@ public function runAllChecksAction()
 
     /**
      * @param  string                                     $checkId
+     * @param  Request                                    $request
      * @return \Symfony\Component\HttpFoundation\Response
      */
-    public function runSingleCheckAction($checkId)
+    public function runSingleCheckAction($checkId, Request $request)
     {
-        $results = $this->runTests($checkId)->getResults();
+        $results = $this->runTests($request, $checkId)->getResults();
 
         return new JsonResponse($results[0]);
     }
 
     /**
+     * @param  Request       $request
      * @param  string|null   $checkId
      * @return ArrayReporter
      */
-    protected function runTests($checkId = null)
+    protected function runTests(Request $request, $checkId = null)
     {
+        $reporters = $request->query->get('reporters', array());
+
+        if (!is_array($reporters)) {
+            $reporters = array($reporters);
+        }
+
         $reporter = new ArrayReporter();
         $this->runner->addReporter($reporter);
+        $this->runner->useAdditionalReporters($reporters);
         $this->runner->run($checkId);
 
         return $reporter;

DependencyInjection/Compiler/AdditionalReporterCompilerPass.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Liip\MonitorBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+class AdditionalReporterCompilerPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        if (false === $container->hasDefinition('liip_monitor.runner')) {
+            return;
+        }
+
+        $definition = $container->getDefinition('liip_monitor.runner');
+
+        foreach ($container->findTaggedServiceIds('liip_monitor.additional_reporter') as $id => $tags) {
+            foreach ($tags as $attributes) {
+                $alias = empty($attributes['alias']) ? $id : $attributes['alias'];
+                $definition->addMethodCall('addAdditionalReporter', array($alias, new Reference($id)));
+            }
+        }
+    }
+}

README.md

@@ -83,6 +83,7 @@ liip_monitor:
     checks:
         php_extensions: [apc, xdebug]
 ```
+
 ## Adding Health Checks ##
 
 Once you implemented the class then it's time to register the check service with our service container:
@@ -102,7 +103,6 @@ as long as the service is properly tagged. The ``alias`` is optional and will th
 define the ``id`` used when running health checks individually, otherwise the full service
 id must be used in this case.
 
-
 ## Available Health Checks ##
 
 On top of all the checks provided by the ZendDiagnostics library this Bundle adds the following
@@ -192,6 +192,28 @@ To run health checks as a composer post-install or post-update script, simply ad
 },
 ```
 
+## Adding Additional Reporters ##
+
+There are two default reporters: `ArrayReporter` for the REST API and `ConsoleReporter` for the CLI command. You can
+add additional reporters to be used by either of these.
+
+First, define an additional reporter service and tag it with `liip_monitor.additional_reporter`:
+
+```
+my_reporter:
+    class: My\Reporter
+    tags:
+        - { name: liip_monitor.additional_reporter, alias: my_reporter }
+```
+
+To run additional reporters with the CLI, add `--reporter=...` options for each one:
+
+    $ ./app/console monitor:health --reporter=my_reporter
+
+To run this reporter with the REST API, add a `reporters` query parameter:
+
+    /monitor/health?reporters[]=my_reporter
+
 ## Full Default Config ##
 
 ```yaml

Resources/config/runner.xml

@@ -5,7 +5,7 @@
            xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
     <parameters>
-        <parameter key="liip_monitor.runner.class">ZendDiagnostics\Runner\Runner</parameter>
+        <parameter key="liip_monitor.runner.class">Liip\MonitorBundle\Runner</parameter>
     </parameters>
 
     <services>

Runner.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Liip\MonitorBundle;
+
+use ZendDiagnostics\Runner\Reporter\ReporterInterface;
+use ZendDiagnostics\Runner\Runner as BaseRunner;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+class Runner extends BaseRunner
+{
+    private $additionalReporters = array();
+
+    /**
+     * @param string            $alias
+     * @param ReporterInterface $reporter
+     */
+    public function addAdditionalReporter($alias, ReporterInterface $reporter)
+    {
+        $this->additionalReporters[$alias] = $reporter;
+    }
+
+    /**
+     * @param array $aliases
+     */
+    public function useAdditionalReporters(array $aliases)
+    {
+        foreach ($this->additionalReporters as $alias => $reporter) {
+            if (in_array($alias, $aliases)) {
+                $this->addReporter($reporter);
+            }
+        }
+    }
+}

Tests/DependencyInjection/Compiler/AdditionalReporterCompilerPassTest.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace Liip\MonitorBundle\Tests\DependencyInjection\Compiler;
+
+use Liip\MonitorBundle\DependencyInjection\Compiler\AdditionalReporterCompilerPass;
+use Matthias\SymfonyDependencyInjectionTest\PhpUnit\AbstractCompilerPassTestCase;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+class AdditionalReporterCompilerPassTest extends AbstractCompilerPassTestCase
+{
+    public function testProcessWithAlias()
+    {
+        $runner = new Definition();
+        $this->setDefinition('liip_monitor.runner', $runner);
+
+        $reporter = new Definition();
+        $reporter->addTag('liip_monitor.additional_reporter', array('alias' => 'foo'));
+        $this->setDefinition('foo_reporter', $reporter);
+
+        $this->compile();
+
+        $this->assertContainerBuilderHasServiceDefinitionWithMethodCall(
+            'liip_monitor.runner',
+            'addAdditionalReporter',
+            array(
+                'foo',
+                new Reference('foo_reporter')
+            )
+        );
+    }
+
+    public function testProcessWithoutAlias()
+    {
+        $runner = new Definition();
+        $this->setDefinition('liip_monitor.runner', $runner);
+
+        $reporter = new Definition();
+        $reporter->addTag('liip_monitor.additional_reporter');
+        $this->setDefinition('foo_reporter', $reporter);
+
+        $this->compile();
+
+        $this->assertContainerBuilderHasServiceDefinitionWithMethodCall(
+            'liip_monitor.runner',
+            'addAdditionalReporter',
+            array(
+                'foo_reporter',
+                new Reference('foo_reporter')
+            )
+        );
+    }
+
+    protected function registerCompilerPass(ContainerBuilder $container)
+    {
+        $container->addCompilerPass(new AdditionalReporterCompilerPass());
+    }
+}

Tests/RunnerTest.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Liip\MonitorBundle\Tests;
+
+use Liip\MonitorBundle\Runner;
+use ZendDiagnostics\Runner\Reporter\ReporterInterface;
+
+/**
+ * @author Kevin Bond <kevinbond@gmail.com>
+ */
+class RunnerTest extends \PHPUnit_Framework_TestCase
+{
+    public function testAdditionalReporters()
+    {
+        $runner = new Runner();
+
+        $this->assertCount(0, $runner->getReporters());
+
+        $runner->addAdditionalReporter('foo', $this->createMockReporter());
+        $runner->addAdditionalReporter('bar', $this->createMockReporter());
+
+        $this->assertCount(0, $runner->getReporters());
+
+        $runner->useAdditionalReporters(array('baz'));
+
+        $this->assertCount(0, $runner->getReporters());
+
+        $runner->useAdditionalReporters(array('foo'));
+
+        $this->assertCount(1, $runner->getReporters());
+
+        $runner->useAdditionalReporters(array('bar'));
+
+        $this->assertCount(2, $runner->getReporters());
+
+        $runner = new Runner();
+        $runner->addAdditionalReporter('foo', $this->createMockReporter());
+        $runner->addAdditionalReporter('bar', $this->createMockReporter());
+        $runner->useAdditionalReporters(array('bar', 'foo'));
+
+        $this->assertCount(2, $runner->getReporters());
+    }
+
+    /**
+     * @return ReporterInterface
+     */
+    private function createMockReporter()
+    {
+        return $this->getMock('ZendDiagnostics\Runner\Reporter\ReporterInterface');
+    }
+}