Simplfying IntegrationTest

Author: weaverryan

composer.json

@@ -8,6 +8,11 @@
             "SymfonyDocsBuilder\\": "src"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "SymfonyDocsBuilder\\Tests\\": "tests"
+        }
+    },
     "require": {
         "ext-json": "*",
         "ext-curl": "*",

src/BuildResult.php

@@ -3,6 +3,7 @@
 namespace SymfonyDocsBuilder;
 
 use Doctrine\RST\Builder;
+use Doctrine\RST\Meta\Metas;
 use Symfony\Component\Console\Output\NullOutput;
 use Symfony\Component\Filesystem\Filesystem;
 use SymfonyDocsBuilder\BuildConfig;
@@ -15,10 +16,13 @@
 class BuildResult
 {
     private $errors;
+    private $metas;
+    private $jsonResults = [];
 
-    public function __construct(array $errors)
+    public function __construct(array $errors, Metas $metas)
     {
         $this->errors = $errors;
+        $this->metas = $metas;
     }
 
     public function appendError(string $errorMessage): void
@@ -40,4 +44,24 @@ public function getErrors(): array
     {
         return $this->errors;
     }
+
+    public function getMetas(): Metas
+    {
+        return $this->metas;
+    }
+
+    /**
+     * Returns the JSON data generated for each file, keyed by the source filename.
+     *
+     * @return string[]
+     */
+    public function getJsonResults(): array
+    {
+        return $this->jsonResults;
+    }
+
+    public function setJsonResults(array $jsonResults): void
+    {
+        $this->jsonResults = $jsonResults;
+    }
 }

src/DocBuilder.php

@@ -25,7 +25,10 @@ public function build(BuildConfig $config): BuildResult
         $builder = new Builder(KernelFactory::createKernel($config));
         $builder->build($config->getContentDir(), $config->getOutputDir());
 
-        $buildResult = new BuildResult($builder->getErrorManager()->getErrors());
+        $buildResult = new BuildResult(
+            $builder->getErrorManager()->getErrors(),
+            $builder->getMetas()
+        );
 
         $missingFilesChecker = new MissingFilesChecker($config);
         $missingFiles = $missingFilesChecker->getMissingFiles();
@@ -38,13 +41,13 @@ public function build(BuildConfig $config): BuildResult
             $filesystem->dumpFile($config->getOutputDir().'/build_errors.txt', implode("\n", $buildResult->getErrors()));
         }
 
-        $metas = $builder->getMetas();
+        $metas = $buildResult->getMetas();
         if ($config->getSubdirectoryToBuild()) {
             $htmlForPdfGenerator = new HtmlForPdfGenerator($metas, $config);
             $htmlForPdfGenerator->generateHtmlForPdf();
         } else {
             $jsonGenerator = new JsonGenerator($metas, $config);
-            $jsonGenerator->generateJson();
+            $buildResult->setJsonResults($jsonGenerator->generateJson());
         }
 
         return $buildResult;

tests/AbstractIntegrationTest.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace SymfonyDocsBuilder\Tests;
+
+use Doctrine\RST\Builder;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Filesystem\Filesystem;
+use SymfonyDocsBuilder\BuildConfig;
+
+class AbstractIntegrationTest extends TestCase
+{
+    protected function createBuildConfig(string $sourceDir): BuildConfig
+    {
+        return (new BuildConfig())
+            ->setSymfonyVersion('4.0')
+            ->setContentDir($sourceDir)
+            ->disableBuildCache()
+            ->setOutputDir(__DIR__.'/_output')
+        ;
+    }
+
+    /**
+     * @after
+     */
+    public function cleanUpOutput()
+    {
+        $filesystem = new Filesystem();
+        $filesystem->remove(__DIR__.'/_output');
+    }
+}

tests/IntegrationTest.php

@@ -9,43 +9,25 @@
 
 namespace SymfonyDocsBuilder\Tests;
 
-use Doctrine\RST\Builder;
 use Doctrine\RST\Configuration;
-use Doctrine\RST\Meta\CachedMetasLoader;
-use Doctrine\RST\Meta\Metas;
 use Doctrine\RST\Parser;
 use Gajus\Dindent\Indenter;
-use PHPUnit\Framework\TestCase;
-use Symfony\Component\Console\Helper\ProgressBar;
-use Symfony\Component\Console\Output\NullOutput;
 use Symfony\Component\DomCrawler\Crawler;
-use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Finder\Finder;
-use SymfonyDocsBuilder\BuildConfig;
+use SymfonyDocsBuilder\DocBuilder;
 use SymfonyDocsBuilder\Generator\JsonGenerator;
 use SymfonyDocsBuilder\KernelFactory;
 
-class IntegrationTest extends TestCase
+class IntegrationTest extends AbstractIntegrationTest
 {
     /**
      * @dataProvider integrationProvider
      */
     public function testIntegration(string $folder)
     {
-        $fs = new Filesystem();
-        $fs->remove([__DIR__.'/_output', __DIR__.'/_cache']);
-        $fs->mkdir([__DIR__.'/_output', __DIR__.'/_cache']);
-
         $buildConfig = $this->createBuildConfig(sprintf('%s/fixtures/source/%s', __DIR__, $folder));
-
-        $builder = new Builder(
-            KernelFactory::createKernel($buildConfig)
-        );
-
-        $builder->build(
-            sprintf('%s/fixtures/source/%s', __DIR__, $folder),
-            __DIR__.'/_output'
-        );
+        $builder = new DocBuilder();
+        $buildResult = $builder->build($buildConfig);
 
         $finder = new Finder();
         $finder->in(sprintf('%s/fixtures/expected/%s', __DIR__, $folder))
@@ -55,7 +37,7 @@ public function testIntegration(string $folder)
         $indenter = $this->createIndenter();
         foreach ($finder as $expectedFile) {
             $relativePath = $expectedFile->getRelativePathname();
-            $actualFilename = __DIR__.'/_output/'.$relativePath;
+            $actualFilename = $buildConfig->getOutputDir().'/'.$relativePath;
             $this->assertFileExists($actualFilename);
 
             $this->assertSame(
@@ -66,13 +48,9 @@ public function testIntegration(string $folder)
             );
         }
 
-        $metas = $builder->getMetas();
-        $jsonGenerator = new JsonGenerator($metas, $buildConfig);
-        $jsonGenerator->generateJson();
-
         foreach ($finder as $htmlFile) {
             $relativePath = $htmlFile->getRelativePathname();
-            $actualFilename = __DIR__.'/_output/'.str_replace('.html', '.fjson', $relativePath);
+            $actualFilename = $buildConfig->getOutputDir().'/'.str_replace('.html', '.fjson', $relativePath);
             $this->assertFileExists($actualFilename);
 
             $jsonData = json_decode(file_get_contents($actualFilename), true);
@@ -269,16 +247,6 @@ public function parserUnitBlockProvider()
         ];
     }
 
-    private function createBuildConfig(string $sourceDir): BuildConfig
-    {
-        return (new BuildConfig())
-            ->setSymfonyVersion('4.0')
-            ->setContentDir($sourceDir)
-            ->disableBuildCache()
-            ->setOutputDir(__DIR__.'/_output')
-        ;
-    }
-
     private function createIndenter(): Indenter
     {
         $indenter = new Indenter();