Revision control
Copy as Markdown
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
@testable import Glean
import XCTest
// REASON: This test is long because of setup boilerplate
class HttpPingUploaderTests: XCTestCase {
var expectation: XCTestExpectation?
private let testPath = "/some/random/path/not/important"
private let testPing = "{ \"ping\": \"test\" }"
private let testRequest = PingRequest(
documentId: "12345",
path: "/some/random/path/not/important",
body: [UInt8]("{ \"ping\": \"test\" }".utf8),
headers: [:],
bodyHasInfoSections: true,
pingName: "testPing",
uploaderCapabilities: []
)
override func setUp() {
resetGleanDiscardingInitialPings(testCase: self, tag: "HttpPingUploaderTests", clearStores: true)
}
override func tearDown() {
// Reset expectations
expectation = nil
tearDownStubs()
}
/// Launch a new ping uploader on the background thread.
///
/// This function doesn't block.
private func getUploader() -> HttpPingUploader {
// Build a URLSession with no-caching suitable for uploading our pings
let config: URLSessionConfiguration = .default
config.requestCachePolicy = NSURLRequest.CachePolicy.reloadIgnoringLocalCacheData
config.urlCache = nil
let session = URLSession(configuration: config)
return HttpPingUploader.init(configuration: Configuration(), session: session)
}
func testHTTPStatusCode() {
// We are explicitly setting the test mode to true here to force the uploader to not
// run in the background, which can make this test take a long time.
var testValue: UploadResult?
stubServerReceive { _, json in
XCTAssert(json != nil)
XCTAssertEqual(json?["ping"] as? String, "test")
}
expectation = expectation(description: "Completed upload")
// Build a URLSession with no-caching suitable for uploading our pings
let httpPingUploader = self.getUploader()
httpPingUploader.upload(request: testRequest) { result in
testValue = result
self.expectation?.fulfill()
}
waitForExpectations(timeout: 5.0) { error in
XCTAssertNil(error, "Test timed out waiting for upload: \(error!)")
}
// `UploadResult` is not `Equatable`, so instead of implementing that we just unpack it
if case let .httpStatus(statusCode) = testValue {
XCTAssertEqual(200, statusCode, "`upload()` returns the expected HTTP status code")
} else {
let value = String(describing: testValue)
XCTAssertTrue(false, "`upload()` returns the expected HTTP status code. Was: \(value)")
}
}
func testRequestParameters() {
// Build a URLSession with no-caching suitable for uploading our pings
let config: URLSessionConfiguration = .default
config.requestCachePolicy = NSURLRequest.CachePolicy.reloadIgnoringLocalCacheData
config.urlCache = nil
let session = URLSession(configuration: config)
// Build a request.
// We specify a single additional header here.
// In usual code they are generated on the Rust side.
let request = HttpPingUploader(configuration: Configuration(), session: session)
.buildRequest(path: testPath, data: Data(testPing.utf8), headers: ["X-Test-Only": "Glean"])
XCTAssertEqual(
request?.url?.path,
testPath,
"Request path set correctly"
)
XCTAssertEqual(
request?.httpMethod,
"POST",
"Request method set correctly"
)
XCTAssertEqual(
request?.httpBody,
Data(testPing.utf8),
"Request body set correctly"
)
XCTAssertEqual(
request?.httpShouldHandleCookies,
false,
"Request cookie policy set correctly"
)
XCTAssertEqual(
request?.value(forHTTPHeaderField: "X-Test-Only"),
"Glean",
"Request header set correctly"
)
}
// We don't support capabilities yet, so return `.incapable` if a ping requires capabilites.
// Once we do support capabilities, this test will need to be removed or changed to test
// what is supported.
func testUploaderReturnsIncapableWhenRequestHasCapabilities() {
let testOhttpRequest = PingRequest(
documentId: "12345",
path: "/some/random/path/not/important",
body: [UInt8]("{ \"ping\": \"test\" }".utf8),
headers: [:],
bodyHasInfoSections: true,
pingName: "testPing",
uploaderCapabilities: ["ohttp", "os2/warp", "sega-genesis"]
)
let httpPingUploader = self.getUploader()
httpPingUploader.upload(request: testOhttpRequest) { result in
XCTAssertEqual(
.incapable(unused: 0),
result,
"upload should return .incapable when capabilities don't match"
)
}
}
}