[Feature] Add integration tests for PageExporter

mike4git · mike4git · commit 90b454c4ad9b · 2025-03-01T21:46:32.000+01:00
Add Menu and Controller route for export page incl. subpages
diff --git a/compose.yaml b/compose.yaml
@@ -16,7 +16,7 @@ services:
       timeout: 10s
 
   php:
-    image: pimcore/pimcore:php8.3-latest
+    image: pimcore/pimcore:php8.3-debug-latest
     volumes:
       - ./:/var/www/html/
     environment:
diff --git a/composer.json b/composer.json
@@ -26,6 +26,7 @@
     "phpstan/phpstan-symfony": "^1.3.8",
     "phpunit/phpunit": "^9.5",
     "pimcore/admin-ui-classic-bundle": "^1.6",
+    "spatie/phpunit-snapshot-assertions": "^4.2",
     "teamneusta/pimcore-testing-framework": "^0.12"
   },
   "autoload": {
diff --git a/config/pimcore/config.yaml b/config/pimcore/config.yaml
@@ -31,6 +31,7 @@ neusta_converter:
         path:
           source: path
           default: '/'
+          skip_null: true
         parentId:
           source: parentId
           default: 0
diff --git a/config/services.yaml b/config/services.yaml
@@ -41,18 +41,21 @@ services:
     arguments:
       $propertyKey: 'language'
       $targetProperty: 'language'
+      $skipNull: true
 
   neusta_pimcore_import_export.page.property.navigation_title.populator:
     class: Neusta\Pimcore\ImportExportBundle\PimcoreConverter\Populator\PropertyBasedMappingPopulator
     arguments:
       $propertyKey: 'navigation_title'
       $targetProperty: 'navigation_title'
+      $skipNull: true
 
   neusta_pimcore_import_export.page.property.navigation_name.populator:
     class: Neusta\Pimcore\ImportExportBundle\PimcoreConverter\Populator\PropertyBasedMappingPopulator
     arguments:
       $propertyKey: 'navigation_name'
       $targetProperty: 'navigation_name'
+      $skipNull: true
 
   Neusta\Pimcore\ImportExportBundle\Documents\Export\PageExporter:
     arguments:
diff --git a/public/js/exportPage.js b/public/js/exportPage.js
@@ -8,6 +8,7 @@ neusta_pimcore_import_export.plugin.page.export = Class.create({
     onPrepareDocumentTreeContextMenu: function (e) {
         let menu = e.detail.menu;
         let document = e.detail.document;
+
         // Export page into yaml file
         menu.add("-");
         menu.add(new Ext.menu.Item({
@@ -17,6 +18,15 @@ neusta_pimcore_import_export.plugin.page.export = Class.create({
                 pimcore.helpers.download(Routing.generate('neusta_pimcore_import_export_page_export', {page_id: document.data.id}));
             }
         }));
+
+        // Export page and children into yaml file
+        menu.add(new Ext.menu.Item({
+            text: t('neusta_pimcore_import_export_export_with_children_menu_label'),
+            iconCls: "pimcore_icon_export",
+            handler: function () {
+                pimcore.helpers.download(Routing.generate('neusta_pimcore_import_export_page_export_with_children', {page_id: document.data.id}));
+            }
+        }));
     },
 
 });
diff --git a/src/Controller/Admin/PageExportController.php b/src/Controller/Admin/PageExportController.php
@@ -37,7 +37,40 @@ public function exportPage(Request $request): Response
         }
 
         try {
-            $yaml = $this->pageExporter->toYaml([$page]);
+            $yaml = $this->pageExporter->exportToYaml([$page]);
+        } catch (\Exception $e) {
+            return new JsonResponse($e->getMessage(), Response::HTTP_INTERNAL_SERVER_ERROR);
+        }
+
+        $response = new Response($yaml);
+        $response->headers->set('Content-type', 'application/yaml');
+        $response->headers->set(
+            'Content-Disposition',
+            HeaderUtils::makeDisposition(HeaderUtils::DISPOSITION_ATTACHMENT, $this->createFilename($page)),
+        );
+
+        return $response;
+    }
+
+    #[Route(
+        '/admin/neusta/import-export/page/export/with-children',
+        name: 'neusta_pimcore_import_export_page_export_with_children',
+        methods: ['GET']
+    )]
+    public function exportPageWithChildren(Request $request): Response
+    {
+        $pageId = $request->query->getInt('page_id');
+        $page = $this->pageRepository->getById($pageId);
+
+        if (!$page instanceof Page) {
+            return new JsonResponse(
+                \sprintf('Page with id "%s" was not found', $pageId),
+                Response::HTTP_NOT_FOUND,
+            );
+        }
+
+        try {
+            $yaml = $this->pageExporter->exportToYaml($this->pageRepository->findAllPagesWithSubPages($page));
         } catch (\Exception $e) {
             return new JsonResponse($e->getMessage(), Response::HTTP_INTERNAL_SERVER_ERROR);
         }
diff --git a/src/Controller/Admin/PageImportController.php b/src/Controller/Admin/PageImportController.php
@@ -19,7 +19,9 @@ final class PageImportController
     public const SUCCESS_WITHOUT_REPLACEMENT = 3;
     public const SUCCESS_NEW_DOCUMENT = 4;
 
-    /** string[] */
+    /**
+     * @var string[] Map of error codes to messages
+     */
     private array $messagesMap;
 
     public function __construct(
@@ -84,7 +86,7 @@ protected function replaceIfExists(Page $page, bool $overwrite): int
 
     private function appendMessage(int|string $index, int $resultCode, string $resultMessage): string
     {
-        $message = \sprintf('%d. %s', $index + 1, $this->messagesMap[$resultCode]);
+        $message = \sprintf('%d. %s', (int) $index + 1, $this->messagesMap[$resultCode]);
         $resultMessage .= $message . \PHP_EOL;
 
         return $resultMessage;
diff --git a/src/Documents/Base/AbstractPageFixture.php b/src/Documents/Base/AbstractPageFixture.php
@@ -48,7 +48,9 @@ private function internalCreate(): void
             $this->fullqualifiedYamlFilename,
             $this->params,
         );
-        $page = $this->pageImporter->parseYaml($yamlContent, false);
-        $this->replaceIfExists($page);
+        $pages = $this->pageImporter->parseYaml($yamlContent, false);
+        foreach ($pages as $page) {
+            $this->replaceIfExists($page);
+        }
     }
 }
diff --git a/src/Documents/Export/PageExporter.php b/src/Documents/Export/PageExporter.php
@@ -11,7 +11,7 @@
 
 class PageExporter
 {
-    private const YAML_DUMP_FLAGS =
+    public const YAML_DUMP_FLAGS =
         Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE |
         Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK |
         Yaml::DUMP_NULL_AS_TILDE;
@@ -34,19 +34,35 @@ public function __construct(
      *     key: 'page_key_2'
      * ...
      *
-     * @param Page|iterable<Page> $pages
-     *
      * @throws ConverterException
      *
-     * @deprecated parameter type Page will not be allowed in further versions
+     * @deprecated use PageExporter#exportToYaml([$page]) in further versions
      */
-    public function toYaml(Page|iterable $pages): string
+    public function toYaml(Page $page): string
     {
-        // @deprecated - should be removed after changing the method signature
-        if ($pages instanceof Page) {
-            $pages = [$pages];
+        $pages = [];
+        if ($page instanceof Page) {
+            $pages = [$page];
         }
 
+        return $this->exportToYaml($pages);
+    }
+
+    /**
+     * Exports one or more pages as YAML with the following structure:
+     * pages:
+     *   - page:
+     *      key: 'page_key_1'
+     *   - page:
+     *     key: 'page_key_2'
+     * ...
+     *
+     * @param iterable<Page> $pages
+     *
+     * @throws ConverterException
+     */
+    public function exportToYaml(iterable $pages): string
+    {
         $yamlExportPages = [];
         foreach ($pages as $page) {
             $yamlExportPages[] = [YamlExportPage::PAGE => $this->pageToYamlConverter->convert($page)];
@@ -57,7 +73,7 @@ public function toYaml(Page|iterable $pages): string
             'yaml',
             [
                 'yaml_inline' => 4,
-                'yaml_indent' => 0,
+                'yaml_indent' => 2,
                 'yaml_flags' => self::YAML_DUMP_FLAGS,
             ]
         );
diff --git a/src/Documents/Export/YamlExportPage.php b/src/Documents/Export/YamlExportPage.php
@@ -13,11 +13,11 @@ class YamlExportPage
     public bool $published = false;
     public string $path = '';
     public string $language = '';
-    public string $navigation_name = '';
+    public ?string $navigation_name = null;
     public ?string $navigation_title = null;
     public string $key = '';
-    public string $title = '';
-    public string $controller = '';
+    public ?string $title = null;
+    public ?string $controller = null;
     /** @var array<YamlExportEditable> */
     public array $editables = [];
 
diff --git a/src/Documents/Import/PageImporter.php b/src/Documents/Import/PageImporter.php
@@ -36,7 +36,7 @@ public function parseYaml(string $yamlInput, bool $forcedSave = true): array
 
         $pages = [];
 
-        foreach ($config[YamlExportPage::PAGES] ?? [] as $configPage) {
+        foreach ($config[YamlExportPage::PAGES] as $configPage) {
             $page = null;
             if (\is_array($configPage[YamlExportPage::PAGE])) {
                 $page = $this->yamlToPageConverter->convert(new YamlExportPage($configPage[YamlExportPage::PAGE]));
diff --git a/src/Toolbox/Repository/PageRepository.php b/src/Toolbox/Repository/PageRepository.php
@@ -19,4 +19,18 @@ public function __construct()
     {
         parent::__construct(Page::class);
     }
+
+    /**
+     * @return iterable<Page>
+     */
+    public function findAllPagesWithSubPages(Page $page): iterable
+    {
+        yield $page;
+
+        foreach ($page->getChildren() as $child) {
+            if ($child instanceof Page) {
+                yield from $this->findAllPagesWithSubPages($child);
+            }
+        }
+    }
 }
diff --git a/tests/Integration/Documents/Export/PageExporterTest.php b/tests/Integration/Documents/Export/PageExporterTest.php
@@ -0,0 +1,105 @@
+<?php declare(strict_types=1);
+
+namespace Neusta\Pimcore\ImportExportBundle\Tests\Integration\Documents\Export;
+
+use Neusta\Pimcore\ImportExportBundle\Documents\Export\PageExporter;
+use Neusta\Pimcore\ImportExportBundle\Tests\Integration\Documents\ImportExportYamlDriver;
+use Neusta\Pimcore\TestingFramework\Database\ResetDatabase;
+use Pimcore\Model\Document\Editable\Input;
+use Pimcore\Model\Document\Page;
+use Pimcore\Test\KernelTestCase;
+use Spatie\Snapshots\MatchesSnapshots;
+
+class PageExporterTest extends KernelTestCase
+{
+    use MatchesSnapshots;
+    use ResetDatabase;
+
+    private PageExporter $exporter;
+
+    protected function setUp(): void
+    {
+        $this->exporter = self::getContainer()->get(PageExporter::class);
+    }
+
+    public function testSinglePageExport(): void
+    {
+        $page = new Page();
+        $page->setId(999);
+        $page->setParentId(4);
+        $page->setType('email');
+        $page->setPublished(false);
+        $page->setPath('/test/');
+        $page->setKey('test_document_1');
+        $page->setProperty('language', 'string', 'fr');
+        $page->setProperty('navigation_name', 'string', 'Mein Dokument');
+        $page->setProperty('navigation_title', 'string', 'Mein Dokument - Titel');
+        $page->setTitle('Titel meines Dokuments');
+        $page->setController('Irgend/ein/Controller');
+        $inputEditable = new Input();
+        $inputEditable->setName('textEingabe');;
+        $inputEditable->setDataFromResource('Texteingabe');
+        $page->setEditables([$inputEditable]);
+
+        $yaml = $this->exporter->exportToYaml([$page]);
+        $this->assertMatchesSnapshot($yaml, new ImportExportYamlDriver());
+    }
+
+    public function testSimpleSavedPagesExport(): void
+    {
+        $page1 = new Page();
+        $page1->setParentId(1);
+        $page1->setKey('test_document_1');
+        $page1->setTitle('Test Document_1');
+        $page1->save();
+
+        $page2 = new Page();
+        $page2->setParentId(1);
+        $page2->setKey('test_document_2');
+        $page2->setTitle('Test Document_2');
+        $page2->save();
+
+        $yaml = $this->exporter->exportToYaml([$page1, $page2]);
+        $this->assertMatchesSnapshot($yaml, new ImportExportYamlDriver());
+    }
+
+    public function testSimpleUnsavedPagesExport(): void
+    {
+        $page1 = new Page();
+        $page1->setParentId(1);
+        $page1->setKey('test_document_1');
+        $page1->setPath('/');
+
+        $page2 = new Page();
+        $page2->setParentId(1);
+        $page2->setKey('test_document_2');
+        $page2->setPath('/');
+
+        $yaml = $this->exporter->exportToYaml([$page1, $page2]);
+        $this->assertMatchesSnapshot($yaml, new ImportExportYamlDriver());
+    }
+
+    public function testTreePagesExport(): void
+    {
+        $page1 = new Page();
+        $page1->setParentId(1);
+        $page1->setKey('test_document_1');
+        $page1->setTitle('Test Document_1');
+        $page1->save();
+
+        $page2 = new Page();
+        $page2->setParentId($page1->getId());
+        $page2->setKey('test_document_2');
+        $page2->setTitle('Test Document_2');
+        $page2->save();
+
+        $page3 = new Page();
+        $page3->setParentId($page2->getId());
+        $page3->setKey('test_document_2');
+        $page3->setTitle('Test Document_2');
+        $page3->save();
+
+        $yaml = $this->exporter->exportToYaml([$page1, $page2, $page3]);
+        $this->assertMatchesSnapshot($yaml, new ImportExportYamlDriver());
+    }
+}
diff --git a/tests/Integration/Documents/ImportExportYamlDriver.php b/tests/Integration/Documents/ImportExportYamlDriver.php
@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Neusta\Pimcore\ImportExportBundle\Tests\Integration\Documents;
+
+use PHPUnit\Framework\Assert;
+use Spatie\Snapshots\Driver;
+
+class ImportExportYamlDriver implements Driver
+{
+    public function serialize($data): string
+    {
+        if (!\is_string($data)) {
+            throw new \InvalidArgumentException('Only strings can be serialized to json');
+        }
+
+        return $data;
+    }
+
+    public function extension(): string
+    {
+        return 'yaml';
+    }
+
+    public function match($expected, $actual)
+    {
+        Assert::assertEquals($expected, $actual);
+    }
+}
diff --git a/tests/Unit/Controller/Admin/PageExportControllerTest.php b/tests/Unit/Controller/Admin/PageExportControllerTest.php
diff --git a/tests/app/config/services.yaml b/tests/app/config/services.yaml
diff --git a/translations/admin.de.yaml b/translations/admin.de.yaml
diff --git a/translations/admin.en.yaml b/translations/admin.en.yaml

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,9 @@ private function internalCreate(): void`
`48`	`48`	`$this->fullqualifiedYamlFilename,`
`49`	`49`	`$this->params,`
`50`	`50`	`);`
`51`		`- $page = $this->pageImporter->parseYaml($yamlContent, false);`
`52`		`- $this->replaceIfExists($page);`
	`51`	`+ $pages = $this->pageImporter->parseYaml($yamlContent, false);`
	`52`	`+ foreach ($pages as $page) {`
	`53`	`+ $this->replaceIfExists($page);`
	`54`	`+ }`
`53`	`55`	`}`
`54`	`56`	`}`