Firebase Installations: integration tests on Travis (#3652)

Author: maksymmalyhin

.gitignore

@@ -9,6 +9,9 @@ Example/Database/App/GoogleService-Info.plist
 
 Example/Storage/App/GoogleService-Info.plist
 
+# FirebaseInstallations integration tests GoogleService-Info.plist
+FirebaseInstallations/Source/Tests/Resources/GoogleService-Info.plist
+
 Secrets.tar
 
 # OS X

.travis.yml

@@ -420,6 +420,8 @@ jobs:
     - stage: test
       env:
         - PROJECT=Installations PLATFORM=iOS METHOD=pod-lib-lint
+      before_install:
+        - ./scripts/if_changed.sh ./scripts/install_prereqs.sh
       script:
         - travis_retry ./scripts/if_changed.sh ./scripts/pod_lib_lint.rb FirebaseInstallations.podspec --platforms=ios,tvos --ignore-local-podspecs=FirebaseInstanceID.podspec
         # TODO: Fix FBLPromises warnings for macOS.

FirebaseInstallations.podspec

@@ -49,6 +49,10 @@ Pod::Spec.new do |s|
     s.test_spec 'integration' do |int_tests|
       int_tests.source_files = base_dir + 'Tests/Integration/**/*.[mh]'
       int_tests.resources = base_dir + 'Tests/Resources/**/*'
+      s.pod_target_xcconfig = {
+      'GCC_PREPROCESSOR_DEFINITIONS' =>
+        'FIR_INSTALLATIONS_INTEGRATION_TESTS_REQUIRED=1'
+    }
       int_tests.requires_app_host = true
       int_tests.dependency 'OCMock'
     end

FirebaseInstallations/Source/Tests/Integration/FIRInstallationsIntegrationTests.m

@@ -14,10 +14,8 @@
  * limitations under the License.
  */
 
-// Uncomment to enable integration tests.
-//#define FIR_INSTALLATIONS_INTEGRATION_TESTS_ENABLED 1
-
-#ifdef FIR_INSTALLATIONS_INTEGRATION_TESTS_ENABLED
+// Uncomment or set the flag in GCC_PREPROCESSOR_DEFINITIONS to enable integration tests.
+//#define FIR_INSTALLATIONS_INTEGRATION_TESTS_REQUIRED 1
 
 #import <XCTest/XCTest.h>
 
@@ -31,17 +29,20 @@
 #import <FirebaseInstallations/FIRInstallations.h>
 #import <FirebaseInstallations/FIRInstallationsAuthTokenResult.h>
 
+static BOOL sFIRInstallationsFirebaseDefaultAppConfigured = NO;
+
 @interface FIRInstallationsIntegrationTests : XCTestCase
 @property(nonatomic) FIRInstallations *installations;
 @end
 
 @implementation FIRInstallationsIntegrationTests
 
 - (void)setUp {
-  static dispatch_once_t onceToken;
-  dispatch_once(&onceToken, ^{
-    [FIRApp configure];
-  });
+  [self configureFirebaseDefaultAppIfCan];
+
+  if (![self isDefaultAppConfigured]) {
+    return;
+  }
 
   self.installations = [FIRInstallations installationsWithApp:[FIRApp defaultApp]];
 }
@@ -54,19 +55,29 @@ - (void)tearDown {
 
   // Wait for any pending background job to be completed.
   FBLWaitForPromisesWithTimeout(10);
+
+  [FIRApp resetApps];
 }
 
 // TODO: Enable the test once Travis configured.
 // Need to configure the GoogleService-Info.plist copying from the encrypted archive.
 // So far, let's run the tests locally.
-- (void)disabled_testGetFID {
+- (void)testGetFID {
+  if (![self isDefaultAppConfigured]) {
+    return;
+  }
+
   NSString *FID1 = [self getFID];
   NSString *FID2 = [self getFID];
 
   XCTAssertEqualObjects(FID1, FID2);
 }
 
-- (void)disabled_testAuthToken {
+- (void)testAuthToken {
+  if (![self isDefaultAppConfigured]) {
+    return;
+  }
+
   XCTestExpectation *authTokenExpectation =
       [self expectationWithDescription:@"authTokenExpectation"];
 
@@ -84,7 +95,11 @@ - (void)disabled_testAuthToken {
   [self waitForExpectations:@[ authTokenExpectation ] timeout:2];
 }
 
-- (void)disabled_testDeleteInstallation {
+- (void)testDeleteInstallation {
+  if (![self isDefaultAppConfigured]) {
+    return;
+  }
+
   NSString *FIDBefore = [self getFID];
   FIRInstallationsAuthTokenResult *authTokenBefore = [self getAuthToken];
 
@@ -111,20 +126,20 @@ - (void)testInstallationsWithApp {
 
   // Wait for finishing all background operations.
   FBLWaitForPromisesWithTimeout(10);
-
-  [FIRApp resetApps];
 }
 
 - (void)testDefaultAppInstallation {
+  if (![self isDefaultAppConfigured]) {
+    return;
+  }
+
   XCTAssertNotNil(self.installations);
   XCTAssertEqualObjects(self.installations.appOptions.googleAppID,
                         [FIRApp defaultApp].options.googleAppID);
   XCTAssertEqualObjects(self.installations.appName, [FIRApp defaultApp].name);
 
   // Wait for finishing all background operations.
   FBLWaitForPromisesWithTimeout(10);
-
-  [FIRApp resetApps];
 }
 
 #endif  // !TARGET_OS_OSX
@@ -197,6 +212,30 @@ - (FIRApp *)createAndConfigureAppWithName:(NSString *)name {
   return [FIRApp appNamed:name];
 }
 
-@end
+- (void)configureFirebaseDefaultAppIfCan {
+  NSBundle *bundle = [NSBundle bundleForClass:[self class]];
+  NSString *plistPath = [bundle pathForResource:@"GoogleService-Info" ofType:@"plist"];
+  if (plistPath == nil) {
+    return;
+  }
 
-#endif  // FIR_INSTALLATIONS_INTEGRATION_TESTS_ENABLED
+  FIROptions *options = [[FIROptions alloc] initWithContentsOfFile:plistPath];
+  [FIRApp configureWithOptions:options];
+  sFIRInstallationsFirebaseDefaultAppConfigured = YES;
+}
+
+- (BOOL)isDefaultAppConfigured {
+  if (!sFIRInstallationsFirebaseDefaultAppConfigured) {
+#if FIR_INSTALLATIONS_INTEGRATION_TESTS_REQUIRED
+    XCTFail(@"GoogleService-Info.plist for integration tests was not found. Please add the file to "
+            @"your project.");
+#else
+    NSLog(@"GoogleService-Info.plist for integration tests was not found. Skipping the test %@",
+          self.name);
+#endif  // FIR_INSTALLATIONS_INTEGRATION_TESTS_REQUIRED
+  }
+
+  return sFIRInstallationsFirebaseDefaultAppConfigured;
+}
+
+@end

FirebaseInstallations/Source/Tests/Resources/GoogleService-Info.plist

@@ -26,7 +26,7 @@ function install_secrets() {
   # requests from forks. See
   # https://docs.travis-ci.com/user/pull-requests#pull-requests-and-security-restrictions
   if [[ ! -z $encrypted_d6a88994a5ab_key ]]; then
-    openssl aes-256-cbc -K $encrypted_b02643c8c602_key -iv $encrypted_b02643c8c602_iv \
+    openssl aes-256-cbc -K $encrypted_3360571ebe7a_key -iv $encrypted_3360571ebe7a_iv \
     -in scripts/travis-encrypted/Secrets.tar.enc \
     -out scripts/travis-encrypted/Secrets.tar -d
 
@@ -43,6 +43,11 @@ function install_secrets() {
     cp Secrets/Storage/App/GoogleService-Info.plist Example/Database/App/GoogleService-Info.plist
 
     cp Secrets/Metrics/database.config Metrics/database.config
+
+    # Firebase Installations
+    fis_resources_dir=FirebaseInstallations/Source/Tests/Resources/
+    mkdir -p "$fis_resources_dir"
+    cp Secrets/Installations/GoogleService-Info.plist "$fis_resources_dir"
   fi
 }
 
@@ -98,6 +103,10 @@ case "$PROJECT-$PLATFORM-$METHOD" in
     install_secrets
     ;;
 
+  Installations-*)
+    install_secrets
+    ;;
+
   InAppMessaging-iOS-xcodebuild)
     gem install xcpretty
     bundle exec pod install --project-directory=InAppMessagingDisplay/Example --repo-update