Listener to realpath program file - only in runners which need it

Author: AydinHassan

app/config.php

@@ -30,6 +30,7 @@
 use PhpSchool\PhpWorkshop\Listener\CodePatchListener;
 use PhpSchool\PhpWorkshop\Listener\ConfigureCommandListener;
 use PhpSchool\PhpWorkshop\Listener\PrepareSolutionListener;
+use PhpSchool\PhpWorkshop\Listener\RealPathListener;
 use PhpSchool\PhpWorkshop\Listener\SelfCheckListener;
 use PhpSchool\PhpWorkshop\MenuItem\ResetProgress;
 use PhpSchool\PhpWorkshop\Output\OutputInterface;
@@ -197,6 +198,7 @@
             $c->get(RunnerManager::class)
         );
     },
+    RealPathListener::class => object(),
 
     //checks
     FileExistsCheck::class              => object(),
@@ -281,6 +283,20 @@
     ],
     'appContributors' => [],
     'eventListeners'  => [
+        'realpath-student-submission' => [
+            'cli.verify.start' => [
+                containerListener(RealPathListener::class)
+            ],
+            'cli.run.start' => [
+                containerListener(RealPathListener::class)
+            ],
+            'cgi.verify.start' => [
+                containerListener(RealPathListener::class)
+            ],
+            'cgi.run.start' => [
+                containerListener(RealPathListener::class)
+            ]
+        ],
         'check-exercise-assigned' => [
             'route.pre.resolve.args' => [
                 containerListener(CheckExerciseAssignedListener::class)

src/Command/RunCommand.php

@@ -61,15 +61,7 @@ public function __construct(
      */
     public function __invoke(Input $input)
     {
-        $program = $input->getArgument('program');
-        if (!file_exists($program)) {
-            $this->output->printError(
-                sprintf('Could not run. File: "%s" does not exist', $program)
-            );
-            return 1;
-        }
-        $program = realpath($program);
         $exercise = $this->exerciseRepository->findByName($this->userState->getCurrentExercise());
-        $this->exerciseDispatcher->run($exercise, $program, $this->output);
+        $this->exerciseDispatcher->run($exercise, $input, $this->output);
     }
 }

src/Command/VerifyCommand.php

@@ -79,15 +79,6 @@ public function __construct(
      */
     public function __invoke(Input $input)
     {
-        $program = $input->getArgument('program');
-        if (!file_exists($program)) {
-            $this->output->printError(
-                sprintf('Could not verify. File: "%s" does not exist', $program)
-            );
-            return 1;
-        }
-        $program = realpath($program);
-
         $exercise   = $this->exerciseRepository->findByName($this->userState->getCurrentExercise());
         $results    = $this->exerciseDispatcher->verify($exercise, $input);
 

src/Listener/RealPathListener.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace PhpSchool\PhpWorkshop\Listener;
+
+use PhpSchool\PhpWorkshop\CommandDefinition;
+use PhpSchool\PhpWorkshop\Event\Event;
+use PhpSchool\PhpWorkshop\Event\ExerciseRunnerEvent;
+use PhpSchool\PhpWorkshop\Input\Input;
+use PhpSchool\PhpWorkshop\UserState;
+
+/**
+ * @author Aydin Hassan <aydin@hotmail.co.uk>
+ */
+class RealPathListener
+{
+
+    /**
+     * @param ExerciseRunnerEvent $event
+     */
+    public function __invoke(ExerciseRunnerEvent $event)
+    {
+        $program = $event->getInput()->getArgument('program');
+
+        if (file_exists($program)) {
+            $event->getInput()->setArgument('program', realpath($program));
+        }
+    }
+}

test/Command/VerifyCommandTest.php

@@ -45,26 +45,6 @@ public function setUp()
             ->will($this->returnValue('Some Check'));
     }
 
-    public function testVerifyPrintsErrorIfProgramDoesNotExist()
-    {
-        $repo = new ExerciseRepository([]);
-        $state = new UserState;
-        $output = $this->createMock(OutputInterface::class);
-        $dispatcher = $this->createMock(ExerciseDispatcher::class);
-
-        $programFile = sprintf('%s/%s/program.php', sys_get_temp_dir(), $this->getName());
-        $output
-            ->expects($this->once())
-            ->method('printError')
-            ->with(sprintf('Could not verify. File: "%s" does not exist', $programFile));
-
-        $serializer = $this->createMock(UserStateSerializer::class);
-        $renderer = $this->createMock(ResultsRenderer::class);
-
-        $command = new VerifyCommand($repo, $dispatcher, $state, $serializer, $output, $renderer);
-        $this->assertSame(1, $command->__invoke(new Input('appName', ['program' => $programFile])));
-    }
-
     public function testVerifyAddsCompletedExerciseAndReturnsCorrectCodeOnSuccess()
     {
         $file = tempnam(sys_get_temp_dir(), 'pws');

test/RealPathListenerTest.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace PhpSchool\PhpWorkshopTest;
+
+use PhpSchool\PhpWorkshop\Event\Event;
+use PhpSchool\PhpWorkshop\Event\ExerciseRunnerEvent;
+use PhpSchool\PhpWorkshop\Input\Input;
+use PhpSchool\PhpWorkshop\Listener\RealPathListener;
+use PhpSchool\PhpWorkshopTest\Asset\CliExerciseImpl;
+use PHPUnit_Framework_TestCase;
+
+/**
+ * @author Aydin Hassan <aydin@hotmail.co.uk>
+ */
+class RealPathListenerTest extends PHPUnit_Framework_TestCase
+{
+    public function testInputArgumentIsReplacesWithAbsolutePathIfFileExists()
+    {
+        $current = getcwd();
+
+        $tempDirectory = sprintf('%s/%s', realpath(sys_get_temp_dir()), $this->getName());
+        mkdir($tempDirectory, 0777, true);
+        chdir($tempDirectory);
+        touch('test-file.php');
+
+        $exercise = new CliExerciseImpl;
+        $input = new Input('app', ['program' => 'test-file.php']);
+        $listener = new RealPathListener;
+        $listener->__invoke(new ExerciseRunnerEvent('some.event', $exercise, $input));
+
+        $this->assertEquals(sprintf('%s/test-file.php', $tempDirectory), $input->getArgument('program'));
+
+        unlink('test-file.php');
+        rmdir($tempDirectory);
+        chdir($current);
+    }
+
+    public function testInputArgumentIsLeftUnchangedIfFileDoesNotExist()
+    {
+        $exercise = new CliExerciseImpl;
+        $input = new Input('app', ['program' => 'test-file.php']);
+        $listener = new RealPathListener;
+        $listener->__invoke(new ExerciseRunnerEvent('some.event', $exercise, $input));
+
+        $this->assertEquals('test-file.php', $input->getArgument('program'));
+    }
+
+    private function runInDir($dir, callable $callback)
+    {
+        $current = getcwd();
+        chdir($dir);
+        $callback($dir);
+        chdir($current);
+    }
+}