minor #203 Added XML routing (phansys)

This PR was merged into the 3.x branch.

Discussion
----------

|Q            |A  |
|---          |---|
|Branch       |3.x|
|Bug fix?     |no |
|New feature? |no |
|BC breaks?   |no |
|Deprecations?|no |
|Tests pass?  |yes|
|Fixed tickets|n/a|
|License      |MIT|
|Doc PR       |n/a|

Commits
-------

1d7007e Added XML routing

Author: phansys

Resources/config/routing.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<routes xmlns="http://symfony.com/schema/routing" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/routing http://symfony.com/schema/routing/routing-1.0.xsd">
+    <import resource="./routing/hackzilla_ticket.xml" type="xml" prefix="/ticket"/>
+</routes>

Resources/config/routing/hackzilla_ticket.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<routes xmlns="http://symfony.com/schema/routing" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/routing http://symfony.com/schema/routing/routing-1.0.xsd">
+    <route id="hackzilla_ticket" path="/" controller="Hackzilla\Bundle\TicketBundle\Controller\TicketController::indexAction"/>
+    <route id="hackzilla_ticket_show" path="/{ticketId}/show" controller="Hackzilla\Bundle\TicketBundle\Controller\TicketController::showAction"/>
+    <route id="hackzilla_ticket_new" path="/new" controller="Hackzilla\Bundle\TicketBundle\Controller\TicketController::newAction"/>
+    <route id="hackzilla_ticket_create" path="/create" controller="Hackzilla\Bundle\TicketBundle\Controller\TicketController::createAction" methods="POST"/>
+    <route id="hackzilla_ticket_delete" path="/{ticketId}/delete" controller="Hackzilla\Bundle\TicketBundle\Controller\TicketController::deleteAction" methods="DELETE|POST"/>
+    <route id="hackzilla_ticket_reply" path="/{ticketId}/reply" controller="Hackzilla\Bundle\TicketBundle\Controller\TicketController::replyAction"/>
+    <route id="hackzilla_ticket_attachment" path="/attachment/{ticketMessageId}/download" controller="Hackzilla\Bundle\TicketBundle\Controller\TicketAttachmentController::downloadAction"/>
+</routes>

Resources/config/routing/ticket.yml

@@ -1,3 +1,4 @@
+# NEXT_MAJOR: remove this file and add upgrade note.
 hackzilla_ticket:
     path: /
     controller: 'Hackzilla\Bundle\TicketBundle\Controller\TicketController::indexAction'

Resources/doc/setup/install.md

@@ -69,15 +69,15 @@ public function registerBundles()
 
 ``` yml
 hackzilla_ticket:
-    resource: "@HackzillaTicketBundle/Resources/config/routing.yml"
+    resource: "@HackzillaTicketBundle/Resources/config/routing.xml"
     prefix: /
 ```
 
 or
 
 ``` yml
 hackzilla_ticket:
-    resource: "@HackzillaTicketBundle/Resources/config/routing/ticket.yml"
+    resource: "@HackzillaTicketBundle/Resources/config/routing/hackzilla_ticket.xml"
     prefix: /ticket
 ```
 

Tests/Functional/RoutingTest.php

@@ -0,0 +1,61 @@
+<?php
+
+/*
+ * This file is part of HackzillaTicketBundle package.
+ *
+ * (c) Daniel Platt <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Hackzilla\Bundle\TicketBundle\Tests\Functional;
+
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+
+/**
+ * @author Javier Spagnoletti <[email protected]>
+ */
+final class RoutingTest extends WebTestCase
+{
+    /**
+     * @dataProvider getRoutes
+     */
+    public function testRoutes(string $name, string $path, array $methods): void
+    {
+        $client = static::createClient();
+        $router = $client->getContainer()->get('router');
+
+        $route = $router->getRouteCollection()->get($name);
+
+        $this->assertNotNull($route);
+        $this->assertSame($path, $route->getPath());
+        $this->assertEmpty(array_diff($methods, $route->getMethods()));
+
+        $matcher = $router->getMatcher();
+        $requestContext = $router->getContext();
+
+        foreach ($methods as $method) {
+            $requestContext->setMethod($method);
+            $match = $matcher->match($path);
+
+            $this->assertSame($name, $match['_route']);
+        }
+    }
+
+    public function getRoutes(): iterable
+    {
+        yield ['hackzilla_ticket', '/ticket/', []];
+        yield ['hackzilla_ticket_show', '/ticket/{ticketId}/show', []];
+        yield ['hackzilla_ticket_new', '/ticket/new', []];
+        yield ['hackzilla_ticket_create', '/ticket/create', ['POST']];
+        yield ['hackzilla_ticket_delete', '/ticket/{ticketId}/delete', ['DELETE', 'POST']];
+        yield ['hackzilla_ticket_reply', '/ticket/{ticketId}/reply', []];
+        yield ['hackzilla_ticket_attachment', '/ticket/attachment/{ticketMessageId}/download', []];
+    }
+
+    protected static function getKernelClass(): string
+    {
+        return TestKernel::class;
+    }
+}

Tests/Functional/TestKernel.php

@@ -84,6 +84,7 @@ public function getLogDir()
      */
     protected function configureRoutes(RouteCollectionBuilder $routes)
     {
+        $routes->import(__DIR__.'/routes.yaml', '/', 'yaml');
     }
 
     /**
@@ -109,6 +110,7 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
             'validation' => [
                 'enabled' => true,
             ],
+            'test' => true,
         ]);
 
         // SecurityBundle config

Tests/Functional/routes.yaml

@@ -0,0 +1,3 @@
+hackzilla_ticket:
+    resource: "@HackzillaTicketBundle/Resources/config/routing.xml"
+    prefix: /

composer.json

@@ -52,6 +52,8 @@
         "ext-pdo_sqlite": "*",
         "friendsofphp/php-cs-fixer": "^2.0",
         "phpstan/phpstan": "^0.12.32",
+        "symfony/browser-kit": "^4.4 || ^5.2",
+        "symfony/http-client": "^4.4 || ^5.2",
         "symfony/phpunit-bridge": "^5.1.1",
         "symfony/security": "^4.4"
     },