support assertFileEquals() normalizing

rectorphp · Jul 19, 2021 · 94d3b1d · 94d3b1d
1 parent 60ebb34
commit 94d3b1d
Show file tree

Hide file tree

Showing 7 changed files with 61 additions and 56 deletions.
diff --git a/packages/FileSystemRector/ValueObject/AddedFileWithContent.php b/packages/FileSystemRector/ValueObject/AddedFileWithContent.php
@@ -18,7 +18,6 @@ public function __construct(
         }
     }
 
-<<<<<<< HEAD
     public function getRealPath(): string
     {
         $realpath = realpath($this->filePath);
@@ -27,24 +26,6 @@ public function getRealPath(): string
         }
 
         return $realpath;
-=======
-    /**
-     * @return string
-     */
-    public function getRealPath()
-    {
-<<<<<<< HEAD
-        return realpath($this->filePath);
->>>>>>> d5ea8a664 (apply PlatformAgnosticAssertions on MoveValueObjectsToValueObjectDirectoryRectorTest)
-=======
-        $realpath = realpath($this->filePath);
-
-        if ($realpath === false) {
-            throw new ShouldNotHappenException();
-        }
-
-        return $realpath;
->>>>>>> c169f9af3 (eleminate false-return type from AddedFileWithContent::getRealPath())
     }
 
     public function getFilePath(): string

diff --git a/packages/Testing/PHPUnit/AbstractRectorTestCase.php b/packages/Testing/PHPUnit/AbstractRectorTestCase.php
@@ -5,7 +5,6 @@
 namespace Rector\Testing\PHPUnit;
 
 use Iterator;
-use Nette\Utils\Strings;
 use PHPStan\Analyser\NodeScopeResolver;
 use PHPUnit\Framework\ExpectationFailedException;
 use Psr\Container\ContainerInterface;
@@ -71,6 +70,18 @@ protected function setUp(): void
         $bootstrapFilesIncluder->includeBootstrapFiles();
     }
 
+    protected function tearDown(): void
+    {
+        unset(
+            $this->applicationFileProcessor,
+            $this->parameterProvider,
+            $this->dynamicSourceLocatorProvider,
+            $this->removedAndAddedFilesCollector,
+            $this->originalTempFileInfo,
+        );
+        gc_collect_cycles();
+    }
+
     /**
      * @return Iterator<SmartFileInfo>
      */
@@ -139,7 +150,7 @@ private function doTestFileMatchesExpectedContent(
 
     private function normalizeNewlines(string $string): string
     {
-        return Strings::replace($string, '#\r\n|\r|\n#', "\n");
+        return str_replace("\r\n", "\n", $string);
     }
 
     private function processFileInfo(SmartFileInfo $fileInfo): string
@@ -160,16 +171,4 @@ private function processFileInfo(SmartFileInfo $fileInfo): string
 
         return $file->getFileContent();
     }
-
-    protected function tearDown(): void
-    {
-        unset(
-            $this->applicationFileProcessor,
-            $this->parameterProvider,
-            $this->dynamicSourceLocatorProvider,
-            $this->removedAndAddedFilesCollector,
-            $this->originalTempFileInfo,
-        );
-        gc_collect_cycles();
-    }
 }
diff --git a/packages/Testing/PHPUnit/PlatformAgnosticAssertions.php b/packages/Testing/PHPUnit/PlatformAgnosticAssertions.php
@@ -1,22 +1,22 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Rector\Testing\PHPUnit;
 
+use Nette\Utils\FileSystem;
 use PHPUnit\Framework\Constraint\IsEqual;
-use PHPUnit\Framework\ExpectationFailedException;
 
 /**
  * Relaxes phpunit assertions to be forgiving about platform issues, like directory-separators or newlines.
  */
-trait PlatformAgnosticAssertions {
+trait PlatformAgnosticAssertions
+{
     /**
      * Asserts that two variables have the same type and value.
      * Used on objects, it asserts that two variables reference
      * the same object.
      *
-     * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
-     * @throws ExpectationFailedException
-     *
      * @psalm-template ExpectedType
      * @psalm-param ExpectedType $expected
      * @psalm-assert =ExpectedType $actual
@@ -37,27 +37,46 @@ public static function assertSame($expected, $actual, string $message = ''): voi
     /**
      * Asserts that the contents of a string is equal
      * to the contents of a file.
-     *
-     * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
-     * @throws ExpectationFailedException
      */
-    public static function assertStringEqualsFile(string $expectedFile, string $actualString, string $message = ''): void
-    {
+    public static function assertStringEqualsFile(
+        string $expectedFile,
+        string $actualString,
+        string $message = ''
+    ): void {
         parent::assertFileExists($expectedFile, $message);
 
-        $expectedString = file_get_contents($expectedFile);
-        $expectedString = self::normalize($expectedString);
-        $constraint = new IsEqual($expectedString);
+        $expectedString = self::getNormalizedFileContents($expectedFile);
+        $isEqual = new IsEqual($expectedString);
 
         $actualString = self::normalize($actualString);
 
-        parent::assertThat($actualString, $constraint, $message);
+        parent::assertThat($actualString, $isEqual, $message);
     }
 
-    private static function normalize(string $string) {
+    /**
+     * Asserts that the contents of one file is equal to the contents of another
+     * file.
+     */
+    public static function assertFileEquals(string $expected, string $actual, string $message = ''): void
+    {
+        static::assertFileExists($expected, $message);
+        static::assertFileExists($actual, $message);
+
+        $isEqual = new IsEqual(self::getNormalizedFileContents($expected));
+
+        static::assertThat(self::getNormalizedFileContents($actual), $isEqual, $message);
+    }
+
+    private static function normalize(string $string): array | string
+    {
         $string = str_replace("\r\n", "\n", $string);
-        $string = str_replace(DIRECTORY_SEPARATOR, "/", $string);
 
-        return $string;
+        return str_replace(DIRECTORY_SEPARATOR, '/', $string);
+    }
+
+    private static function getNormalizedFileContents(string $filePath): string
+    {
+        $expectedString = FileSystem::read($filePath);
+        return self::normalize($expectedString);
     }
 }
diff --git a/rules-tests/Php73/Rector/String_/SensitiveHereNowDocRector/SensitiveHereNowDocRectorTest.php b/rules-tests/Php73/Rector/String_/SensitiveHereNowDocRector/SensitiveHereNowDocRectorTest.php
@@ -8,6 +8,9 @@
 use Rector\Testing\PHPUnit\AbstractRectorTestCase;
 use Symplify\SmartFileSystem\SmartFileInfo;
 
+/**
+ * Minor differences on windows, see https://github.com/rectorphp/rector/issues/6571
+ */
 final class SensitiveHereNowDocRectorTest extends AbstractRectorTestCase
 {
     /**

diff --git a/rules-tests/TypeDeclaration/TypeNormalizerTest.php b/rules-tests/TypeDeclaration/TypeNormalizerTest.php
@@ -23,6 +23,11 @@ protected function setUp(): void
         $this->typeNormalizer = $this->getService(TypeNormalizer::class);
     }
 
+    protected function tearDown(): void
+    {
+        unset($this->typeNormalizer);
+    }
+
     /**
      * @dataProvider provideDataNormalizeArrayOfUnionToUnionArray()
      */
@@ -48,9 +53,4 @@ public function provideDataNormalizeArrayOfUnionToUnionArray(): Iterator
         $evenMoreNestedArrayType = new ArrayType(new MixedType(), $moreNestedArrayType);
         yield [$evenMoreNestedArrayType, 'int[][][]|string[][][]'];
     }
-
-    protected function tearDown(): void
-    {
-        unset($this->typeNormalizer);
-    }
 }
diff --git a/rules/PSR4/FileRelocationResolver.php b/rules/PSR4/FileRelocationResolver.php
@@ -180,7 +180,8 @@ private function replaceRelativeFilePathsWithBeforeAfter(
         return implode(DIRECTORY_SEPARATOR, $relativeFilePathParts);
     }
 
-    private function normalizeDirectorySeparator(string $path):string {
+    private function normalizeDirectorySeparator(string $path): string
+    {
         return str_replace('/', DIRECTORY_SEPARATOR, $path);
     }
 }
diff --git a/tests/NodeFactory/ClassWithPublicPropertiesFactory/ClassWithPublicPropertiesFactoryTest.php b/tests/NodeFactory/ClassWithPublicPropertiesFactory/ClassWithPublicPropertiesFactoryTest.php
@@ -34,6 +34,8 @@ protected function setUp(): void
     public function test(SmartFileInfo $fixtureFileInfo): void
     {
         $contents = $fixtureFileInfo->getContents();
+        // normalize for windows compat
+        $contents = str_replace("\r\n", "\n", $contents);
         [$content, $expected] = explode("-----\n", $contents, 2);
 
         $classSettings = Json::decode($content, Json::FORCE_ARRAY);