[FEATURE] Navigate directly to a backend module

solves #232
TYPO3-Documentation · Nov 7, 2021 · 93ed637 · 93ed637
1 parent 58b000c
commit 93ed637
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 0 deletions.
diff --git a/packages/screenshots/Classes/Configuration/Configuration.php b/packages/screenshots/Classes/Configuration/Configuration.php
@@ -350,6 +350,23 @@ public function createBasicConfig(): void
                         '_default' => [
                             ['action' => 'resizeWindow', 'width' => 1024, 'height' => 768],
                         ],
+                        'actionsIdentifierStyleguideNavigation' => [
+                            ['include' => '_default'],
+                            ['action' => 'setScreenshotsDocumentationPath', 'path' => "StyleguideDocumentation"],
+                            ['action' => 'setScreenshotsImagePath', 'path' => "Images/StyleguideScreenshots"],
+                            ['action' => 'goToModule', 'module' => 'List', 'path' => ['styleguide TCA demo', 'elements rte']],
+                            ['action' => 'makeScreenshotOfWindow', 'fileName' => "StyleguideModuleList"],
+                            ['action' => 'goToModule', 'module' => 'Page'],
+                            ['action' => 'makeScreenshotOfWindow', 'fileName' => "StyleguideModulePage"],
+                            ['action' => 'goToRecord', "table" => "tx_styleguide_elements_basic", "uid" => 5],
+                            ['action' => 'makeScreenshotOfWindow', 'fileName' => "StyleguideModuleSomeRecord"],
+                            ['action' => 'goToModule', 'module' => 'Extensions'],
+                            ['action' => 'makeScreenshotOfWindow', 'fileName' => "StyleguideModuleExtensions"],
+                            ['action' => 'goToModule', 'module' => 'Reports', 'subModule' => 'Installed Services'],
+                            ['action' => 'makeScreenshotOfWindow', 'fileName' => 'StyleguideModuleReportsInstalledServices'],
+                            ['action' => 'goToModule', 'module' => 'Template', 'path' => ['styleguide TCA demo'], 'subModule' => 'Template Analyzer'],
+                            ['action' => 'makeScreenshotOfWindow', 'fileName' => 'StyleguideModuleTemplateAnalyzer'],
+                        ],
                         'actionsIdentifierStyleguideScreenshots' => [
                             ['comment' => '********************************************************'],
                             ['comment' => 'Take screenshots configured in a dummy screenshots.json.'],

diff --git a/packages/screenshots/Classes/Runner/Codeception/Support/Helper/Typo3Navigation.php b/packages/screenshots/Classes/Runner/Codeception/Support/Helper/Typo3Navigation.php
@@ -495,6 +495,34 @@ public function goToRecord(string $table = '', int $uid = -1): void
         $this->scrollModuleBodyToTop();
     }
 
+    /**
+     * Navigate directly to a TYPO3 backend module
+     *
+     * @param string $module
+     * @param array $pageTree
+     * @param string $subModule
+     * @throws \Exception
+     */
+    public function goToModule(string $module = 'List', array $path = [], string $subModule = ''): void
+    {
+        if (!$this->_hasMainFrame()) {
+            $this->reloadBackend();
+        }
+        if (!$this->_isOnMainFrame() && $this->_hasMainFrame()) {
+            $this->switchToMainFrame();
+        }
+        $this->getWebDriver()->see($module);
+        $this->getWebDriver()->click($module);
+        if ($path !== []) {
+            $this->getTypo3PageTree()->openPageTreePath($path);
+        }
+        $this->switchToContentFrame();
+        if ($subModule !== '') {
+            $this->getWebDriver()->selectOption('select.t3-js-jumpMenuBox', $subModule);
+        }
+        $this->scrollModuleBodyToTop();
+    }
+
     protected function resolveRecord(string $table, int $uid): array
     {
         $table = $table !== '' ? $table : $this->_getConfig('defaults')['table'];