Tests for debug logger

Author: AydinHassan

app/config.php

@@ -98,7 +98,7 @@
         $globalDir = $c->get('phpschoolGlobalDir');
 
         if ($c->get('debugMode')) {
-            return new ConsoleLogger($c->get(OutputInterface::class));
+            return new ConsoleLogger($c->get(OutputInterface::class), $c->get(Color::class));
         }
 
         return new Logger("$globalDir/logs/$appName.log");

composer.json

@@ -30,7 +30,8 @@
         "php-school/keylighter": "^0.8.4",
         "nikic/php-parser": "^4.0",
         "guzzlehttp/guzzle": "^7.2",
-        "psr/log": "^1.1"
+        "psr/log": "^1.1",
+        "ext-json": "*"
     },
     "require-dev": {
         "composer/composer": "^2.0",

src/Application.php

@@ -223,9 +223,9 @@ public function run(): int
     {
         $args = $_SERVER['argv'] ?? [];
 
-        $debug = array_reduce($args, function (bool $debugEnabled, string $arg) {
-            return $debugEnabled || $arg === '--debug';
-        }, false);
+        $debug = any($args, function (string $arg) {
+            return $arg === '--debug';
+        });
 
         $args = array_values(array_filter($args, function (string $arg) {
             return $arg !== '--debug';

src/ExerciseRenderer.php

@@ -82,8 +82,6 @@ public function __construct(
      */
     public function __invoke(CliMenu $menu): void
     {
-        $menu->close();
-
         $item = $menu->getSelectedItem();
         $exercise = $this->exerciseRepository->findByName($item->getText());
         $exercises = $this->exerciseRepository->findAll();

src/Factory/MenuFactory.php

@@ -59,6 +59,7 @@ public function __invoke(ContainerInterface $c): CliMenu
             $builder->addItem(
                 $exercise->getName(),
                 function (CliMenu $menu) use ($exerciseRenderer, $eventDispatcher, $exercise) {
+                    $menu->close();
                     $this->dispatchExerciseSelectedEvent($eventDispatcher, $exercise);
                     $exerciseRenderer->__invoke($menu);
                 },

src/Logger/ConsoleLogger.php

@@ -4,6 +4,7 @@
 
 namespace PhpSchool\PhpWorkshop\Logger;
 
+use Colors\Color;
 use PhpSchool\PhpWorkshop\Output\OutputInterface;
 use Psr\Log\AbstractLogger;
 use Psr\Log\LoggerInterface;
@@ -15,19 +16,29 @@ class ConsoleLogger extends AbstractLogger implements LoggerInterface
      */
     private $output;
 
-    public function __construct(OutputInterface $output)
+    /**
+     * @var Color
+     */
+    private $color;
+
+    public function __construct(OutputInterface $output, Color $color)
     {
         $this->output = $output;
+        $this->color = $color;
     }
 
     public function log($level, $message, array $context = []): void
     {
-        $this->output->writeLine(sprintf(
-            "Time: %s, Level: %s, Message: %s, Context: %s",
-            (new \DateTime())->format('d-m-y H:i:s'),
-            $level,
-            $message,
-            json_encode($context)
-        ));
+        $parts = [
+            sprintf(
+                '%s - %s - %s',
+                $this->color->fg('yellow', (new \DateTime())->format('H:i:s')),
+                $this->color->bg('red', strtoupper($level)),
+                $this->color->fg('red', $message)
+            ),
+            json_encode($context, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT)
+        ];
+
+        $this->output->writeLine(implode("\n", $parts));
     }
 }

src/functions.php

@@ -73,3 +73,14 @@ function collect(array $array): Collection
         return new Collection($array);
     }
 }
+
+
+if (!function_exists('any')) {
+
+    function any(array $values, callable $cb): bool
+    {
+        return array_reduce($values, function (bool $carry, $value) use ($cb) {
+            return $carry || $cb($value);
+        }, false);
+    }
+}

test/ApplicationTest.php

@@ -15,6 +15,9 @@
 use PhpSchool\PhpWorkshopTest\Asset\MockEventDispatcher;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
+use PhpSchool\PhpWorkshop\Logger\ConsoleLogger;
+use PhpSchool\PhpWorkshop\Logger\Logger;
+use PHPUnit\Framework\TestCase;
 
 class ApplicationTest extends BaseTest
 {
@@ -53,7 +56,7 @@ public function testEventListenersFromLocalAndWorkshopConfigAreMerged(): void
         $rp->setAccessible(true);
         $rp->setValue($app, $frameworkFile);
 
-        $container = $rm->invoke($app);
+        $container = $rm->invoke($app, false);
 
         $eventListeners = $container->get('eventListeners');
 
@@ -162,8 +165,26 @@ public function testConfigureReturnsSameContainerInstance(): void
         self::assertSame($application->configure(), $application->configure());
     }
 
-    public function tearDown(): void
+    public function testDebugFlagSwitchesLoggerToConsoleLogger(): void
     {
-        parent::tearDown();
+        $app = new Application('My workshop', __DIR__ . '/../app/config.php');
+
+        $frameworkFile = sprintf('%s/%s', sys_get_temp_dir(), uniqid($this->getName(), true));
+        file_put_contents($frameworkFile, '<?php return []; ');
+
+        $rp = new \ReflectionProperty(Application::class, 'frameworkConfigLocation');
+        $rp->setAccessible(true);
+        $rp->setValue($app, $frameworkFile);
+
+        $rm = new \ReflectionMethod($app, 'getContainer');
+        $rm->setAccessible(true);
+
+        $container = $rm->invoke($app, true);
+
+        $container->set('phpschoolGlobalDir', $this->getTemporaryDirectory());
+        $container->set('appName', 'my-workshop');
+
+        $logger = $container->get(LoggerInterface::class);
+        self::assertInstanceOf(ConsoleLogger::class, $logger);
     }
 }

test/BaseTest.php

@@ -16,10 +16,8 @@ abstract class BaseTest extends TestCase
     public function getTemporaryDirectory(): string
     {
         if (!$this->tempDirectory) {
-            $tempDirectory = System::tempDir($this->getName());
-            mkdir($tempDirectory, 0777, true);
-
-            $this->tempDirectory = realpath($tempDirectory);
+            $this->tempDirectory = System::tempDir($this->getName());
+            mkdir($this->tempDirectory, 0777, true);
         }
 
         return $this->tempDirectory;

test/ExerciseRendererTest.php

@@ -33,10 +33,6 @@ public function testExerciseRendererSetsCurrentExerciseAndRendersExercise(): voi
             ->method('getSelectedItem')
             ->willReturn($item);
 
-        $menu
-            ->expects($this->once())
-            ->method('close');
-
         $exercise1 = $this->createMock(ExerciseInterface::class);
         $exercise2 = $this->createMock(ExerciseInterface::class);
         $exercises = [$exercise1, $exercise2];