Testing refactor; add tests to ensure percent-encoded URLs (those with reserved characters) are processed correctly

Author: gregneagle

BunnyNetMiddleware/BunnyNetMiddleware.swift

@@ -47,9 +47,29 @@ func generateToken(key: String, path: String, expires: Int, filteredIP: String =
         .replacingOccurrences(of: "+", with: "-")
         .replacingOccurrences(of: "/", with: "_")
         .replacingOccurrences(of: "=", with: "")
+    print("'\(path)' generates '\(tokenFormatted)'")
     return tokenFormatted
 }
 
+/// Generates a bunny.net URL
+func generateBunnyNetURL(url: String, key: String, expires: Int) -> String? {
+    guard var components = URLComponents(string: url) else {
+        print("ERROR: Can't parse \(url) as a valid URL")
+        return nil
+    }
+    let token = generateToken(key: key, path: components.path, expires: expires)
+    let queryItems: [URLQueryItem] = [
+        URLQueryItem(name: "token", value: token),
+        URLQueryItem(name: "expires", value: String(expires)),
+    ]
+    components.queryItems = queryItems
+    guard let modifiedURL = components.string else {
+        print("ERROR: Can't construct modified URL")
+        return nil
+    }
+    return modifiedURL
+}
+
 class BunnyNetMiddleware: MunkiMiddleware {
     /// process the request
     func processRequest(_ request: MunkiMiddlewareRequest) -> MunkiMiddlewareRequest {
@@ -58,23 +78,14 @@ class BunnyNetMiddleware: MunkiMiddleware {
                 print("ERROR: BunnyNetKey preference not set")
                 return request
             }
-            guard var components = URLComponents(string: request.url) else {
-                print("ERROR: Can't parse \(request.url) as a valid URL")
-                return request
-            }
             let expires = Int(Date().timeIntervalSince1970 + 3600)
-            let token = generateToken(
+            guard let modifiedURL = generateBunnyNetURL(
+                url: request.url,
                 key: securityKey,
-                path: components.path,
                 expires: expires
-            )
-            let queryItems: [URLQueryItem] = [
-                URLQueryItem(name: "token", value: token),
-                URLQueryItem(name: "expires", value: String(expires)),
-            ]
-            components.queryItems = queryItems
-            guard let modifiedURL = components.string else {
-                print("ERROR: Can't construct modified URL")
+            ) else {
+                // error message was printed by generateBunnyNetURL
+                // return unmodifed request
                 return request
             }
             var modifiedRequest = request

BunnyNetMiddlewareTests/BunnyNetMiddlewareTests.swift

@@ -10,15 +10,46 @@ import Testing
 struct BunnyNetMiddlewareTests {
     /// This simply tests that the generateToken function produces the same output
     /// as the Python version
-    @Test func generateTokenGeneratesExpected() {
+    @Test func generateTokenWithNoPercentEncodingInPathGeneratesExpected() {
         let token = generateToken(
             key: "FOOBARBAZ",
             path: "/someinstaller.dmg",
             expires: 1_747_270_308
         )
         #expect(token == "CNje5yxtqEdjkrN4RvhSlg")
     }
-    
+
+    @Test func generateTokenWithPercentEncodedPathGeneratesExpected() {
+        let token = generateToken(
+            key: "FOOBARBAZ",
+            path: "/some%20installer.dmg",
+            expires: 1_747_270_308
+        )
+        #expect(token == "IGdIFRU7caWJqfLIRmbwxw")
+    }
+
+    @Test func urlWithNoPercentEncodingGeneratesExpectedBunnyNetURL() {
+        let testURL = "https://test.b-cdn.net/someinstaller.dmg"
+        let expectedURL = "https://test.b-cdn.net/someinstaller.dmg?token=CNje5yxtqEdjkrN4RvhSlg&expires=1747270308"
+        let modifiedURL = generateBunnyNetURL(
+            url: testURL,
+            key: "FOOBARBAZ",
+            expires: 1_747_270_308
+        )
+        #expect(modifiedURL == expectedURL)
+    }
+
+    @Test func urlWithPercentEncodingGeneratesExpectedBunnyNetURL2() {
+        let testURL = "https://test.b-cdn.net/some%20installer.dmg"
+        let expectedURL = "https://test.b-cdn.net/some%20installer.dmg?token=krv82IZ0s4Nhg2zfVtRlfA&expires=1747270308"
+        let modifiedURL = generateBunnyNetURL(
+            url: testURL,
+            key: "FOOBARBAZ",
+            expires: 1_747_270_308
+        )
+        #expect(modifiedURL == expectedURL)
+    }
+
     /// Test that a non-BunnyNet request is returned unmodified
     @Test func nonBunnyNetRequestShouldNotBeModified() async throws {
         let request = MunkiMiddlewareRequest(