Fake Remote Config console for testing #5633
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,7 +14,7 @@ | |
| * limitations under the License. | ||
| */ | ||
|
|
||
| #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; | ||
|
|
||
| #pragma mark - RCNConfig | ||
|
|
||
| @implementation RCNConfigFetch { | ||
|
|
@@ -271,13 +269,7 @@ - (void)refreshInstallationsTokenWithCompletionHandler: | |
|
|
||
| FIRLogInfo(kFIRLoggerRemoteConfig, @"I-RCN000022", @"Success to get iid : %@.", | ||
| strongSelfQueue->_settings.configInstallationsIdentifier); | ||
| [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 | |
| }); | ||
| }; | ||
|
|
||
| FIRLogDebug(kFIRLoggerRemoteConfig, @"I-RCN000061", @"Making remote config fetch."); | ||
|
|
||
| NSURLSessionDataTask *dataTask = [self URLSessionDataTaskWithContent:compressedContent | ||
| completionHandler:fetcherCompletion]; | ||
| [dataTask resume]; | ||
| } | ||
|
|
||
charlotteliang marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
There was a problem hiding this comment. I feel like using a test block is simpler and doesn't take a lot of test code in production. And you can customize the block in test rather than having all the test logic in production code. You can also provide flexible return value (not just success) to test different scenarios. This is used in a lot of the unit tests of remote config (search setGlobalTestBlock in tests), but I'm not sure the current state of how many of those tests are running but if we remove this, we might also have to adjust all those unit test as well. Another thing is do we want to fake fetch in integration test since in github network is available. isn't it better to actually enable fetch from prod server? There was a problem hiding this comment. The test block is only used in disabled unit tests that still need to be ported from RC v1 to v2. This implementation allows the tests to be implemented without any knowledge of the library implementation details - just a simple API of managing a dictionary. The swift_api tests are similar to these but do fetches from a prod server. This set of tests are to enable API tests that require midstream console changes. There was a problem hiding this comment. As for me, for unit tests I would prefer injecting another implementation of For integration end-to-end tests, in contrast to unit tests, I would suggest not to mock anything and use real implementations only. |
||
| - (NSString *)constructServerURL { | ||
| NSString *serverURLStr = [[NSString alloc] initWithString:kServerURLDomain]; | ||
| serverURLStr = [serverURLStr stringByAppendingString:kServerURLVersion]; | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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)") | ||
|
There was a problem hiding this comment. I'm guessing this should also be removed :) There was a problem hiding this comment. With the deprecated API whether or not there is an error on the first activate call is random depending on the state of the console - so it might be useful to keep until we can delete along with the deprecated API at the next major release. |
||
| } | ||
| 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) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| // 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. | ||
|
|
||
| class FakeConsole { | ||
| var config = [String: AnyHashable]() | ||
| private var last = [String: AnyHashable]() | ||
|
|
||
| init() { | ||
| config = [String: AnyHashable]() | ||
| } | ||
|
|
||
| func empty() { | ||
| config = [String: AnyHashable]() | ||
| } | ||
|
|
||
| func get() -> [String: AnyHashable] { | ||
| if config.count == 0 { | ||
| last = config | ||
| return [RCNFetchResponseKeyState: RCNFetchResponseKeyStateEmptyConfig] | ||
| } | ||
| var state = RCNFetchResponseKeyStateNoChange | ||
| if last != config { | ||
| state = RCNFetchResponseKeyStateUpdate | ||
| } | ||
| last = config | ||
| return [RCNFetchResponseKeyState: state, RCNFetchResponseKeyEntries: config] | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| // 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 <Foundation/Foundation.h> | ||
| #import "FirebaseRemoteConfig/Sources/Private/RCNConfigFetch.h" | ||
|
|
||
| NS_ASSUME_NONNULL_BEGIN | ||
|
|
||
| @interface FetchMocks : NSObject | ||
| + (RCNConfigFetch *)mockFetch:(RCNConfigFetch *)fetch; | ||
| @end | ||
|
|
||
| NS_ASSUME_NONNULL_END |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| // 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 <OCMock/OCMock.h> | ||
|
|
||
| #import "FetchMocks.h" | ||
| #import "FirebaseRemoteConfig/Sources/Private/RCNConfigFetch.h" | ||
|
|
||
| @interface RCNConfigFetch (ExposedForTest) | ||
| - (void)refreshInstallationsTokenWithCompletionHandler: | ||
| (FIRRemoteConfigFetchCompletion)completionHandler; | ||
| - (void)doFetchCall:(FIRRemoteConfigFetchCompletion)completionHandler; | ||
| @end | ||
|
|
||
| @implementation FetchMocks | ||
|
|
||
| + (RCNConfigFetch *)mockFetch:(RCNConfigFetch *)fetch { | ||
| RCNConfigFetch *mock = OCMPartialMock(fetch); | ||
| OCMStub([mock recreateNetworkSession]).andDo(nil); | ||
| OCMStub([mock refreshInstallationsTokenWithCompletionHandler:[OCMArg any]]) | ||
| .andCall(mock, @selector(doFetchCall:)); | ||
|
There was a problem hiding this comment. Reliance on private methods can make refactoring a bit more painful in the future. |
||
| return mock; | ||
| } | ||
|
|
||
| @end | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pod lib linttests don't work now that there's multiple RC test_specs. All tests are run in GHA.