Add a utility method to test base_url handling

Author: JamesDPC

src/Services/CloudflarePurgeService.php

@@ -193,6 +193,56 @@ function(&$value, $key) {
         return $urls;
     }
 
+    /**
+     * Replace the scheme/host with the configured base URL if it exists
+     * This is gnerally used by tests to validate base_url functionality
+     */
+    public static function replaceWithBaseUrl(array $urls) : array {
+
+        $baseURL = self::config()->get('base_url');
+        if(!$baseURL) {
+            return $urls;
+        }
+
+        $scheme = parse_url($baseURL, PHP_URL_SCHEME);
+        $host = parse_url($baseURL, PHP_URL_HOST);
+
+        if(!$scheme) {
+            throw new \Exception("base_url needs to have a scheme");
+        }
+        if(!$host) {
+            throw new \Exception("base_url needs to have a host");
+        }
+
+        // Replace base_url
+        $updatedUrls = [];
+        foreach($urls as $url) {
+
+            // gather parts from URL provide
+            $path = parse_url($url, PHP_URL_PATH);
+            $port = parse_url($url, PHP_URL_PORT);
+            $query = parse_url($url, PHP_URL_QUERY);
+
+            // use base URL parts for these components
+            $newUrl = $scheme . "://";
+            $newUrl .= $host;
+            if($port) {
+                $newUrl .= ":" . $port;
+            }
+            if($path) {
+                $newUrl .= $path;
+            }
+            if($query) {
+                $newUrl .= "?" . $query;
+            }
+
+            $updatedUrls[] = $newUrl;
+
+        }
+
+        return $updatedUrls;
+    }
+
     /**
      * Purge all from zone by creating a cache purge job in the future (which handles the purging)
      * The idea here is that job will be created in the future with a configured delay (hrs)

tests/BaseURLTest.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace NSWDPC\Utilities\Cloudflare\Tests;
+
+use NSWDPC\Utilities\Cloudflare\CloudflarePurgeService;
+use SilverStripe\Core\Config\Config;
+
+require_once(dirname(__FILE__) . '/CloudflarePurgeTest.php');
+
+/**
+ * Test base_url configuration
+ * @author James
+ */
+class BaseURLTest extends CloudflarePurgeTest
+{
+
+    protected $usesDatabase = false;
+
+    public function testBaseURL() {
+
+        $scheme = "https";
+        $host = "alt.example.com";
+        $baseUrl = $scheme . "://" . $host;
+        Config::modify()->update(CloudflarePurgeService::class, 'base_url', $baseUrl);
+
+        // these URLS should all have their scheme + host updated
+        $urls = [
+            "https://example.com/testversionedrecord.html?stage=Stage&alternateformat=1"
+                => "{$baseUrl}/testversionedrecord.html?stage=Stage&alternateformat=1",
+
+            "/testversionedrecord.html?stage=Stage&alternateformat=1"
+                => "{$baseUrl}/testversionedrecord.html?stage=Stage&alternateformat=1",
+
+            "https://example.com/testversionedrecord.html?stage=Stage"
+                => "{$baseUrl}/testversionedrecord.html?stage=Stage",
+
+            // this URL will produce a host as below
+            "example.com/testversionedrecord.html?stage=Stage"
+                => "{$baseUrl}example.com/testversionedrecord.html?stage=Stage",
+
+            "https://example.org/testversionedrecord.html?alternateformat=1"
+                => "{$baseUrl}/testversionedrecord.html?alternateformat=1",
+
+            "https://example.org/testversionedrecord/"
+                => "{$baseUrl}/testversionedrecord/",
+
+            "https://example.org/"
+                => "{$baseUrl}/",
+
+            "https://example.org"
+                => "{$baseUrl}",
+        ];
+
+        foreach($urls as $inUrl => $expectedUrl) {
+            $outUrls = CloudflarePurgeService::replaceWithBaseUrl( [$inUrl] );
+            $this->assertEquals($expectedUrl, $outUrls[0], "Returned URL does not match expected");
+        }
+
+    }
+
+}