Fake Remote Config console for testing (#5633)

Author: paulb777

.github/workflows/remoteconfig.yml

@@ -31,6 +31,8 @@ jobs:
           FirebaseRemoteConfig/Tests/SwiftAPI/GoogleService-Info.plist "$plist_secret"
     - 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
+      run: scripts/third_party/travis/retry.sh scripts/build.sh RemoteConfig iOS fakeconsole
     - name: IntegrationTest
       if: matrix.target == 'iOS'
       run: ([ -z $plist_secret ] || scripts/third_party/travis/retry.sh scripts/build.sh RemoteConfig iOS integration)

.travis.yml

@@ -194,7 +194,7 @@ jobs:
       env:
         - PROJECT=RemoteConfig METHOD=pod-lib-lint
       script:
-        - travis_retry ./scripts/if_changed.sh ./scripts/pod_lib_lint.rb FirebaseRemoteConfig.podspec --platforms=ios
+        - travis_retry ./scripts/if_changed.sh ./scripts/pod_lib_lint.rb FirebaseRemoteConfig.podspec --platforms=ios --skip-tests
 
     - stage: test
       osx_image: xcode10.3

FirebaseRemoteConfig.podspec

@@ -70,11 +70,32 @@ app update.
     unit_tests.requires_arc = true
   end
 
-  s.test_spec 'swift-api' do |swift_api_tests|
-    swift_api_tests.platforms = {:ios => '8.0', :osx => '10.11', :tvos => '10.0'}
-    swift_api_tests.source_files = 'FirebaseRemoteConfig/Tests/SwiftAPI/*.swift'
-    swift_api_tests.requires_app_host = true
-    swift_api_tests.resources =
-        'FirebaseRemoteConfig/Tests/SwiftAPI/GoogleService-Info.plist'
+  # Run Swift API tests on a real backend.
+  s.test_spec 'swift-api-tests' do |swift_api|
+    swift_api.platforms = {:ios => '8.0', :osx => '10.11', :tvos => '10.0'}
+    swift_api.source_files = 'FirebaseRemoteConfig/Tests/SwiftAPI/*.swift',
+                             'FirebaseRemoteConfig/Tests/FakeUtils/*.[hm]',
+                             'FirebaseRemoteConfig/Tests/FakeUtils/*.swift'
+    swift_api.requires_app_host = true
+    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.dependency 'OCMock'
+  end
+
+  # Run Swift API tests and tests requiring console changes on a Fake Console.
+  s.test_spec 'fake-console-tests' do |fake_console|
+    fake_console.platforms = {:ios => '8.0', :osx => '10.11', :tvos => '10.0'}
+    fake_console.source_files = 'FirebaseRemoteConfig/Tests/SwiftAPI/*.swift',
+                                      'FirebaseRemoteConfig/Tests/FakeUtils/*.[hm]',
+                                      'FirebaseRemoteConfig/Tests/FakeUtils/*.swift',
+                                      'FirebaseRemoteConfig/Tests/FakeConsole/*.swift'
+    fake_console.requires_app_host = true
+    fake_console.pod_target_xcconfig = {
+      'SWIFT_OBJC_BRIDGING_HEADER' => '$(PODS_TARGET_SRCROOT)/FirebaseRemoteConfig/Tests/FakeUtils/Bridging-Header.h'
+    }
+    fake_console.resources = 'FirebaseRemoteConfig/Tests/FakeUtils/GoogleService-Info.plist'
+    fake_console.dependency 'OCMock'
   end
 end

FirebaseRemoteConfig/CHANGELOG.md

@@ -1,6 +1,7 @@
 # Unreleased
 - [changed] Updated `fetchAndActivateWithCompletionHandler:` implementation to activate asynchronously. (#5617)
 - [fixed] Remove undefined class via removing unused proto generated source files. (#4334)
+- [added] Add an URLSession Partial Mock to enable testing without a backend. (#5633)
 
 # v4.4.11
 - [fixed] Fixed a bug where settings updates weren't applied before fetches. (#4740)

FirebaseRemoteConfig/Sources/FIRRemoteConfig.m

@@ -23,12 +23,12 @@
 #import <FirebaseCore/FIROptionsInternal.h>
 #import "FirebaseRemoteConfig/Sources/FIRRemoteConfigComponent.h"
 #import "FirebaseRemoteConfig/Sources/Private/FIRRemoteConfig_Private.h"
+#import "FirebaseRemoteConfig/Sources/Private/RCNConfigFetch.h"
 #import "FirebaseRemoteConfig/Sources/Private/RCNConfigSettings.h"
 #import "FirebaseRemoteConfig/Sources/RCNConfigConstants.h"
 #import "FirebaseRemoteConfig/Sources/RCNConfigContent.h"
 #import "FirebaseRemoteConfig/Sources/RCNConfigDBManager.h"
 #import "FirebaseRemoteConfig/Sources/RCNConfigExperiment.h"
-#import "FirebaseRemoteConfig/Sources/RCNConfigFetch.h"
 #import "FirebaseRemoteConfig/Sources/RCNConfigValue_Internal.h"
 #import "FirebaseRemoteConfig/Sources/RCNDevice.h"
 

FirebaseRemoteConfig/Sources/Private/FIRRemoteConfig_Private.h

@@ -17,6 +17,7 @@
 #import <FirebaseRemoteConfig/FIRRemoteConfig.h>
 
 #import <FirebaseAnalyticsInterop/FIRAnalyticsInterop.h>
+#import <FirebaseRemoteConfig/RCNConfigFetch.h>
 #import <FirebaseRemoteConfig/RCNConfigSettings.h>
 
 @class FIROptions;
@@ -34,6 +35,9 @@ NS_ASSUME_NONNULL_BEGIN
 /// Internal settings
 @property(nonatomic, readonly, strong) RCNConfigSettings *settings;
 
+/// Config settings are custom settings.
+@property(nonatomic, readwrite, strong, nonnull) RCNConfigFetch *configFetch;
+
 /// Returns the FIRRemoteConfig instance for your namespace and for the default Firebase App.
 /// This singleton object contains the complete set of Remote Config parameter values available to
 /// the app, including the Active Config and Default Config.. This object also caches values fetched

FirebaseRemoteConfig/Sources/RCNConfigFetch.h renamed to FirebaseRemoteConfig/Sources/Private/RCNConfigFetch.h

@@ -30,9 +30,6 @@ NS_ASSUME_NONNULL_BEGIN
 /// Completion handler invoked by NSSessionFetcher.
 typedef void (^RCNConfigFetcherCompletion)(NSData *data, NSURLResponse *response, NSError *error);
 
-/// Test block used for global NSSessionFetcher.
-typedef void (^RCNConfigFetcherTestBlock)(RCNConfigFetcherCompletion completion);
-
 @interface RCNConfigFetch : NSObject
 
 - (instancetype)init NS_UNAVAILABLE;
@@ -56,8 +53,8 @@ typedef void (^RCNConfigFetcherTestBlock)(RCNConfigFetcherCompletion completion)
 /// Add the ability to update NSURLSession's timeout after a session has already been created.
 - (void)recreateNetworkSession;
 
-/// Sets the test block to mock the fetch response instead of performing the fetch task from server.
-+ (void)setGlobalTestBlock:(RCNConfigFetcherTestBlock)block;
+/// Provide fetchSession for tests to override.
+@property(nonatomic, readwrite, strong, nonnull) NSURLSession *fetchSession;
 
 NS_ASSUME_NONNULL_END
 

FirebaseRemoteConfig/Sources/RCNFetch.m

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-#import "FirebaseRemoteConfig/Sources/RCNConfigFetch.h"
+#import "FirebaseRemoteConfig/Sources/Private/RCNConfigFetch.h"
 
 #import <FirebaseCore/FIRApp.h>
 #import <FirebaseCore/FIRLogger.h>
@@ -66,8 +66,6 @@
 // Deprecated error code previously from FirebaseCore
 static const NSInteger FIRErrorCodeConfigFailed = -114;
 
-static RCNConfigFetcherTestBlock gGlobalTestBlock;
-
 #pragma mark - RCNConfig
 
 @implementation RCNConfigFetch {
@@ -271,13 +269,7 @@ - (void)refreshInstallationsTokenWithCompletionHandler:
 
         FIRLogInfo(kFIRLoggerRemoteConfig, @"I-RCN000022", @"Success to get iid : %@.",
                    strongSelfQueue->_settings.configInstallationsIdentifier);
-        [strongSelf
-            getAnalyticsUserPropertiesWithCompletionHandler:^(NSDictionary *userProperties) {
-              dispatch_async(strongSelf->_lockQueue, ^{
-                [strongSelf fetchWithUserProperties:userProperties
-                                  completionHandler:completionHandler];
-              });
-            }];
+        [strongSelf doFetchCall:completionHandler];
       });
     }];
   };
@@ -286,6 +278,14 @@ - (void)refreshInstallationsTokenWithCompletionHandler:
   [installations authTokenWithCompletion:installationsTokenHandler];
 }
 
+- (void)doFetchCall:(FIRRemoteConfigFetchCompletion)completionHandler {
+  [self getAnalyticsUserPropertiesWithCompletionHandler:^(NSDictionary *userProperties) {
+    dispatch_async(self->_lockQueue, ^{
+      [self fetchWithUserProperties:userProperties completionHandler:completionHandler];
+    });
+  }];
+}
+
 - (void)getAnalyticsUserPropertiesWithCompletionHandler:
     (FIRAInteropUserPropertiesCallback)completionHandler {
   FIRLogDebug(kFIRLoggerRemoteConfig, @"I-RCN000060", @"Fetch with user properties completed.");
@@ -489,23 +489,13 @@ - (void)fetchWithUserProperties:(NSDictionary *)userProperties
     });
   };
 
-  if (gGlobalTestBlock) {
-    gGlobalTestBlock(fetcherCompletion);
-    return;
-  }
   FIRLogDebug(kFIRLoggerRemoteConfig, @"I-RCN000061", @"Making remote config fetch.");
 
   NSURLSessionDataTask *dataTask = [self URLSessionDataTaskWithContent:compressedContent
                                                      completionHandler:fetcherCompletion];
   [dataTask resume];
 }
 
-+ (void)setGlobalTestBlock:(RCNConfigFetcherTestBlock)block {
-  FIRLogDebug(kFIRLoggerRemoteConfig, @"I-RCN000027",
-              @"Set global test block for NSSessionFetcher, it will not fetch from server.");
-  gGlobalTestBlock = [block copy];
-}
-
 - (NSString *)constructServerURL {
   NSString *serverURLStr = [[NSString alloc] initWithString:kServerURLDomain];
   serverURLStr = [serverURLStr stringByAppendingString:kServerURLVersion];

FirebaseRemoteConfig/Tests/FakeConsole/FakeConsoleTests.swift

@@ -0,0 +1,71 @@
+// 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
+@testable import FirebaseRemoteConfig
+
+import XCTest
+
+class FakeConsoleTests: APITestBase {
+  override func setUp() {
+    super.setUp()
+    fakeConsole.config = ["Key1": "Value1"]
+  }
+
+  // Contrast with testUnchangedActivateWillError in APITests.swift.
+  func testChangedActivateWillNotError() {
+    let expectation = self.expectation(description: #function)
+    config.fetch { status, error in
+      if let error = error {
+        XCTFail("Fetch Error \(error)")
+      }
+      XCTAssertEqual(status, RemoteConfigFetchStatus.success)
+      self.config.activate { error in
+        if let error = error {
+          print("Activate Error \(error)")
+        }
+        XCTAssertEqual(self.config["Key1"].stringValue, "Value1")
+        expectation.fulfill()
+      }
+    }
+    waitForExpectations()
+
+    // Simulate updating console.
+    fakeConsole.config = ["Key1": "Value2"]
+
+    let expectation2 = self.expectation(description: #function + "2")
+    config.fetch { status, error in
+      if let error = error {
+        XCTFail("Fetch Error \(error)")
+      }
+      XCTAssertEqual(status, RemoteConfigFetchStatus.success)
+      self.config.activate { error in
+        XCTAssertNil(error)
+        XCTAssertEqual(self.config["Key1"].stringValue, "Value2")
+        expectation2.fulfill()
+      }
+    }
+    waitForExpectations()
+  }
+
+  private func waitForExpectations() {
+    let kFIRStorageIntegrationTestTimeout = 10.0
+    waitForExpectations(timeout: kFIRStorageIntegrationTestTimeout,
+                        handler: { (error) -> Void in
+                          if let error = error {
+                            print(error)
+                          }
+    })
+  }
+}

FirebaseRemoteConfig/Tests/FakeUtils/Bridging-Header.h

@@ -0,0 +1,17 @@
+// 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 <FirebaseRemoteConfig/FIRRemoteConfig_Private.h>
+#import "FetchMocks.h"
+#import "FirebaseRemoteConfig/Sources/RCNConfigConstants.h"