Add missing dependencies and check for presence of VichUploaderBundle before trying to use it

Author: phansys

.gitignore

@@ -1,3 +1,5 @@
-vendor/
+/vendor/
+/Tests/Functional/cache
+/Tests/Functional/logs
 composer.lock
 .php_cs.cache

.travis.yml

@@ -27,6 +27,8 @@ matrix:
       env: SYMFONY_VERSION="3.1.*"
     - php: 5.6
       env: SYMFONY_VERSION="3.2.*@dev"
+    - php: 5.6
+      env: INSTALL_VICH_UPLOADER_BUNDLE=true
   allow_failures:
     - php: nightly
     - php: hhvm
@@ -42,7 +44,8 @@ before_script:
   - if [[ $TRAVIS_PHP_VERSION != hhvm && -f xdebug.ini ]]; then phpenv config-rm xdebug.ini; fi
   - if [ "$GITHUB_OAUTH_TOKEN" != "" ]; then echo -e $GITHUB_OAUTH_TOKEN && composer config -g github-oauth.github.com $GITHUB_OAUTH_TOKEN; fi;
   - if [ "$SYMFONY_VERSION" != "" ]; then composer require "symfony/symfony:${SYMFONY_VERSION}" --no-update; fi;
+  - if [ -n $INSTALL_VICH_UPLOADER_BUNDLE ]; then composer require "vich/uploader-bundle" --no-update; fi;
   - composer update --prefer-dist --no-interaction $COMPOSER_FLAGS
 
 script:
-  - make test
+  - if [[ -n $INSTALL_VICH_UPLOADER_BUNDLE ]]; then make test_with_vichuploaderbundle; else make test; fi;

DependencyInjection/HackzillaTicketExtension.php

@@ -31,6 +31,12 @@ public function load(array $configs, ContainerBuilder $container)
 
         $container->setParameter('hackzilla_ticket.features', $config['features']);
         $container->setParameter('hackzilla_ticket.templates', $config['templates']);
+
+        $bundles = $container->getParameter('kernel.bundles');
+        // Remove "file_upload_subscriber" definition if VichUploaderBundle is not registered
+        if (!isset($bundles['VichUploaderBundle'])) {
+            $container->removeDefinition('hackzilla_ticket.file_upload_subscriber');
+        }
     }
 
     public static function bundleDirectory()

Makefile

@@ -5,4 +5,7 @@ cs_dry_run:
 	php-cs-fixer fix --verbose --dry-run
 
 test:
+	vendor/bin/phpunit -c phpunit.xml.dist --exclude-group vichuploaderbundle
+
+test_with_vichuploaderbundle:
 	vendor/bin/phpunit -c phpunit.xml.dist

Tests/Functional/Entity/User.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Hackzilla\Bundle\TicketBundle\Tests\Functional\Entity;
+
+use Hackzilla\Bundle\TicketBundle\Model\UserInterface;
+
+/**
+ * @author Javier Spagnoletti <phansys@gmail.com>
+ */
+class User implements UserInterface
+{
+    public function getId()
+    {
+    }
+
+    public function getUsername()
+    {
+    }
+
+    public function getEmail()
+    {
+    }
+
+    public function getRoles()
+    {
+    }
+
+    public function getPassword()
+    {
+    }
+
+    public function getSalt()
+    {
+    }
+
+    public function eraseCredentials()
+    {
+    }
+}

Tests/Functional/FunctionalTest.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Hackzilla\Bundle\TicketBundle\Tests\Functional;
+
+use Vich\UploaderBundle\Event\Events;
+
+/**
+ * @author Javier Spagnoletti <phansys@gmail.com>
+ */
+class FunctionalTest extends WebTestCase
+{
+    public function testConfiguredTicketManager()
+    {
+        $this->assertTrue(static::$kernel->getContainer()->has('hackzilla_ticket.ticket_manager'));
+    }
+
+    /**
+     * @group vichuploaderbundle
+     */
+    public function testConfiguredFileUploadSubscriber()
+    {
+        $eventDispatcher = static::$kernel->getContainer()->get('event_dispatcher');
+        $listeners = $eventDispatcher->getListeners();
+
+        $this->assertArrayHasKey(Events::POST_UPLOAD, $listeners);
+    }
+}

Tests/Functional/TestBundle.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Hackzilla\Bundle\TicketBundle\Tests\Functional;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+/**
+ * @author Javier Spagnoletti <phansys@gmail.com>
+ */
+class TestBundle extends Bundle
+{
+}

Tests/Functional/TestKernel.php

@@ -0,0 +1,136 @@
+<?php
+
+namespace Hackzilla\Bundle\TicketBundle\Tests\Functional;
+
+use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
+use Hackzilla\Bundle\TicketBundle\HackzillaTicketBundle;
+use Hackzilla\Bundle\TicketBundle\Tests\Functional\Entity\User;
+use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
+use Symfony\Bundle\SecurityBundle\SecurityBundle;
+use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
+use Symfony\Component\Config\Loader\LoaderInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\HttpKernel\Kernel;
+use Symfony\Component\Routing\RouteCollectionBuilder;
+use Vich\UploaderBundle\VichUploaderBundle;
+
+/**
+ * @author Javier Spagnoletti <phansys@gmail.com>
+ */
+class TestKernel extends Kernel
+{
+    use MicroKernelTrait;
+
+    private $useVichUploaderBundle = false;
+
+    public function __construct()
+    {
+        $this->useVichUploaderBundle = \class_exists(VichUploaderBundle::class);
+
+        parent::__construct('test'.(int) $this->useVichUploaderBundle, true);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function registerBundles()
+    {
+        $bundles = [
+            new FrameworkBundle(),
+            new SecurityBundle(),
+            new DoctrineBundle(),
+            new HackzillaTicketBundle(),
+            new TestBundle(),
+        ];
+
+        if ($this->useVichUploaderBundle) {
+            $bundles[] = new VichUploaderBundle();
+        }
+
+        return $bundles;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function configureRoutes(RouteCollectionBuilder $routes)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function configureContainer(ContainerBuilder $c, LoaderInterface $loader)
+    {
+        // FrameworkBundle config
+        $c->loadFromExtension('framework', [
+            'secret' => 'MySecretKey',
+        ]);
+
+        // SecurityBundle config
+        $c->loadFromExtension('security', [
+            'providers' => [
+                'in_memory' => [
+                    'memory' => null,
+                ],
+            ],
+            'firewalls' => [
+                'main' => [
+                    'anonymous' => null,
+                ],
+            ],
+        ]);
+
+        // DoctrineBundle config
+        $c->loadFromExtension('doctrine', [
+            'dbal' => [
+                'connections' => [
+                    'default' => [
+                        'driver' => 'pdo_sqlite',
+                    ],
+                ],
+            ],
+            'orm' => [
+                'default_entity_manager' => 'default',
+            ],
+        ]);
+
+        // HackzillaBundle config
+        $c->loadFromExtension('hackzilla_ticket', [
+            'user_class' => User::class,
+        ]);
+
+        if ($this->useVichUploaderBundle) {
+            // VichUploaderBundle config
+            $c->loadFromExtension('vich_uploader', [
+                'db_driver' => 'orm',
+            ]);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getCacheDir()
+    {
+        return parent::getCacheDir().'/'.(int) $this->useVichUploaderBundle;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getLogDir()
+    {
+        return parent::getLogDir().'/'.(int) $this->useVichUploaderBundle;
+    }
+
+    public function serialize()
+    {
+        return serialize($this->useVichUploaderBundle);
+    }
+
+    public function unserialize($str)
+    {
+        $this->__construct(unserialize($str));
+    }
+}

Tests/Functional/WebTestCase.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Hackzilla\Bundle\TicketBundle\Tests\Functional;
+
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase as BaseWebTestCase;
+
+/**
+ * @author Javier Spagnoletti <phansys@gmail.com>
+ */
+class WebTestCase extends BaseWebTestCase
+{
+    protected function setUp()
+    {
+        parent::setUp();
+
+        static::bootKernel();
+    }
+
+    protected static function createKernel(array $options = [])
+    {
+        return new TestKernel();
+    }
+}

composer.json

@@ -39,6 +39,7 @@
         "symfony/http-foundation": "^2.8 || ^3.0 || ^4.0",
         "symfony/http-kernel": "^2.8 || ^3.0 || ^4.0",
         "symfony/options-resolver": "^2.8 || ^3.0 || ^4.0",
+        "symfony/security-bundle": "^2.8 || ^3.0 || ^4.0",
         "symfony/validator": "^2.8 || ^3.0 || ^4.0"
     },
     "suggest": {