Civi::url() - Add E2E test-coverage

Author: totten

tests/phpunit/E2E/Core/PathUrlTest.php

@@ -68,6 +68,56 @@ public function testPaths_getVariable() {
     }
   }
 
+  /**
+   * Get URLs through Civi::url().
+   */
+  public function testUrl(): void {
+    // Make some reqeusts for actual URLs
+    $this->assertUrlContentRegex(';crm-section event_date_time-section;', \Civi::url('frontend://civicrm/event/info?id=1', 'a'));
+    $this->assertUrlContentRegex(';MIT-LICENSE.txt;', \Civi::url('asset://[civicrm.packages]/jquery/plugins/jquery.timeentry.js'));
+    $this->assertUrlContentRegex(';Please enter a valid email address;', \Civi::url('assetBuilder://crm-l10n.js?locale=en_US'));
+    $this->assertUrlContentRegex(';.module..crmSearchAdmin;', \Civi::url('ext://org.civicrm.search_kit/ang/crmSearchAdmin.module.js'));
+    $this->assertUrlContentRegex(';MIT-LICENSE.txt;', \Civi::url('[civicrm.packages]/jquery/plugins/jquery.timeentry.js'));
+
+    // Check for well-formedness of some URLs
+    $urlPats = [];
+    switch (CIVICRM_UF) {
+      case 'Drupal':
+      case 'Drupal8':
+      case 'Backdrop':
+        $urlPats[] = [';/civicrm/event/info\?reset=1&id=9;', \Civi::url('frontend://civicrm/event/info?reset=1')->addQuery('id=9')];
+        $urlPats[] = [';/civicrm/admin\?reset=1;', \Civi::url('backend://civicrm/admin')->addQuery(['reset' => 1])];
+        $this->assertNotEmpty($_SERVER['HTTP_HOST']);
+        break;
+
+      case 'WordPress':
+        $urlPats[] = [';civiwp=CiviCRM.*civicrm.*event.*info.*reset=1&id=9;', \Civi::url('frontend://civicrm/event/info?reset=1')->addQuery('id=9')];
+        $urlPats[] = [';/wp-admin.*civicrm.*admin.*reset=1;', \Civi::url('backend://civicrm/admin?reset=1')];
+        break;
+
+      case 'Joomla':
+        $urlPats[] = [';/index.php\?.*task=civicrm/event/info&reset=1&id=9;', \Civi::url('frontend://civicrm/event/inof?reset=1')->addQuery('id=9')];
+        $urlPats[] = [';/administrator/.*task=civicrm/admin/reset=1;', \Civi::url('backend://civicrm/admin')->addQuery('reset=1')];
+        break;
+
+      default:
+        $this->fail('Unrecognized UF: ' . CIVICRM_UF);
+    }
+
+    $urlPats[] = [';^https?://.*civicrm;', \Civi::url('frontend://civicrm/event/info?reset=1', 'a')];
+    $urlPats[] = [';^https://.*civicrm;', \Civi::url('frontend://civicrm/event/info?reset=1', 'as')];
+
+    // Some test-harnesses have HTTP_HOST. Some don't. It's pre-req for truly relative URLs.
+    if (!empty($_SERVER['HTTP_HOST'])) {
+      $urlPats[] = [';^/.*civicrm.*ajax.*api4.*Contact.*get;', \Civi::url('backend://civicrm/ajax/api4/Contact/get', 'r')];
+    }
+
+    $this->assertNotEmpty($urlPats);
+    foreach ($urlPats as $urlPat) {
+      $this->assertRegExp($urlPat[0], $urlPat[1]);
+    }
+  }
+
   /**
    * @param string $expectContentRegex
    * @param string $url