Merge pull request #124 from php-school/runners-specify-checks

Runners specify checks

Author: AydinHassan

app/config.php

@@ -59,18 +59,12 @@
 return [
     'appName' => basename($_SERVER['argv'][0]),
     ExerciseDispatcher::class => function (ContainerInterface $c) {
-        $dispatcher = new ExerciseDispatcher(
+        return new ExerciseDispatcher(
             $c->get(RunnerFactory::class),
             $c->get(ResultAggregator::class),
             $c->get(EventDispatcher::class),
             $c->get(CheckRepository::class)
         );
-
-        //checks which should always run (probably)
-        $dispatcher->requireCheck(FileExistsCheck::class);
-        $dispatcher->requireCheck(PhpLintCheck::class);
-        $dispatcher->requireCheck(CodeParseCheck::class);
-        return $dispatcher;
     },
     ResultAggregator::class => object(ResultAggregator::class),
     CheckRepository::class => function (ContainerInterface $c) {

src/Exception/ExerciseNotConfiguredException.php

@@ -18,7 +18,7 @@ class ExerciseNotConfiguredException extends RuntimeException
      * Static constructor to create an instance from the exercise and interface name.
      *
      * @param ExerciseInterface $exercise The exercise instance.
-     * @param $interface The FQCN of the interface.
+     * @param string $interface The FQCN of the interface.
      * @return static
      */
     public static function missingImplements(ExerciseInterface $exercise, $interface)

src/ExerciseDispatcher.php

@@ -25,12 +25,12 @@
 class ExerciseDispatcher
 {
     /**
-     * @var CheckInterface[]
+     * @var SimpleCheckInterface[]
      */
     private $checksToRunBefore = [];
 
     /**
-     * @var CheckInterface[]
+     * @var SimpleCheckInterface[]
      */
     private $checksToRunAfter = [];
 
@@ -129,7 +129,7 @@ public function verify(ExerciseInterface $exercise, $fileName)
     {
         $exercise->configure($this);
 
-        $runner = $this->runnerFactory->create($exercise, $this->eventDispatcher);
+        $runner = $this->runnerFactory->create($exercise, $this->eventDispatcher, $this);
         $this->eventDispatcher->dispatch(new Event('verify.start', compact('exercise', 'fileName')));
 
         $this->validateChecks($this->checksToRunBefore, $exercise);
@@ -179,7 +179,7 @@ public function run(ExerciseInterface $exercise, $fileName, OutputInterface $out
 
         try {
             $exitStatus = $this->runnerFactory
-                ->create($exercise, $this->eventDispatcher)
+                ->create($exercise, $this->eventDispatcher, $this)
                 ->run($fileName, $output);
         } finally {
             $this->eventDispatcher->dispatch(new Event('run.finish', compact('exercise', 'fileName')));

src/ExerciseRunner/CgiRunner.php

@@ -2,12 +2,16 @@
 
 namespace PhpSchool\PhpWorkshop\ExerciseRunner;
 
+use PhpSchool\PhpWorkshop\Check\CodeParseCheck;
+use PhpSchool\PhpWorkshop\Check\FileExistsCheck;
+use PhpSchool\PhpWorkshop\Check\PhpLintCheck;
 use PhpSchool\PhpWorkshop\Event\CgiExecuteEvent;
 use PhpSchool\PhpWorkshop\Event\Event;
 use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 use PhpSchool\PhpWorkshop\Exception\CodeExecutionException;
 use PhpSchool\PhpWorkshop\Exception\SolutionExecutionException;
 use PhpSchool\PhpWorkshop\Exercise\CgiExercise;
+use PhpSchool\PhpWorkshop\ExerciseDispatcher;
 use PhpSchool\PhpWorkshop\Output\OutputInterface;
 use PhpSchool\PhpWorkshop\Result\CgiOutFailure;
 use PhpSchool\PhpWorkshop\Result\CgiOutRequestFailure;
@@ -85,6 +89,22 @@ public function getName()
         return 'CGI Program Runner';
     }
 
+    /**
+     * Configure the exercise dispatcher. For example set the required checks
+     * for this exercise type.
+     *
+     * @param ExerciseDispatcher $exerciseDispatcher
+     * @return self
+     */
+    public function configure(ExerciseDispatcher $exerciseDispatcher)
+    {
+        $exerciseDispatcher->requireCheck(FileExistsCheck::class);
+        $exerciseDispatcher->requireCheck(PhpLintCheck::class);
+        $exerciseDispatcher->requireCheck(CodeParseCheck::class);
+
+        return $this;
+    }
+
     /**
      * @param RequestInterface $request
      * @param string $fileName
@@ -113,7 +133,7 @@ private function checkRequest(RequestInterface $request, $fileName)
             $this->eventDispatcher->dispatch(new Event('cgi.verify.student-execute.fail', ['exception' => $e]));
             return Failure::fromNameAndCodeExecutionFailure($this->getName(), $e);
         }
-        
+
         $solutionBody       = (string) $solutionResponse->getBody();
         $userBody           = (string) $userResponse->getBody();
         $solutionHeaders    = $this->getHeaders($solutionResponse);

src/ExerciseRunner/CliRunner.php

@@ -2,12 +2,16 @@
 
 namespace PhpSchool\PhpWorkshop\ExerciseRunner;
 
+use PhpSchool\PhpWorkshop\Check\CodeParseCheck;
+use PhpSchool\PhpWorkshop\Check\FileExistsCheck;
+use PhpSchool\PhpWorkshop\Check\PhpLintCheck;
 use PhpSchool\PhpWorkshop\Event\CliExecuteEvent;
 use PhpSchool\PhpWorkshop\Event\Event;
 use PhpSchool\PhpWorkshop\Event\EventDispatcher;
 use PhpSchool\PhpWorkshop\Exception\CodeExecutionException;
 use PhpSchool\PhpWorkshop\Exception\SolutionExecutionException;
 use PhpSchool\PhpWorkshop\Exercise\CliExercise;
+use PhpSchool\PhpWorkshop\ExerciseDispatcher;
 use PhpSchool\PhpWorkshop\Output\OutputInterface;
 use PhpSchool\PhpWorkshop\Result\Failure;
 use PhpSchool\PhpWorkshop\Result\ResultInterface;
@@ -58,6 +62,22 @@ public function getName()
         return 'CLI Program Runner';
     }
 
+    /**
+     * Configure the exercise dispatcher. For example set the required checks
+     * for this exercise type.
+     *
+     * @param ExerciseDispatcher $exerciseDispatcher
+     * @return self
+     */
+    public function configure(ExerciseDispatcher $exerciseDispatcher)
+    {
+        $exerciseDispatcher->requireCheck(FileExistsCheck::class);
+        $exerciseDispatcher->requireCheck(PhpLintCheck::class);
+        $exerciseDispatcher->requireCheck(CodeParseCheck::class);
+
+        return $this;
+    }
+
     /**
      * @param string $fileName
      * @param ArrayObject $args
@@ -75,7 +95,7 @@ private function executePhpFile($fileName, ArrayObject $args, $type)
         if (!$process->isSuccessful()) {
             throw CodeExecutionException::fromProcess($process);
         }
-        
+
         return $process->getOutput();
     }
 

src/ExerciseRunner/ExerciseRunnerInterface.php

@@ -3,6 +3,7 @@
 namespace PhpSchool\PhpWorkshop\ExerciseRunner;
 
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
+use PhpSchool\PhpWorkshop\ExerciseDispatcher;
 use PhpSchool\PhpWorkshop\Output\OutputInterface;
 use PhpSchool\PhpWorkshop\Result\ResultInterface;
 
@@ -22,6 +23,15 @@ interface ExerciseRunnerInterface
      */
     public function getName();
 
+    /**
+     * Configure the exercise dispatcher. For example set the required checks
+     * for this exercise type.
+     *
+     * @param ExerciseDispatcher $exerciseDispatcher
+     * @return self
+     */
+    public function configure(ExerciseDispatcher $exerciseDispatcher);
+
     /**
      * Verify a solution to an exercise. Verification involves executing the reference solution
      * and the student's solution and comparing their output. If the output is the same

src/Factory/RunnerFactory.php

@@ -7,6 +7,7 @@
 use PhpSchool\PhpWorkshop\Exception\InvalidArgumentException;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
 use PhpSchool\PhpWorkshop\Exercise\ExerciseType;
+use PhpSchool\PhpWorkshop\ExerciseDispatcher;
 use PhpSchool\PhpWorkshop\ExerciseRunner\CgiRunner;
 use PhpSchool\PhpWorkshop\ExerciseRunner\CliRunner;
 use PhpSchool\PhpWorkshop\ExerciseRunner\ExerciseRunnerInterface;
@@ -21,19 +22,27 @@ class RunnerFactory
     /**
      * @param ExerciseInterface $exercise
      * @param EventDispatcher $eventDispatcher
+     * @param ExerciseDispatcher $exerciseDispatcher
      * @return ExerciseRunnerInterface
      */
-    public function create(ExerciseInterface $exercise, EventDispatcher $eventDispatcher)
-    {
+    public function create(
+        ExerciseInterface $exercise,
+        EventDispatcher $eventDispatcher,
+        ExerciseDispatcher $exerciseDispatcher
+    ) {
         switch ($exercise->getType()->getValue()) {
             case ExerciseType::CLI:
-                return new CliRunner($exercise, $eventDispatcher);
+                $runner = new CliRunner($exercise, $eventDispatcher);
+                break;
             case ExerciseType::CGI:
-                return new CgiRunner($exercise, $eventDispatcher);
+                $runner = new CgiRunner($exercise, $eventDispatcher);
+                break;
+            default:
+                throw new InvalidArgumentException(
+                    sprintf('Exercise Type: "%s" not supported', $exercise->getType()->getValue())
+                );
         }
 
-        throw new InvalidArgumentException(
-            sprintf('Exercise Type: "%s" not supported', $exercise->getType()->getValue())
-        );
+        return $runner->configure($exerciseDispatcher);
     }
 }