Create Binary Size Report Generation (#8539)

Create Binary Size Report Generation
This report is prepared for API request to the Metrics Service.

Author: granluo

.github/workflows/test_coverage.yml renamed to .github/workflows/health_metrics.yml

@@ -1,4 +1,4 @@
-name: test_coverage
+name: health_metrics
 
 on:
   pull_request:
@@ -39,9 +39,33 @@ jobs:
           pr_branch: ${{ github.event.pull_request.head.ref }}
         run: |
           if [ ! -z "${{ env.METRICS_SERVICE_SECRET }}"  ]; then
-            ./scripts/code_coverage_report/get_updated_files.sh
+            ./scripts/health_metrics/get_updated_files.sh
           fi
 
+  binary_size_metrics:
+    needs: check
+    if: always() && github.repository == 'Firebase/firebase-ios-sdk' && (github.event.action == 'opened' || github.event.action == 'synchronize' || github.event.pull_request.merged)
+    runs-on: macOS-latest
+    strategy:
+      matrix:
+        target: [iOS]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Build and test
+      run: |
+        FirebaseABTesting=${{ needs.check.outputs.abtesting_run_job }} \
+        FirebaseAuth=${{ needs.check.outputs.auth_run_job }} \
+        FirebaseDatabase=${{ needs.check.outputs.database_run_job }} \
+        FirebaseDynamicLinks=${{ needs.check.outputs.dynamiclinks_run_job }} \
+        FirebaseFirestore=${{ needs.check.outputs.firestore_run_job }} \
+        FirebaseFunctions=${{ needs.check.outputs.functions_run_job}} \
+        FirebaseInAppMessaging=${{ needs.check.outputs.inappmessaging_run_job }} \
+        FirebaseMessaging=${{ needs.check.outputs.messaging_run_job}} \
+        FirebasePerformance=${{ needs.check.outputs.performance_run_job }} \
+        FirebaseRemoteConfig=${{ needs.check.outputs.remoteconfig_run_job }} \
+        FirebaseStorage=${{ needs.check.outputs.storage_run_job }} \
+        ./scripts/health_metrics/create_binary_size_report.sh
+
   pod-lib-lint-abtesting:
     needs: check
     # Don't run on private repo unless it is a PR.
@@ -56,7 +80,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Build and test
-      run: ./scripts/code_coverage_report/pod_test_code_coverage_report.sh --sdk=FirebaseABTesting --platform=${{ matrix.target }}
+      run: ./scripts/health_metrics/pod_test_code_coverage_report.sh --sdk=FirebaseABTesting --platform=${{ matrix.target }}
     - uses: actions/upload-artifact@v2
       with:
         name: codecoverage
@@ -75,7 +99,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Build and test
-      run: ./scripts/code_coverage_report/pod_test_code_coverage_report.sh --sdk=FirebaseAuth --platform=${{ matrix.target }}
+      run: ./scripts/health_metrics/pod_test_code_coverage_report.sh --sdk=FirebaseAuth --platform=${{ matrix.target }}
     - uses: actions/upload-artifact@v2
       with:
         name: codecoverage
@@ -94,7 +118,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Build and test
-      run: ./scripts/code_coverage_report/pod_test_code_coverage_report.sh --sdk=FirebaseDatabase --platform=${{ matrix.target }}
+      run: ./scripts/health_metrics/pod_test_code_coverage_report.sh --sdk=FirebaseDatabase --platform=${{ matrix.target }}
     - uses: actions/upload-artifact@v2
       with:
         name: codecoverage
@@ -113,7 +137,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Build and test
-      run: ./scripts/code_coverage_report/pod_test_code_coverage_report.sh --sdk=FirebaseDynamicLinks --platform=${{ matrix.target }}
+      run: ./scripts/health_metrics/pod_test_code_coverage_report.sh --sdk=FirebaseDynamicLinks --platform=${{ matrix.target }}
     - uses: actions/upload-artifact@v2
       with:
         name: codecoverage
@@ -133,7 +157,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Build and test
-      run: ./scripts/code_coverage_report/pod_test_code_coverage_report.sh --sdk=FirebaseFirestore --platform=${{ matrix.target }}
+      run: ./scripts/health_metrics/pod_test_code_coverage_report.sh --sdk=FirebaseFirestore --platform=${{ matrix.target }}
     - uses: actions/upload-artifact@v2
       with:
         name: codecoverage
@@ -152,7 +176,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Build and test
-      run: ./scripts/code_coverage_report/pod_test_code_coverage_report.sh --sdk=FirebaseFunctions --platform=${{ matrix.target }}
+      run: ./scripts/health_metrics/pod_test_code_coverage_report.sh --sdk=FirebaseFunctions --platform=${{ matrix.target }}
     - uses: actions/upload-artifact@v2
       with:
         name: codecoverage
@@ -171,7 +195,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Build and test
-      run: ./scripts/code_coverage_report/pod_test_code_coverage_report.sh --sdk=FirebaseInAppMessaging --platform=${{ matrix.target }}
+      run: ./scripts/health_metrics/pod_test_code_coverage_report.sh --sdk=FirebaseInAppMessaging --platform=${{ matrix.target }}
     - uses: actions/upload-artifact@v2
       with:
         name: codecoverage
@@ -190,7 +214,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Build and test
-      run: ./scripts/code_coverage_report/pod_test_code_coverage_report.sh --sdk=FirebaseMessaging --platform=${{ matrix.target }}
+      run: ./scripts/health_metrics/pod_test_code_coverage_report.sh --sdk=FirebaseMessaging --platform=${{ matrix.target }}
     - uses: actions/upload-artifact@v2
       with:
         name: codecoverage
@@ -209,7 +233,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Build and test
-      run: ./scripts/code_coverage_report/pod_test_code_coverage_report.sh --sdk=FirebasePerformance --platform=${{ matrix.target }}
+      run: ./scripts/health_metrics/pod_test_code_coverage_report.sh --sdk=FirebasePerformance --platform=${{ matrix.target }}
     - uses: actions/upload-artifact@v2
       with:
         name: codecoverage
@@ -228,7 +252,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Build and test
-      run: ./scripts/code_coverage_report/pod_test_code_coverage_report.sh --sdk=FirebaseRemoteConfig --platform=${{ matrix.target }}
+      run: ./scripts/health_metrics/pod_test_code_coverage_report.sh --sdk=FirebaseRemoteConfig --platform=${{ matrix.target }}
     - uses: actions/upload-artifact@v2
       with:
         name: codecoverage
@@ -247,7 +271,7 @@ jobs:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Build and test
-      run: ./scripts/code_coverage_report/pod_test_code_coverage_report.sh --sdk=FirebaseStorage --platform=${{ matrix.target }}
+      run: ./scripts/health_metrics/pod_test_code_coverage_report.sh --sdk=FirebaseStorage --platform=${{ matrix.target }}
     - uses: actions/upload-artifact@v2
       with:
         name: codecoverage
@@ -286,7 +310,7 @@ jobs:
         run: |
           # Get Head commit of the branch, instead of a merge commit created by actions/checkout.
           if [ -d "${{steps.download.outputs.download-path}}" ]; then
-            cd scripts/code_coverage_report/generate_code_coverage_report
+            cd scripts/health_metrics/generate_code_coverage_report
             swift run CoverageReportGenerator --presubmit "firebase/firebase-ios-sdk" --head-commit "${GITHUB_SHA}" --token $(gcloud auth print-identity-token) --xcresult-dir "/Users/runner/test/codecoverage" --log-link "https://github.com/firebase/firebase-ios-sdk/actions/runs/${GITHUB_RUN_ID}" --pull-request-num ${{github.event.pull_request.number}} --base-commit "$base_commit"
           fi
       - name: Incremental Code Coverage
@@ -297,11 +321,11 @@ jobs:
           # Get Head commit of the branch, instead of a merge commit created by actions/checkout.
           GITHUB_SHA=$(cat $GITHUB_EVENT_PATH | jq -r .pull_request.head.sha)
           # Get a JSON of `git diff` from the base commit.
-          git diff -U0 ${base_commit} "${GITHUB_SHA}" | scripts/code_coverage_report/git_diff_to_json.sh > scripts/code_coverage_report/generate_code_coverage_report/git_diff.json
-          cat "scripts/code_coverage_report/generate_code_coverage_report/git_diff.json"
+          git diff -U0 ${base_commit} "${GITHUB_SHA}" | scripts/health_metrics/git_diff_to_json.sh > scripts/health_metrics/generate_code_coverage_report/git_diff.json
+          cat "scripts/health_metrics/generate_code_coverage_report/git_diff.json"
           if [ -d "${{steps.download.outputs.download-path}}" ]; then
             # Create an uncovered_file_lines.json including code lines not covered by tests.
-            cd scripts/code_coverage_report/generate_code_coverage_report
+            cd scripts/health_metrics/generate_code_coverage_report
             swift run IncrementalCoverageReportGenerator --changed-files "git_diff.json" --file-archive-root-path "${GITHUB_WORKSPACE}" --xcresult-dir "${{steps.download.outputs.download-path}}" --uncovered-line-file-json "uncovered_file_lines.json"
             # Post uncovered lines to PRs.
             pull_number=$(jq --raw-output .pull_request.number "$GITHUB_EVENT_PATH")
@@ -318,6 +342,6 @@ jobs:
         if: github.event.pull_request.merged && github.event.pull_request.head.repo.full_name == github.repository
         run: |
           if [ -d "${{steps.download.outputs.download-path}}" ]; then
-            cd scripts/code_coverage_report/generate_code_coverage_report
+            cd scripts/health_metrics/generate_code_coverage_report
             swift run CoverageReportGenerator --merge "firebase/firebase-ios-sdk" --head-commit "${GITHUB_SHA}" --token $(gcloud auth print-identity-token) --xcresult-dir "/Users/runner/test/codecoverage" --log-link "https://github.com/firebase/firebase-ios-sdk/actions/runs/${GITHUB_RUN_ID}" --source-branch "${{ github.base_ref }}"
           fi

scripts/code_coverage_report/Gemfile renamed to scripts/health_metrics/Gemfile

@@ -1,15 +1,15 @@
 # Code Coverage Report Generation
 
-This tool is to help generate coverage reports for pull requests. It's defined by the [test_coverage  workflow](https://github.com/firebase/firebase-ios-sdk/blob/master/scripts/code_coverage_report/code_coverage_file_list.json).
+This tool is to help generate coverage reports for pull requests. It's defined by the [test_coverage  workflow](https://github.com/firebase/firebase-ios-sdk/blob/master/scripts/health_metrics/code_coverage_file_list.json).
 
 Coverage reports of SDK frameworks will be displayed in a pull request if the change is under corresponding SDK file patterns.
 
-[UpdatedFilesCollector](https://github.com/firebase/firebase-ios-sdk/tree/master/scripts/code_coverage_report/generate_code_coverage_report/Sources/UpdatedFilesCollector) will detect file changes and compare file paths to file patterns in [code_coverage_file_list.json](https://github.com/firebase/firebase-ios-sdk/blob/master/scripts/code_coverage_report/code_coverage_file_list.json). If updated file paths fit any patterns, corresponding SDK coverage job will be triggered.
+[UpdatedFilesCollector](https://github.com/firebase/firebase-ios-sdk/tree/master/scripts/health_metrics/generate_code_coverage_report/Sources/UpdatedFilesCollector) will detect file changes and compare file paths to file patterns in [code_coverage_file_list.json](https://github.com/firebase/firebase-ios-sdk/blob/master/scripts/health_metrics/code_coverage_file_list.json). If updated file paths fit any patterns, corresponding SDK coverage job will be triggered.
 
 ## Add a new coverage workflow
 
 To create a code coverage workflow for a new SDK,
-1. Add `newsdk` and its patterns in [code_coverage_file_list.json](https://github.com/firebase/firebase-ios-sdk/blob/master/scripts/code_coverage_report/code_coverage_file_list.json).
+1. Add `newsdk` and its patterns in [code_coverage_file_list.json](https://github.com/firebase/firebase-ios-sdk/blob/master/scripts/health_metrics/code_coverage_file_list.json).
 2. Add a new output flag, e.g. `newsdk_run_job`, in the [coverage workflow](https://github.com/firebase/firebase-ios-sdk/blob/64d50a7f7b3af104a88f9c9203285ae20ea309d4/.github/workflows/test_coverage.yml#L17). `newsdk_run_job` should be aligned with the name of SDK `newsdk` in code_coverage_file_list.json.
 3. Add a newsdk coverage job in the [workflow](https://github.com/firebase/firebase-ios-sdk/blob/master/.github/workflows/test_coverage.yml):
 ```
@@ -26,13 +26,12 @@ pod-lib-lint-newsdk:
     - name: Setup Bundler
       run: scripts/setup_bundler.sh
     - name: Build and test
-      run: ./scripts/code_coverage_report/pod_test_code_coverage_report.sh FirebaseNewSDK "${{ matrix.target }}"
+      run: ./scripts/health_metrics/pod_test_code_coverage_report.sh FirebaseNewSDK "${{ matrix.target }}"
     - uses: actions/upload-artifact@v2
       with:
         name: codecoverage
         path: /Users/runner/*.xcresult
 ```
 Add the job name to the [`needs` of `create_report` job](https://github.com/firebase/firebase-ios-sdk/blob/64d50a7f7b3af104a88f9c9203285ae20ea309d4/.github/workflows/test_coverage.yml#L277).
 
-4. If this newsdk podspec has unit test setup, e.g. [database](https://github.com/firebase/firebase-ios-sdk/blob/64d50a7f7b3af104a88f9c9203285ae20ea309d4/FirebaseDatabase.podspec#L44-L57), with `unit_tests.scheme = { :code_coverage => true }`, the code coverage workflow should run unit tests through podspecs and utilize those coverage data and nothing is needed to update here. Otherwise, add [another way of running tests](https://github.com/firebase/firebase-ios-sdk/blob/64d50a7f7b3af104a88f9c9203285ae20ea309d4/scripts/code_coverage_report/pod_test_code_coverage_report.sh#L26) and generating xcresult bundles with code coverage data in pod_test_code_coverage_report.sh.
-
+4. If this newsdk podspec has unit test setup, e.g. [database](https://github.com/firebase/firebase-ios-sdk/blob/64d50a7f7b3af104a88f9c9203285ae20ea309d4/FirebaseDatabase.podspec#L44-L57), with `unit_tests.scheme = { :code_coverage => true }`, the code coverage workflow should run unit tests through podspecs and utilize those coverage data and nothing is needed to update here. Otherwise, add [another way of running tests](https://github.com/firebase/firebase-ios-sdk/blob/64d50a7f7b3af104a88f9c9203285ae20ea309d4/scripts/health_metrics/pod_test_code_coverage_report.sh#L26) and generating xcresult bundles with code coverage data in pod_test_code_coverage_report.sh.

scripts/code_coverage_report/README.md renamed to scripts/health_metrics/README.md

@@ -0,0 +1,61 @@
+#!/bin/bash
+
+# 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.
+
+# USAGE: git diff -U0 [base_commit] HEAD | get_diff_lines.sh
+#
+# This will generate a JSON output of changed files and their newly added
+# lines.
+
+BINARY_SIZE_SDK=()
+if $FirebaseABTesting == 'true'; then
+  BINARY_SIZE_SDK+=('FirebaseABTesting')
+fi
+if $FirebaseAuth == 'true'; then
+  BINARY_SIZE_SDK+=('FirebaseAuth')
+fi
+if $FirebaseDatabase == 'true'; then
+  BINARY_SIZE_SDK+=('FirebaseDatabase')
+fi
+if $FirebaseDynamicLinks == 'true'; then
+  BINARY_SIZE_SDK+=('FirebaseDynamicLinks')
+fi
+if $FirebaseFirestore == 'true'; then
+  BINARY_SIZE_SDK+=('FirebaseFirestore')
+fi
+if $FirebaseFunctions == 'true'; then
+  BINARY_SIZE_SDK+=('FirebaseFunctions')
+fi
+if $FirebaseInAppMessaging == 'true'; then
+  BINARY_SIZE_SDK+=('FirebaseInAppMessaging')
+fi
+if $FirebaseMessaging == 'true'; then
+  BINARY_SIZE_SDK+=('FirebaseMessaging')
+fi
+if $FirebasePerformance == 'true'; then
+  BINARY_SIZE_SDK+=('FirebasePerformance');
+fi
+if $FirebaseRemoteConfig == 'true'; then
+  BINARY_SIZE_SDK+=('FirebaseRemoteConfig')
+fi
+if $FirebaseStorage == 'true'; then
+  BINARY_SIZE_SDK+=('FirebaseStorage')
+fi
+if [ -n "$BINARY_SIZE_SDK" ]; then
+  cd scripts/health_metrics/generate_code_coverage_report/
+  git clone https://github.com/google/cocoapods-size
+  swift build
+  .build/debug/BinarySizeReportGenerator --binary-size-tool-dir cocoapods-size/  --sdk-repo-dir "${GITHUB_WORKSPACE}" --sdk ${BINARY_SIZE_SDK[@]} --log-path "https://github.com/firebase/firebase-ios-sdk/actions/runs/${GITHUB_RUN_ID}"
+fi

scripts/code_coverage_report/code_coverage_file_list.json renamed to scripts/health_metrics/code_coverage_file_list.json

@@ -34,6 +34,10 @@ let package = Package(
       name: "IncrementalCoverageReportGenerator",
       targets: ["IncrementalCoverageReportGenerator"]
     ),
+    .executable(
+      name: "BinarySizeReportGenerator",
+      targets: ["BinarySizeReportGenerator"]
+    ),
   ],
   dependencies: [
     .package(url: "https://github.com/apple/swift-argument-parser", from: "0.2.0"),
@@ -59,6 +63,13 @@ let package = Package(
         "Utils",
       ]
     ),
+    .target(
+      name: "BinarySizeReportGenerator",
+      dependencies: [
+        .product(name: "ArgumentParser", package: "swift-argument-parser"),
+        "Utils",
+      ]
+    ),
     .target(
       name: "Utils"
     ),