firebase-ios-sdk/FirebaseRemoteConfig/Tests/Swift/SwiftAPI/APITestBase.swift

// Copyright 2020 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 FirebaseCore
import FirebaseRemoteConfig

#if SWIFT_PACKAGE
  import RemoteConfigFakeConsoleObjC
#endif

import XCTest

class APITestBase: XCTestCase {
  static var useFakeConfig: Bool!
  static var mockedFetch: Bool!
  static var mockedRealtime: Bool!
  var app: FirebaseApp!
  var config: RemoteConfig!
  var console: RemoteConfigConsole!
  var fakeConsole: FakeConsole!

  override class func setUp() {
    if FirebaseApp.app() == nil {
      #if USE_REAL_CONSOLE
        useFakeConfig = false
        FirebaseApp.configure()
        // Sleep for 1 minute between test files to avoid exceeding rate limit.
        sleep(60)
      #else
        useFakeConfig = true
        let options = FirebaseOptions(googleAppID: "1:123:ios:123abc",
                                      gcmSenderID: "correct_gcm_sender_id")
        options.apiKey = "A23456789012345678901234567890123456789"
        options.projectID = "Fake_Project"
        FirebaseApp.configure(options: options)
        APITests.mockedFetch = false
        APITests.mockedRealtime = false
      #endif
    }
  }

  override func setUpWithError() throws {
    try super.setUpWithError()
    app = FirebaseApp.app()
    config = RemoteConfig.remoteConfig(app: app!)
    let settings = RemoteConfigSettings()
    settings.minimumFetchInterval = 0
    config.configSettings = settings
    config.settings.customSignals = [:]

    let jsonData = try JSONSerialization.data(
      withJSONObject: Constants.jsonValue
    )
    guard let jsonValue = String(data: jsonData, encoding: .ascii) else {
      fatalError("Failed to make json Value from jsonData")
    }
    let arrayjsonData = try JSONSerialization.data(
      withJSONObject: Constants.arrayValue
    )
    guard let arrayJsonValue = String(data: arrayjsonData, encoding: .ascii) else {
      fatalError("Failed to make json Value from jsonData")
    }
    let dictJsonData = try JSONSerialization.data(
      withJSONObject: Constants.dictValue
    )
    guard let dictJsonValue = String(data: dictJsonData, encoding: .ascii) else {
      fatalError("Failed to make json Value from jsonData")
    }

    if APITests.useFakeConfig {
      if !APITests.mockedFetch {
        APITests.mockedFetch = true
        config.configFetch = FetchMocks.mockFetch(config.configFetch)
      }
      if !APITests.mockedRealtime {
        APITests.mockedRealtime = true
        config.configRealtime = RealtimeMocks.mockRealtime(config.configRealtime)
      }
      fakeConsole = FakeConsole()
      let configuration = URLSessionConfiguration.default
      configuration.protocolClasses = [MockURLProtocol.self]
      config.configFetch.fetchSession = URLSession(configuration: configuration)

      var etag = ""
      MockURLProtocol.requestHandler = { request in
        let consoleValues = self.fakeConsole.get()
        if etag == "" || consoleValues["state"] as! String == RCNFetchResponseKeyStateUpdate {
          // Time string in microseconds to insure a different string from previous change.
          etag = String(NSDate().timeIntervalSince1970)
        }
        let jsonData = try! JSONSerialization.data(withJSONObject: consoleValues)
        let response = HTTPURLResponse(url: URL(fileURLWithPath: "fakeURL"),
                                       statusCode: 200,
                                       httpVersion: nil,
                                       headerFields: ["etag": etag])
        return (jsonData, response!)
      }

      fakeConsole.config = [Constants.key1: Constants.value1,
                            Constants.jsonKey: jsonValue,
                            Constants.nonJsonKey: Constants.nonJsonValue,
                            Constants.stringKey: Constants.stringValue,
                            Constants.intKey: String(Constants.intValue),
                            Constants.floatKey: String(Constants.floatValue),
                            Constants.decimalKey: "\(Constants.decimalValue)",
                            Constants.trueKey: String(true),
                            Constants.falseKey: String(false),
                            Constants.dataKey: String(decoding: Constants.dataValue, as: UTF8.self),
                            Constants.arrayKey: arrayJsonValue,
                            Constants.dictKey: dictJsonValue]
    } else {
      console = RemoteConfigConsole()
      console.updateRemoteConfigValue(Constants.obiwan, forKey: Constants.jedi)
    }

    // Uncomment for verbose debug logging.
    // FirebaseConfiguration.shared.setLoggerLevel(FirebaseLoggerLevel.debug)
  }

  override func tearDown() {
    if APITests.useFakeConfig {
      fakeConsole.empty()
    } else {
      console.removeRemoteConfigValue(forKey: Constants.sith)
      console.removeRemoteConfigValue(forKey: Constants.jedi)
    }
    app = nil
    config = nil
    super.tearDown()
  }
}