|
| 1 | +import Foundation |
| 2 | +import XCTest |
| 3 | +import UniformTypeIdentifiers |
| 4 | +import OHHTTPStubs |
| 5 | +import wpxmlrpc |
| 6 | + |
| 7 | +/// This type acts like a WordPress Media Library. It can be used in test cases to stub loading media library content |
| 8 | +/// API calls and provides a close-to-production API responses, which relieves test cases from the burden of creating |
| 9 | +/// appropriate responses. |
| 10 | +/// |
| 11 | +/// This class creates many dummy media items upon initlisation. Test cases can call the `stubREST` or `stubRPC` |
| 12 | +/// function to create an HTTP stub for WordPress.com REST API or WordPress XML-RPC API that are used in the |
| 13 | +/// `-[MediaServiceRemote getMediaLibraryWithPageLoad:success:failure:]` method. The stubs parse the pagination |
| 14 | +/// parameters in the API requests and returns appropriate media items accordingly. |
| 15 | +class MediaLibraryTestSupport { |
| 16 | + private let media: [Media] |
| 17 | + |
| 18 | + private var restStub: HTTPStubsDescriptor? { |
| 19 | + didSet { |
| 20 | + if let oldValue { |
| 21 | + HTTPStubs.removeStub(oldValue) |
| 22 | + } |
| 23 | + } |
| 24 | + } |
| 25 | + |
| 26 | + private var rpcStub: HTTPStubsDescriptor? { |
| 27 | + didSet { |
| 28 | + if let oldValue { |
| 29 | + HTTPStubs.removeStub(oldValue) |
| 30 | + } |
| 31 | + } |
| 32 | + } |
| 33 | + |
| 34 | + init(totalMedia: Int) { |
| 35 | + media = (1...totalMedia).map { id in |
| 36 | + Media( |
| 37 | + mediaID: id, |
| 38 | + postID: (1...12345).randomElement()!, |
| 39 | + mimeType: ["image/png", "audio/mp3", "video/mp4"].randomElement()!, |
| 40 | + cusor: UUID().uuidString |
| 41 | + ) |
| 42 | + } |
| 43 | + } |
| 44 | + |
| 45 | + deinit { |
| 46 | + restStub = nil |
| 47 | + rpcStub = nil |
| 48 | + } |
| 49 | +} |
| 50 | + |
| 51 | +extension MediaLibraryTestSupport { |
| 52 | + |
| 53 | + func stubREST(siteID: Int, failAtPage pageToFail: Int) { |
| 54 | + restStub = stub(condition: isPath("/rest/v1.1/sites/\(siteID)/media")) { [weak self] request in |
| 55 | + self?.handleREST(request: request, failAtPage: pageToFail) ?? .init(error: URLError(.networkConnectionLost)) |
| 56 | + } |
| 57 | + } |
| 58 | + |
| 59 | + private func handleREST(request: URLRequest, failAtPage pageToFail: Int) -> HTTPStubsResponse { |
| 60 | + let cursor = request.url?.query("page_handle") ?? nil |
| 61 | + let number = request.url?.query("number").flatMap(Int.init(_:)) ?? 100 |
| 62 | + |
| 63 | + let cursorIndex = media.firstIndex { $0.cusor == cursor } ?? 0 |
| 64 | + let requestPage = (cursorIndex / number) + 1 |
| 65 | + |
| 66 | + if pageToFail == requestPage { |
| 67 | + return .init(error: URLError(.cannotFindHost)) |
| 68 | + } |
| 69 | + |
| 70 | + let range = cursorIndex...min(cursorIndex + number - 1, media.count - 1) |
| 71 | + let json: [String: Any] = [ |
| 72 | + "media": media[range].map { $0.asRESTResponse() }, |
| 73 | + "meta": [ |
| 74 | + "next_page": range.upperBound + 1 < media.count ? media[range.upperBound + 1].cusor : "" |
| 75 | + ] |
| 76 | + ] |
| 77 | + |
| 78 | + return .init(jsonObject: json, statusCode: 200, headers: nil) |
| 79 | + } |
| 80 | + |
| 81 | +} |
| 82 | + |
| 83 | +extension MediaLibraryTestSupport { |
| 84 | + |
| 85 | + func stubRPC(endpoint: URL, failAtPage pageToFail: Int) { |
| 86 | + rpcStub = stub(condition: isMethodPOST() && isAbsoluteURLString(endpoint.absoluteString)) { [weak self] request in |
| 87 | + self?.handleRPC(request: request, failAtPage: pageToFail) ?? .init(error: URLError(.networkConnectionLost)) |
| 88 | + } |
| 89 | + } |
| 90 | + |
| 91 | + private func handleRPC(request: URLRequest, failAtPage pageToFail: Int) -> HTTPStubsResponse { |
| 92 | + let parser: XMLParser |
| 93 | + if let stream = request.httpBodyStream { |
| 94 | + parser = XMLParser(stream: stream) |
| 95 | + } else if let body = request.httpBody { |
| 96 | + parser = XMLParser(data: body) |
| 97 | + } else { |
| 98 | + return .init(error: URLError(.cannotDecodeContentData)) |
| 99 | + } |
| 100 | + |
| 101 | + let delegate = RequestParser() |
| 102 | + parser.delegate = delegate |
| 103 | + guard parser.parse() else { |
| 104 | + return .init(data: Data(), statusCode: 200, headers: nil) |
| 105 | + } |
| 106 | + |
| 107 | + XCTAssertEqual(delegate.methodName, "wp.getMediaLibrary") |
| 108 | + |
| 109 | + let number = delegate.params["number"] as? Int ?? 100 |
| 110 | + let offset = delegate.params["offset"] as? Int ?? 0 |
| 111 | + let requestPage = (offset / number) + 1 |
| 112 | + |
| 113 | + if pageToFail == requestPage { |
| 114 | + return .init(error: URLError(.cannotFindHost)) |
| 115 | + } |
| 116 | + |
| 117 | + let range = offset...min(offset + number - 1, media.count - 1) |
| 118 | + |
| 119 | + do { |
| 120 | + let data = try WPXMLRPCEncoder(responseParams: [media[range].map { $0.asRPCResponse() }]).dataEncoded() |
| 121 | + return .init(data: data, statusCode: 200, headers: ["Content-Type": "application/xml"]) |
| 122 | + } catch { |
| 123 | + return .init(error: error) |
| 124 | + } |
| 125 | + } |
| 126 | + |
| 127 | + private class RequestParser: NSObject, XMLParserDelegate { |
| 128 | + var elementPath: [String] = [] |
| 129 | + var methodName: String? |
| 130 | + var params: [String: Any] = [:] |
| 131 | + var content: String? |
| 132 | + var paramName: String? |
| 133 | + |
| 134 | + func parser(_ parser: XMLParser, didStartElement elementName: String, namespaceURI: String?, qualifiedName qName: String?, attributes attributeDict: [String : String] = [:]) { |
| 135 | + elementPath.append(elementName) |
| 136 | + } |
| 137 | + |
| 138 | + func parser(_ parser: XMLParser, foundCharacters string: String) { |
| 139 | + self.content = string |
| 140 | + } |
| 141 | + |
| 142 | + func parser(_ parser: XMLParser, didEndElement elementName: String, namespaceURI: String?, qualifiedName qName: String?) { |
| 143 | + assert(elementName == elementPath.last) |
| 144 | + |
| 145 | + defer { |
| 146 | + self.content = nil |
| 147 | + elementPath.removeLast() |
| 148 | + } |
| 149 | + |
| 150 | + switch elementPath { |
| 151 | + case ["methodCall", "methodName"]: |
| 152 | + self.methodName = self.content |
| 153 | + case ["methodCall", "params", "param", "value", "struct", "member", "name"]: |
| 154 | + self.paramName = self.content |
| 155 | + case ["methodCall", "params", "param", "value", "struct", "member", "value", "i4"]: |
| 156 | + self.params[self.paramName!] = Int(self.content!) |
| 157 | + self.paramName = nil |
| 158 | + default: |
| 159 | + break |
| 160 | + } |
| 161 | + } |
| 162 | + } |
| 163 | + |
| 164 | +} |
| 165 | + |
| 166 | +private struct Media: Codable { |
| 167 | + var mediaID: Int |
| 168 | + var postID: Int |
| 169 | + var mimeType: String |
| 170 | + |
| 171 | + var cusor: String |
| 172 | + |
| 173 | + func asRESTResponse() -> [String: Any] { |
| 174 | + [ |
| 175 | + "ID": mediaID, |
| 176 | + "post_ID": postID, |
| 177 | + "mime_type": mimeType |
| 178 | + ] |
| 179 | + } |
| 180 | + |
| 181 | + func asRPCResponse() -> [String: Any] { |
| 182 | + [ |
| 183 | + "id": mediaID, |
| 184 | + "parent": postID, |
| 185 | + "type": mimeType |
| 186 | + ] |
| 187 | + } |
| 188 | +} |
| 189 | + |
| 190 | +private extension URL { |
| 191 | + func query(_ name: String) -> String? { |
| 192 | + URLComponents(url: self, resolvingAgainstBaseURL: true)? |
| 193 | + .queryItems? |
| 194 | + .first { $0.name == name }? |
| 195 | + .value |
| 196 | + } |
| 197 | +} |
0 commit comments