Improve code linting and testing

.gitignore

@@ -1,10 +1,7 @@
-/Tests/app/cache/*
-/Tests/app/logs/*
-/node_modules/
+/Tests/Application/var/*
 /vendor/
 /composer.phar
 /composer.lock
-/.sass-cache/
 .php_cs.cache
 *~
 

.travis.yml

@@ -11,20 +11,25 @@ matrix:
   include:
     - php: 7.2
       env:
-        - COMPOSER_FLAGS="--prefer-lowest --prefer-dist --no-interaction"
-    - php: 7.3
+        - COMPOSER_FLAGS="--prefer-lowest --prefer-stable --prefer-dist --no-interaction"
+    - php: 7.4
       env:
         - COMPOSER_FLAGS="--prefer-dist --no-interaction"
-        - PHPSTAN=true
+        - LINT=true
+        - PECL_INSTALL=imagick
 
 before_install:
+  - |
+    if [[ $PECL_INSTALL ]]; then
+        printf "\n" | pecl install $PECL_INSTALL
+    fi
   - echo "memory_limit=4096M" >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
+  - phpenv config-rm xdebug.ini
 
 before_script:
-  - phpenv config-rm xdebug.ini
   - composer self-update
   - COMPOSER_MEMORY_LIMIT=-1 travis_retry composer update $COMPOSER_FLAGS
 
 script:
-  - if [[ $PHPSTAN = true ]]; then composer phpstan; fi
+  - if [[ $LINT = true ]]; then composer lint; fi
   - composer phpunit

DependencyInjection/CompilerPass/WebspaceStructureProviderCompilerPass.php

@@ -21,7 +21,7 @@ class WebspaceStructureProviderCompilerPass implements CompilerPassInterface
     /**
      * {@inheritdoc}
      */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition('sulu.content.webspace_structure_provider')) {
             return;

DependencyInjection/SuluThemeExtension.php

@@ -26,7 +26,7 @@ class SuluThemeExtension extends Extension
     /**
      * {@inheritdoc}
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load(sprintf('%s.xml', $container->getParameter('sulu.context')));

EventListener/SetThemeEventListener.php

@@ -25,18 +25,13 @@ class SetThemeEventListener
      */
     private $activeTheme;
 
-    /**
-     * @param ActiveTheme $activeTheme
-     */
     public function __construct(ActiveTheme $activeTheme)
     {
         $this->activeTheme = $activeTheme;
     }
 
     /**
      * Set the active theme if there is a portal.
-     *
-     * @param GetResponseEvent $event
      */
     public function setActiveThemeOnRequest(GetResponseEvent $event): void
     {
@@ -52,8 +47,6 @@ public function setActiveThemeOnRequest(GetResponseEvent $event): void
 
     /**
      * Set the active theme for a preview rendering.
-     *
-     * @param PreRenderEvent $event
      */
     public function setActiveThemeOnPreviewPreRender(PreRenderEvent $event): void
     {

StructureProvider/WebspaceStructureProvider.php

@@ -14,6 +14,7 @@
 use Doctrine\Common\Cache\Cache;
 use Liip\ThemeBundle\ActiveTheme;
 use Sulu\Component\Content\Compat\Structure\PageBridge;
+use Sulu\Component\Content\Compat\StructureInterface;
 use Sulu\Component\Content\Compat\StructureManagerInterface;
 use Sulu\Component\Webspace\Manager\WebspaceManagerInterface;
 use Sulu\Component\Webspace\StructureProvider\WebspaceStructureProvider as BaseWebspaceStructureProvider;
@@ -33,13 +34,6 @@ class WebspaceStructureProvider extends BaseWebspaceStructureProvider
      */
     protected $activeTheme;
 
-    /**
-     * @param \Twig_Environment $twig
-     * @param StructureManagerInterface $structureManager
-     * @param Cache $cache
-     * @param WebspaceManagerInterface $webspaceManager
-     * @param ActiveTheme $activeTheme
-     */
     public function __construct(
         \Twig_Environment $twig,
         StructureManagerInterface $structureManager,
@@ -55,8 +49,10 @@ public function __construct(
 
     /**
      * {@inheritdoc}
+     *
+     * @return StructureInterface[]
      */
-    protected function loadStructures($webspaceKey)
+    protected function loadStructures($webspaceKey): array
     {
         $before = $this->activeTheme->getName();
         $webspace = $this->webspaceManager->findWebspaceByKey($webspaceKey);

SuluThemeBundle.php

@@ -18,7 +18,7 @@
 
 class SuluThemeBundle extends Bundle
 {
-    public function build(ContainerBuilder $container)
+    public function build(ContainerBuilder $container): void
     {
         parent::build($container);
 

Tests/Application/.env

@@ -0,0 +1,4 @@
+APP_ENV=test
+DATABASE_URL=mysql://root:@127.0.0.1:3306/su_theme_test
+DATABASE_CHARSET=utf8mb4
+DATABASE_COLLATE=utf8mb4_unicode_ci

Tests/Application/Kernel.php

@@ -0,0 +1,52 @@
+<?php
+
+/*
+ * This file is part of Sulu.
+ *
+ * (c) Sulu GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Sulu\Bundle\ThemeBundle\Tests\Application;
+
+use Liip\ThemeBundle\LiipThemeBundle;
+use Sulu\Bundle\TestBundle\Kernel\SuluTestKernel;
+use Sulu\Bundle\ThemeBundle\SuluThemeBundle;
+use Symfony\Component\Config\Loader\LoaderInterface;
+
+class Kernel extends SuluTestKernel
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function __construct($environment, $debug, $suluContext = self::CONTEXT_ADMIN)
+    {
+        parent::__construct($environment, $debug, $suluContext);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function registerBundles()
+    {
+        return array_merge(
+            parent::registerBundles(),
+            [
+                new LiipThemeBundle(),
+                new SuluThemeBundle(),
+            ]
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function registerContainerConfiguration(LoaderInterface $loader): void
+    {
+        parent::registerContainerConfiguration($loader);
+
+        $loader->load(__DIR__ . '/config/config_' . $this->getContext() . '.yaml');
+    }
+}

Tests/Application/bin/adminconsole

@@ -0,0 +1,5 @@
+#!/usr/bin/env php
+<?php
+
+$suluContext = 'admin';
+include __DIR__ . DIRECTORY_SEPARATOR. 'console.php';

Tests/Application/bin/console.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of Sulu.
+ *
+ * (c) Sulu GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+// if you don't want to setup permissions the proper way, just uncomment the following PHP line
+// read http://symfony.com/doc/current/book/installation.html#configuration-and-setup for more information
+//umask(0000);
+
+set_time_limit(0);
+
+require_once __DIR__ . '/../config/bootstrap.php';
+
+use Sulu\Bundle\ThemeBundle\Tests\Application\Kernel;
+use Symfony\Bundle\FrameworkBundle\Console\Application;
+use Symfony\Component\Console\Input\ArgvInput;
+use Symfony\Component\ErrorHandler\Debug;
+
+$input = new ArgvInput();
+$env = $input->getParameterOption(['--env', '-e'], getenv('SYMFONY_ENV') ?: 'dev');
+$debug = '0' !== getenv('SYMFONY_DEBUG') && !$input->hasParameterOption(['--no-debug', '']) && 'prod' !== $env;
+
+if ($debug) {
+    // Clean up when sf 4.3 support is removed
+    if (class_exists(Debug::class)) {
+        Debug::enable();
+    } else {
+        \Symfony\Component\Debug\Debug::enable();
+    }
+}
+
+$kernel = new Kernel($env, $debug, $suluContext);
+$application = new Application($kernel);
+$application->run($input);

Tests/Application/bin/websiteconsole

@@ -0,0 +1,5 @@
+#!/usr/bin/env php
+<?php
+
+$suluContext = 'website';
+include __DIR__ . DIRECTORY_SEPARATOR. 'console.php';

Tests/Application/config/bootstrap.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of Sulu.
+ *
+ * (c) Sulu GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+use Symfony\Component\Dotenv\Dotenv;
+
+$file = __DIR__ . '/../../../vendor/autoload.php';
+
+if (!file_exists($file)) {
+    throw new RuntimeException('Install dependencies to run test suite.');
+}
+
+require $file;
+
+// Load cached env vars if the .env.local.php file exists
+// Run "composer dump-env prod" to create it (requires symfony/flex >=1.2)
+if (is_array($env = @include dirname(__DIR__) . '/.env.local.php')) {
+    $_SERVER += $env;
+    $_ENV += $env;
+} elseif (!class_exists(Dotenv::class)) {
+    throw new RuntimeException('Please run "composer require symfony/dotenv" to load the ".env" files configuring the application.');
+} else {
+    $path = dirname(__DIR__) . '/.env';
+    $dotenv = new Dotenv();
+    $dotenv->loadEnv($path);
+}
+
+$_SERVER['APP_ENV'] = $_ENV['APP_ENV'] = ($_SERVER['APP_ENV'] ?? $_ENV['APP_ENV'] ?? null) ?: 'dev';
+$_SERVER['APP_DEBUG'] = $_SERVER['APP_DEBUG'] ?? $_ENV['APP_DEBUG'] ?? 'prod' !== $_SERVER['APP_ENV'];
+$_SERVER['APP_DEBUG'] = $_ENV['APP_DEBUG'] = (int) $_SERVER['APP_DEBUG'] || filter_var($_SERVER['APP_DEBUG'], FILTER_VALIDATE_BOOLEAN) ? '1' : '0';

Tests/Application/config/config.yaml

@@ -0,0 +1,12 @@
+doctrine:
+    orm:
+        mappings:
+            gedmo_tree:
+                type: xml
+                prefix: Gedmo\Tree\Entity
+                dir: "%kernel.project_dir%/../../vendor/gedmo/doctrine-extensions/lib/Gedmo/Tree/Entity"
+                alias: GedmoTree
+                is_bundle: false
+
+massive_search:
+    adapter: test

Tests/Application/config/config_admin.yaml

@@ -0,0 +1,5 @@
+imports:
+    - config.yaml
+
+framework:
+    router: { resource: "%kernel.project_dir%/config/routing_admin.yaml" }

Tests/Application/config/config_website.yaml

@@ -0,0 +1,5 @@
+imports:
+    - config.yaml
+
+framework:
+    router: { resource: "%kernel.project_dir%/config/routing_website.yml" }

Tests/Application/config/routing_admin.yaml

@@ -0,0 +1,3 @@
+sulu_admin:
+    resource: "@SuluAdminBundle/Resources/config/routing.yml"
+    prefix: /admin

Tests/Application/config/routing_website.yaml

@@ -0,0 +1 @@
+# no theme specific routes

Tests/Application/config/webspaces/sulu.io.xml

@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?>
+<webspace xmlns="http://schemas.sulu.io/webspace/webspace"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://schemas.sulu.io/webspace/webspace http://schemas.sulu.io/webspace/webspace-1.1.xsd">
+
+    <name>Sulu CMF</name>
+    <key>sulu-io</key>
+
+    <security>
+        <system>Website</system>
+    </security>
+
+    <localizations>
+        <localization language="de" default="true"/>
+    </localizations>
+
+    <theme>default</theme>
+
+    <default-templates>
+        <default-template type="homepage">overview</default-template>
+        <default-template type="page">overview</default-template>
+    </default-templates>
+
+    <navigation>
+        <contexts>
+            <context key="main">
+                <meta>
+                    <title lang="en">Mainnavigation</title>
+                </meta>
+            </context>
+        </contexts>
+    </navigation>
+
+    <portals>
+        <portal>
+            <name>Sulu CMF AT</name>
+            <key>sulucmf_at</key>
+
+            <environments>
+                <environment type="prod">
+                    <urls>
+                        <url language="de">{host}</url>
+                    </urls>
+                </environment>
+                <environment type="dev">
+                    <urls>
+                        <url language="de">{host}</url>
+                    </urls>
+                </environment>
+                <environment type="test">
+                    <urls>
+                        <url language="de">{host}</url>
+                    </urls>
+                </environment>
+            </environments>
+        </portal>
+    </portals>
+</webspace>

Tests/Unit/StructureProvider/WebspaceStructureProviderTest.php

@@ -112,12 +112,6 @@ public function testGetStructuresCached(): void
         $this->assertEquals($structures[2]->getKey(), $result[1]->getKey());
     }
 
-    /**
-     * @param string $key
-     * @param string $view
-     *
-     * @return StructureInterface
-     */
     private function generateStructure(string $key, string $view): StructureInterface
     {
         $mock = $this->prophesize('Sulu\Component\Content\Compat\Structure\PageBridge');