Add logging to initial code listener

Author: AydinHassan

app/config.php

@@ -87,6 +87,9 @@
 return [
     'appName' => basename($_SERVER['argv'][0]),
     'phpschoolGlobalDir' => sprintf('%s/.php-school', getenv('HOME')),
+    'currentWorkingDirectory' => function (ContainerInterface $c) {
+        return getcwd();
+    },
     WorkshopType::class => WorkshopType::STANDARD(),
     Psr\Log\LoggerInterface::class => function (ContainerInterface $c) {
         $appName = $c->get('appName');
@@ -212,7 +215,7 @@
 
     //Listeners
     InitialCodeListener::class => function (ContainerInterface $c) {
-        return new InitialCodeListener(getcwd());
+        return new InitialCodeListener($c->get('currentWorkingDirectory'), $c->get(LoggerInterface::class));
     },
     PrepareSolutionListener::class => create(),
     CodePatchListener::class => function (ContainerInterface $c) {

src/Listener/InitialCodeListener.php

@@ -5,8 +5,10 @@
 namespace PhpSchool\PhpWorkshop\Listener;
 
 use PhpSchool\PhpWorkshop\Event\Event;
+use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Exercise\ProvidesInitialCode;
 use PhpSchool\PhpWorkshop\Solution\SolutionFile;
+use Psr\Log\LoggerInterface;
 
 /**
  * Copy over any initial files for this exercise when
@@ -22,16 +24,23 @@ class InitialCodeListener
      */
     private $workingDirectory;
 
-    public function __construct(string $workingDirectory)
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    public function __construct(string $workingDirectory, LoggerInterface $logger)
     {
         $this->workingDirectory = $workingDirectory;
+        $this->logger = $logger;
     }
 
     /**
      * @param Event $event
      */
     public function __invoke(Event $event): void
     {
+        /** @var ExerciseInterface $exercise */
         $exercise = $event->getParameter('exercise');
 
         if (!$exercise instanceof ProvidesInitialCode) {
@@ -42,7 +51,19 @@ public function __invoke(Event $event): void
             /** @var SolutionFile $file */
             if (!file_exists($this->workingDirectory . '/' . $file->getRelativePath())) {
                 copy($file->getAbsolutePath(), $this->workingDirectory . '/' . $file->getRelativePath());
+                $message = 'File successfully copied to working directory';
+            } else {
+                $message = 'File not copied. File with same name already exists in working directory';
             }
+
+            $this->logger->debug(
+                $message,
+                [
+                    'exercise' => $exercise->getName(),
+                    'workingDir' => $this->workingDirectory,
+                    'file' => $file->getAbsolutePath()
+                ]
+            );
         }
     }
 }

test/Asset/ExerciseWithInitialCode.php

@@ -13,7 +13,7 @@ class ExerciseWithInitialCode implements ExerciseInterface, ProvidesInitialCode
 {
     public function getName(): string
     {
-        // TODO: Implement getName() method.
+        return 'exercise-with-initial-code';
     }
 
     public function getDescription(): string

test/Listener/InitialCodeListenerTest.php

@@ -8,27 +8,16 @@
 use PhpSchool\PhpWorkshop\Listener\InitialCodeListener;
 use PhpSchool\PhpWorkshopTest\Asset\CliExerciseImpl;
 use PhpSchool\PhpWorkshopTest\Asset\ExerciseWithInitialCode;
-use PHPUnit\Framework\TestCase;
-use Symfony\Component\Filesystem\Filesystem;
+use PhpSchool\PhpWorkshopTest\ContainerAwareTest;
 
-class InitialCodeListenerTest extends TestCase
+class InitialCodeListenerTest extends ContainerAwareTest
 {
-    /**
-     * @var Filesystem
-     */
-    private $filesystem;
-
-    /**
-     * @var string
-     */
-    private $cwd;
-
     public function setUp(): void
     {
-        $this->filesystem = new Filesystem();
+        parent::setUp();
 
-        $this->cwd = sprintf('%s/%s', str_replace('\\', '/', sys_get_temp_dir()), $this->getName());
-        mkdir($this->cwd, 0775, true);
+        $this->mockCurrentWorkingDirectory();
+        $this->mockLogger();
     }
 
     public function testExerciseCodeIsCopiedIfExerciseProvidesInitialCode(): void
@@ -37,30 +26,67 @@ public function testExerciseCodeIsCopiedIfExerciseProvidesInitialCode(): void
 
         $event = new Event('exercise.selected', ['exercise' => $exercise]);
 
-        $listener = new InitialCodeListener($this->cwd);
+        $listener = $this->container->get(InitialCodeListener::class);
         $listener->__invoke($event);
 
-        $this->assertFileExists($this->cwd . '/init-solution.php');
+        $this->assertFileExists($this->getCurrentWorkingDirectory() . '/init-solution.php');
         $this->assertFileEquals(
             $exercise->getInitialCode()->getFiles()[0]->getAbsolutePath(),
-            $this->cwd . '/init-solution.php'
+            $this->getCurrentWorkingDirectory() . '/init-solution.php'
+        );
+
+        $this->assertLoggerHasMessages(
+            [
+                [
+                    'level' => 'debug',
+                    'message' => 'File successfully copied to working directory',
+                    'context' => [
+                        'exercise' => 'exercise-with-initial-code',
+                        'workingDir' => $this->getCurrentWorkingDirectory(),
+                        'file' => $exercise->getInitialCode()->getFiles()[0]->getAbsolutePath()
+                    ]
+                ]
+            ]
         );
     }
 
-    public function testExerciseCodeIsNotCopiedIfExerciseDoesNotProvideInitialCode(): void
+    public function testExerciseCodeIsNotCopiedIfFileWithSameNameExistsInWorkingDirectory(): void
     {
-        $exercise = new CliExerciseImpl();
+        $exercise = new ExerciseWithInitialCode();
 
         $event = new Event('exercise.selected', ['exercise' => $exercise]);
 
-        $listener = new InitialCodeListener($this->cwd);
+        touch($this->getCurrentWorkingDirectory() . '/init-solution.php');
+
+        $listener = $this->container->get(InitialCodeListener::class);
         $listener->__invoke($event);
 
-        $this->assertEmpty(array_diff(scandir($this->cwd), ['.', '..']));
+        $this->assertFileExists($this->getCurrentWorkingDirectory() . '/init-solution.php');
+
+        $this->assertLoggerHasMessages(
+            [
+                [
+                    'level' => 'debug',
+                    'message' => 'File not copied. File with same name already exists in working directory',
+                    'context' => [
+                        'exercise' => 'exercise-with-initial-code',
+                        'workingDir' => $this->getCurrentWorkingDirectory(),
+                        'file' => $exercise->getInitialCode()->getFiles()[0]->getAbsolutePath()
+                    ]
+                ]
+            ]
+        );
     }
 
-    public function tearDown(): void
+    public function testExerciseCodeIsNotCopiedIfExerciseDoesNotProvideInitialCode(): void
     {
-        $this->filesystem->remove($this->cwd);
+        $exercise = new CliExerciseImpl();
+
+        $event = new Event('exercise.selected', ['exercise' => $exercise]);
+
+        $listener = $this->container->get(InitialCodeListener::class);
+        $listener->__invoke($event);
+
+        $this->assertEmpty(array_diff(scandir($this->getCurrentWorkingDirectory()), ['.', '..']));
     }
 }