aleph1.co.uk Git - yaffs-website/blob - web/core/tests/Drupal/Tests/Core/PathProcessor/PathProcessorTest.php

   1 <?php
   2
   3 namespace Drupal\Tests\Core\PathProcessor;
   4
   5 use Drupal\Core\Language\Language;
   6 use Drupal\Core\Language\LanguageInterface;
   7 use Drupal\Core\PathProcessor\PathProcessorAlias;
   8 use Drupal\Core\PathProcessor\PathProcessorDecode;
   9 use Drupal\Core\PathProcessor\PathProcessorFront;
  10 use Drupal\Core\PathProcessor\PathProcessorManager;
  11 use Drupal\language\HttpKernel\PathProcessorLanguage;
  12 use Drupal\language\Plugin\LanguageNegotiation\LanguageNegotiationUrl;
  13 use Symfony\Component\HttpFoundation\Request;
  14
  15 use Drupal\Tests\UnitTestCase;
  16
  17 /**
  18  * Tests processing of the inbound path.
  19  *
  20  * @group PathProcessor
  21  */
  22 class PathProcessorTest extends UnitTestCase {
  23
  24   /**
  25    * Configuration for the languageManager stub.
  26    *
  27    * @var \Drupal\Core\Language\LanguageInterface[]
  28    */
  29   protected $languages;
  30
  31   /**
  32    * The language manager stub used to construct a PathProcessorLanguage object.
  33    *
  34    * @var \Drupal\language\ConfigurableLanguageManagerInterface|\PHPUnit_Framework_MockObject_MockBuilder
  35    */
  36   protected $languageManager;
  37
  38   protected function setUp() {
  39
  40     // Set up some languages to be used by the language-based path processor.
  41     $languages = [];
  42     foreach (['en', 'fr'] as $langcode) {
  43       $language = new Language(['id' => $langcode]);
  44       $languages[$langcode] = $language;
  45     }
  46     $this->languages = $languages;
  47
  48     // Create a stub configuration.
  49     $language_prefixes = array_keys($this->languages);
  50     $config = [
  51       'url' => [
  52         'prefixes' => array_combine($language_prefixes, $language_prefixes)
  53       ]
  54     ];
  55
  56     // Create a URL-based language negotiation method definition.
  57     $method_definitions = [
  58       LanguageNegotiationUrl::METHOD_ID => [
  59         'class' => '\Drupal\language\Plugin\LanguageNegotiation\LanguageNegotiationUrl',
  60         'weight' => 9,
  61       ],
  62     ];
  63
  64     // Create a URL-based language negotiation method.
  65     $method_instance = new LanguageNegotiationUrl($config);
  66
  67     // Create a language manager stub.
  68     $language_manager = $this->getMockBuilder('Drupal\language\ConfigurableLanguageManagerInterface')
  69       ->getMock();
  70     $language_manager->expects($this->any())
  71       ->method('getCurrentLanguage')
  72       ->will($this->returnValue($languages['en']));
  73     $language_manager->expects($this->any())
  74       ->method('getLanguages')
  75       ->will($this->returnValue($this->languages));
  76     $language_manager->expects($this->any())
  77       ->method('getLanguageTypes')
  78       ->will($this->returnValue([LanguageInterface::TYPE_INTERFACE]));
  79
  80     $method_instance->setLanguageManager($language_manager);
  81     $this->languageManager = $language_manager;
  82   }
  83
  84   /**
  85    * Tests resolving the inbound path to the system path.
  86    */
  87   public function testProcessInbound() {
  88
  89     // Create an alias manager stub.
  90     $alias_manager = $this->getMockBuilder('Drupal\Core\Path\AliasManager')
  91       ->disableOriginalConstructor()
  92       ->getMock();
  93
  94     $system_path_map = [
  95       // Set up one proper alias that can be resolved to a system path.
  96       ['/foo', NULL, '/user/1'],
  97       // Passing in anything else should return the same string.
  98       ['/fr/foo', NULL, '/fr/foo'],
  99       ['/fr', NULL, '/fr'],
 100       ['/user/login', NULL, '/user/login'],
 101     ];
 102
 103     $alias_manager->expects($this->any())
 104       ->method('getPathByAlias')
 105       ->will($this->returnValueMap($system_path_map));
 106
 107     // Create a stub config factory with all config settings that will be checked
 108     // during this test.
 109     $config_factory_stub = $this->getConfigFactoryStub(
 110       [
 111         'system.site' => [
 112           'page.front' => '/user/login'
 113         ],
 114         'language.negotiation' => [
 115           'url' => [
 116             'prefixes' => ['fr' => 'fr'],
 117             'source' => LanguageNegotiationUrl::CONFIG_PATH_PREFIX,
 118           ],
 119         ],
 120       ]
 121     );
 122
 123     // Create a language negotiator stub.
 124     $negotiator = $this->getMockBuilder('Drupal\language\LanguageNegotiatorInterface')
 125       ->getMock();
 126     $negotiator->expects($this->any())
 127       ->method('getNegotiationMethods')
 128       ->will($this->returnValue([
 129         LanguageNegotiationUrl::METHOD_ID => [
 130           'class' => 'Drupal\language\Plugin\LanguageNegotiation\LanguageNegotiationUrl',
 131           'weight' => 9,
 132         ],
 133       ]));
 134     $method = new LanguageNegotiationUrl();
 135     $method->setConfig($config_factory_stub);
 136     $method->setLanguageManager($this->languageManager);
 137     $negotiator->expects($this->any())
 138       ->method('getNegotiationMethodInstance')
 139       ->will($this->returnValue($method));
 140
 141     // Create a user stub.
 142     $current_user = $this->getMockBuilder('Drupal\Core\Session\AccountInterface')
 143       ->getMock();
 144
 145     // Create a config event subscriber stub.
 146     $config_subscriber = $this->getMockBuilder('Drupal\language\EventSubscriber\ConfigSubscriber')
 147       ->disableOriginalConstructor()
 148       ->getMock();
 149
 150     // Create the processors.
 151     $alias_processor = new PathProcessorAlias($alias_manager);
 152     $decode_processor = new PathProcessorDecode();
 153     $front_processor = new PathProcessorFront($config_factory_stub);
 154     $language_processor = new PathProcessorLanguage($config_factory_stub, $this->languageManager, $negotiator, $current_user, $config_subscriber);
 155
 156     // First, test the processor manager with the processors in the incorrect
 157     // order. The alias processor will run before the language processor, meaning
 158     // aliases will not be found.
 159     $priorities = [
 160       1000 => $alias_processor,
 161       500 => $decode_processor,
 162       300 => $front_processor,
 163       200 => $language_processor,
 164     ];
 165
 166     // Create the processor manager and add the processors.
 167     $processor_manager = new PathProcessorManager();
 168     foreach ($priorities as $priority => $processor) {
 169       $processor_manager->addInbound($processor, $priority);
 170     }
 171
 172     // Test resolving the French homepage using the incorrect processor order.
 173     $test_path = '/fr';
 174     $request = Request::create($test_path);
 175     $processed = $processor_manager->processInbound($test_path, $request);
 176     $this->assertEquals('/', $processed, 'Processing in the incorrect order fails to resolve the system path from the empty path');
 177
 178     // Test resolving an existing alias using the incorrect processor order.
 179     $test_path = '/fr/foo';
 180     $request = Request::create($test_path);
 181     $processed = $processor_manager->processInbound($test_path, $request);
 182     $this->assertEquals('/foo', $processed, 'Processing in the incorrect order fails to resolve the system path from an alias');
 183
 184     // Now create a new processor manager and add the processors, this time in
 185     // the correct order.
 186     $processor_manager = new PathProcessorManager();
 187     $priorities = [
 188       1000 => $decode_processor,
 189       500 => $language_processor,
 190       300 => $front_processor,
 191       200 => $alias_processor,
 192     ];
 193     foreach ($priorities as $priority => $processor) {
 194       $processor_manager->addInbound($processor, $priority);
 195     }
 196
 197     // Test resolving the French homepage using the correct processor order.
 198     $test_path = '/fr';
 199     $request = Request::create($test_path);
 200     $processed = $processor_manager->processInbound($test_path, $request);
 201     $this->assertEquals('/user/login', $processed, 'Processing in the correct order resolves the system path from the empty path.');
 202
 203     // Test resolving an existing alias using the correct processor order.
 204     $test_path = '/fr/foo';
 205     $request = Request::create($test_path);
 206     $processed = $processor_manager->processInbound($test_path, $request);
 207     $this->assertEquals('/user/1', $processed, 'Processing in the correct order resolves the system path from an alias.');
 208   }
 209
 210 }