[TASK] Split integration tests in content and full test

This way changes to the general layouts do not change all the tests. As a bonus with php tools/integration-test-copy-baseline.php you can update the baseline of your tests if still many tests should be affected
phpDocumentor · Nov 21, 2023 · 47f956d · 47f956d
1 parent f1aa6ef
commit 47f956d
Show file tree

Hide file tree

Showing 177 changed files with 876 additions and 1,638 deletions.
diff --git a/packages/guides-theme-bootstrap/resources/template/structure/layout.html.twig b/packages/guides-theme-bootstrap/resources/template/structure/layout.html.twig
@@ -27,8 +27,10 @@
                 <div class="col-lg-9">
                     {% block breadcrumb %}
                     {% endblock %}
+                    <!-- content start -->
                     {% block body %}
                     {% endblock %}
+                    <!-- content end -->
                 </div>
             </div>
         </div>

diff --git a/packages/guides/resources/template/html/structure/layout.html.twig b/packages/guides/resources/template/html/structure/layout.html.twig
@@ -8,7 +8,9 @@
     {%~ endblock %}
 </head>
 <body>
+<!-- content start -->
 {%~ block body %}
 {%~ endblock %}
+<!-- content end -->
 </body>
 </html>
diff --git a/tests/Integration/IntegrationTest.php b/tests/Integration/IntegrationTest.php
@@ -21,16 +21,23 @@
 use function file_exists;
 use function file_get_contents;
 use function implode;
+use function PHPUnit\Framework\assertIsString;
 use function setlocale;
 use function str_ends_with;
 use function str_replace;
+use function strlen;
+use function strpos;
+use function substr;
 use function system;
 use function trim;
 
 use const LC_ALL;
 
 class IntegrationTest extends ApplicationTestCase
 {
+    private const CONTENT_START = '<!-- content start -->';
+    private const CONTENT_END = '<!-- content end -->';
+
     protected function setUp(): void
     {
         setlocale(LC_ALL, 'en_US.utf8');
@@ -44,6 +51,23 @@ public function testHtmlIntegration(
         string $outputPath,
         array $compareFiles,
     ): void {
+        $this->compareHtmlIntegration($outputPath, $inputPath, $expectedPath, $compareFiles, true);
+    }
+
+    /** @param list<string> $compareFiles */
+    #[DataProvider('getTestsForDirectoryTestsFull')]
+    public function testHtmlIntegrationFullFile(
+        string $inputPath,
+        string $expectedPath,
+        string $outputPath,
+        array $compareFiles,
+    ): void {
+        $this->compareHtmlIntegration($outputPath, $inputPath, $expectedPath, $compareFiles, false);
+    }
+
+    /** @param list<string> $compareFiles */
+    private function compareHtmlIntegration(string $outputPath, string $inputPath, string $expectedPath, array $compareFiles, bool $htmlOnlyBetweenMarkers): void
+    {
         system('rm -rf ' . escapeshellarg($outputPath));
         self::assertDirectoryExists($inputPath);
         self::assertDirectoryExists($expectedPath);
@@ -91,6 +115,14 @@ public function testHtmlIntegration(
                 $outputFile = str_replace($expectedPath, $outputPath, $compareFile);
                 if (str_ends_with($compareFile, '.log')) {
                     self::assertFileContainsLines($compareFile, $outputFile);
+                } elseif ($htmlOnlyBetweenMarkers && str_ends_with($compareFile, '.html')) {
+                    self::assertFileEqualsTrimmedBetweenMarkers(
+                        $compareFile,
+                        $outputFile,
+                        'Expected file path: ' . $compareFile,
+                        self::CONTENT_START,
+                        self::CONTENT_END,
+                    );
                 } else {
                     self::assertFileEqualsTrimmed($compareFile, $outputFile, 'Expected file path: ' . $compareFile);
                 }
@@ -106,6 +138,37 @@ public function testHtmlIntegration(
         self::assertFalse($skip, 'Test passes while marked as SKIP.');
     }
 
+    /**
+     * Asserts that each line of the expected file is contained in actual
+     *
+     * @throws ExpectationFailedException
+     */
+    private static function assertFileEqualsTrimmedBetweenMarkers(string $expected, string $actual, string $message, string $startMarker, string $endMarker): void
+    {
+        self::assertFileExists($expected);
+        self::assertFileExists($actual);
+
+        $expectedContent = self::extractContentBetweenMarkers($expected, $startMarker, $endMarker);
+        $actualContent = self::extractContentBetweenMarkers($actual, $startMarker, $endMarker);
+
+        self::assertEquals(self::getTrimmedContent($expectedContent), self::getTrimmedContent($actualContent), $message);
+    }
+
+    /**
+     * Extract content between specified markers in a file.
+     */
+    private static function extractContentBetweenMarkers(string $filePath, string $startMarker, string $endMarker): string
+    {
+        $fileContent = file_get_contents($filePath);
+        self::assertIsString($fileContent);
+        $startPos = strpos($fileContent, $startMarker);
+        self::assertIsInt($startPos, 'Start marker not found in file: ' . $filePath);
+        $endPos = strpos($fileContent, $endMarker, $startPos + strlen($startMarker));
+        self::assertIsInt($endPos, 'End marker not found in file: ' . $filePath);
+
+        return substr($fileContent, $startPos + strlen($startMarker), $endPos - $startPos - strlen($startMarker));
+    }
+
     /**
      * Asserts that each line of the expected file is contained in actual
      *
@@ -145,6 +208,13 @@ public static function assertFileEqualsTrimmed(string $expected, string $actual,
     public static function getTrimmedFileContent(string $file): string
     {
         $fileContent = file_get_contents($file);
+        assertIsString($fileContent);
+
+        return self::getTrimmedContent($fileContent);
+    }
+
+    public static function getTrimmedContent(string $fileContent): string
+    {
         self::assertIsString($fileContent);
         $contentArray = explode("\n", $fileContent);
         array_walk($contentArray, static function (&$value): void {
@@ -164,9 +234,9 @@ public static function getTestsForDirectoryTest(): array
     }
 
     /** @return mixed[] */
-    public static function getTestsForLatex(): array
+    public static function getTestsForDirectoryTestsFull(): array
     {
-        return self::getTestsForDirectory(__DIR__ . '/tests-latex');
+        return self::getTestsForDirectory(__DIR__ . '/tests-full');
     }
 
     /** @return mixed[] */

diff --git a/...lt-menu-several/expected/anotherPage.html → ...lt-menu-several/expected/anotherPage.html b/...lt-menu-several/expected/anotherPage.html → ...lt-menu-several/expected/anotherPage.html
@@ -80,6 +80,7 @@ <h2>Additional Menu</h2>
             </ol>
 </nav>
 
+                    <!-- content start -->
 
 
 <div class="section" id="another-page">
@@ -88,6 +89,7 @@ <h1>Another Page</h1>
             <p>Lorem Ipsum Dolor.</p>
     </div>
 
+                    <!-- content end -->
                 </div>
             </div>
         </div>

diff --git a/...-default-menu-several/expected/index.html → ...-default-menu-several/expected/index.html b/...-default-menu-several/expected/index.html → ...-default-menu-several/expected/index.html
@@ -79,6 +79,7 @@ <h2>Additional Menu</h2>
             </ol>
 </nav>
 
+                    <!-- content start -->
 
 
 <div class="section" id="document-title">
@@ -89,6 +90,7 @@ <h1>Document Title</h1>
 
     </div>
 
+                    <!-- content end -->
                 </div>
             </div>
         </div>

diff --git a/...fault-menu-several/expected/somePage.html → ...fault-menu-several/expected/somePage.html b/...fault-menu-several/expected/somePage.html → ...fault-menu-several/expected/somePage.html
@@ -80,6 +80,7 @@ <h2>Additional Menu</h2>
             </ol>
 </nav>
 
+                    <!-- content start -->
 
 
 <div class="section" id="some-page">
@@ -88,6 +89,7 @@ <h1>Some Page</h1>
             <p>Lorem Ipsum <span class="custom">Dolor</span>.</p>
     </div>
 
+                    <!-- content end -->
                 </div>
             </div>
         </div>

diff --git a/...efault-menu-several/input/anotherPage.rst → ...efault-menu-several/input/anotherPage.rst b/...efault-menu-several/input/anotherPage.rst → ...efault-menu-several/input/anotherPage.rst
diff --git a/...rap-default-menu-several/input/guides.xml → ...rap-default-menu-several/input/guides.xml b/...rap-default-menu-several/input/guides.xml → ...rap-default-menu-several/input/guides.xml
diff --git a/...efault-menu-several/input/include.rst.txt → ...efault-menu-several/input/include.rst.txt b/...efault-menu-several/input/include.rst.txt → ...efault-menu-several/input/include.rst.txt
diff --git a/...trap-default-menu-several/input/index.rst → ...trap-default-menu-several/input/index.rst b/...trap-default-menu-several/input/index.rst → ...trap-default-menu-several/input/index.rst
diff --git a/...p-default-menu-several/input/somePage.rst → ...p-default-menu-several/input/somePage.rst b/...p-default-menu-several/input/somePage.rst → ...p-default-menu-several/input/somePage.rst
diff --git a/...ult-menu-several/input/yetAnotherPage.rst → ...ult-menu-several/input/yetAnotherPage.rst b/...ult-menu-several/input/yetAnotherPage.rst → ...ult-menu-several/input/yetAnotherPage.rst
diff --git a/...ap-default-menu/expected/anotherPage.html → ...ap-default-menu/expected/anotherPage.html b/...ap-default-menu/expected/anotherPage.html → ...ap-default-menu/expected/anotherPage.html
@@ -10,7 +10,8 @@
 </head>
 <body>
 <header class="">
-        <nav class="navbar navbar-expand-lg navbar-dark bg-primary">
+
+<nav class="navbar navbar-expand-lg navbar-dark bg-primary">
     <div class="container">
 
         <a class="navbar-brand" href="#">Navbar</a>
@@ -19,8 +20,7 @@
         </button>
         <div class="collapse navbar-collapse" id="navbarSupportedContent">
 
-
-
+
 <ul class="navbar-nav me-auto mb-2 mb-lg-0">
     <li class="nav-item">
                 <a href="/anotherPage.html" class="nav-link " >
@@ -36,7 +36,8 @@
         </a>
         </li></ul>
 
-</div>
+
+                    </div>
     </div>
 </nav>
 </header>
@@ -47,7 +48,7 @@
                 <div class="col-lg-3">
 
 <nav class="nav flex-column">
-        <ul class="level-1">
+                <ul class="level-1">
     <li><a href="/anotherPage.html"
            class="nav-link ">
             Another Page
@@ -75,6 +76,7 @@
             </ol>
 </nav>
 
+                    <!-- content start -->
 
 
 <div class="section" id="another-page">
@@ -83,6 +85,7 @@ <h1>Another Page</h1>
             <p>Lorem Ipsum Dolor.</p>
     </div>
 
+                    <!-- content end -->
                 </div>
             </div>
         </div>

diff --git a/...ootstrap-default-menu/expected/index.html → ...ootstrap-default-menu/expected/index.html b/...ootstrap-default-menu/expected/index.html → ...ootstrap-default-menu/expected/index.html
@@ -10,7 +10,8 @@
 </head>
 <body>
 <header class="">
-        <nav class="navbar navbar-expand-lg navbar-dark bg-primary">
+
+<nav class="navbar navbar-expand-lg navbar-dark bg-primary">
     <div class="container">
 
         <a class="navbar-brand" href="#">Navbar</a>
@@ -19,8 +20,7 @@
         </button>
         <div class="collapse navbar-collapse" id="navbarSupportedContent">
 
-
-
+
 <ul class="navbar-nav me-auto mb-2 mb-lg-0">
     <li class="nav-item">
                 <a href="/anotherPage.html" class="nav-link " >
@@ -36,7 +36,8 @@
         </a>
         </li></ul>
 
-</div>
+
+                    </div>
     </div>
 </nav>
 </header>
@@ -47,7 +48,7 @@
                 <div class="col-lg-3">
 
 <nav class="nav flex-column">
-        <ul class="level-1">
+                <ul class="level-1">
     <li><a href="/anotherPage.html"
            class="nav-link ">
             Another Page
@@ -74,6 +75,7 @@
             </ol>
 </nav>
 
+                    <!-- content start -->
 
 
 <div class="section" id="document-title">
@@ -83,6 +85,7 @@ <h1>Document Title</h1>
 
     </div>
 
+                    <!-- content end -->
                 </div>
             </div>
         </div>

diff --git a/...strap-default-menu/expected/somePage.html → ...strap-default-menu/expected/somePage.html b/...strap-default-menu/expected/somePage.html → ...strap-default-menu/expected/somePage.html
@@ -10,7 +10,8 @@
 </head>
 <body>
 <header class="">
-        <nav class="navbar navbar-expand-lg navbar-dark bg-primary">
+
+<nav class="navbar navbar-expand-lg navbar-dark bg-primary">
     <div class="container">
 
         <a class="navbar-brand" href="#">Navbar</a>
@@ -19,8 +20,7 @@
         </button>
         <div class="collapse navbar-collapse" id="navbarSupportedContent">
 
-
-
+
 <ul class="navbar-nav me-auto mb-2 mb-lg-0">
     <li class="nav-item">
                 <a href="/anotherPage.html" class="nav-link " >
@@ -36,7 +36,8 @@
         </a>
         </li></ul>
 
-</div>
+
+                    </div>
     </div>
 </nav>
 </header>
@@ -47,7 +48,7 @@
                 <div class="col-lg-3">
 
 <nav class="nav flex-column">
-        <ul class="level-1">
+                <ul class="level-1">
     <li><a href="/anotherPage.html"
            class="nav-link ">
             Another Page
@@ -75,6 +76,7 @@
             </ol>
 </nav>
 
+                    <!-- content start -->
 
 
 <div class="section" id="some-page">
@@ -83,6 +85,7 @@ <h1>Some Page</h1>
             <p>Lorem Ipsum <span class="custom">Dolor</span>.</p>
     </div>
 
+                    <!-- content end -->
                 </div>
             </div>
         </div>

diff --git a/...tstrap-default-menu/input/anotherPage.rst → ...tstrap-default-menu/input/anotherPage.rst b/...tstrap-default-menu/input/anotherPage.rst → ...tstrap-default-menu/input/anotherPage.rst
diff --git a/...p/bootstrap-default-menu/input/guides.xml → ...p/bootstrap-default-menu/input/guides.xml b/...p/bootstrap-default-menu/input/guides.xml → ...p/bootstrap-default-menu/input/guides.xml
diff --git a/...tstrap-default-menu/input/include.rst.txt → ...tstrap-default-menu/input/include.rst.txt b/...tstrap-default-menu/input/include.rst.txt → ...tstrap-default-menu/input/include.rst.txt
diff --git a/...ap/bootstrap-default-menu/input/index.rst → ...ap/bootstrap-default-menu/input/index.rst b/...ap/bootstrap-default-menu/input/index.rst → ...ap/bootstrap-default-menu/input/index.rst
diff --git a/...bootstrap-default-menu/input/somePage.rst → ...bootstrap-default-menu/input/somePage.rst b/...bootstrap-default-menu/input/somePage.rst → ...bootstrap-default-menu/input/somePage.rst
diff --git a/...rap-default-menu/input/yetAnotherPage.rst → ...rap-default-menu/input/yetAnotherPage.rst b/...rap-default-menu/input/yetAnotherPage.rst → ...rap-default-menu/input/yetAnotherPage.rst
-Original file line number
+Diff line change
@@ Expand Up / @@ -80,6 +80,7 @@ <h2>Additional Menu</h2> @@
                 </ol>
     </nav>
+                        <!-- content start -->
     <div class="section" id="another-page">
@@ Expand All / @@ -88,6 +89,7 @@ <h1>Another Page</h1> @@
                 <p>Lorem Ipsum Dolor.</p>
         </div>
+                        <!-- content end -->
                     </div>
                 </div>
             </div>
@@ Expand Down @@