Remote Config Console API for Testing (#6009)

* Added Remote Config Console API and some tests

* Added workflow scripts

* Update path in remote config workflow

* Update path in remote config workflow 2.0

* Adding print statements to debug

* Update generate_access_token.sh

* Style and script cleanup

* Updated README and script

* reordering workflow tests for faster dev

* Updated generate_access_token.sh

* Removed unneeded part of path

* Set env var in GHA rather than script

* Fix env var in GHA

* Fix env var in GHA 2.0

* Refactored actions into one script

* removed back slash

* Removed unneeded workflow step

* Refactored script and added comments

* Minor tweaks

* Added new line

* well nvm that tweak

* Reordered workflow steps back to original order

* Only generate access token for ios runs

* Fixed readme, organized tests, improved RemoteConfigConsole

* Fixed test

* reordering tests for dev

* Removed README.md

* Added local dev mode for script

* Reset the ordering of tests to original order

* Update README

* Update README again

* Trailing space

* trailing space..again

* Cleanup up cloned repo in script

* Resolved feedback

* Style

* Gotta love trailing spaces

* Resolved feedback 2.0

* Resolved feedback 3.0

* Changed param type for update APIs

* Fixed type in updateRemoteConfigValue  method

Author: ncooke3

.github/workflows/remoteconfig.yml

@@ -30,6 +30,10 @@ jobs:
     - name: Install Secret GoogleService-Info.plist
       run: scripts/decrypt_gha_secret.sh scripts/gha-encrypted/RemoteConfigSwiftAPI/GoogleService-Info.plist.gpg \
           FirebaseRemoteConfig/Tests/SwiftAPI/GoogleService-Info.plist "$plist_secret"
+    - name: Generate Access Token for RemoteConfigConsoleAPI in IntegrationTests
+      if: matrix.target == 'iOS'
+      run: scripts/generate_access_token.sh "$plist_secret" scripts/gha-encrypted/RemoteConfigSwiftAPI/ServiceAccount.json.gpg
+          FirebaseRemoteConfig/Tests/SwiftAPI/AccessToken.json
     - name: BuildAndUnitTest # can be replaced with pod lib lint with CocoaPods 1.10
       run: scripts/third_party/travis/retry.sh scripts/build.sh RemoteConfig ${{ matrix.target }} unit
     - name: Fake Console API Tests

FirebaseRemoteConfig.podspec

@@ -87,7 +87,8 @@ app update.
     swift_api.pod_target_xcconfig = {
       'SWIFT_OBJC_BRIDGING_HEADER' => '$(PODS_TARGET_SRCROOT)/FirebaseRemoteConfig/Tests/FakeUtils/Bridging-Header.h'
     }
-    swift_api.resources = 'FirebaseRemoteConfig/Tests/SwiftAPI/GoogleService-Info.plist'
+    swift_api.resources = 'FirebaseRemoteConfig/Tests/SwiftAPI/GoogleService-Info.plist',
+                          'FirebaseRemoteConfig/Tests/SwiftAPI/AccessToken.json'
     swift_api.dependency 'OCMock'
   end
 

FirebaseRemoteConfig/Tests/SwiftAPI/APITests.swift

@@ -17,11 +17,37 @@ import FirebaseCore
 
 import XCTest
 
+/// String constants used for testing.
+private enum Constants {
+  static let key1 = "Key1"
+  static let jedi = "Jedi"
+  static let sith = "Sith_Lord"
+  static let value1 = "Value1"
+  static let obiwan = "Obi-Wan"
+  static let yoda = "Yoda"
+  static let darthSidious = "Darth Sidious"
+}
+
 class APITests: APITestBase {
+  var console: RemoteConfigConsole!
+
   override func setUp() {
     super.setUp()
     if APITests.useFakeConfig {
-      fakeConsole.config = ["Key1": "Value1"]
+      fakeConsole.config = [Constants.key1: Constants.value1]
+    } else {
+      console = RemoteConfigConsole()
+      console.updateRemoteConfigValue(Constants.obiwan, forKey: Constants.jedi)
+    }
+  }
+
+  override func tearDown() {
+    super.tearDown()
+
+    // If using RemoteConfigConsole, reset remote config values.
+    if !APITests.useFakeConfig {
+      console.removeRemoteConfigValue(forKey: Constants.sith)
+      console.removeRemoteConfigValue(forKey: Constants.jedi)
     }
   }
 
@@ -34,7 +60,7 @@ class APITests: APITestBase {
       XCTAssertEqual(status, RemoteConfigFetchStatus.success)
       self.config.activate { _, error in
         XCTAssertNil(error)
-        XCTAssertEqual(self.config["Key1"].stringValue, "Value1")
+        XCTAssertEqual(self.config[Constants.key1].stringValue, Constants.value1)
         expectation.fulfill()
       }
     }
@@ -50,7 +76,7 @@ class APITests: APITestBase {
       XCTAssertEqual(status, RemoteConfigFetchStatus.success)
       self.config.activate { _, error in
         XCTAssertNil(error)
-        XCTAssertEqual(self.config["Key1"].stringValue, "Value1")
+        XCTAssertEqual(self.config[Constants.key1].stringValue, Constants.value1)
         expectation.fulfill()
       }
     }
@@ -63,7 +89,7 @@ class APITests: APITestBase {
       if let error = error {
         XCTFail("Fetch and Activate Error \(error)")
       }
-      XCTAssertEqual(self.config["Key1"].stringValue, "Value1")
+      XCTAssertEqual(self.config[Constants.key1].stringValue, Constants.value1)
       expectation.fulfill()
     }
     waitForExpectations()
@@ -82,7 +108,7 @@ class APITests: APITestBase {
         if let error = error {
           print("Activate Error \(error)")
         }
-        XCTAssertEqual(self.config["Key1"].stringValue, "Value1")
+        XCTAssertEqual(self.config[Constants.key1].stringValue, Constants.value1)
         expectation.fulfill()
       }
     }
@@ -98,7 +124,7 @@ class APITests: APITestBase {
         if let error = error {
           XCTAssertEqual((error as NSError).code, RemoteConfigError.internalError.rawValue)
         }
-        XCTAssertEqual(self.config["Key1"].stringValue, "Value1")
+        XCTAssertEqual(self.config[Constants.key1].stringValue, Constants.value1)
         expectation2.fulfill()
       }
     }
@@ -117,7 +143,7 @@ class APITests: APITestBase {
       self.config.activate { changed, error in
         XCTAssertTrue(!APITests.useFakeConfig || changed)
         XCTAssertNil(error)
-        XCTAssertEqual(self.config["Key1"].stringValue, "Value1")
+        XCTAssertEqual(self.config[Constants.key1].stringValue, Constants.value1)
         expectation.fulfill()
       }
     }
@@ -131,13 +157,161 @@ class APITests: APITestBase {
       self.config.activate { changed, error in
         XCTAssertFalse(changed)
         XCTAssertNil(error)
-        XCTAssertEqual(self.config["Key1"].stringValue, "Value1")
+        XCTAssertEqual(self.config[Constants.key1].stringValue, Constants.value1)
         expectation2.fulfill()
       }
     }
     waitForExpectations()
   }
 
+  func testFetchAndActivateUnchangedConfig() throws {
+    guard APITests.useFakeConfig == false else { return }
+
+    let expectation = self.expectation(description: #function)
+
+    XCTAssertEqual(config.settings.minimumFetchInterval, 0)
+
+    let serialQueue = DispatchQueue(label: "\(#function)Queue")
+    let group = DispatchGroup()
+    group.enter()
+    serialQueue.async {
+      // Represents pre-fetch occuring sometime in past.
+      self.config.fetch { status, error in
+        XCTAssertNil(error, "Fetch Error \(error!)")
+        XCTAssertEqual(status, .success)
+        group.leave()
+      }
+    }
+
+    serialQueue.async {
+      group.wait()
+      group.enter()
+      // Represents a `fetchAndActivate` being made to pull latest changes from Remote Config.
+      self.config.fetchAndActivate { status, error in
+        XCTAssertNil(error, "Fetch & Activate Error \(error!)")
+        // Since no updates to remote config have occurred we use the `.successUsingPreFetchedData`.
+        XCTAssertEqual(status, .successUsingPreFetchedData)
+        // The `lastETagUpdateTime` should either be older or the same time as `lastFetchTime`.
+        if let lastFetchTime = try? XCTUnwrap(self.config.lastFetchTime) {
+          XCTAssertLessThanOrEqual(Double(self.config.settings.lastETagUpdateTime),
+                                   Double(lastFetchTime.timeIntervalSince1970))
+        } else {
+          XCTFail("Could not unwrap lastFetchTime.")
+        }
+
+        expectation.fulfill()
+      }
+    }
+
+    waitForExpectations()
+  }
+
+  // MARK: - RemoteConfigConsole Tests
+
+  func testFetchConfigThenUpdateConsoleThenFetchAgain() {
+    guard APITests.useFakeConfig == false else { return }
+
+    let expectation = self.expectation(description: #function)
+
+    config.fetchAndActivate { status, error in
+      XCTAssertNil(error, "Fetch & Activate Error \(error!)")
+
+      if let configValue = self.config.configValue(forKey: Constants.jedi).stringValue {
+        XCTAssertEqual(configValue, Constants.obiwan)
+      } else {
+        XCTFail("Could not unwrap config value for key: \(Constants.jedi)")
+      }
+      expectation.fulfill()
+    }
+    waitForExpectations()
+
+    // Synchronously update the console.
+    console.updateRemoteConfigValue(Constants.yoda, forKey: Constants.jedi)
+
+    let expectation2 = self.expectation(description: #function + "2")
+    config.fetchAndActivate { status, error in
+      XCTAssertNil(error, "Fetch & Activate Error \(error!)")
+
+      if let configValue = self.config.configValue(forKey: Constants.jedi).stringValue {
+        XCTAssertEqual(configValue, Constants.yoda)
+      } else {
+        XCTFail("Could not unwrap config value for key: \(Constants.jedi)")
+      }
+
+      expectation2.fulfill()
+    }
+    waitForExpectations()
+  }
+
+  func testFetchConfigThenAddValueOnConsoleThenFetchAgain() {
+    guard APITests.useFakeConfig == false else { return }
+
+    // Ensure no Sith Lord has been written to Remote Config yet.
+    let expectation = self.expectation(description: #function)
+
+    config.fetchAndActivate { status, error in
+      XCTAssertNil(error, "Fetch & Activate Error \(error!)")
+
+      XCTAssertTrue(self.config.configValue(forKey: Constants.sith).dataValue.isEmpty)
+
+      expectation.fulfill()
+    }
+    waitForExpectations()
+
+    // Synchronously update the console
+    console.updateRemoteConfigValue(Constants.darthSidious, forKey: Constants.sith)
+
+    // Verify the Sith Lord can now be fetched from Remote Config.
+    let expectation2 = self.expectation(description: #function + "2")
+
+    config.fetchAndActivate { status, error in
+      XCTAssertNil(error, "Fetch & Activate Error \(error!)")
+
+      if let configValue = self.config.configValue(forKey: Constants.sith).stringValue {
+        XCTAssertEqual(configValue, Constants.darthSidious)
+      } else {
+        XCTFail("Could not unwrap config value for key: \(Constants.sith)")
+      }
+
+      expectation2.fulfill()
+    }
+    waitForExpectations()
+  }
+
+  func testFetchConfigThenDeleteValueOnConsoleThenFetchAgain() {
+    guard APITests.useFakeConfig == false else { return }
+
+    let expectation = self.expectation(description: #function)
+
+    config.fetchAndActivate { status, error in
+      XCTAssertNil(error, "Fetch & Activate Error \(error!)")
+
+      if let configValue = self.config.configValue(forKey: Constants.jedi).stringValue {
+        XCTAssertEqual(configValue, Constants.obiwan)
+      } else {
+        XCTFail("Could not unwrap config value for key: \(Constants.jedi)")
+      }
+      expectation.fulfill()
+    }
+    waitForExpectations()
+
+    // Synchronously delete value on the console.
+    console.removeRemoteConfigValue(forKey: Constants.jedi)
+
+    let expectation2 = self.expectation(description: #function + "2")
+    config.fetchAndActivate { status, error in
+      XCTAssertNil(error, "Fetch & Activate Error \(error!)")
+
+      XCTAssertTrue(self.config.configValue(forKey: Constants.jedi).dataValue.isEmpty,
+                    "Remote config should have been deleted.")
+
+      expectation2.fulfill()
+    }
+    waitForExpectations()
+  }
+
+  // MARK: - Private Helpers
+
   private func waitForExpectations() {
     let kFIRStorageIntegrationTestTimeout = 10.0
     waitForExpectations(timeout: kFIRStorageIntegrationTestTimeout,

FirebaseRemoteConfig/Tests/SwiftAPI/AccessToken.json

@@ -0,0 +1,5 @@
+{
+    "token_type":"Bearer",
+    "expires_in":3599,
+    "access_token":"Generated by ./scripts/generate_access_token.sh"
+}