Merge pull request #144 from WouterJ/orm_testing

[WIP] Added Orm testing

Author: lsmith77

.travis.yml

@@ -13,7 +13,7 @@ env:
 before_script:
   - composer self-update
   - composer require symfony/symfony:${SYMFONY_VERSION} --prefer-source
-  - vendor/symfony-cmf/testing/bin/travis/phpcr_odm_doctrine_dbal.sh
+  - vendor/symfony-cmf/testing/bin/travis/phpcr_odm_doctrine_orm_dbal.sh
 
 script: phpunit --coverage-text
 

Doctrine/Orm/ContentRepository.php

@@ -26,6 +26,10 @@ protected function getModelAndId($identifier)
 
     /**
      * {@inheritDoc}
+     *
+     * @param string $id The ID contains both model name and id, seperated by a colon.
+     *     The model name must not contain a colon. For instance, "Acme\Content:12"
+     *     tries to find the Acme\Content object where id = 12
      */
     public function findById($id)
     {

Doctrine/Orm/Route.php

@@ -5,18 +5,61 @@
 use Symfony\Cmf\Bundle\RoutingBundle\Model\Route as RouteModel;
 
 /**
- * ORM route version.
- * @author matteo caberlotto [email protected]
+ * The ORM route version.
+ *
+ * @author matteo caberlotto <[email protected]>
+ * @author Wouter J <[email protected]>
  */
 class Route extends RouteModel
 {
+    protected $name;
+    protected $position = 0;
+
     /**
-     * {@inheritDoc}
+     * Sets the name.
+     *
+     * @param string $name
+     *
+     * @return self
      */
-    protected $name;
+    public function setName($name)
+    {
+        $this->name = $name;
+
+        return $this;
+    }
+
+    /**
+     * Gets the name.
+     *
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * Sets the position.
+     *
+     * @param int $position
+     *
+     * @return self
+     */
+    public function setPosition($position)
+    {
+        $this->position = $position;
+
+        return $this;
+    }
 
     /**
-     * {@inheritDoc}
+     * Gets the position.
+     *
+     * @return int
      */
-    protected $position;
+    public function getPosition()
+    {
+        return $this->position;
+    }
 }

Resources/config/doctrine-model/Route.orm.xml

@@ -3,9 +3,9 @@
       xsi:schemaLocation="https://raw.github.com/doctrine/doctrine2/master/doctrine-mapping.xsd">
 
     <mapped-superclass name="Symfony\Cmf\Bundle\RoutingBundle\Model\Route">
-        <field name="variablePattern" type="string"/>
+        <field name="variablePattern" type="string" nullable="true"/>
         <field name="addFormatPattern" type="boolean"/>
-        <field name="staticPrefix" type="string"/>
+        <field name="staticPrefix" type="string" nullable="true"/>
 
         <indexes>
             <index name="name_idx" columns="name"/>

Tests/Functional/Admin/RouteAdminTest.php

@@ -22,7 +22,7 @@ class RouteAdminTest extends BaseTestCase
      */
     private $errorElement;
 
-    protected function setUp()
+    public function setUp()
     {
         parent::setUp();
         $this->db('PHPCR')->createTestNode();

Tests/Functional/Doctrine/Orm/OrmTestCase.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\Tests\Functional\Doctrine\Orm;
+
+use Symfony\Cmf\Component\Testing\Functional\BaseTestCase as ComponentBaseTestCase;
+use Symfony\Cmf\Component\Testing\Document\Content;
+
+use Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Orm\Route;
+
+class OrmTestCase extends ComponentBaseTestCase
+{
+    protected function getKernelConfiguration()
+    {
+        return array(
+            'environment' => 'orm',
+        );
+    }
+
+    protected function clearDb($model)
+    {
+        if (is_array($model)) {
+            foreach ($model as $singleModel) {
+                $this->clearDb($singleModel);
+            }
+        }
+
+        $items = $this->getDm()->getRepository($model)->findAll();
+
+        foreach ($items as $item) {
+            $this->getDm()->remove($item);
+        }
+
+        $this->getDm()->flush();
+    }
+
+    protected function getDm()
+    {
+        return $this->db('ORM')->getOm();
+    }
+
+    protected function createRoute($name, $path)
+    {
+        // split path in static and variable part
+        preg_match('{^(.*?)(/[^/]*\{.*)?$}', $path, $paths);
+
+        $route = new Route();
+        $route->setName($name);
+        $route->setStaticPrefix($paths[1]);
+        if (isset($paths[2])) {
+            $route->setVariablePattern($paths[2]);
+        }
+
+        $this->getDm()->persist($route);
+        $this->getDm()->flush();
+
+        return $route;
+    }
+}

Tests/Functional/Doctrine/Orm/RouteProviderTest.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\Tests\Functional\Doctrine\Orm;
+
+use Symfony\Component\HttpFoundation\Request;
+
+class RouteProviderTest extends OrmTestCase
+{
+    private $repository;
+
+    public function setUp()
+    {
+        parent::setUp();
+        $this->clearDb('Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Orm\Route');
+
+        $this->repository = $this->getContainer()->get('cmf_routing.route_provider');
+    }
+
+    public function testGetRouteCollectionForRequest()
+    {
+        $this->createRoute('route1', '/test');
+        $this->createRoute('route2', '/test/child');
+        $this->createRoute('route3', '/test/child/testroutechild');
+
+        $this->getDm()->clear();
+
+        $routes = $this->repository->getRouteCollectionForRequest(Request::create('/test/child/testroutechild'));
+        $this->assertCount(3, $routes);
+        $this->assertContainsOnlyInstancesOf('Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Orm\Route', $routes);
+    }
+}

Tests/Functional/Routing/DynamicRouterTest.php

@@ -30,6 +30,7 @@ class DynamicRouterTest extends BaseTestCase
     public function setUp()
     {
         parent::setUp();
+
         $this->db('PHPCR')->createTestNode();
         $this->createRoute(self::ROUTE_ROOT);
 

Tests/Resources/app/AppKernel.php

@@ -20,6 +20,6 @@ public function configure()
 
     public function registerContainerConfiguration(LoaderInterface $loader)
     {
-        $loader->load(__DIR__.'/config/config.php');
+        $loader->load(__DIR__.'/config/config_'.$this->environment.'.php');
     }
 }

Tests/Resources/app/config/cmf_routing.orm.yml

@@ -0,0 +1,5 @@
+cmf_routing:
+    dynamic:
+        persistence:
+            orm:
+                enabled: true

Tests/Resources/app/config/cmf_routing.phpcr.yml

@@ -0,0 +1,6 @@
+cmf_routing:
+    dynamic:
+        persistence:
+            phpcr:
+                enabled: true
+                route_basepath: /test/routing

Tests/Resources/app/config/cmf_routing.yml

@@ -12,10 +12,6 @@ cmf_routing:
             Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\RedirectRoute:  cmf_routing.redirect_controller:redirectAction
         templates_by_class:
             Symfony\Cmf\Component\Testing\Document\Content: TestBundle:Content:index.html.twig
-        persistence:
-            phpcr:
-                enabled: true
-                route_basepath: /test/routing
         locales:
             - en
             - de

Tests/Resources/app/config/config_orm.php

@@ -0,0 +1,8 @@
+<?php
+
+$loader->import(CMF_TEST_CONFIG_DIR.'/default.php');
+$loader->import(CMF_TEST_CONFIG_DIR.'/phpcr_odm.php'); // todo find some way to don't have this in the ORM config
+$loader->import(CMF_TEST_CONFIG_DIR.'/doctrine_orm.php');
+$loader->import(CMF_TEST_CONFIG_DIR.'/sonata_admin.php');
+$loader->import(__DIR__.'/cmf_routing.yml');
+$loader->import(__DIR__.'/cmf_routing.orm.yml');

Tests/Resources/app/config/config.php renamed to Tests/Resources/app/config/config_phpcr.php

@@ -4,3 +4,4 @@
 $loader->import(CMF_TEST_CONFIG_DIR.'/phpcr_odm.php');
 $loader->import(CMF_TEST_CONFIG_DIR.'/sonata_admin.php');
 $loader->import(__DIR__.'/cmf_routing.yml');
+$loader->import(__DIR__.'/cmf_routing.phpcr.yml');

Tests/Unit/Doctrine/Orm/ContentRepositoryTest.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingBundle\Tests\Unit\Doctrine\Orm;
+
+use Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Orm\ContentRepository;
+
+class ContentRepositoryTest extends \PHPUnit_Framework_TestCase
+{
+    private $document;
+    private $managerRegistry;
+    private $objectManager;
+    private $objectRepository;
+
+    public function setUp()
+    {
+        $this->document = new \stdClass;
+        $this->objectManager = $this->getMock('Doctrine\Common\Persistence\ObjectManager');
+        $this->managerRegistry = $this->getMock('Doctrine\Common\Persistence\ManagerRegistry');
+        $this->objectRepository = $this->getMock('Doctrine\Common\Persistence\ObjectRepository');
+    }
+
+    public function testFindById()
+    {
+        $this->objectManager
+            ->expects($this->any())
+            ->method('getRepository')
+            ->with($this->equalTo('stdClass'))
+            ->will($this->returnValue($this->objectRepository))
+        ;
+
+        $this->objectRepository
+            ->expects($this->any())
+            ->method('find')
+            ->with(123)
+            ->will($this->returnValue($this->document))
+        ;
+
+        $this->managerRegistry
+            ->expects($this->any())
+            ->method('getManager')
+            ->will($this->returnValue($this->objectManager))
+        ;
+
+        $contentRepository = new ContentRepository($this->managerRegistry);
+        $contentRepository->setManagerName('default');
+
+        $foundDocument = $contentRepository->findById('stdClass:123');
+
+        $this->assertSame($this->document, $foundDocument);
+    }
+
+    /**
+     * @dataProvider getFindCorrectModelAndIdData
+     */
+    public function testFindCorrectModelAndId($input, $model, $id)
+    {
+        $this->objectManager
+            ->expects($this->any())
+            ->method('getRepository')
+            ->with($this->equalTo($model))
+            ->will($this->returnValue($this->objectRepository))
+        ;
+
+        $this->objectRepository
+            ->expects($this->any())
+            ->method('find')
+            ->with($id)
+        ;
+
+        $this->managerRegistry
+            ->expects($this->any())
+            ->method('getManager')
+            ->will($this->returnValue($this->objectManager))
+        ;
+
+        $contentRepository = new ContentRepository($this->managerRegistry);
+        $contentRepository->setManagerName('default');
+
+        $foundDocument = $contentRepository->findById($input);
+    }
+
+    public function getFindCorrectModelAndIdData()
+    {
+        return array(
+            array('Acme\ContentBundle\Entity\Content:12', 'Acme\ContentBundle\Entity\Content', 12),
+            array('Id\Contains\Colon:12:1', 'Id\Contains\Colon', '12:1'),
+            array('Class\EndsWith\Number12:20', 'Class\EndsWith\Number12', 20),
+        );
+    }
+}