Make tests pass

Author: AydinHassan

composer.lock

@@ -1,9 +1,6 @@
 parameters:
     treatPhpDocTypesAsCertain: false
     ignoreErrors:
-        -
-            message: '#PhpSchool\\PhpWorkshop\\ExerciseRunner\\CliRunner\:\:preserveOldArgFormat\(\) should return#'
-            path: src/ExerciseRunner/CliRunner.php
         -
             message: '#Call to an undefined method PhpParser\\Node\\Expr\|PhpParser\\Node\\Name\:\:__toString\(\)#'
             path: src/Check/FunctionRequirementsCheck.php

phpstan.neon

@@ -5,6 +5,7 @@
 namespace PhpSchool\PhpWorkshop\Event;
 
 use PhpSchool\PhpWorkshop\Utils\ArrayObject;
+use PhpSchool\PhpWorkshop\Utils\Collection;
 
 /**
  * An event to represent events which occur throughout the verification and running process in
@@ -13,16 +14,16 @@
 class CliExecuteEvent extends Event
 {
     /**
-     * @var ArrayObject<int, string>
+     * @var Collection<int, string>
      */
-    private $args;
+    private Collection $args;
 
     /**
      * @param string $name The event name.
-     * @param ArrayObject<int, string> $args The arguments that should be/have been passed to the program.
+     * @param Collection<int, string> $args The arguments that should be/have been passed to the program.
      * @param array<mixed> $parameters The event parameters.
      */
-    public function __construct(string $name, ArrayObject $args, array $parameters = [])
+    public function __construct(string $name, Collection $args, array $parameters = [])
     {
         $parameters['args'] = $args;
         parent::__construct($name, $parameters);
@@ -52,9 +53,9 @@ public function appendArg(string $arg): void
     /**
      * Get the arguments to be passed to the program.
      *
-     * @return ArrayObject<int, string>
+     * @return Collection<int, string>
      */
-    public function getArgs(): ArrayObject
+    public function getArgs(): Collection
     {
         return $this->args;
     }

src/Event/CliExecuteEvent.php

@@ -195,15 +195,16 @@ private function getProcess(string $fileName, RequestInterface $request): Proces
         $env = $this->getDefaultEnv();
         $env += [
             'REQUEST_METHOD'  => $request->getMethod(),
-            'SCRIPT_FILENAME' => '/solution/' . basename($fileName), // TODO: Figure out this path in the container
-            'REDIRECT_STATUS' => 302,
+            //'SCRIPT_FILENAME' => '/solution/' . basename($fileName), // TODO: Figure out this path in the container
+            'SCRIPT_FILENAME' => $fileName,
+            'REDIRECT_STATUS' => '302',
             'QUERY_STRING'    => $request->getUri()->getQuery(),
             'REQUEST_URI'     => $request->getUri()->getPath(),
             'XDEBUG_MODE'     => 'off',
         ];
 
         $content                = $request->getBody()->__toString();
-        $env['CONTENT_LENGTH']  = $request->getBody()->getSize();
+        $env['CONTENT_LENGTH']  = (string) $request->getBody()->getSize();
         $env['CONTENT_TYPE']    = $request->getHeaderLine('Content-Type');
 
         foreach ($request->getHeaders() as $name => $values) {

src/ExerciseRunner/CgiRunner.php

@@ -26,6 +26,7 @@
 use PhpSchool\PhpWorkshop\Result\Cli\ResultInterface as CliResultInterface;
 use PhpSchool\PhpWorkshop\Result\ResultInterface;
 use PhpSchool\PhpWorkshop\Utils\ArrayObject;
+use PhpSchool\PhpWorkshop\Utils\Collection;
 use Psr\Container\ContainerInterface;
 use RuntimeException;
 use Symfony\Component\Process\ExecutableFinder;
@@ -100,11 +101,11 @@ public function getRequiredChecks(): array
 
     /**
      * @param string $fileName
-     * @param ArrayObject<int, string> $args
+     * @param Collection<int, string> $args
      * @param string $type
      * @return string
      */
-    private function executePhpFile(string $fileName, ArrayObject $args, string $type): string
+    private function executePhpFile(string $fileName, Collection $args, string $type): string
     {
         $process = $this->getPhpProcess($fileName, $args);
 
@@ -121,13 +122,13 @@ private function executePhpFile(string $fileName, ArrayObject $args, string $typ
 
     /**
      * @param string $fileName
-     * @param ArrayObject<int, string> $args
+     * @param Collection<int, string> $args
      *
      * @return Process
      */
-    private function getPhpProcess(string $fileName, ArrayObject $args): Process
+    private function getPhpProcess(string $fileName, Collection $args): Process
     {
-        return $this->processFactory->phpCli(dirname($fileName), $args->getArrayCopy());
+        return $this->processFactory->phpCli($fileName, $args);
     }
 
     /**
@@ -151,33 +152,14 @@ public function verify(Input $input): ResultInterface
         $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('cli.verify.start', $this->exercise, $input));
         $result = new CliResult(
             array_map(
-                function (array $args) use ($input) {
-                    return $this->doVerify($args, $input);
-                },
-                $this->preserveOldArgFormat($this->exercise->getArgs())
+                fn(array $args) => $this->doVerify($args, $input),
+                $this->exercise->getArgs()
             )
         );
         $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('cli.verify.finish', $this->exercise, $input));
         return $result;
     }
 
-    /**
-     * BC - getArgs only returned 1 set of args in v1 instead of multiple sets of args in v2
-     *
-     * @param array<int, array<string>>|array<int, string> $args
-     * @return array<int, array<string>>
-     */
-    private function preserveOldArgFormat(array $args): array
-    {
-        if (isset($args[0]) && !is_array($args[0])) {
-            $args = [$args];
-        } elseif (count($args) === 0) {
-            $args = [[]];
-        }
-
-        return $args;
-    }
-
     /**
      * @param array<string> $args
      * @param Input $input
@@ -186,7 +168,8 @@ private function preserveOldArgFormat(array $args): array
     private function doVerify(array $args, Input $input): CliResultInterface
     {
         //arrays are not pass-by-ref
-        $args = new ArrayObject($args);
+        $args = new Collection($args);
+        /** @var Collection<int,string> $args */
 
         try {
             /** @var CliExecuteEvent $event */
@@ -236,10 +219,12 @@ public function run(Input $input, OutputInterface $output): bool
     {
         $this->eventDispatcher->dispatch(new ExerciseRunnerEvent('cli.run.start', $this->exercise, $input));
         $success = true;
-        foreach ($this->preserveOldArgFormat($this->exercise->getArgs()) as $i => $args) {
+        foreach ($this->exercise->getArgs() as $i => $args) {
+            /** @var Collection<int, string> $argsCollection */
+            $argsCollection = new Collection($args);
             /** @var CliExecuteEvent $event */
             $event = $this->eventDispatcher->dispatch(
-                new CliExecuteEvent('cli.run.student-execute.pre', new ArrayObject($args))
+                new CliExecuteEvent('cli.run.student-execute.pre', $argsCollection)
             );
 
             $args = $event->getArgs();

src/ExerciseRunner/CliRunner.php

@@ -21,21 +21,9 @@ class PrepareSolutionListener
 
     public function __construct(ProcessFactory $processFactory)
     {
-                $this->processFactory = $processFactory;
+        $this->processFactory = $processFactory;
     }
 
-    /**
-     * Locations for composer executable
-     *
-     * @var array<string>
-     */
-    private static $composerLocations = [
-        'composer',
-        'composer.phar',
-        '/usr/local/bin/composer',
-        __DIR__ . '/../../vendor/bin/composer',
-    ];
-
     /**
      * @param ExerciseRunnerEvent $event
      */
@@ -49,37 +37,25 @@ public function __invoke(ExerciseRunnerEvent $event): void
 
         $solution = $exercise->getSolution();
 
-        if ($solution->hasComposerFile()) {
-            //prepare composer deps
-            //only install if composer.lock file not available
+        if (!$solution->hasComposerFile()) {
+            return;
+        }
 
-            if (!file_exists(sprintf('%s/vendor', $solution->getBaseDirectory()))) {
-                $process = $this->processFactory->composer(
-                    $solution->getBaseDirectory(),
-                    'install',
-                    ['--no-interaction']
-                );
+        //prepare composer deps
+        //only install if composer.lock file not available
 
-                try {
-                    $process->mustRun();
-                } catch (\Symfony\Component\Process\Exception\RuntimeException $e) {
-                    throw new RuntimeException('Composer dependencies could not be installed', 0, $e);
-                }
-            }
-        }
-    }
+        if (!file_exists(sprintf('%s/vendor', $solution->getBaseDirectory()))) {
+            $process = $this->processFactory->composer(
+                $solution->getBaseDirectory(),
+                'install',
+                ['--no-interaction']
+            );
 
-    /**
-     * @return string
-     */
-    public static function locateComposer(): string
-    {
-        foreach (self::$composerLocations as $location) {
-            if (file_exists($location) && is_executable($location)) {
-                return $location;
+            try {
+                $process->mustRun();
+            } catch (\Symfony\Component\Process\Exception\RuntimeException $e) {
+                throw new RuntimeException('Composer dependencies could not be installed', 0, $e);
             }
         }
-
-        throw new RuntimeException('Composer could not be located on the system');
     }
 }

src/Listener/PrepareSolutionListener.php

@@ -4,6 +4,7 @@
 
 namespace PhpSchool\PhpWorkshop\Process;
 
+use PhpSchool\PhpWorkshop\Utils\Collection;
 use Symfony\Component\Process\ExecutableFinder;
 use Symfony\Component\Process\Process;
 
@@ -20,30 +21,33 @@ public function __construct(string $basePath, string $dockerBinaryPath, string $
         $this->projectName = $projectName;
     }
 
+    /**
+     * @return array<string>
+     */
     private function baseComposeCommand(): array
     {
-                return [
-                    $this->docker,
-                    'compose',
-                    '-p', $this->projectName,
-                    '-f', '.docker/runtime/docker-compose.yml',
-                    'run',
-                    '--rm'
-                ];
+        return [
+            $this->docker,
+            'compose',
+            '-p', $this->projectName,
+            '-f', '.docker/runtime/docker-compose.yml',
+            'run',
+            '--rm'
+        ];
     }
 
-    public function composer(string $solitionPath, string $composerCommand, array $composerArgs): Process
+    public function composer(string $solutionPath, string $composerCommand, array $composerArgs): Process
     {
         return new Process(
-            [...$this->baseComposeCommand(), 'runtime', ...$composerCommand, ...$composerArgs],
+            [...$this->baseComposeCommand(), 'runtime', $composerCommand, ...$composerArgs],
             $this->basePath,
             ['SOLUTION' => $solutionPath],
             null,
             60
         );
     }
 
-    public function phpCli(string $fileName, array $args): Process
+    public function phpCli(string $fileName, Collection $args): Process
     {
         return new Process(
             [...$this->baseComposeCommand(), 'runtime', 'php', '/solution/' . basename($fileName), ...$args],