firebase-ios-sdk/FirebaseStorage/Tests/Unit/StorageTestHelpers.swift

// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import Foundation

import FirebaseCore
@testable import FirebaseStorage
import GTMSessionFetcherCore

import XCTest

@available(iOS 13, tvOS 13, macOS 10.15, macCatalyst 13, watchOS 7, *)
class StorageTestHelpers: XCTestCase {
  static var app: FirebaseApp!

  func storage() -> Storage {
    return Storage(app: FirebaseApp.app()!, bucket: "bucket")
  }

  override class func setUp() {
    super.setUp()
    if app == nil {
      let options = FirebaseOptions(googleAppID: "0:0000000000000:ios:0000000000000000",
                                    gcmSenderID: "00000000000000000-00000000000-000000000")
      options.projectID = "myProjectID"
      FirebaseApp.configure(options: options)
      app = FirebaseApp(instanceWithName: "test", options: options)
    }
  }

  func rootReference() -> StorageReference {
    let path = StoragePath(with: "bucket")
    return StorageReference(storage: storage(), path: path)
  }

  func waitForExpectation(test: XCTest) {
    waitForExpectations(timeout: 10) { error in
      if let error {
        print("Error \(error)")
      }
    }
  }

  func successBlock(withMetadata metadata: StorageMetadata? = nil)
    -> GTMSessionFetcherTestBlock {
    var data: Data?
    if let metadata {
      data = try? JSONSerialization.data(withJSONObject: metadata.dictionaryRepresentation())
    }
    return block(forData: data, url: nil, statusCode: 200)
  }

  func successBlock(withURL url: URL) -> GTMSessionFetcherTestBlock {
    let data = "{}".data(using: .utf8)
    return block(forData: data, url: url, statusCode: 200)
  }

  func unauthenticatedBlock() -> GTMSessionFetcherTestBlock {
    let unauthenticatedString =
      "<html><body><p>User not authenticated. Authentication via Authorization header required. " +
      "Authorization Header does not match expected format of 'Authorization: Firebase " +
      "<JWT>'.</p></body></html>"
    let data = unauthenticatedString.data(using: .utf8)
    return block(forData: data, url: nil, statusCode: 401)
  }

  func unauthorizedBlock() -> GTMSessionFetcherTestBlock {
    let unauthorizedString =
      "<html><body><p>User not authorized. Authentication via Authorization header required. " +
      "Authorization Header does not match expected format of 'Authorization: Firebase " +
      "<JWT>'.</p></body></html>"
    let data = unauthorizedString.data(using: .utf8)
    return block(forData: data, url: nil, statusCode: 403)
  }

  func notFoundBlock() -> GTMSessionFetcherTestBlock {
    let unauthenticatedString = "<html><body><p>Object not found.</p></body></html>"
    let data = unauthenticatedString.data(using: .utf8)
    return block(forData: data, url: nil, statusCode: 404)
  }

  func invalidJSONBlock() -> GTMSessionFetcherTestBlock {
    let string = "This is not a JSON object"
    let data = string.data(using: .utf8)
    return block(forData: data, url: nil, statusCode: 200)
  }

  private func block(forData data: Data?, url: URL?,
                     statusCode code: Int) -> GTMSessionFetcherTestBlock {
    let block = { (fetcher: GTMSessionFetcher, response: GTMSessionFetcherTestResponse) in
      let fetcherURL = fetcher.request?.url!
      if let url {
        XCTAssertEqual(url, fetcherURL)
      }
      let httpResponse = HTTPURLResponse(
        url: fetcherURL!,
        statusCode: code,
        httpVersion: "HTTP/1.1",
        headerFields: nil
      )
      var error: NSError?
      if code >= 400 {
        var userInfo: [String: Any]?
        if let data {
          userInfo = ["data": data]
        }
        error = NSError(domain: "com.google.HTTPStatus", code: code, userInfo: userInfo)
      }
      response(httpResponse, data, error)
    }
    return block
  }

  private let objectString = "https://firebasestorage.googleapis.com:443/v0/b/bucket/o/object"

  func objectURL() -> URL {
    return URL(string: objectString)!
  }

  func objectPath() -> StoragePath {
    guard let path = try? StoragePath.path(string: objectString) else {
      fatalError("Failed to get StoragePath")
    }
    return path
  }
}