Use test specs for Functions unit tests (#1864)

Author: paulb777

.gitignore

@@ -81,3 +81,6 @@ Ninja
 
 # Visual Studio
 /.vs
+
+# CocoaPods generate
+gen/

.travis.yml

@@ -35,6 +35,16 @@ jobs:
       script:
         - travis_retry ./scripts/if_changed.sh ./scripts/build.sh $PROJECT $PLATFORM
 
+    - stage: test
+      env:
+        - PROJECT=Functions 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.sh FirebaseFunctions.podspec
+        - travis_retry ./scripts/if_changed.sh ./scripts/pod_lib_lint.sh FirebaseFunctions.podspec --use-libraries
+        - travis_retry ./scripts/if_changed.sh ./scripts/pod_lib_lint.sh FirebaseFunctions.podspec --use-modular-headers
+
     - stage: test
       env:
         - PROJECT=InAppMessaging PLATFORM=iOS METHOD=xcodebuild
@@ -68,7 +78,6 @@ jobs:
         - travis_retry ./scripts/if_changed.sh ./scripts/pod_lib_lint.sh FirebaseInstanceID.podspec
         - travis_retry ./scripts/if_changed.sh ./scripts/pod_lib_lint.sh FirebaseMessaging.podspec
         - travis_retry ./scripts/if_changed.sh ./scripts/pod_lib_lint.sh FirebaseStorage.podspec
-        - travis_retry ./scripts/if_changed.sh ./scripts/pod_lib_lint.sh FirebaseFunctions.podspec
         - travis_retry ./scripts/if_changed.sh ./scripts/pod_lib_lint.sh FirebaseInAppMessaging.podspec
         - travis_retry ./scripts/if_changed.sh ./scripts/pod_lib_lint.sh FirebaseInAppMessagingDisplay.podspec
 
@@ -100,7 +109,6 @@ jobs:
         # The Protobuf dependency of FirebaseMessaging has warnings with --use-libraries
         - travis_retry ./scripts/if_cron.sh ./scripts/pod_lib_lint.sh FirebaseMessaging.podspec --use-libraries --allow-warnings
         - travis_retry ./scripts/if_cron.sh ./scripts/pod_lib_lint.sh FirebaseStorage.podspec --use-libraries
-        - travis_retry ./scripts/if_cron.sh ./scripts/pod_lib_lint.sh FirebaseFunctions.podspec --use-libraries
         - travis_retry ./scripts/if_cron.sh ./scripts/pod_lib_lint.sh FirebaseInAppMessaging.podspec --use-libraries
         - travis_retry ./scripts/if_cron.sh ./scripts/pod_lib_lint.sh FirebaseInAppMessagingDisplay.podspec --use-libraries
 

FirebaseFunctions.podspec

@@ -32,4 +32,14 @@ iOS SDK for Cloud Functions for Firebase.
     'GCC_C_LANGUAGE_STANDARD' => 'c99',
     'GCC_PREPROCESSOR_DEFINITIONS' => 'FIRFunctions_VERSION=' + s.version.to_s
   }
+
+  s.test_spec 'unit' do |unit_tests|
+    unit_tests.source_files = 'Functions/Example/Test*/*.[mh]', 'Example/Shared/FIRAuthInteropFake*'
+  end
+
+  s.test_spec 'integration' do |int_tests|
+    int_tests.source_files = 'Functions/Example/IntegrationTests/*.[mh]',
+                             'Functions/Example/TestUtils/*.[mh]',
+                             'Example/Shared/FIRAuthInteropFake*'
+  end
 end

Functions/Backend/start.sh

@@ -17,6 +17,10 @@
 # Sets up a project with the functions CLI and starts a backend to run
 # integration tests against.
 
+# Adding the "synchronous" parameter will cause the script to exit
+# with the server still running so that other scripts can invoke this
+# script followed by subsequent dependent commands.
+
 set -e
 
 # Get the absolute path to the directory containing this script.
@@ -32,7 +36,9 @@ npm install
 
 # Start the server.
 FUNCTIONS_BIN="./node_modules/.bin/functions"
-"${FUNCTIONS_BIN}" config set projectId functions-integration-test
+"${FUNCTIONS_BIN}" config set projectId functions-integration-test <<-!
+  myproject
+!
 "${FUNCTIONS_BIN}" config set supervisorPort 5005
 "${FUNCTIONS_BIN}" config set region us-central1
 "${FUNCTIONS_BIN}" config set verbose true
@@ -49,8 +55,10 @@ FUNCTIONS_BIN="./node_modules/.bin/functions"
 "${FUNCTIONS_BIN}" deploy httpErrorTest --trigger-http
 "${FUNCTIONS_BIN}" deploy timeoutTest --trigger-http
 
-# Wait for the user to tell us to stop the server.
-echo "Functions emulator now running in ${TEMP_DIR}."
-read -n 1 -p "*** Press any key to stop the server. ***"
-echo "\nStopping the emulator..."
-"${FUNCTIONS_BIN}" stop
+if [ "$1" != "synchronous" ]; then
+  # Wait for the user to tell us to stop the server.
+  echo "Functions emulator now running in ${TEMP_DIR}."
+  read -n 1 -p "*** Press any key to stop the server. ***"
+  echo "\nStopping the emulator..."
+  "${FUNCTIONS_BIN}" stop
+fi

Functions/Example/Podfile

@@ -5,7 +5,7 @@ target 'FirebaseFunctions_Example' do
 
   pod 'FirebaseAuthInterop', :path => '../../'
   pod 'FirebaseCore', :path => '../../'
-  pod 'FirebaseFunctions', :path => '../../'
+  pod 'FirebaseFunctions', :path => '../../', :testspecs => ['unit']
   pod 'GoogleUtilities', :path => '../../'
 
   target 'FirebaseFunctions_Tests' do

Functions/README.md

@@ -5,16 +5,26 @@
 Follow the subsequent instructions to develop, debug, unit test, and
 integration test FirebaseFunctions:
 
-```
-$ git clone [email protected]:firebase/firebase-ios-sdk.git
-$ cd firebase-ios-sdk/Functions/Example
-$ pod update
-$ open FirebaseFunctions.xcworkspace
-```
+### Prereqs
+
+- At least CocoaPods 1.6.0
+- Install [cocoapods-generate](https://github.com/square/cocoapods-generate)
+
+### To Develop
+
+- Run `pod gen FirebaseFunctions.podspec`
+- `open gen/FirebaseFunctions/FirebaseFunctions.xcworkspace`
+
+OR these two commands can be combined with
+
+- `pod gen FirebaseFunctions.podspec --auto-open --gen-directory="gen" --clean`
+
+You're now in an Xcode workspace generate for building, debugging and
+testing the FirebaseFunctions CocoaPod.
 
 ### Running Unit Tests
 
-Choose the FirebaseFunctions_Tests scheme and press Command-u.
+Choose the FirebaseFunctions-Unit-unit scheme and press Command-u.
 
 ## Running Integration Tests
 
@@ -29,5 +39,5 @@ for them to talk to.
     You can put anything you like. It will be ignored.
 3.  Create the workspace in Functions/Example with `pod install`.
 4.  `open FirebaseFunctions.xcworkspace`
-5.  Choose the FirebaseFunctions_IntegrationTests scheme and press Command-u.
+5.  Choose the FirebaseFunctions-Unit-integration scheme and press Command-u.
 6.  When you are finished, you can press any key to stop the backend.

Gemfile

@@ -3,3 +3,4 @@
 source 'https://rubygems.org'
 
 gem 'cocoapods', "=1.6.1"
+gem 'cocoapods-generate'

Gemfile.lock

@@ -34,6 +34,7 @@ GEM
       nap (~> 1.0)
     cocoapods-deintegrate (1.0.3)
     cocoapods-downloader (1.2.2)
+    cocoapods-generate (1.3.1)
     cocoapods-plugins (1.0.0)
       nap
     cocoapods-search (1.0.0)
@@ -71,6 +72,7 @@ PLATFORMS
 
 DEPENDENCIES
   cocoapods (= 1.6.1)
+  cocoapods-generate
 
 BUNDLED WITH
    1.16.6

scripts/build.sh

@@ -185,13 +185,6 @@ case "$product-$method-$platform" in
         test
 
     if [[ $platform == 'iOS' ]]; then
-      RunXcodebuild \
-          -workspace 'Functions/Example/FirebaseFunctions.xcworkspace' \
-          -scheme "FirebaseFunctions_Tests" \
-          "${xcb_flags[@]}" \
-          build \
-          test
-
       # Run integration tests (not allowed on PRs)
       if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then
         RunXcodebuild \
@@ -227,17 +220,6 @@ case "$product-$method-$platform" in
           "${xcb_flags[@]}" \
           build \
           test
-
-      cd Functions/Example
-      sed -i -e 's/use_frameworks/\#use_frameworks/' Podfile
-      pod update --no-repo-update
-      cd ../..
-      RunXcodebuild \
-          -workspace 'Functions/Example/FirebaseFunctions.xcworkspace' \
-          -scheme "FirebaseFunctions_Tests" \
-          "${xcb_flags[@]}" \
-          build \
-          test
     fi
     ;;
 

scripts/if_changed.sh

@@ -47,24 +47,28 @@ else
   case "$PROJECT-$METHOD" in
     Firebase-pod-lib-lint) # Combines Firebase-* and InAppMessaging*
       check_changes '^(Firebase/Auth|Firebase/Core|Firebase/Database|Firebase/DynamicLinks|'\
-'Firebase/Messaging|Firebase/Storage|Functions|GoogleUtilities|Interop|Example|'\
+'Firebase/Messaging|Firebase/Storage|GoogleUtilities|Interop|Example|'\
 'FirebaseAnalyticsIntop.podspec|FirebaseAuth.podspec|FirebaseAuthInterop.podspec|'\
 'FirebaseCore.podspec|FirebaseDatabase.podspec|FirebaseDynamicLinks.podspec|'\
-'FirebaseFunctions.podspec|FirebaseMessaging.podspec|FirebaseStorage.podspec|'\
+'FirebaseMessaging.podspec|FirebaseStorage.podspec|'\
 'FirebaseStorage.podspec|Firebase/InAppMessagingDisplay|InAppMessagingDisplay|'\
 'InAppMessaging|Firebase/InAppMessaging|'\
 'FirebaseInAppMessaging.podspec|FirebaseInAppMessagingDisplay.podspec)'
       ;;
 
     Firebase-*)
       check_changes '^(Firebase/Auth|Firebase/Core|Firebase/Database|Firebase/DynamicLinks|'\
-'Firebase/Messaging|Firebase/Storage|Functions|GoogleUtilities|Interop|Example|'\
+'Firebase/Messaging|Firebase/Storage|GoogleUtilities|Interop|Example|'\
 'FirebaseAnalyticsIntop.podspec|FirebaseAuth.podspec|FirebaseAuthInterop.podspec|'\
 'FirebaseCore.podspec|FirebaseDatabase.podspec|FirebaseDynamicLinks.podspec|'\
-'FirebaseFunctions.podspec|FirebaseMessaging.podspec|FirebaseStorage.podspec|'\
+'FirebaseMessaging.podspec|FirebaseStorage.podspec|'\
 'FirebaseStorage.podspec)'
       ;;
 
+    Functions-*)
+      check_changes '^(Firebase/Core|Functions|GoogleUtilities|FirebaseFunctions.podspec)'
+      ;;
+
     InAppMessaging-*)
       check_changes '^(Firebase/InAppMessagingDisplay|InAppMessagingDisplay|InAppMessaging|'\
 'Firebase/InAppMessaging)'

scripts/install_prereqs.sh

@@ -55,6 +55,12 @@ case "$PROJECT-$PLATFORM-$METHOD" in
     bundle exec pod install --project-directory=GoogleUtilities/Example
     ;;
 
+  Functions-*)
+    bundle exec pod repo update
+    # Start server for Functions integration tests.
+    ./Functions/Backend/start.sh synchronous
+    ;;
+
   InAppMessaging-iOS-xcodebuild)
     gem install xcpretty
     bundle exec pod install --project-directory=InAppMessagingDisplay/Example --repo-update