SADM/pest
1
0
Fork 0
mirror of https://github.com/pestphp/pest.git synced 2026-03-06 15:57:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

snapshots code cleanup

Browse Source
This commit is contained in:
Fabio Ivona
2023-07-27 11:16:27 +02:00
parent 39e0d61dec
commit b60d21dfe2
4 changed files with 48 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/Mixins/Expectation.php
View File

@ -805,6 +805,11 @@ final class Expectation
*/
public function toMatchSnapshot(string $message = ''): self
{
$snapshots = TestSuite::getInstance()->snapshots;
$testCase = TestSuite::getInstance()->test;
assert($testCase instanceof TestCase);
$string = match (true) {
is_string($this->value) => $this->value,
is_object($this->value) && method_exists($this->value, '__toString') => $this->value->__toString(),
@ -817,12 +822,8 @@ final class Expectation
default => InvalidExpectationValue::expected('array|object|string'),
};
$testCase = TestSuite::getInstance()->test;
assert($testCase instanceof TestCase);
$snapshots = TestSuite::getInstance()->snapshots;
if ($snapshots->has($testCase, $string)) {
[$filename, $content] = $snapshots->get($testCase, $string);
if ($snapshots->has()) {
[$filename, $content] = $snapshots->get();
Assert::assertSame(
$content,
@ -830,7 +831,7 @@ final class Expectation
$message === '' ? "Failed asserting that the string value matches its snapshot ($filename)." : $message
);
} else {
$filename = $snapshots->save($testCase, $string);
$filename = $snapshots->save($string);
$testCase::markTestIncomplete('Snapshot created at ['.$filename.'].');
}

44
src/Repositories/SnapshotRepository.php
View File

@ -5,8 +5,7 @@ declare(strict_types=1);
namespace Pest\Repositories;
use Pest\Exceptions\ShouldNotHappen;
use Pest\Support\Str;
use PHPUnit\Framework\TestCase;
use Pest\TestSuite;
/**
* @internal
@ -25,11 +24,9 @@ final class SnapshotRepository
/**
* Checks if the snapshot exists.
*/
public function has(TestCase $testCase, string $description): bool
public function has(): bool
{
[$filename, $description] = $this->getFilenameAndDescription($testCase);
return file_exists($this->getSnapshotFilename($filename, $description));
return file_exists($this->getSnapshotFilename());
}
/**
@ -39,11 +36,9 @@ final class SnapshotRepository
*
* @throws ShouldNotHappen
*/
public function get(TestCase $testCase, string $description): array
public function get(): array
{
[$filename, $description] = $this->getFilenameAndDescription($testCase);
$contents = file_get_contents($snapshotFilename = $this->getSnapshotFilename($filename, $description));
$contents = file_get_contents($snapshotFilename = $this->getSnapshotFilename());
if ($contents === false) {
throw ShouldNotHappen::fromMessage('Snapshot file could not be read.');
@ -57,11 +52,9 @@ final class SnapshotRepository
/**
* Saves the given snapshot for the given test case.
*/
public function save(TestCase $testCase, string $snapshot): string
public function save(string $snapshot): string
{
[$filename, $description] = $this->getFilenameAndDescription($testCase);
$snapshotFilename = $this->getSnapshotFilename($filename, $description);
$snapshotFilename = $this->getSnapshotFilename();
if (! file_exists(dirname($snapshotFilename))) {
mkdir(dirname($snapshotFilename), 0755, true);
@ -103,33 +96,16 @@ final class SnapshotRepository
}
}
/**
* Gets the snapshot's "filename" and "description".
*
* @return array{0: string, 1: string}
*/
private function getFilenameAndDescription(TestCase $testCase): array
{
$filename = (fn () => self::$__filename)->call($testCase, $testCase::class); // @phpstan-ignore-line
$description = str_replace('__pest_evaluable_', '', $testCase->name());
$datasetAsString = str_replace('__pest_evaluable_', '', Str::evaluable($testCase->dataSetAsStringWithData()));
$description = str_replace(' ', '_', $description.$datasetAsString);
return [$filename, $description];
}
/**
* Gets the snapshot's "filename".
*/
private function getSnapshotFilename(string $filename, string $description): string
private function getSnapshotFilename(): string
{
$relativePath = str_replace($this->testsPath, '', $filename);
$relativePath = str_replace($this->testsPath, '', TestSuite::getInstance()->getFilename());
// remove extension from filename
$relativePath = substr($relativePath, 0, (int) strrpos($relativePath, '.'));
return sprintf('%s/%s.snap', $this->testsPath.'/'.$this->snapshotsPath.$relativePath, $description);
return sprintf('%s/%s.snap', $this->testsPath.'/'.$this->snapshotsPath.$relativePath, TestSuite::getInstance()->getDescription());
}
}

18
src/TestSuite.php
View File

@ -11,6 +11,7 @@ use Pest\Repositories\BeforeAllRepository;
use Pest\Repositories\BeforeEachRepository;
use Pest\Repositories\SnapshotRepository;
use Pest\Repositories\TestRepository;
use Pest\Support\Str;
use PHPUnit\Framework\TestCase;
/**
@ -105,4 +106,21 @@ final class TestSuite
return self::$instance;
}
public function getFilename(): string
{
assert($this->test instanceof TestCase);
return (fn () => self::$__filename)->call($this->test, $this->test::class); // @phpstan-ignore-line
}
public function getDescription(): string
{
assert($this->test instanceof TestCase);
$description = str_replace('__pest_evaluable_', '', $this->test->name());
$datasetAsString = str_replace('__pest_evaluable_', '', Str::evaluable($this->test->dataSetAsStringWithData()));
return str_replace(' ', '_', $description.$datasetAsString);
}
}