Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 1f68e38
Showing
25 changed files
with
887 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
/.github export-ignore | ||
/Tests export-ignore | ||
/.gitattributes export-ignore | ||
/.gitignore export-ignore | ||
/ecs.php export-ignore | ||
/phpstan.dist.neon export-ignore | ||
/phpunit.xml.dist export-ignore | ||
/psalm.xml export-ignore | ||
/rector.php export-ignore |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
name: 'Continuous Integration' | ||
|
||
on: | ||
pull_request: ~ | ||
push: | ||
branches: [ main ] | ||
|
||
jobs: | ||
composer-validate: | ||
name: Composer Validate | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: 'Checkout Code' | ||
uses: actions/checkout@v4 | ||
|
||
- name: 'Validate composer.json' | ||
run: composer validate --strict --ansi | ||
|
||
code-analysis: | ||
needs: composer-validate | ||
name: ${{ matrix.actions.name }} | ||
runs-on: ubuntu-latest | ||
strategy: | ||
fail-fast: false | ||
matrix: | ||
actions: | ||
- name: 'Coding Standard' | ||
run: vendor/bin/ecs check --no-progress-bar --ansi | ||
- name: 'Rector' | ||
run: vendor/bin/rector process --dry-run --no-progress-bar --ansi | ||
- name: 'Psalm' | ||
run: vendor/bin/psalm --stats --no-progress --output-format=github --threads=$(nproc) | ||
- name: 'PHPStan' | ||
run: vendor/bin/phpstan analyze --no-progress --error-format=github --ansi --configuration=phpstan.dist.neon ./ | ||
steps: | ||
- name: 'Checkout Code' | ||
uses: actions/checkout@v4 | ||
|
||
- name: 'Setup PHP' | ||
uses: shivammathur/setup-php@v2 | ||
with: | ||
php-version: 8.2 | ||
coverage: none | ||
tools: composer:v2 | ||
|
||
- name: 'Install Dependencies' | ||
uses: "ramsey/composer-install@v2" | ||
with: | ||
composer-options: "--optimize-autoloader" | ||
|
||
- run: ${{ matrix.actions.run }} | ||
test: | ||
needs: composer-validate | ||
name: PHPUnit | ||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
php: [ '8.0', '8.2' ] | ||
dependencies: [ highest, lowest ] | ||
steps: | ||
- name: 'Checkout Code' | ||
uses: actions/checkout@v4 | ||
|
||
- name: 'Setup PHP' | ||
uses: shivammathur/setup-php@v2 | ||
with: | ||
php-version: ${{ matrix.php }} | ||
coverage: none | ||
tools: composer:v2 | ||
|
||
- name: 'Install Dependencies' | ||
uses: "ramsey/composer-install@v2" | ||
with: | ||
composer-options: "--optimize-autoloader" | ||
dependency-versions: ${{ matrix.dependencies }} | ||
|
||
- name: 'Run PHPUnit' | ||
run: vendor/bin/phpunit --testdox --colors=always --configuration=phpunit.xml.dist | ||
|
||
code-coverage: | ||
needs: test | ||
name: PHPUnit Coverage | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: 'Checkout Code' | ||
uses: actions/checkout@v4 | ||
|
||
- name: 'Setup PHP' | ||
uses: shivammathur/setup-php@v2 | ||
with: | ||
php-version: 8.2 | ||
coverage: xdebug | ||
tools: composer:v2 | ||
|
||
- name: 'Install Dependencies' | ||
uses: "ramsey/composer-install@v2" | ||
with: | ||
composer-options: "--optimize-autoloader" | ||
|
||
- name: 'Run PHPUnit with Coverage' | ||
run: vendor/bin/phpunit --configuration=phpunit.xml.dist --coverage-clover=coverage.xml | ||
|
||
- name: 'Upload coverage reports to Codecov' | ||
uses: codecov/codecov-action@v3 | ||
with: | ||
token: ${{ secrets.CODECOV_TOKEN }} | ||
files: ./coverage.xml | ||
fail_ci_if_error: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
/vendor/ | ||
/.phpunit.cache/ | ||
composer.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace PhPhD\CacheTestBundle\Accessor; | ||
|
||
use Closure; | ||
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase; | ||
use Symfony\Component\DependencyInjection\ContainerInterface; | ||
|
||
final class TestContainerAccessor | ||
{ | ||
/** @param class-string<KernelTestCase> $testClassName */ | ||
public function runWithContainer(string $testClassName, callable $callback): void | ||
{ | ||
$container = $this->getContainer($testClassName); | ||
|
||
try { | ||
$callback($container); | ||
} finally { | ||
$this->ensureKernelShutdown($testClassName); | ||
} | ||
} | ||
|
||
/** @param class-string<KernelTestCase> $testClassName */ | ||
private function getContainer(string $testClassName): ContainerInterface | ||
{ | ||
/** | ||
* @var Closure $getContainer | ||
* | ||
* @psalm-suppress NonStaticSelfCall | ||
* @psalm-suppress TooFewArguments | ||
* | ||
* @phpstan-ignore-next-line | ||
*/ | ||
$getContainer = (static fn (): ContainerInterface => self::getContainer())->bindTo(null, $testClassName); | ||
|
||
/** @var ContainerInterface $container */ | ||
$container = $getContainer(); | ||
|
||
return $container; | ||
} | ||
|
||
/** @param class-string<KernelTestCase> $testClassName */ | ||
private function ensureKernelShutdown(string $testClassName): void | ||
{ | ||
/** | ||
* @var Closure $shutDown | ||
* | ||
* @psalm-suppress NonStaticSelfCall | ||
* @psalm-suppress TooFewArguments | ||
* | ||
* @phpstan-ignore-next-line | ||
*/ | ||
$shutDown = (static fn () => self::ensureKernelShutdown())->bindTo(null, $testClassName); | ||
|
||
$shutDown(); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace PhPhD\CacheTestBundle\Attribute; | ||
|
||
use Attribute; | ||
|
||
#[Attribute(Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)] | ||
final class ClearPool | ||
{ | ||
public function __construct( | ||
private string $name, | ||
) { | ||
} | ||
|
||
public function getName(): string | ||
{ | ||
return $this->name; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace PhPhD\CacheTestBundle\Clearer; | ||
|
||
use Psr\Cache\CacheItemPoolInterface; | ||
use Symfony\Component\DependencyInjection\ContainerInterface; | ||
use UnexpectedValueException; | ||
|
||
use function array_map; | ||
use function sprintf; | ||
|
||
final class CacheItemPoolsClearer | ||
{ | ||
public function __construct( | ||
/** @var list<string> */ | ||
private array $poolsServiceNames, | ||
) { | ||
} | ||
|
||
public function __invoke(ContainerInterface $container): void | ||
{ | ||
$pools = $this->getPools($container); | ||
|
||
$this->clearPools($pools); | ||
} | ||
|
||
/** @return list<CacheItemPoolInterface> */ | ||
private function getPools(ContainerInterface $container): array | ||
{ | ||
return array_map(static function (string $poolServiceName) use ($container) { | ||
/** @var CacheItemPoolInterface $pool */ | ||
$pool = $container->get($poolServiceName); | ||
|
||
if (!$pool instanceof CacheItemPoolInterface) { | ||
throw new UnexpectedValueException( | ||
sprintf('Expected the service "%s" to be instance of %s', $poolServiceName, CacheItemPoolInterface::class), | ||
); | ||
} | ||
|
||
return $pool; | ||
}, $this->poolsServiceNames); | ||
} | ||
|
||
/** @param list<CacheItemPoolInterface> $pools */ | ||
private function clearPools(array $pools): void | ||
{ | ||
array_map( | ||
static fn (CacheItemPoolInterface $pool): bool => $pool->clear(), | ||
$pools, | ||
); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
<?php | ||
|
||
/** @noinspection PhpDocMissingThrowsInspection */ | ||
|
||
declare(strict_types=1); | ||
|
||
namespace PhPhD\CacheTestBundle\Clearer; | ||
|
||
use PhPhD\CacheTestBundle\Accessor\TestContainerAccessor; | ||
use PhPhD\CacheTestBundle\Attribute\ClearPool; | ||
use ReflectionAttribute; | ||
use ReflectionClass; | ||
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase; | ||
|
||
use function array_map; | ||
use function is_a; | ||
use function strtok; | ||
|
||
final class TestClearer | ||
{ | ||
private TestContainerAccessor $containerAccessor; | ||
|
||
public function __construct() | ||
{ | ||
$this->containerAccessor = new TestContainerAccessor(); | ||
} | ||
|
||
public function __invoke(string $testName): void | ||
{ | ||
/** @var class-string $testClassName */ | ||
$testClassName = strtok($testName, '::'); | ||
|
||
if (!$this->supports($testClassName)) { | ||
return; | ||
} | ||
|
||
$poolServiceNames = $this->getPoolServiceNames($testClassName); | ||
|
||
if ([] === $poolServiceNames) { | ||
return; | ||
} | ||
|
||
$cacheItemPoolsClearer = new CacheItemPoolsClearer($poolServiceNames); | ||
|
||
$this->containerAccessor->runWithContainer($testClassName, $cacheItemPoolsClearer); | ||
} | ||
|
||
/** @psalm-assert-if-true class-string<KernelTestCase> $testClassName */ | ||
private function supports(string $testClassName): bool | ||
{ | ||
return is_a($testClassName, KernelTestCase::class, true); | ||
} | ||
|
||
/** | ||
* @param class-string<KernelTestCase> $testClassName | ||
* | ||
* @return list<string> | ||
*/ | ||
private function getPoolServiceNames(string $testClassName): array | ||
{ | ||
$clearPools = $this->getClearPoolAttributes($testClassName); | ||
|
||
return array_map(static fn (ClearPool $pool): string => $pool->getName(), $clearPools); | ||
} | ||
|
||
/** | ||
* @param class-string<KernelTestCase> $testClassName | ||
* | ||
* @return list<ClearPool> | ||
*/ | ||
private function getClearPoolAttributes(string $testClassName): array | ||
{ | ||
$reflectionClass = new ReflectionClass($testClassName); | ||
$attributes = $reflectionClass->getAttributes(ClearPool::class); | ||
|
||
return array_map(static fn (ReflectionAttribute $attribute): object => $attribute->newInstance(), $attributes); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace PhPhD\CacheTestBundle\DependencyInjection; | ||
|
||
use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
use Symfony\Component\DependencyInjection\Extension\Extension; | ||
|
||
final class PhdCacheTestExtension extends Extension | ||
{ | ||
public const ALIAS = 'phd_cache_test'; | ||
|
||
/** @override */ | ||
public function load(array $configs, ContainerBuilder $container): void | ||
{ | ||
// nothing to do yet | ||
} | ||
|
||
/** @override */ | ||
public function getAlias(): string | ||
{ | ||
return self::ALIAS; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Copyright (c) Yevhen Sidelnyk | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
this software and associated documentation files (the "Software"), to deal in | ||
the Software without restriction, including without limitation the rights to | ||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies | ||
of the Software, and to permit persons to whom the Software is furnished to do | ||
so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
Oops, something went wrong.