GMA Merge to Main (#1001)

Merge the GMA SDK Feature Branch to main.

Author: DellaBitta

.github/workflows/integration_tests.yml

@@ -16,7 +16,7 @@ on:
         required: true
       apis:
         description: 'CSV of apis to build and test'
-        default: 'admob,analytics,auth,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
+        default: 'admob,analytics,auth,database,dynamic_links,firestore,functions,gma,installations,messaging,remote_config,storage'
         required: true
       operating_systems:
         description: 'CSV of VMs to run on'
@@ -1092,7 +1092,7 @@ jobs:
 
 
   test_android:
-    name: test-android-${{ matrix.build_os }}-${{ matrix.android_device }}
+    name: test-android-${{ matrix.build_os }}-${{ matrix.android_device }}-${{ matrix.test_type }}
     needs: [check_and_prepare, build_android]
     runs-on: macos-12
     if: contains(needs.check_and_prepare.outputs.matrix_platform, 'Android') && needs.check_and_prepare.outputs.apis != '' && !cancelled()
@@ -1101,6 +1101,12 @@ jobs:
       matrix:
         build_os: ${{ fromJson(needs.check_and_prepare.outputs.matrix_os) }}
         android_device: ${{ fromJson(needs.check_and_prepare.outputs.android_device) }}
+        test_type: ["gameloop"]
+        exclude:
+          -  android_device: "android_target"
+             test_type: "uitest"
+          -  android_device: "android_latest"
+             test_type: "uitest"
     steps:
       - name: setup Xcode version (macos)
         if: runner.os == 'macOS'
@@ -1151,8 +1157,9 @@ jobs:
         if: steps.get-device-type.outputs.device_type == 'virtual'
         run: |
           python scripts/gha/test_simulator.py --testapp_dir testapps \
+            --test_type "${{ matrix.test_type }}" \
             --android_device "${{ matrix.android_device }}" \
-            --logfile_name "android-${{ matrix.build_os }}-${{ matrix.android_device }}" \
+            --logfile_name "android-${{ matrix.build_os }}-${{ matrix.android_device }}-${{ matrix.test_type }}" \
             --ci
       - name: Install Cloud SDK
         if: steps.get-device-type.outputs.device_type == 'real'
@@ -1163,24 +1170,31 @@ jobs:
         run: |
           python scripts/gha/test_lab.py --testapp_dir testapps \
             --android_device "${{ matrix.android_device }}" \
-            --logfile_name "android-${{ matrix.build_os }}-${{ matrix.android_device }}" \
+            --logfile_name "android-${{ matrix.build_os }}-${{ matrix.android_device }}-${{ matrix.test_type }}" \
             --code_platform cpp \
             --key_file_encrypted scripts/gha-encrypted/gcs_key_file.json.gpg \
             --key_file_passphrase "${{ secrets.TEST_SECRET }}"
       - name: Prepare results summary artifact
         if: ${{ !cancelled() }}
         shell: bash
         run: |
-          # If testapps do not exist, then it's a build error not test error.
-          if [ -d "testapps/testapps-android-${{ matrix.build_os }}" && ! -f "testapps/test-results-android-${{ matrix.build_os }}-${{ matrix.android_device }}.log.json" ]; then
-            mkdir -p testapps && echo "__SUMMARY_MISSING__" > "testapps/test-results-android-${{ matrix.build_os }}-${{ matrix.android_device }}.log.json"
+          # If testapps do not exist, then it's a build error not test error. 
+          if [ -d "testapps/testapps-android-${{ matrix.build_os }}" && ! -f "testapps/test-results-android-${{ matrix.build_os }}-${{ matrix.android_device }}-${{ matrix.test_type }}.log.json" ]; then
+            mkdir -p testapps && echo "__SUMMARY_MISSING__" > "testapps/test-results-android-${{ matrix.build_os }}-${{ matrix.android_device }}-${{ matrix.test_type }}.log.json"
           fi
       - name: Upload Android test results artifact
         if: ${{ !cancelled() }}
         uses: actions/upload-artifact@v3
         with:
           name: log-artifact
-          path: testapps/test-results-android-${{ matrix.build_os }}-${{ matrix.android_device }}*
+          path: testapps/test-results-android-${{ matrix.build_os }}-${{ matrix.android_device }}-${{ matrix.test_type }}*
+          retention-days: ${{ env.artifactRetentionDays }}
+      - name: Upload Android test video artifact
+        if: ${{ steps.get-device-type.outputs.device_type == 'virtual' && !cancelled() }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: mobile-simulator-test-video-artifact
+          path: testapps/video-*-android-${{ matrix.build_os }}-${{ matrix.android_device }}-${{ matrix.test_type }}.mp4
           retention-days: ${{ env.artifactRetentionDays }}
       - name: Download log artifacts
         if: ${{ needs.check_and_prepare.outputs.pr_number && failure() && !cancelled() }}
@@ -1202,20 +1216,28 @@ jobs:
         if: ${{ !cancelled() }}
         shell: bash
         run: |
-          cat "testapps/test-results-android-${{ matrix.build_os }}-${{ matrix.android_device }}.log"
+          cat "testapps/test-results-android-${{ matrix.build_os }}-${{ matrix.android_device }}-${{ matrix.test_type }}.log"
           if [[ "${{ job.status }}" != "success" ]]; then
             exit 1
           fi
 
   test_ios:
-    name: test-ios-${{ matrix.build_os }}-${{ matrix.ios_device }}
+    name: test-ios-${{ matrix.build_os }}-${{ matrix.ios_device }}-${{ matrix.test_type }}
     needs: [check_and_prepare, build_ios]
     runs-on: macos-12
     if: contains(needs.check_and_prepare.outputs.matrix_platform, 'iOS') && needs.check_and_prepare.outputs.apis != '' && !cancelled()
     strategy:
       fail-fast: false
       matrix:
         ios_device: ${{ fromJson(needs.check_and_prepare.outputs.ios_device) }}
+        test_type: ["gameloop"]
+        exclude:
+          -  ios_device: "ios_min"
+             test_type: "uitest"
+          -  ios_device: "ios_target"
+             test_type: "uitest"
+          -  ios_device: "ios_latest"
+             test_type: "uitest"
         build_os: [macos-12]
     steps:
       - name: setup Xcode version (macos)
@@ -1261,8 +1283,9 @@ jobs:
         if: steps.get-device-type.outputs.device_type == 'virtual'
         run: |
           python scripts/gha/test_simulator.py --testapp_dir testapps \
+            --test_type "${{ matrix.test_type }}" \
             --ios_device "${{ matrix.ios_device }}" \
-            --logfile_name "ios-${{ matrix.build_os }}-${{ matrix.ios_device }}" \
+            --logfile_name "ios-${{ matrix.build_os }}-${{ matrix.ios_device }}-${{ matrix.test_type }}" \
             --ci
       - name: Install Cloud SDK
         if: steps.get-device-type.outputs.device_type == 'real'
@@ -1274,24 +1297,31 @@ jobs:
         run: |
           python scripts/gha/test_lab.py --testapp_dir testapps \
             --ios_device "${{ matrix.ios_device }}" \
-            --logfile_name "ios-${{ matrix.build_os }}-${{ matrix.ios_device }}" \
+            --logfile_name "ios-${{ matrix.build_os }}-${{ matrix.ios_device }}-${{ matrix.test_type }}" \
             --code_platform cpp \
             --key_file_encrypted scripts/gha-encrypted/gcs_key_file.json.gpg \
             --key_file_passphrase "${{ secrets.TEST_SECRET }}"
       - name: Prepare results summary artifact
         if: ${{ !cancelled() }}
         shell: bash
         run: |
-          # If testapps do not exist, then it's a build error not test error.
-          if [ -d "testapps/testapps-ios-${{ matrix.build_os }}" && ! -f "testapps/test-results-ios-${{ matrix.build_os }}-${{ matrix.ios_device }}.log.json" ]; then
-            mkdir -p testapps && echo "__SUMMARY_MISSING__" > "testapps/test-results-ios-${{ matrix.build_os }}-${{ matrix.ios_device }}.log.json"
+          # If testapps do not exist, then it's a build error not test error. 
+          if [ -d "testapps/testapps-ios-${{ matrix.build_os }}" && ! -f "testapps/test-results-ios-${{ matrix.build_os }}-${{ matrix.ios_device }}-${{ matrix.test_type }}.log.json" ]; then
+            mkdir -p testapps && echo "__SUMMARY_MISSING__" > "testapps/test-results-ios-${{ matrix.build_os }}-${{ matrix.ios_device }}-${{ matrix.test_type }}.log.json"
           fi
       - name: Upload iOS test results artifact
         if: ${{ !cancelled() }}
         uses: actions/upload-artifact@v3
         with:
           name: log-artifact
-          path: testapps/test-results-ios-${{ matrix.build_os }}-${{ matrix.ios_device }}*
+          path: testapps/test-results-ios-${{ matrix.build_os }}-${{ matrix.ios_device }}-${{ matrix.test_type }}*
+          retention-days: ${{ env.artifactRetentionDays }}
+      - name: Upload iOS test video artifact
+        if: ${{ steps.get-device-type.outputs.device_type == 'virtual' && !cancelled() }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: mobile-simulator-test-video-artifact
+          path: testapps/video-*-ios-${{ matrix.build_os }}-${{ matrix.ios_device }}-${{ matrix.test_type }}.mp4
           retention-days: ${{ env.artifactRetentionDays }}
       - name: Download log artifacts
         if: ${{ needs.check_and_prepare.outputs.pr_number && failure() && !cancelled() }}
@@ -1313,7 +1343,7 @@ jobs:
         if: ${{ !cancelled() }}
         shell: bash
         run: |
-          cat "testapps/test-results-ios-${{ matrix.build_os }}-${{ matrix.ios_device }}.log"
+          cat "testapps/test-results-ios-${{ matrix.build_os }}-${{ matrix.ios_device }}-${{ matrix.test_type }}.log"
           if [[ "${{ job.status }}" != "success" ]]; then
             exit 1
           fi

Android/firebase_dependencies.gradle

@@ -26,6 +26,7 @@ def firebaseDependenciesMap = [
   'dynamic_links' : ['com.google.firebase:firebase-dynamic-links'],
   'firestore' : ['com.google.firebase:firebase-firestore'],
   'functions' : ['com.google.firebase:firebase-functions'],
+  'gma' : ['com.google.android.gms:play-services-ads:21.0.0'],
   'installations' : ['com.google.firebase:firebase-installations'],
   'invites' : ['com.google.firebase:firebase-invites'],
   // Messaging has an additional local dependency to include.
@@ -48,6 +49,7 @@ def firebaseResourceDependenciesMap = [
   'auth' : [':auth:auth_resources'],
   'database' : [':database:database_resources'],
   'firestore' : [':firestore:firestore_resources'],
+  'gma' : [':gma:gma_resources'],
   'storage' : [':storage:storage_resources']
 ]
 
@@ -87,6 +89,9 @@ class Dependencies {
   def getFirestore() {
     libSet.add('firestore')
   }
+  def getGma() {
+    libSet.add('gma')
+  }
   def getFunctions() {
     libSet.add('functions')
   }

CMakeLists.txt

@@ -46,6 +46,8 @@ option(FIREBASE_INCLUDE_FIRESTORE
 option(FIREBASE_INCLUDE_FUNCTIONS
        "Include the Cloud Functions for Firebase library."
        ${FIREBASE_INCLUDE_LIBRARY_DEFAULT})
+option(FIREBASE_INCLUDE_GMA "Include the GMA library."
+       ${FIREBASE_INCLUDE_LIBRARY_DEFAULT})
 option(FIREBASE_INCLUDE_INSTALLATIONS
        "Include the Firebase Installations library."
        ${FIREBASE_INCLUDE_LIBRARY_DEFAULT})
@@ -116,9 +118,10 @@ if(FIREBASE_CPP_BUILD_TESTS OR FIREBASE_CPP_BUILD_STUB_TESTS)
 endif()
 
 if (PLATFORM STREQUAL TVOS OR PLATFORM STREQUAL SIMULATOR_TVOS)
-  # AdMob and FDL are not supported on tvOS.
+  # AdMob, GMA and FDL are not supported on tvOS.
   set(FIREBASE_INCLUDE_ADMOB OFF)
   set(FIREBASE_INCLUDE_DYNAMIC_LINKS OFF)
+  set(FIREBASE_INCLUDE_GMA OFF)
 endif()
 
 # Occasionally ANDROID is not being set correctly when invoked by gradle, so
@@ -599,6 +602,9 @@ endif()
 if (FIREBASE_INCLUDE_FUNCTIONS)
   add_subdirectory(functions)
 endif()
+if (FIREBASE_INCLUDE_GMA)
+  add_subdirectory(gma)
+endif()
 if (FIREBASE_INCLUDE_INSTALLATIONS)
   add_subdirectory(installations)
 endif()

admob/CMakeLists.txt

@@ -89,6 +89,14 @@ target_include_directories(firebase_admob
   PRIVATE
     ${FIREBASE_CPP_SDK_ROOT_DIR}
 )
+
+if(IOS)
+  target_include_directories(firebase_admob
+    PRIVATE
+      ${CMAKE_CURRENT_LIST_DIR}/admob_resources/ios_headers
+  )
+endif()
+
 target_compile_definitions(firebase_admob
   PRIVATE
     -DINTERNAL_EXPERIMENTAL=1
@@ -110,16 +118,6 @@ elseif(IOS)
   target_link_libraries(firebase_admob
                         PUBLIC "-fembed-bitcode")
 
-  setup_pod_headers(
-    firebase_admob
-    POD_NAMES
-      Google-Mobile-Ads-SDK
-  )
-
-  # AdMob expects the header files to be in a subfolder, so set up a symlink to
-  # accomplish that.
-  symlink_pod_headers(firebase_admob Google-Mobile-Ads-SDK GoogleMobileAds)
-
   if (FIREBASE_XCODE_TARGET_FORMAT STREQUAL "frameworks")
     set_target_properties(firebase_admob PROPERTIES
       FRAMEWORK TRUE

admob/admob_resources/ios_headers/CPPLINT.cfg

@@ -0,0 +1,20 @@
+# Copyright 2021 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.
+
+# Don't inherit configurations from  CPPLINT.cfg in parent directories.
+set noparent
+
+# Don't attempt to lint headers that came straight of the original pod file
+exclude_files=GoogleMobileAds
+

admob/admob_resources/ios_headers/GoogleMobileAds/DFPBannerView.h

@@ -0,0 +1,92 @@
+//
+//  DFPBannerView.h
+//  Google Mobile Ads SDK
+//
+//  Copyright 2012 Google LLC. All rights reserved.
+//
+
+#import <GoogleMobileAds/GADAdLoader.h>
+#import <GoogleMobileAds/GADAdLoaderDelegate.h>
+#import <GoogleMobileAds/GADAppEventDelegate.h>
+#import <GoogleMobileAds/GADBannerView.h>
+#import <GoogleMobileAds/GADVideoController.h>
+
+@class DFPBannerView;
+
+/// The delegate of a GADAdLoader object must conform to this protocol to receive DFPBannerViews.
+@protocol DFPBannerAdLoaderDelegate <GADAdLoaderDelegate>
+
+/// Asks the delegate which banner ad sizes should be requested.
+- (nonnull NSArray<NSValue *> *)validBannerSizesForAdLoader:(nonnull GADAdLoader *)adLoader;
+
+/// Tells the delegate that a Google Ad Manager banner ad was received.
+- (void)adLoader:(nonnull GADAdLoader *)adLoader
+    didReceiveDFPBannerView:(nonnull DFPBannerView *)bannerView;
+
+@end
+
+/// The view that displays Ad Manager banner ads.
+///
+/// To request this ad type using GADAdLoader, you need to pass kGADAdLoaderAdTypeDFPBanner (see
+/// GADAdLoaderAdTypes.h) to the |adTypes| parameter in GADAdLoader's initializer method. If you
+/// request this ad type, your delegate must conform to the DFPBannerAdLoaderDelegate protocol.
+@interface DFPBannerView : GADBannerView
+
+/// Required value created on the Ad Manager website. Create a new ad unit for every unique
+/// placement of an ad in your application. Set this to the ID assigned for this placement. Ad units
+/// are important for targeting and statistics.
+///
+/// Example Ad Manager ad unit ID: @"/6499/example/banner"
+@property(nonatomic, copy, nullable) NSString *adUnitID;
+
+/// Optional delegate that is notified when creatives send app events.
+@property(nonatomic, weak, nullable) IBOutlet id<GADAppEventDelegate> appEventDelegate;
+
+/// Optional delegate that is notified when creatives cause the banner to change size.
+@property(nonatomic, weak, nullable) IBOutlet id<GADAdSizeDelegate> adSizeDelegate;
+
+/// Optional array of NSValue encoded GADAdSize structs, specifying all valid sizes that are
+/// appropriate for this slot. Never create your own GADAdSize directly. Use one of the predefined
+/// standard ad sizes (such as kGADAdSizeBanner), or create one using the GADAdSizeFromCGSize
+/// method.
+///
+/// Example:
+///
+///   \code
+///   NSArray *validSizes = @[
+///     NSValueFromGADAdSize(kGADAdSizeBanner),
+///     NSValueFromGADAdSize(kGADAdSizeLargeBanner)
+///   ];
+///
+///   bannerView.validAdSizes = validSizes;
+///   \endcode
+@property(nonatomic, copy, nullable) NSArray<NSValue *> *validAdSizes;
+
+/// Indicates that the publisher will record impressions manually when the ad becomes visible to the
+/// user.
+@property(nonatomic) BOOL enableManualImpressions;
+
+/// Video controller for controlling video rendered by this ad view.
+@property(nonatomic, readonly, nonnull) GADVideoController *videoController;
+
+/// If you've set enableManualImpressions to YES, call this method when the ad is visible.
+- (void)recordImpression;
+
+/// Use this function to resize the banner view without launching a new ad request.
+- (void)resize:(GADAdSize)size;
+
+/// Sets options that configure ad loading.
+///
+/// @param adOptions An array of GADAdLoaderOptions objects. The array is deep copied and option
+/// objects cannot be modified after calling this method.
+- (void)setAdOptions:(nonnull NSArray<GADAdLoaderOptions *> *)adOptions;
+
+#pragma mark Deprecated
+
+/// Deprecated. Use the validAdSizes property.
+/// Sets the receiver's valid ad sizes to the values pointed to by the provided NULL terminated list
+/// of GADAdSize pointers.
+- (void)setValidAdSizesWithSizes:(nullable GADAdSize *)firstSize, ... NS_REQUIRES_NIL_TERMINATION
+                                 GAD_DEPRECATED_MSG_ATTRIBUTE("Use validAdSizes property.");
+
+@end

admob/admob_resources/ios_headers/GoogleMobileAds/DFPBannerViewOptions.h

@@ -0,0 +1,25 @@
+//
+//  DFPBannerViewOptions.h
+//  Google Mobile Ads SDK
+//
+//  Copyright 2016 Google LLC. All rights reserved.
+//
+
+#import <GoogleMobileAds/GADAdLoader.h>
+#import <GoogleMobileAds/GADAdSize.h>
+#import <GoogleMobileAds/GADAdSizeDelegate.h>
+#import <GoogleMobileAds/GADAppEventDelegate.h>
+
+/// Ad loader options for banner ads.
+@interface DFPBannerViewOptions : GADAdLoaderOptions
+
+/// Optional delegate that is notified if the loaded banner sends app events.
+@property(nonatomic, weak, nullable) id<GADAppEventDelegate> appEventDelegate;
+
+/// Optional delegate that is notified if the loaded banner changes size.
+@property(nonatomic, weak, nullable) id<GADAdSizeDelegate> adSizeDelegate;
+
+/// Whether the publisher will record impressions manually when the ad becomes visible to the user.
+@property(nonatomic, assign) BOOL enableManualImpressions;
+
+@end