tests/phpunit/Civi/Core/PathsTest.php

   1 <?php
   2
   3 namespace Civi\Core;
   4
   5 /**
   6  * Class PathsTest
   7  * @package Civi\Core
   8  * @group headless
   9  */
  10 class PathsTest extends \CiviUnitTestCase {
  11
  12   public function getExamples() {
  13     $exs = [];
  14
  15     // Ensure that various permutations of `$civicrm_paths`, `Civi::paths()->getPath()`
  16     // and `Civi::paths()->getUrl()` work as expected.
  17
  18     // Trailing-slash configurations
  19
  20     $exs['ap1'] = ['te.st', 'path', '/var/www/files/', '[te.st]/foo/bar', '/var/www/files/foo/bar'];
  21     $exs['ap2'] = ['te.st', 'path', '/var/www/files/', '[te.st]/foo/', '/var/www/files/foo/'];
  22     $exs['ap3'] = ['te.st', 'path', '/var/www/files/', '[te.st]/foo', '/var/www/files/foo'];
  23     $exs['ap4'] = ['te.st', 'path', '/var/www/files/', '[te.st]/.', '/var/www/files'];
  24     $exs['ap5'] = ['te.st', 'path', '/var/www/files/', '[te.st]/0', '/var/www/files/0'];
  25     $exs['ap6'] = ['te.st', 'path', '/var/www/files/', '[te.st]/', '/var/www/files/'];
  26
  27     $exs['au1'] = ['te.st', 'url', 'http://example.com/files/', '[te.st]/foo/bar', 'http://example.com/files/foo/bar'];
  28     $exs['au2'] = ['te.st', 'url', 'http://example.com/files/', '[te.st]/foo/', 'http://example.com/files/foo/'];
  29     $exs['au3'] = ['te.st', 'url', 'http://example.com/files/', '[te.st]/foo', 'http://example.com/files/foo'];
  30     $exs['au4'] = ['te.st', 'url', 'http://example.com/files/', '[te.st]/.', 'http://example.com/files'];
  31     $exs['au5'] = ['te.st', 'url', 'http://example.com/files/', '[te.st]/0', 'http://example.com/files/0'];
  32     $exs['au6'] = ['te.st', 'url', 'http://example.com/files/', '[te.st]/', 'http://example.com/files/'];
  33
  34     $exs['au18'] = ['te.st', 'url', 'http://example.com:8080/', '[te.st]/foo/bar', 'http://example.com:8080/foo/bar'];
  35     $exs['au28'] = ['te.st', 'url', 'http://example.com:8080/', '[te.st]/foo/', 'http://example.com:8080/foo/'];
  36     $exs['au38'] = ['te.st', 'url', 'http://example.com:8080/', '[te.st]/foo', 'http://example.com:8080/foo'];
  37     $exs['au48'] = ['te.st', 'url', 'http://example.com:8080/', '[te.st]/.', 'http://example.com:8080'];
  38     $exs['au58'] = ['te.st', 'url', 'http://example.com:8080/', '[te.st]/0', 'http://example.com:8080/0'];
  39     $exs['au68'] = ['te.st', 'url', 'http://example.com:8080/', '[te.st]/', 'http://example.com:8080/'];
  40
  41     // Trimmed-slash configurations
  42
  43     $exs['bp1'] = ['te.st', 'path', '/var/www/files', '[te.st]/foo/bar', '/var/www/files/foo/bar'];
  44     $exs['bp2'] = ['te.st', 'path', '/var/www/files', '[te.st]/foo/', '/var/www/files/foo/'];
  45     $exs['bp3'] = ['te.st', 'path', '/var/www/files', '[te.st]/foo', '/var/www/files/foo'];
  46     $exs['bp4'] = ['te.st', 'path', '/var/www/files', '[te.st]/.', '/var/www/files'];
  47     $exs['bp5'] = ['te.st', 'path', '/var/www/files', '[te.st]/0', '/var/www/files/0'];
  48     $exs['bp6'] = ['te.st', 'path', '/var/www/files', '[te.st]/', '/var/www/files/'];
  49
  50     $exs['bu1'] = ['te.st', 'url', 'http://example.com/files', '[te.st]/foo/bar', 'http://example.com/files/foo/bar'];
  51     $exs['bu2'] = ['te.st', 'url', 'http://example.com/files', '[te.st]/foo/', 'http://example.com/files/foo/'];
  52     $exs['bu3'] = ['te.st', 'url', 'http://example.com/files', '[te.st]/foo', 'http://example.com/files/foo'];
  53     $exs['bu4'] = ['te.st', 'url', 'http://example.com/files', '[te.st]/.', 'http://example.com/files'];
  54     $exs['bu5'] = ['te.st', 'url', 'http://example.com/files', '[te.st]/0', 'http://example.com/files/0'];
  55     $exs['bu6'] = ['te.st', 'url', 'http://example.com/files', '[te.st]/', 'http://example.com/files/'];
  56
  57     $exs['bu18'] = ['te.st', 'url', 'http://example.com:8080', '[te.st]/foo/bar', 'http://example.com:8080/foo/bar'];
  58     $exs['bu28'] = ['te.st', 'url', 'http://example.com:8080', '[te.st]/foo/', 'http://example.com:8080/foo/'];
  59     $exs['bu38'] = ['te.st', 'url', 'http://example.com:8080', '[te.st]/foo', 'http://example.com:8080/foo'];
  60     $exs['bu48'] = ['te.st', 'url', 'http://example.com:8080', '[te.st]/.', 'http://example.com:8080'];
  61     $exs['bu58'] = ['te.st', 'url', 'http://example.com:8080', '[te.st]/0', 'http://example.com:8080/0'];
  62     $exs['bu68'] = ['te.st', 'url', 'http://example.com:8080', '[te.st]/', 'http://example.com:8080/'];
  63
  64     // Oddballs
  65     $exs['wp1'] = ['wp.ex1', 'url', 'http://example.com/wp-admin/admin.php', '[wp.ex1]/.', 'http://example.com/wp-admin/admin.php'];
  66     $exs['http'] = ['te.st', 'url', 'http://example.com/files', '[te.st]/httpIsBetterThanGopher', 'http://example.com/files/httpIsBetterThanGopher'];
  67
  68     return $exs;
  69   }
  70
  71   /**
  72    * @param $varName
  73    * @param $varType
  74    * @param $varValue
  75    * @param $inputExpr
  76    * @param $expectValue
  77    * @dataProvider getExamples
  78    */
  79   public function testExamples($varName, $varType, $varValue, $inputExpr, $expectValue) {
  80     global $civicrm_paths;
  81     $civicrm_paths[$varName][$varType] = $varValue;
  82     $func = ($varType === 'url') ? 'getUrl' : 'getPath';
  83
  84     $paths = new Paths();
  85     $paths->register($varName, function() {
  86       return ['path' => 'FIXME-PATH', 'url' => 'FIXME-URL'];
  87     });
  88
  89     $actualValue = call_user_func([$paths, $func], $inputExpr);
  90     $this->assertEquals($expectValue, $actualValue, "Evaluate $func(\"$inputExpr\") given ([$varName] = \"$varValue\")");
  91
  92     unset($civicrm_paths[$varName][$varType]);
  93   }
  94
  95   public function testGetUrl_ImplicitBase() {
  96     $p = \Civi::paths();
  97     $cmsRoot = rtrim($p->getVariable('cms.root', 'url'), '/');
  98
  99     $this->assertEquals("$cmsRoot/foo/bar", $p->getUrl('foo/bar'));
 100     $this->assertEquals("$cmsRoot/foo/", $p->getUrl('foo/'));
 101     $this->assertEquals("$cmsRoot/foo", $p->getUrl('foo'));
 102   }
 103
 104 }