Skip to content

Pushes all solution files into temp when created #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 18, 2021
Merged

Pushes all solution files into temp when created #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dba1d8e
Pushes all solution files into temp when created
mikeymike May 17, 2021
a250b0c
Fix AbstractExerciseTest::testGetSolution
mikeymike May 17, 2021
57f6f75
Make In temp solution path deterministic
mikeymike May 17, 2021
08af37a
Fix test breakages from InTempSolutionMapper
mikeymike May 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Solution/DirectorySolution.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ public function __construct(string $directory, string $entryPoint, array $exclus
*/
public static function fromDirectory(string $directory, array $exclusions = [], $entryPoint = 'solution.php'): self
{
$directory = InTempSolutionMapper::mapDirectory($directory);
return new self($directory, $entryPoint, array_merge($exclusions, ['composer.lock', 'vendor']));
}

Expand Down
57 changes: 57 additions & 0 deletions src/Solution/InTempSolutionMapper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<?php

declare(strict_types=1);

namespace PhpSchool\PhpWorkshop\Solution;

use PhpSchool\PhpWorkshop\Utils\Path;
use PhpSchool\PhpWorkshop\Utils\System;
use Symfony\Component\Filesystem\Filesystem;

class InTempSolutionMapper
{
public static function mapDirectory(string $directory): string
{
$fileSystem = new Filesystem();
$tempDir = self::getDeterministicTempDir($directory);

$fileSystem->mkdir($tempDir);

$dirIterator = new \RecursiveDirectoryIterator($directory, \RecursiveDirectoryIterator::SKIP_DOTS);
$iterator = new \RecursiveIteratorIterator($dirIterator, \RecursiveIteratorIterator::SELF_FIRST);

foreach ($iterator as $file) {
$target = Path::join($tempDir, $iterator->getSubPathName());

if ($fileSystem->exists($target)) {
continue;
}

$file->isDir()
? $fileSystem->mkdir($target)
: $fileSystem->copy($file->getPathname(), $target);
}

return $tempDir;
}

public static function mapFile(string $file): string
{
$fileSystem = new Filesystem();
$tempFile = Path::join(self::getDeterministicTempDir($file), basename($file));

if ($fileSystem->exists($tempFile)) {
return $tempFile;
}

$fileSystem->mkdir(System::tempDir());
$fileSystem->copy($file, $tempFile);

return $tempFile;
}

private static function getDeterministicTempDir(string $path): string
{
return Path::join(System::tempDir(), 'php-school', md5($path));
}
}
2 changes: 1 addition & 1 deletion src/Solution/SingleFileSolution.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public function __construct(string $file)
*/
public static function fromFile(string $file): self
{
return new self($file);
return new self(InTempSolutionMapper::mapFile($file));
}

/**
Expand Down
10 changes: 4 additions & 6 deletions test/Exercise/AbstractExerciseTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,10 @@ public function testGetSolution(string $name): void
$path = __DIR__ . '/../../exercises/array-we-go/solution/solution.php';
mkdir(dirname($path), 0777, true);
touch($path);
$solution = $exercise->getSolution();
$this->assertInstanceOf(SolutionInterface::class, $solution);
$files = $solution->getFiles();
$this->assertCount(1, $files);
$this->assertInstanceOf(SolutionFile::class, $files[0]);
$this->assertSame(realpath($path), $files[0]->__toString());
$files = $exercise->getSolution()->getFiles();
self::assertCount(1, $files);
self::assertInstanceOf(SolutionFile::class, $files[0]);
self::assertFileEquals(realpath($path), $files[0]->__toString());
unlink($path);
rmdir(__DIR__ . '/../../exercises/array-we-go/solution');
rmdir(__DIR__ . '/../../exercises/array-we-go');
Expand Down
218 changes: 89 additions & 129 deletions test/Solution/DirectorySolutionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,194 +4,154 @@

use InvalidArgumentException;
use PhpSchool\PhpWorkshop\Solution\DirectorySolution;
use PhpSchool\PhpWorkshop\Utils\Path;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Filesystem\Filesystem;

class DirectorySolutionTest extends TestCase
{
/**
* @var string
*/
private $tempPath;

public function setUp(): void
{
$this->tempPath = sprintf('%s/%s', realpath(sys_get_temp_dir()), $this->getName());
@mkdir($this->tempPath);
}

public function tearDown(): void
{
$fileSystem = new Filesystem();
$fileSystem->remove(Path::join(realpath(sys_get_temp_dir()), 'php-school'));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably could have used \PhpSchool\PhpWorkshop\Utils\System::tempDir('php-school') and in a few other places not that it really matters

$fileSystem->remove($this->tempPath);
}

public function testExceptionIsThrownIfEntryPointDoesNotExist(): void
{
$tempPath = sprintf('%s/%s', realpath(sys_get_temp_dir()), $this->getName());
@mkdir($tempPath, 0775, true);
touch(sprintf('%s/some-class.php', $tempPath));
touch(sprintf('%s/some-class.php', $this->tempPath));

$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage(sprintf('Entry point: "solution.php" does not exist in: "%s"', $tempPath));
$this->expectExceptionMessageMatches('/Entry point: "solution.php" does not exist in: ".*"/');

DirectorySolution::fromDirectory($tempPath);

unlink(sprintf('%s/some-class.php', $tempPath));
rmdir($tempPath);
DirectorySolution::fromDirectory($this->tempPath);
}

public function testWithDefaultEntryPoint(): void
{
$tempPath = sprintf('%s/%s', realpath(sys_get_temp_dir()), $this->getName());
@mkdir($tempPath, 0775, true);
touch(sprintf('%s/solution.php', $tempPath));
touch(sprintf('%s/some-class.php', $tempPath));
file_put_contents(sprintf('%s/solution.php', $this->tempPath), 'ENTRYPOINT');
file_put_contents(sprintf('%s/some-class.php', $this->tempPath), 'SOME CLASS');

$solution = DirectorySolution::fromDirectory($tempPath);
$solution = DirectorySolution::fromDirectory($this->tempPath);

$this->assertSame($tempPath, $solution->getBaseDirectory());
$this->assertFalse($solution->hasComposerFile());
$this->assertSame(sprintf('%s/solution.php', $tempPath), $solution->getEntryPoint());
self::assertFalse($solution->hasComposerFile());
self::assertSame('ENTRYPOINT', file_get_contents($solution->getEntryPoint()));
$files = $solution->getFiles();
$this->assertCount(2, $files);

$this->assertSame(sprintf('%s/solution.php', $tempPath), $files[0]->__toString());
$this->assertSame(sprintf('%s/some-class.php', $tempPath), $files[1]->__toString());
self::assertCount(2, $files);

unlink(sprintf('%s/solution.php', $tempPath));
unlink(sprintf('%s/some-class.php', $tempPath));
rmdir($tempPath);
self::assertSame('ENTRYPOINT', file_get_contents($files[0]->__toString()));
self::assertSame('SOME CLASS', file_get_contents($files[1]->__toString()));
}

public function testWithManualEntryPoint(): void
{
$tempPath = sprintf('%s/%s', realpath(sys_get_temp_dir()), $this->getName());
@mkdir($tempPath, 0775, true);
touch(sprintf('%s/index.php', $tempPath));
touch(sprintf('%s/some-class.php', $tempPath));
file_put_contents(sprintf('%s/index.php', $this->tempPath), 'ENTRYPOINT');
file_put_contents(sprintf('%s/some-class.php', $this->tempPath), 'SOME CLASS');

$solution = DirectorySolution::fromDirectory($tempPath, [], 'index.php');
$solution = DirectorySolution::fromDirectory($this->tempPath, [], 'index.php');

$this->assertSame($tempPath, $solution->getBaseDirectory());
$this->assertFalse($solution->hasComposerFile());
$this->assertSame(sprintf('%s/index.php', $tempPath), $solution->getEntryPoint());
self::assertFalse($solution->hasComposerFile());
self::assertSame('ENTRYPOINT', file_get_contents($solution->getEntryPoint()));
$files = $solution->getFiles();
$this->assertCount(2, $files);
self::assertCount(2, $files);

$this->assertSame(sprintf('%s/index.php', $tempPath), $files[0]->__toString());
$this->assertSame(sprintf('%s/some-class.php', $tempPath), $files[1]->__toString());

unlink(sprintf('%s/index.php', $tempPath));
unlink(sprintf('%s/some-class.php', $tempPath));
rmdir($tempPath);
self::assertSame('ENTRYPOINT', file_get_contents($files[0]->__toString()));
self::assertSame('SOME CLASS', file_get_contents($files[1]->__toString()));
}

public function testHasComposerFileReturnsTrueIfPresent(): void
{
$tempPath = sprintf('%s/%s', realpath(sys_get_temp_dir()), $this->getName());
@mkdir($tempPath, 0775, true);
touch(sprintf('%s/solution.php', $tempPath));
touch(sprintf('%s/some-class.php', $tempPath));
touch(sprintf('%s/composer.lock', $tempPath));
file_put_contents(sprintf('%s/solution.php', $this->tempPath), 'ENTRYPOINT');
file_put_contents(sprintf('%s/some-class.php', $this->tempPath), 'SOME CLASS');
touch(sprintf('%s/composer.lock', $this->tempPath));

$solution = DirectorySolution::fromDirectory($tempPath);
$solution = DirectorySolution::fromDirectory($this->tempPath);

$this->assertSame($tempPath, $solution->getBaseDirectory());
$this->assertTrue($solution->hasComposerFile());
$this->assertSame(sprintf('%s/solution.php', $tempPath), $solution->getEntryPoint());
self::assertTrue($solution->hasComposerFile());
self::assertSame('ENTRYPOINT', file_get_contents($solution->getEntryPoint()));
$files = $solution->getFiles();
$this->assertCount(2, $files);

$this->assertSame(sprintf('%s/solution.php', $tempPath), $files[0]->__toString());
$this->assertSame(sprintf('%s/some-class.php', $tempPath), $files[1]->__toString());
self::assertCount(2, $files);

unlink(sprintf('%s/composer.lock', $tempPath));
unlink(sprintf('%s/solution.php', $tempPath));
unlink(sprintf('%s/some-class.php', $tempPath));
self::assertSame('ENTRYPOINT', file_get_contents($files[0]->__toString()));
self::assertSame('SOME CLASS', file_get_contents($files[1]->__toString()));
}

public function testWithExceptions(): void
{
$tempPath = sprintf('%s/%s', realpath(sys_get_temp_dir()), $this->getName());
@mkdir($tempPath, 0775, true);
touch(sprintf('%s/solution.php', $tempPath));
touch(sprintf('%s/some-class.php', $tempPath));
touch(sprintf('%s/exclude.txt', $tempPath));
file_put_contents(sprintf('%s/solution.php', $this->tempPath), 'ENTRYPOINT');
file_put_contents(sprintf('%s/some-class.php', $this->tempPath), 'SOME CLASS');
touch(sprintf('%s/exclude.txt', $this->tempPath));

$exclusions = ['exclude.txt'];

$solution = DirectorySolution::fromDirectory($tempPath, $exclusions);
$solution = DirectorySolution::fromDirectory($this->tempPath, $exclusions);

$this->assertSame(sprintf('%s/solution.php', $tempPath), $solution->getEntryPoint());
self::assertSame('ENTRYPOINT', file_get_contents($solution->getEntryPoint()));
$files = $solution->getFiles();
$this->assertCount(2, $files);
self::assertCount(2, $files);

$this->assertSame(sprintf('%s/solution.php', $tempPath), $files[0]->__toString());
$this->assertSame(sprintf('%s/some-class.php', $tempPath), $files[1]->__toString());

unlink(sprintf('%s/solution.php', $tempPath));
unlink(sprintf('%s/some-class.php', $tempPath));
unlink(sprintf('%s/exclude.txt', $tempPath));
rmdir($tempPath);
self::assertSame('ENTRYPOINT', file_get_contents($files[0]->__toString()));
self::assertSame('SOME CLASS', file_get_contents($files[1]->__toString()));
}

public function testWithNestedDirectories(): void
{
$tempPath = sprintf('%s/%s', realpath(sys_get_temp_dir()), $this->getName());
@mkdir($tempPath, 0775, true);

@mkdir(sprintf('%s/nested', $tempPath), 0775, true);
@mkdir(sprintf('%s/nested/deep', $tempPath), 0775, true);
@mkdir(sprintf('%s/nested', $this->tempPath), 0775, true);
@mkdir(sprintf('%s/nested/deep', $this->tempPath), 0775, true);

touch(sprintf('%s/solution.php', $tempPath));
touch(sprintf('%s/some-class.php', $tempPath));
touch(sprintf('%s/composer.json', $tempPath));
touch(sprintf('%s/nested/another-class.php', $tempPath));
touch(sprintf('%s/nested/deep/even-more.php', $tempPath));
file_put_contents(sprintf('%s/solution.php', $this->tempPath), 'ENTRYPOINT');
file_put_contents(sprintf('%s/some-class.php', $this->tempPath), 'SOME CLASS');
file_put_contents(sprintf('%s/composer.json', $this->tempPath), 'COMPOSER DATA');
file_put_contents(sprintf('%s/nested/another-class.php', $this->tempPath), 'ANOTHER CLASS');
file_put_contents(sprintf('%s/nested/deep/even-more.php', $this->tempPath), 'EVEN MOAR');

$solution = DirectorySolution::fromDirectory($tempPath);
$solution = DirectorySolution::fromDirectory($this->tempPath);

$this->assertSame(sprintf('%s/solution.php', $tempPath), $solution->getEntryPoint());
self::assertSame('ENTRYPOINT', file_get_contents($solution->getEntryPoint()));
$files = $solution->getFiles();
$this->assertCount(5, $files);

$this->assertSame(sprintf('%s/composer.json', $tempPath), $files[0]->__toString());
$this->assertSame(sprintf('%s/nested/another-class.php', $tempPath), $files[1]->__toString());
$this->assertSame(sprintf('%s/nested/deep/even-more.php', $tempPath), $files[2]->__toString());
$this->assertSame(sprintf('%s/solution.php', $tempPath), $files[3]->__toString());
$this->assertSame(sprintf('%s/some-class.php', $tempPath), $files[4]->__toString());

unlink(sprintf('%s/solution.php', $tempPath));
unlink(sprintf('%s/some-class.php', $tempPath));
unlink(sprintf('%s/composer.json', $tempPath));
unlink(sprintf('%s/nested/another-class.php', $tempPath));
unlink(sprintf('%s/nested/deep/even-more.php', $tempPath));
rmdir(sprintf('%s/nested/deep', $tempPath));
rmdir(sprintf('%s/nested', $tempPath));
rmdir($tempPath);
self::assertCount(5, $files);

self::assertSame('COMPOSER DATA', file_get_contents($files[0]->__toString()));
self::assertSame('ANOTHER CLASS', file_get_contents($files[1]->__toString()));
self::assertSame('EVEN MOAR', file_get_contents($files[2]->__toString()));
self::assertSame('ENTRYPOINT', file_get_contents($files[3]->__toString()));
self::assertSame('SOME CLASS', file_get_contents($files[4]->__toString()));
}

public function testExceptionsWithNestedDirectories(): void
{
$tempPath = sprintf('%s/%s', realpath(sys_get_temp_dir()), $this->getName());
@mkdir($tempPath, 0775, true);

@mkdir(sprintf('%s/nested', $tempPath), 0775, true);
@mkdir(sprintf('%s/nested/deep', $tempPath), 0775, true);
@mkdir(sprintf('%s/vendor', $tempPath), 0775, true);
@mkdir(sprintf('%s/vendor/somelib', $tempPath), 0775, true);

touch(sprintf('%s/solution.php', $tempPath));
touch(sprintf('%s/some-class.php', $tempPath));
touch(sprintf('%s/exclude.txt', $tempPath));
touch(sprintf('%s/nested/exclude.txt', $tempPath));
touch(sprintf('%s/nested/deep/exclude.txt', $tempPath));
touch(sprintf('%s/vendor/somelib/app.php', $tempPath));
@mkdir(sprintf('%s/nested', $this->tempPath), 0775, true);
@mkdir(sprintf('%s/nested/deep', $this->tempPath), 0775, true);
@mkdir(sprintf('%s/vendor', $this->tempPath), 0775, true);
@mkdir(sprintf('%s/vendor/somelib', $this->tempPath), 0775, true);

file_put_contents(sprintf('%s/solution.php', $this->tempPath), 'ENTRYPOINT');
file_put_contents(sprintf('%s/some-class.php', $this->tempPath), 'SOME CLASS');
touch(sprintf('%s/exclude.txt', $this->tempPath));
touch(sprintf('%s/nested/exclude.txt', $this->tempPath));
touch(sprintf('%s/nested/deep/exclude.txt', $this->tempPath));
touch(sprintf('%s/vendor/somelib/app.php', $this->tempPath));

$exclusions = ['exclude.txt', 'vendor'];

$solution = DirectorySolution::fromDirectory($tempPath, $exclusions);
$solution = DirectorySolution::fromDirectory($this->tempPath, $exclusions);

$this->assertSame(sprintf('%s/solution.php', $tempPath), $solution->getEntryPoint());
self::assertSame('ENTRYPOINT', file_get_contents($solution->getEntryPoint()));
$files = $solution->getFiles();
$this->assertCount(2, $files);

$this->assertSame(sprintf('%s/solution.php', $tempPath), $files[0]->__toString());
$this->assertSame(sprintf('%s/some-class.php', $tempPath), $files[1]->__toString());

unlink(sprintf('%s/solution.php', $tempPath));
unlink(sprintf('%s/some-class.php', $tempPath));
unlink(sprintf('%s/exclude.txt', $tempPath));
unlink(sprintf('%s/nested/exclude.txt', $tempPath));
unlink(sprintf('%s/nested/deep/exclude.txt', $tempPath));
unlink(sprintf('%s/vendor/somelib/app.php', $tempPath));
rmdir(sprintf('%s/nested/deep', $tempPath));
rmdir(sprintf('%s/nested', $tempPath));
rmdir(sprintf('%s/vendor/somelib', $tempPath));
rmdir(sprintf('%s/vendor', $tempPath));
rmdir($tempPath);
self::assertCount(2, $files);

self::assertSame('ENTRYPOINT', file_get_contents($files[0]->__toString()));
self::assertSame('SOME CLASS', file_get_contents($files[1]->__toString()));
}
}
Loading