Merge pull request #73 from moufmouf/without_security_bundle

Removing hidden dependency on the security-bundle

Author: moufmouf

.travis.yml

@@ -17,7 +17,7 @@ matrix:
     - php: 7.2
       env: PHPSTAN=true
     - php: 7.4
-      env: COVERAGE=true PHPUNIT_FLAGS="-v --coverage-text"
+      env: COVERAGE=true PHPUNIT_FLAGS="-v --coverage-text" TESTNOSECURITYBUNDLE=true
 
       # Test LTS versions.
     - php: 7.4
@@ -53,7 +53,9 @@ script:
   # it helps with testing legacy code and deprecations (composer require symfony/phpunit-bridge)
   #- ./vendor/bin/simple-phpunit $PHPUNIT_FLAGS
   - if [[ $PHPSTAN == true ]]; then composer phpstan; fi
-  - ./vendor/bin/phpunit
+  - ./vendor/bin/phpunit --coverage-clover build/logs/clover.xml
+  # Let's test without the security bundle
+  - if [[ $TESTNOSECURITYBUNDLE == true ]]; then composer remove --dev symfony/security-bundle && phpunit Tests/NoSecurityBundleTest.php; fi
 
 after_script:
   - ./vendor/bin/php-coveralls -v

DependencyInjection/GraphqliteCompilerPass.php

@@ -11,6 +11,8 @@
 use Symfony\Component\Cache\Adapter\ApcuAdapter;
 use Symfony\Component\Cache\Adapter\PhpFilesAdapter;
 use Symfony\Component\Cache\Psr16Cache;
+use TheCodingMachine\GraphQLite\Mappers\StaticClassListTypeMapper;
+use TheCodingMachine\GraphQLite\Mappers\StaticClassListTypeMapperFactory;
 use function class_exists;
 use Doctrine\Common\Annotations\AnnotationException;
 use Doctrine\Common\Annotations\AnnotationReader as DoctrineAnnotationReader;
@@ -43,6 +45,7 @@
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
 use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface;
+use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\Component\Security\Core\User\UserProviderInterface;
 use TheCodingMachine\CacheUtils\ClassBoundCache;
 use TheCodingMachine\CacheUtils\ClassBoundCacheContract;
@@ -76,6 +79,7 @@
 use TheCodingMachine\GraphQLite\Types\MutableObjectType;
 use TheCodingMachine\GraphQLite\Types\ResolvableInputObjectType;
 use function var_dump;
+use TheCodingMachine\Graphqlite\Bundle\Types\SymfonyUserInterfaceType;
 
 /**
  * Detects controllers and types automatically and tag them.
@@ -192,6 +196,13 @@ public function process(ContainerBuilder $container): void
             $container->removeDefinition(AggregateControllerQueryProviderFactory::class);
         }
 
+        // Let's register the mapping with UserInterface if UserInterface is available.
+        if (interface_exists(UserInterface::class)) {
+            $staticTypes = $container->getDefinition(StaticClassListTypeMapperFactory::class)->getArgument(0);
+            $staticTypes[] = SymfonyUserInterfaceType::class;
+            $container->getDefinition(StaticClassListTypeMapperFactory::class)->setArgument(0, $staticTypes);
+        }
+
         foreach ($container->getDefinitions() as $id => $definition) {
             if ($definition->isAbstract() || $definition->getClass() === null) {
                 continue;

Resources/config/container/graphqlite.xml

@@ -107,7 +107,6 @@
 
         <service id="TheCodingMachine\GraphQLite\Mappers\StaticClassListTypeMapperFactory">
             <argument type="collection">
-                <argument>TheCodingMachine\Graphqlite\Bundle\Types\SymfonyUserInterfaceType</argument>
             </argument>
             <tag name="graphql.type_mapper_factory"/>
         </service>

Tests/Fixtures/config/services.yaml

@@ -17,6 +17,9 @@ services:
         resource: '../*'
         exclude: '../{Entities}'
 
+    TheCodingMachine\Graphqlite\Bundle\Tests\NoSecurityBundleFixtures\:
+        resource: '../../NoSecurityBundleFixtures/*'
+
     someService:
         class: stdClass
 

Tests/GraphqliteTestingKernel.php

@@ -16,6 +16,8 @@
 use Symfony\Component\Routing\RouteCollectionBuilder;
 use TheCodingMachine\Graphqlite\Bundle\GraphqliteBundle;
 use Symfony\Component\Security\Core\User\User;
+use function class_exists;
+use function serialize;
 
 class GraphqliteTestingKernel extends Kernel
 {
@@ -50,8 +52,28 @@ class GraphqliteTestingKernel extends Kernel
      * @var int|null
      */
     private $maximumQueryDepth;
+    /**
+     * @var array|string[]
+     */
+    private $controllersNamespace;
+    /**
+     * @var array|string[]
+     */
+    private $typesNamespace;
 
-    public function __construct(bool $enableSession = true, ?string $enableLogin = null, bool $enableSecurity = true, ?string $enableMe = null, bool $introspection = true, ?int $maximumQueryComplexity = null, ?int $maximumQueryDepth = null)
+    /**
+     * @param string[] $controllersNamespace
+     * @param string[] $typesNamespace
+     */
+    public function __construct(bool $enableSession = true,
+                                ?string $enableLogin = null,
+                                bool $enableSecurity = true,
+                                ?string $enableMe = null,
+                                bool $introspection = true,
+                                ?int $maximumQueryComplexity = null,
+                                ?int $maximumQueryDepth = null,
+                                array $controllersNamespace = ['TheCodingMachine\\Graphqlite\\Bundle\\Tests\\Fixtures\\Controller\\'],
+                                array $typesNamespace = ['TheCodingMachine\\Graphqlite\\Bundle\\Tests\\Fixtures\\Types\\', 'TheCodingMachine\\Graphqlite\\Bundle\\Tests\\Fixtures\\Entities\\'])
     {
         parent::__construct('test', true);
         $this->enableSession = $enableSession;
@@ -61,15 +83,18 @@ public function __construct(bool $enableSession = true, ?string $enableLogin = n
         $this->introspection = $introspection;
         $this->maximumQueryComplexity = $maximumQueryComplexity;
         $this->maximumQueryDepth = $maximumQueryDepth;
+        $this->controllersNamespace = $controllersNamespace;
+        $this->typesNamespace = $typesNamespace;
     }
 
     public function registerBundles()
     {
-        return [
-            new FrameworkBundle(),
-            new SecurityBundle(),
-            new GraphqliteBundle(),
-        ];
+        $bundles = [ new FrameworkBundle() ];
+        if (class_exists(SecurityBundle::class)) {
+            $bundles[] = new SecurityBundle();
+        }
+        $bundles[] = new GraphqliteBundle();
+        return $bundles;
     }
 
     public function configureContainer(ContainerBuilder $c, LoaderInterface $loader)
@@ -133,8 +158,8 @@ public function configureContainer(ContainerBuilder $c, LoaderInterface $loader)
 
             $graphqliteConf = array(
                 'namespace' => [
-                    'controllers' => ['TheCodingMachine\\Graphqlite\\Bundle\\Tests\\Fixtures\\Controller\\'],
-                    'types' => ['TheCodingMachine\\Graphqlite\\Bundle\\Tests\\Fixtures\\Types\\', 'TheCodingMachine\\Graphqlite\\Bundle\\Tests\\Fixtures\\Entities\\']
+                    'controllers' => $this->controllersNamespace,
+                    'types' => $this->typesNamespace
                 ],
             );
 
@@ -176,6 +201,6 @@ protected function configureRoutes(/*RoutingConfigurator*/ $routes)
 
     public function getCacheDir()
     {
-        return __DIR__.'/../cache/'.($this->enableSession?'withSession':'withoutSession').$this->enableLogin.($this->enableSecurity?'withSecurity':'withoutSecurity').$this->enableMe.'_'.($this->introspection?'withIntrospection':'withoutIntrospection').'_'.$this->maximumQueryComplexity.'_'.$this->maximumQueryDepth;
+        return __DIR__.'/../cache/'.($this->enableSession?'withSession':'withoutSession').$this->enableLogin.($this->enableSecurity?'withSecurity':'withoutSecurity').$this->enableMe.'_'.($this->introspection?'withIntrospection':'withoutIntrospection').'_'.$this->maximumQueryComplexity.'_'.$this->maximumQueryDepth.'_'.md5(serialize($this->controllersNamespace).'_'.md5(serialize($this->typesNamespace)));
     }
 }

Tests/NoSecurityBundleFixtures/Controller/EchoController.php

@@ -0,0 +1,17 @@
+<?php
+
+
+namespace TheCodingMachine\Graphqlite\Bundle\Tests\NoSecurityBundleFixtures\Controller;
+
+
+use TheCodingMachine\GraphQLite\Annotations\Query;
+
+class EchoController
+{
+    /**
+     * @Query()
+     */
+    public function echoMsg(string $message): string {
+        return $message;
+    }
+}

Tests/NoSecurityBundleTest.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace TheCodingMachine\Graphqlite\Bundle\Tests;
+
+use function json_decode;
+use PHPUnit\Framework\TestCase;
+use Psr\Container\ContainerInterface;
+use function spl_object_hash;
+use Symfony\Component\HttpFoundation\Cookie;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Session\Session;
+use Symfony\Component\HttpFoundation\Session\Storage\MockArraySessionStorage;
+use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
+use Symfony\Component\Security\Core\User\User;
+use TheCodingMachine\Graphqlite\Bundle\Controller\GraphqliteController;
+use TheCodingMachine\Graphqlite\Bundle\Security\AuthenticationService;
+use TheCodingMachine\GraphQLite\GraphQLRuntimeException as GraphQLException;
+use TheCodingMachine\GraphQLite\Schema;
+use function var_dump;
+
+/**
+ * This test class is supposed to work even if the security bundle is not installed in the project.
+ * It is here to check we don't have hidden dependencies on this bundle and that it remains optional.
+ */
+class NoSecurityBundleTest extends TestCase
+{
+    public function testServiceWiring(): void
+    {
+        $kernel = new GraphqliteTestingKernel(true, null, false, null, true, null, null, ['TheCodingMachine\\Graphqlite\\Bundle\\Tests\\NoSecurityBundleFixtures\\Controller\\']);
+        $kernel->boot();
+        $container = $kernel->getContainer();
+
+        $schema = $container->get(Schema::class);
+        $this->assertInstanceOf(Schema::class, $schema);
+        $schema->assertValid();
+
+        $request = Request::create('/graphql', 'GET', ['query' => '
+        { 
+          echoMsg(message: "Hello world")
+        }']);
+
+        $response = $kernel->handle($request);
+
+        $result = json_decode($response->getContent(), true);
+
+        $this->assertSame([
+            'data' => [
+                'echoMsg' => 'Hello world'
+            ]
+        ], $result);
+    }
+}

composer.json

@@ -33,11 +33,11 @@
   "require-dev": {
     "symfony/security-bundle": "^4.1.9 | ^5",
     "symfony/yaml": "^4.1.9 | ^5",
-    "phpunit/phpunit": "^7.5.1",
+    "phpunit/phpunit": "^8.5.5",
     "phpstan/phpstan": "^0.12.25",
     "beberlei/porpaginas": "^1.2",
     "php-coveralls/php-coveralls": "^2.1.0",
-    "symfony/phpunit-bridge": "^5.1"
+    "symfony/phpunit-bridge": "^4.1.9 | ^5.1"
   },
   "scripts": {
     "phpstan": "phpstan analyse GraphqliteBundle.php DependencyInjection/ Controller/ Resources/ Security/ -c phpstan.neon --level=7 --no-progress"

phpunit.xml.dist

@@ -31,10 +31,17 @@
 	</filter>
     <logging>
         <log type="coverage-html" target="build/coverage"/>
-        <log type="coverage-clover" target="build/logs/clover.xml"/>
     </logging>
 
     <listeners>
-        <listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener"/>
+        <listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener">
+            <arguments>
+                <array>
+                    <!-- set this option to 0 to disable the DebugClassLoader integration -->
+                    <!-- See https://github.com/sebastianbergmann/phpunit/issues/4002 -->
+                    <element key="debug-class-loader"><integer>0</integer></element>
+                </array>
+            </arguments>
+        </listener>
     </listeners>
 </phpunit>