Skip to content
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.

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

Bump PHPUnit to version 10 and apply some rules of rector for PHPUnit #39

Merged
merged 1 commit into from
Aug 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/code_analysis.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:

-
name: 'Tests'
run: vendor/bin/phpunit
run: vendor/bin/phpunit --testdox

-
name: 'PHP Linter'
Expand Down
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
composer.lock
/vendor

.phpunit.result.cache
/.phpunit.cache
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"symplify/symplify-kernel": "^11.1"
},
"require-dev": {
"phpunit/phpunit": "^9.5.26",
"phpunit/phpunit": "^10.3.1",
"cweagans/composer-patches": "^1.7",
"rector/rector": "^0.17",
"phpstan/phpstan": "^1.10",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace Symplify\MonorepoBuilder\Tests\ComposerJsonManipulator\Sorter;

use PHPUnit\Framework\Attributes\DataProvider;
use Iterator;
use Symplify\MonorepoBuilder\ComposerJsonManipulator\Sorter\ComposerPackageSorter;
use Symplify\MonorepoBuilder\Kernel\MonorepoBuilderKernel;
Expand All @@ -20,10 +21,10 @@ protected function setUp(): void
}

/**
* @dataProvider provideData()
* @param array<string, string> $packages
* @param array<string, string> $expectedSortedPackages
*/
#[DataProvider('provideData')]
public function test(array $packages, array $expectedSortedPackages): void
{
$sortedPackages = $this->composerPackageSorter->sortPackages($packages);
Expand All @@ -33,7 +34,7 @@ public function test(array $packages, array $expectedSortedPackages): void
/**
* @return Iterator<array<int, array<string, string>>>
*/
public function provideData(): Iterator
public static function provideData(): Iterator
{
yield [
[
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace Symplify\MonorepoBuilder\Tests\Merge\ComposerJsonMerger;

use PHPUnit\Framework\Attributes\DataProvider;
use Iterator;
use Symplify\EasyTesting\DataProvider\StaticFixtureFinder;
use Symplify\MonorepoBuilder\Merge\ComposerJsonMerger;
Expand All @@ -21,9 +22,7 @@ protected function setUp(): void
$this->composerJsonMerger = $this->getService(ComposerJsonMerger::class);
}

/**
* @dataProvider provideData()
*/
#[DataProvider('provideData')]
public function testFixture(SmartFileInfo $fixtureFileInfo): void
{
$trioContent = $this->trioFixtureSplitter->splitFileInfo($fixtureFileInfo);
Expand All @@ -36,7 +35,7 @@ public function testFixture(SmartFileInfo $fixtureFileInfo): void
$this->assertComposerJsonEquals($trioContent->getExpectedResult(), $mainComposerJson);
}

public function provideData(): Iterator
public static function provideData(): Iterator
{
return StaticFixtureFinder::yieldDirectoryExclusively(__DIR__ . '/Fixture', '*.json');
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

namespace Symplify\MonorepoBuilder\Tests\Merge\ComposerKeyMerger;

use Iterator;
use PHPUnit\Framework\Attributes\DataProvider;
use Symplify\EasyTesting\DataProvider\StaticFixtureFinder;
use Symplify\MonorepoBuilder\Merge\ComposerKeyMerger\MinimalStabilityKeyMerger;
use Symplify\MonorepoBuilder\Tests\Merge\ComposerJsonDecorator\AbstractComposerJsonDecoratorTest;
Expand All @@ -15,9 +15,7 @@
*/
final class MinimalStabilityKeyMergerTest extends AbstractComposerJsonDecoratorTest
{
/**
* @dataProvider provideData
*/
#[DataProvider('provideData')]
public function testFixture(SmartFileInfo $fixtureFileInfo): void
{
$trioContent = $this->trioFixtureSplitter->splitFileInfo($fixtureFileInfo);
Expand All @@ -30,7 +28,7 @@ public function testFixture(SmartFileInfo $fixtureFileInfo): void
$this->assertComposerJsonEquals($trioContent->getExpectedResult(), $mainComposerJson);
}

public function provideData(): Iterator
public static function provideData(): iterable
{
return StaticFixtureFinder::yieldDirectoryExclusively(__DIR__ . '/Fixture/MinimalStability', '*.json');
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,9 @@

final class ComposerPatchesPathNormalizerTest extends AbstractComposerJsonDecoratorTest
{
private ComposerPatchesPathNormalizer $composerPatchesPathNormalizer;

protected function setUp(): void
{
parent::setUp();

$this->composerPatchesPathNormalizer = $this->getService(ComposerPatchesPathNormalizer::class);
}

public function test(): void
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace Symplify\MonorepoBuilder\Tests\Propagate\VersionPropagator;

use PHPUnit\Framework\Attributes\DataProvider;
use Iterator;
use Symplify\EasyTesting\DataProvider\StaticFixtureFinder;
use Symplify\MonorepoBuilder\Propagate\VersionPropagator;
Expand All @@ -20,9 +21,7 @@ protected function setUp(): void
$this->versionPropagator = $this->getService(VersionPropagator::class);
}

/**
* @dataProvider provideData()
*/
#[DataProvider('provideData')]
public function test(SmartFileInfo $fixtureFileInfo): void
{
$trioContent = $this->trioFixtureSplitter->splitFileInfo($fixtureFileInfo);
Expand All @@ -35,7 +34,7 @@ public function test(SmartFileInfo $fixtureFileInfo): void
$this->assertComposerJsonEquals($trioContent->getExpectedResult(), $packageComposerJson);
}

public function provideData(): Iterator
public static function provideData(): Iterator
{
return StaticFixtureFinder::yieldDirectoryExclusively(__DIR__ . '/Fixture', '*.json');
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace Symplify\MonorepoBuilder\Tests\Testing\ComposerJson;

use PHPUnit\Framework\Attributes\DataProvider;
use Iterator;
use Nette\Utils\Json;
use Symplify\MonorepoBuilder\Kernel\MonorepoBuilderKernel;
Expand All @@ -22,9 +23,7 @@ protected function setUp(): void
$this->composerJsonSymlinker = $this->getService(ComposerJsonSymlinker::class);
}

/**
* @dataProvider provideData()
*/
#[DataProvider('provideData')]
public function testItCanAppendPathRepository(
string $packagePath,
string $packageName,
Expand All @@ -48,7 +47,7 @@ public function testItCanAppendPathRepository(
/**
* @return Iterator<string[]|bool[]>
*/
public function provideData(): Iterator
public static function provideData(): Iterator
{
yield [
__DIR__ . '/packages/package-one/composer.json',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
use Symplify\MonorepoBuilder\ComposerJsonManipulator\Json\JsonCleaner;
use Symplify\MonorepoBuilder\ComposerJsonManipulator\Json\JsonInliner;
use Symplify\MonorepoBuilder\ComposerJsonManipulator\ValueObject\ComposerJson;
use Symplify\PackageBuilder\Configuration\StaticEolConfiguration;
use Symplify\SmartFileSystem\SmartFileInfo;
use Symplify\SmartFileSystem\SmartFileSystem;

Expand Down Expand Up @@ -85,7 +84,7 @@ public function encodeJsonToFileContent(array $json): string
{
// Empty arrays may lead to bad encoding since we can't be sure whether they need to be arrays or objects.
$json = $this->jsonCleaner->removeEmptyKeysFromJsonArray($json);
$jsonContent = Json::encode($json, Json::PRETTY) . StaticEolConfiguration::getEolChar();
$jsonContent = Json::encode($json, Json::PRETTY) . PHP_EOL;

return $this->jsonInliner->inlineSections($jsonContent);
}
Expand Down
4 changes: 2 additions & 2 deletions packages/ComposerJsonManipulator/ValueObject/ComposerJson.php
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ public function getAutoload(): array
*/
public function getAbsoluteAutoloadDirectories(): array
{
if ($this->fileInfo === null) {
if (!$this->fileInfo instanceof SmartFileInfo) {
throw new ShouldNotHappenException();
}

Expand Down Expand Up @@ -832,7 +832,7 @@ private function sortItemsByOrderedListOfKeys(array $contentItems, array $ordere

private function resolveExistingAutoloadDirectory(string $autoloadDirectory): string
{
if ($this->fileInfo === null) {
if (!$this->fileInfo instanceof SmartFileInfo) {
throw new ShouldNotHappenException();
}

Expand Down
1 change: 1 addition & 0 deletions packages/Merge/ComposerJsonMerger.php
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ private function mergeJsonToRootWithPackageFileInfo(
foreach ($this->composerPathNormalizers as $composerPathNormalizer) {
$composerPathNormalizer->normalizePaths($newComposerJson, $packageFileInfo);
}

$this->mergeJsonToRoot($mainComposerJson, $newComposerJson);
}
}
4 changes: 2 additions & 2 deletions packages/Merge/ComposerKeyMerger/ExtraComposerKeyMerger.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ final class ExtraComposerKeyMerger implements ComposerKeyMergerInterface
private const PHPSTAN = 'phpstan';

public function __construct(
private SortedParameterMerger $sorted_parameter_merger
private SortedParameterMerger $sortedParameterMerger
) {
}

Expand All @@ -37,7 +37,7 @@ public function merge(ComposerJson $mainComposerJson, ComposerJson $newComposerJ
}
}

$extra = $this->sorted_parameter_merger->mergeRecursiveAndSort($mainComposerJson->getExtra(), $newComposerJsonExtra);
$extra = $this->sortedParameterMerger->mergeRecursiveAndSort($mainComposerJson->getExtra(), $newComposerJsonExtra);

// do not merge extra alias as only for local packages
if (isset($extra['branch-alias'])) {
Expand Down
15 changes: 6 additions & 9 deletions phpunit.xml
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
<phpunit
bootstrap="vendor/autoload.php"
colors="true"
verbose="true"
>
<testsuite name="all">
<directory>tests</directory>
<directory>packages/*/tests</directory>
</testsuite>
<?xml version="1.0"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd" cacheDirectory=".phpunit.cache">
<testsuite name="all">
<directory>tests</directory>
<directory>packages/*/tests</directory>
</testsuite>
</phpunit>
9 changes: 9 additions & 0 deletions rector.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,19 @@
PHPUnitSetList::PHPUNIT_CODE_QUALITY,
]);

$rectorConfig->rules([
Rector\PHPUnit\PHPUnit70\Rector\Class_\RemoveDataProviderTestPrefixRector::class,
Rector\PHPUnit\PHPUnit100\Rector\Class_\StaticDataProviderClassMethodRector::class,
Rector\PHPUnit\AnnotationsToAttributes\Rector\ClassMethod\DataProviderAnnotationToAttributeRector::class,

]);

$rectorConfig->paths([
__DIR__ . '/config',
__DIR__ . '/src',
__DIR__ . '/tests',
__DIR__ . '/packages',
__DIR__ . '/packages-tests',
]);

$rectorConfig->importNames();
Expand Down
21 changes: 8 additions & 13 deletions tests/Utils/VersionUtilsTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
namespace Symplify\MonorepoBuilder\Tests\Utils;

use Iterator;
use PHPUnit\Framework\Attributes\DataProvider;
use Symplify\MonorepoBuilder\Kernel\MonorepoBuilderKernel;
use Symplify\MonorepoBuilder\Utils\VersionUtils;
use Symplify\PackageBuilder\Testing\AbstractKernelTestCase;
Expand All @@ -19,52 +20,46 @@ protected function setUp(): void
$this->versionUtils = $this->getService(VersionUtils::class);
}

/**
* @dataProvider provideDataAlias()
*/
#[DataProvider('provideDataAlias')]
public function testAlias(string $currentVersion, string $expectedVersion): void
{
$nextAliasVersion = $this->versionUtils->getNextAliasFormat($currentVersion);
$this->assertSame($expectedVersion, $nextAliasVersion);
}

public function provideDataAlias(): Iterator
public static function provideDataAlias(): Iterator
{
yield ['v4.0.0', '4.1-dev'];
yield ['4.0.0', '4.1-dev'];
yield ['4.5.0', '4.6-dev'];
yield ['v8.0-beta', '8.0-dev'];
}

/**
* @dataProvider provideDataForRequiredNextVersion()
*/
#[DataProvider('provideDataForRequiredNextVersion')]
public function testRequiredNextVersion(string $currentVersion, string $expectedVersion): void
{
$nextRequiredVersion = $this->versionUtils->getRequiredNextFormat($currentVersion);
$this->assertSame($expectedVersion, $nextRequiredVersion);
}

public function provideDataForRequiredNextVersion(): Iterator
public static function provideDataForRequiredNextVersion(): Iterator
{
yield ['v4.0.0', '^4.1'];
yield ['4.0.0', '^4.1'];
yield ['8.0-beta', '^8.0'];
}

/**
* @dataProvider provideDataForRequiredVersion()
*/
#[DataProvider('provideDataForRequiredVersion')]
public function testRequiredVersion(string $currentVersion, string $expectedVersion): void
{
$requiredVersion = $this->versionUtils->getRequiredFormat($currentVersion);
$this->assertSame($expectedVersion, $requiredVersion);
}

/**
* @return \Iterator<string[]>
* @return Iterator<string[]>
*/
public function provideDataForRequiredVersion(): Iterator
public static function provideDataForRequiredVersion(): Iterator
{
yield ['v4.0.0', '^4.0'];
yield ['4.0.0', '^4.0'];
Expand Down