Introduce new class to prepare environment files

Author: AydinHassan

Diff for: src/ExerciseRunner/EnvironmentManager.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace PhpSchool\PhpWorkshop\ExerciseRunner;
+
+use PhpSchool\PhpWorkshop\Exercise\ProvidesSolution;
+use PhpSchool\PhpWorkshop\Exercise\Scenario\ExerciseScenario;
+use PhpSchool\PhpWorkshop\ExerciseRunner\Context\ExecutionContext;
+use PhpSchool\PhpWorkshop\Utils\Path;
+use Symfony\Component\Filesystem\Filesystem;
+
+class EnvironmentManager
+{
+    public function __construct(private Filesystem $filesystem)
+    {
+    }
+
+    public function prepareStudent(ExecutionContext $context, ExerciseScenario $scenario): void
+    {
+        $this->copyExerciseFiles($scenario, $context->getStudentExecutionDirectory());
+    }
+
+    public function prepareReference(ExecutionContext $context, ExerciseScenario $scenario): void
+    {
+        $exercise = $context->getExercise();
+
+        if (!$exercise instanceof ProvidesSolution) {
+            return;
+        }
+
+        $this->filesystem->mkdir($context->getReferenceExecutionDirectory());
+
+        $solution = $exercise->getSolution();
+
+        foreach ($solution->getFiles() as $file) {
+            $this->filesystem->copy(
+                $file->getAbsolutePath(),
+                Path::join($context->getReferenceExecutionDirectory(), $file->getRelativePath())
+            );
+        }
+
+        $this->copyExerciseFiles($scenario, $context->getReferenceExecutionDirectory());
+    }
+
+    private function copyExerciseFiles(ExerciseScenario $scenario, string $dir): void
+    {
+        foreach ($scenario->getFiles() as $fileName => $content) {
+            $this->filesystem->dumpFile(
+                Path::join($dir, $fileName),
+                $content
+            );
+        }
+    }
+
+    public function cleanup(ExecutionContext $context, ExerciseScenario $scenario): void
+    {
+        $this->filesystem->remove($context->getReferenceExecutionDirectory());
+
+        foreach ($scenario->getFiles() as $fileName => $content) {
+            $this->filesystem->remove(Path::join($context->getStudentExecutionDirectory(), $fileName));
+        }
+    }
+}

Diff for: test/ExerciseRunner/EnvironmentManagerTest.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace PhpSchool\PhpWorkshopTest\ExerciseRunner;
+
+use PhpSchool\PhpWorkshop\Exercise\MockExercise;
+use PhpSchool\PhpWorkshop\Exercise\Scenario\CliScenario;
+use PhpSchool\PhpWorkshop\ExerciseRunner\Context\TestContext;
+use PhpSchool\PhpWorkshop\ExerciseRunner\EnvironmentManager;
+use PhpSchool\PhpWorkshop\Solution\DirectorySolution;
+use PhpSchool\PhpWorkshop\Solution\SingleFileSolution;
+use PhpSchool\PhpWorkshopTest\Asset\CliExerciseImpl;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Filesystem\Filesystem;
+
+class EnvironmentManagerTest extends TestCase
+{
+    public function testPrepareStudentCopiesAllScenarioFilesToExecutionDirectory(): void
+    {
+        $context = new TestContext();
+        $context->createStudentSolutionDirectory();
+
+        $scenario = (new CliScenario())
+            ->withFile('file.txt', 'content')
+            ->withFile('file2.txt', 'content2');
+
+        $manager = new EnvironmentManager(new Filesystem());
+        $manager->prepareStudent($context, $scenario);
+
+        static::assertStringEqualsFile($context->getStudentExecutionDirectory() . '/file.txt', 'content');
+        static::assertStringEqualsFile($context->getStudentExecutionDirectory() . '/file2.txt', 'content2');
+    }
+
+    public function testPrepareReferenceCopiesAllScenarioFilesAndSolutionFilesToExecutionDirectory(): void
+    {
+        $exercise = new CliExerciseImpl();
+        $solution = SingleFileSolution::fromFile(realpath(__DIR__ . '/../res/cli/solution.php'));
+        $exercise->setSolution($solution);
+
+        $context = new TestContext($exercise);
+
+        $scenario = (new CliScenario())
+            ->withFile('file.txt', 'content')
+            ->withFile('file2.txt', 'content2');
+
+        $manager = new EnvironmentManager(new Filesystem());
+        $manager->prepareReference($context, $scenario);
+
+        static::assertFileEquals($context->getReferenceExecutionDirectory() . '/solution.php', __DIR__ . '/../res/cli/solution.php');
+        static::assertStringEqualsFile($context->getReferenceExecutionDirectory() . '/file.txt', 'content');
+        static::assertStringEqualsFile($context->getReferenceExecutionDirectory() . '/file2.txt', 'content2');
+    }
+
+    public function testCleanupRemovesReferenceDirectoryAndFilesCopiesToStudentDirectory(): void
+    {
+        $exercise = new CliExerciseImpl();
+        $solution = SingleFileSolution::fromFile(realpath(__DIR__ . '/../res/cli/solution.php'));
+        $exercise->setSolution($solution);
+
+        $context = new TestContext($exercise);
+        $context->createStudentSolutionDirectory();
+
+        $scenario = (new CliScenario())
+            ->withFile('file.txt', 'content')
+            ->withFile('file2.txt', 'content2');
+
+        $manager = new EnvironmentManager(new Filesystem());
+        $manager->prepareStudent($context, $scenario);
+        $manager->prepareReference($context, $scenario);
+
+        static::assertFileExists($context->getStudentExecutionDirectory());
+        static::assertFileExists($context->getReferenceExecutionDirectory());
+
+        $manager->cleanup($context, $scenario);
+
+        static::assertFileExists($context->getStudentExecutionDirectory());
+        static::assertFileNotExists($context->getReferenceExecutionDirectory() . '/file.txt');
+        static::assertFileNotExists($context->getReferenceExecutionDirectory() . '/file2.txt');
+        static::assertFileNotExists($context->getReferenceExecutionDirectory());
+    }
+}