Open source CMake changes for ios tests.

 - Added all cc_test_on_ios targets as they exist in google3.
 - Configuredthe cc_test_on_ios targets to include the correct depdendencies.
   These targets now compile and link via ./test_mac_ios.sh.
 - Added automatic download of iOS SDK to link against the frameworks.

PiperOrigin-RevId: 289937761

Author: Googler

CMakeLists.txt

@@ -95,7 +95,9 @@ set(FIREBASE_INSTALL_DIR ${PROJECT_BINARY_DIR}/opt)
 set(FIREBASE_DOWNLOAD_DIR ${PROJECT_BINARY_DIR}/downloads)
 
 # Run the CMake build logic that will download all the external dependencies.
+message(STATUS "Downloading external project dependencies...")
 download_external_sources()
+message(STATUS "Download complete.")
 
 # Disable the Flatbuffer build tests, install and flathash
 set(FLATBUFFERS_BUILD_TESTS OFF CACHE BOOL "")

cmake/external/CMakeLists.txt

@@ -23,7 +23,7 @@ project(Firebase-cpp-download C CXX)
 list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR})
 
 include(flatbuffers)
-include(googletest)
+
 
 # Some of the external dependencies are not needed for mobile.
 if (${FIREBASE_EXTERNAL_PLATFORM} STREQUAL "DESKTOP")
@@ -33,3 +33,13 @@ if (${FIREBASE_EXTERNAL_PLATFORM} STREQUAL "DESKTOP")
   include(uWebSockets)
   include(zlib)
 endif()
+
+# Support files for the test framework.
+if(FIREBASE_CPP_BUILD_TESTS)
+  include(googletest)
+
+  # Download the iOS SDK Frameworks required for linking the tests.
+  if (${FIREBASE_EXTERNAL_PLATFORM} STREQUAL "IOS")
+    include(firebase_ios_sdk)
+  endif()
+endif()

cmake/external/firebase_ios_sdk.cmake

@@ -0,0 +1,48 @@
+# Copyright 2020 Google
+#
+# 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.
+
+include(ExternalProject)
+
+if(TARGET firebase_ios_sdk OR NOT DOWNLOAD_FIREBASE_IOS_SDK)
+  return()
+endif()
+
+cmake_minimum_required(VERSION 3.0)
+
+set(SDK_VERSION "6.14.0")
+
+# Build the download URL.
+string(REPLACE "." "_" SDK_VERSION_PATH ${SDK_VERSION})
+string(CONCAT URL
+       "https://dl.google.com/firebase/sdk/ios/"
+       ${SDK_VERSION_PATH}
+       "/Firebase-"
+       ${SDK_VERSION}
+       ".zip")
+
+# Configure local storage of download.
+set(ZIP_FILENAME "./firebase_sdk_${SDK_VERSION}.zip")
+set(OUTDIR "./firebase_ios_sdk/")
+
+# Download as required.
+if(FIREBASE_CPP_BUILD_TESTS)
+  if(NOT EXISTS ${OUTDIR})
+    if(NOT EXISTS ${ZIP_FILENAME})
+      file(DOWNLOAD ${URL} ${ZIP_FILENAME}) 
+    endif()
+    execute_process(COMMAND mkdir ${OUTDIR})
+    execute_process(COMMAND tar -xf ${ZIP_FILENAME} -C ${OUTDIR})
+    execute_process(COMMAND rm ${ZIP_FILENAME})
+  endif()
+endif()

cmake/external_rules.cmake

@@ -52,6 +52,7 @@ function(download_external_sources)
   check_use_local_directory(NANOPB)
   check_use_local_directory(UWEBSOCKETS)
   check_use_local_directory(ZLIB)
+  check_use_local_directory(FIREBASE_IOS_SDK)
 
   execute_process(
     COMMAND
@@ -66,6 +67,8 @@ function(download_external_sources)
       -DDOWNLOAD_NANOPB=${DOWNLOAD_NANOPB}
       -DDOWNLOAD_UWEBSOCKETS=${DOWNLOAD_UWEBSOCKETS}
       -DDOWNLOAD_ZLIB=${DOWNLOAD_ZLIB}
+      -DDOWNLOAD_FIREBASE_IOS_SDK=${DOWNLOAD_FIREBASE_IOS_SDK}
+      -DFIREBASE_CPP_BUILD_TESTS=${FIREBASE_CPP_BUILD_TESTS}
       ${PROJECT_SOURCE_DIR}/cmake/external
     OUTPUT_FILE ${PROJECT_BINARY_DIR}/external/output_cmake_config.txt
     WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/external

cmake/test_rules.cmake

@@ -61,26 +61,80 @@ endfunction()
 #   target
 #   SOURCES sources...
 #   DEPENDS libraries...
+#   CUSTOM_FRAMEWORKS frameworks...
 # )
 #
 # Defines a new test executable target with the given target name, sources, and
 # dependencies.  Implicitly adds DEPENDS on gtest, gtest_main, Foundation and
-# CoreFoundation frameworks.
+# CoreFoundation frameworks. CUSTOM_FRAMEWORKS will include any custom Cocoapods
+# frameworks beyond the baseline FirebaseAnalytics.
 function(cc_test_on_ios name)
   if (NOT IOS)
     return()
   endif()
 
-  set(multi DEPENDS SOURCES INCLUDES DEFINES)
+  set(multi DEPENDS SOURCES INCLUDES DEFINES CUSTOM_FRAMEWORKS)
   # Parse the arguments into cc_test_SOURCES and cc_test_DEPENDS.
   cmake_parse_arguments(cc_test "" "" "${multi}" ${ARGN})
 
+  set(SDK_FRAMEWORK_DIR_NAMES 
+    FirebaseABTesting
+    FirebaseAnalytics
+    FirebaseAuth
+    FirebaseDatabase
+    FirebaseDynamicLinks
+    FirebaseFunctions
+    FirebaseMessaging
+    FirebaseRemoteConfig
+    FirebaseStorage
+    GoogleSignIn
+  )
+
+  # The build environment can use a user-downloaded Firebase IOS SDK defined by
+  # FIREBASE_IOS_SDK_DIR.  Alternatively download the SDK directly if it's not
+  # configured and store the files in external/firebase_ios_sdk.
+  if(NOT DEFINED ${FIREBASE_IOS_SDK_DIR})
+    set(FIREBASE_IOS_SDK_DIR 
+        "${CMAKE_BINARY_DIR}/external/firebase_ios_sdk/Firebase")
+  endif()
+
+  # Add the directories of the SDK download to the framework searchpath.
+  foreach(FRAMEWORK IN LISTS SDK_FRAMEWORK_DIR_NAMES)
+    set(directory "${FIREBASE_IOS_SDK_DIR}/${FRAMEWORK}")
+    LIST(APPEND FRAMEWORK_DIRS "-F ${directory}")
+  endforeach()
+
+  # All Firebase SDK modules require the Firebase Analytics Frameworks
+  # so include them by default:
+  set(DEFAULT_FRAMEWORKS
+    FIRAnalyticsConnector
+    FirebaseAnalytics
+    FirebaseCore
+    FirebaseCoreDiagnostics
+    FirebaseInstanceID
+    GTMSessionFetcher
+    GoogleAppMeasurement
+    GoogleDataTransport
+    GoogleDataTransportCCTSupport
+    GoogleUtilities
+    nanopb
+  )
+
+  # Construct a command line list of frameworks from the default frameworks
+  # (above) and for those passed to this function through the CUSTOM_FRAMEWORKS
+  # parameter.
+  foreach(FRAMEWORK IN LISTS DEFAULT_FRAMEWORKS cc_test_CUSTOM_FRAMEWORKS)
+    LIST(APPEND FRAMEWORK_INCLUDES "-framework ${FRAMEWORK}")
+  endforeach()
+
   list(APPEND cc_test_DEPENDS
        gmock
        gtest
        gtest_main
+       "${FRAMEWORK_DIRS}"
        "-framework CoreFoundation"
        "-framework Foundation"
+       "${FRAMEWORK_INCLUDES}"
   )
 
   add_executable(${name} ${cc_test_SOURCES})