Context

Author: AydinHassan

src/Exercise/MockExercise.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace PhpSchool\PhpWorkshop\Exercise;
+
+use PhpSchool\PhpWorkshop\ExerciseDispatcher;
+
+class MockExercise extends AbstractExercise implements ExerciseInterface
+{
+    public function getName(): string
+    {
+        return 'Mock Exercise';
+    }
+
+    public function getDescription(): string
+    {
+        return 'Mock Exercise';
+    }
+
+    public function getType(): ExerciseType
+    {
+        return ExerciseType::CUSTOM();
+    }
+
+    public function getProblem(): string
+    {
+        return 'problem-file.md';
+    }
+}

src/ExerciseRunner/Context/ExecutionContext.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace PhpSchool\PhpWorkshop\ExerciseRunner\Context;
+
+use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
+use PhpSchool\PhpWorkshop\Input\Input;
+use PhpSchool\PhpWorkshop\Utils\Path;
+use PhpSchool\PhpWorkshop\Utils\System;
+
+class ExecutionContext
+{
+    public string $studentExecutionDirectory;
+    public string $referenceExecutionDirectory;
+
+    public function __construct(
+        string $studentWorkingDirectory,
+        string $referenceWorkingDirectory,
+        public ExerciseInterface $exercise,
+        public Input $input,
+    ) {
+        $this->studentExecutionDirectory = $studentWorkingDirectory;
+        $this->referenceExecutionDirectory = $referenceWorkingDirectory;
+    }
+
+    public function hasStudentSolution(): bool
+    {
+        return $this->input->hasArgument('program');
+    }
+
+    public function getEntryPoint(): string
+    {
+        return Path::join(
+            $this->studentExecutionDirectory,
+            basename($this->input->getRequiredArgument('program'))
+        );
+    }
+}

src/ExerciseRunner/Context/ExecutionContextFactory.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace PhpSchool\PhpWorkshop\ExerciseRunner\Context;
+
+use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
+use PhpSchool\PhpWorkshop\Input\Input;
+use PhpSchool\PhpWorkshop\Utils\System;
+
+class ExecutionContextFactory
+{
+    public function fromInputAndExercise(Input $input, ExerciseInterface $exercise): ExecutionContext
+    {
+        return new ExecutionContext(
+            dirname($input->getRequiredArgument('program')),
+            System::randomTempDir(),
+            $exercise,
+            $input
+        );
+    }
+}

src/ExerciseRunner/Context/StaticExecutionContextFactory.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace PhpSchool\PhpWorkshop\ExerciseRunner\Context;
+
+use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
+use PhpSchool\PhpWorkshop\Input\Input;
+use PhpSchool\PhpWorkshop\Utils\System;
+use Symfony\Component\Filesystem\Filesystem;
+
+class StaticExecutionContextFactory extends ExecutionContextFactory
+{
+    public function __construct(private TestContext $context)
+    {
+    }
+
+    public function fromInputAndExercise(Input $input, ExerciseInterface $exercise): ExecutionContext
+    {
+        return $this->context;
+    }
+}

src/ExerciseRunner/Context/TestContext.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace PhpSchool\PhpWorkshop\ExerciseRunner\Context;
+
+use PhpSchool\PhpWorkshop\Exercise\ExerciseInterface;
+use PhpSchool\PhpWorkshop\Exercise\MockExercise;
+use PhpSchool\PhpWorkshop\Input\Input;
+use PhpSchool\PhpWorkshop\Solution\SolutionInterface;
+use PhpSchool\PhpWorkshop\Utils\System;
+use Symfony\Component\Filesystem\Filesystem;
+use PhpSchool\PhpWorkshop\Utils\Path;
+
+class TestContext extends ExecutionContext
+{
+    public Filesystem $filesystem;
+    public ExerciseInterface $exercise;
+
+    private function __construct(
+        ExerciseInterface $exercise = null,
+        Input $input = null
+    ) {
+        $this->exercise = $exercise ?? new MockExercise();
+
+        $this->filesystem = new Filesystem();
+
+        parent::__construct(
+            System::randomTempDir(),
+            System::randomTempDir(),
+            $this->exercise,
+            $input ? $input : new Input('test', ['program' => 'solution.php']),
+        );
+    }
+
+    public function importStudentSolution(string $file): void
+    {
+        copy($file, Path::join($this->studentExecutionDirectory, 'solution.php'));
+    }
+
+    public function importStudentSolutionFolder(string $folder): void
+    {
+        $this->filesystem->mirror($folder, $this->studentExecutionDirectory);
+    }
+
+    public function importReferenceSolution(SolutionInterface $solution): void
+    {
+        foreach ($solution->getFiles() as $file) {
+            $this->filesystem->copy(
+                $file->getAbsolutePath(),
+                Path::join($this->referenceExecutionDirectory, $file->getRelativePath())
+            );
+        }
+    }
+
+    public static function withDirectories(ExerciseInterface $exercise = null, Input $input = null): self
+    {
+        $self = new self($exercise, $input);
+
+        $self->filesystem->mkdir($self->studentExecutionDirectory);
+        $self->filesystem->mkdir($self->referenceExecutionDirectory);
+
+        return $self;
+    }
+
+    public static function withoutDirectories(ExerciseInterface $exercise = null, Input $input = null): self
+    {
+        return new self($exercise, $input);
+    }
+
+    public function __destruct()
+    {
+        $this->filesystem->remove($this->studentExecutionDirectory);
+        $this->filesystem->remove($this->referenceExecutionDirectory);
+    }
+}

src/Utils/System.php

@@ -23,4 +23,9 @@ public static function tempDir(string $path = ''): string
     {
         return Path::join(self::realpath(sys_get_temp_dir()), 'php-school', $path);
     }
+
+    public static function randomTempDir(): string
+    {
+        return Path::join(self::realpath(sys_get_temp_dir()), 'php-school', bin2hex(random_bytes(4)));
+    }
 }

test/Utils/SystemTest.php

@@ -33,4 +33,9 @@ public function testTempDirWithPath(): void
         $expect = sprintf('%s/php-school/%s', realpath(sys_get_temp_dir()), 'test');
         self::assertSame($expect, System::tempDir('test'));
     }
+
+    public function testRandomTempDir(): void
+    {
+        self::assertTrue(str_starts_with(System::randomTempDir(), realpath(sys_get_temp_dir()) . '/php-school'));
+    }
 }