Update changed file tool (#7463)

Author: granluo

.gitignore

@@ -69,8 +69,8 @@ DerivedData
 ReleaseTooling/Packages
 ReleaseTooling/*.xcodeproj
 ReleaseTooling/Package.resolved
-scripts/code_coverage_report/generate_code_coverage_report/Package.resolved
-scripts/code_coverage_report/generate_code_coverage_report/.build
+scripts/code_coverage_report/*/Package.resolved
+scripts/code_coverage_report/*/.build
 
 # Mint package manager
 Mint

scripts/code_coverage_report/code_coverage_file_list.json

@@ -0,0 +1,20 @@
+[
+  {
+    "sdk": "database",
+    "filePatterns": [
+      "FirebaseDatabase.*",
+      "\\.github/workflows/database\\.yml",
+      "Example/Database/",
+      "Interop/Auth/Public/.*\\.h"
+    ]
+  },
+  {
+    "sdk": "functions",
+    "filePatterns": [
+      "Functions.*",
+      "\\.github/workflows/functions\\.yml",
+      "Interop/Auth/Public/.*\\.h",
+      "FirebaseMessaging/Sources/Interop/.*\\.h"
+    ]
+  }
+]

scripts/code_coverage_report/generate_code_coverage_report/Package.swift

@@ -19,13 +19,17 @@
 import PackageDescription
 
 let package = Package(
-  name: "CoverageReportGenerator",
+  name: "CodeCoverage",
   products: [
     // Products define the executables and libraries a package produces, and make them visible to other packages.
     .executable(
       name: "CoverageReportGenerator",
       targets: ["CoverageReportGenerator"]
     ),
+    .executable(
+      name: "UpdatedFilesCollector",
+      targets: ["UpdatedFilesCollector"]
+    ),
   ],
   dependencies: [
     // Dependencies declare other packages that this package depends on.
@@ -41,5 +45,11 @@ let package = Package(
         .product(name: "ArgumentParser", package: "swift-argument-parser"),
       ]
     ),
+    .target(
+      name: "UpdatedFilesCollector",
+      dependencies: [
+        .product(name: "ArgumentParser", package: "swift-argument-parser"),
+      ]
+    ),
   ]
 )

scripts/code_coverage_report/generate_code_coverage_report/Sources/UpdatedFilesCollector/main.swift

@@ -0,0 +1,76 @@
+/*
+ * 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.
+ */
+
+import ArgumentParser
+import Foundation
+
+struct SDKFilePattern: Codable {
+  let sdk: String
+  let filePatterns: [String]
+}
+
+struct UpdatedFilesCollector: ParsableCommand {
+  @Option(help: "A txt File with updated files.",
+          transform: { str in
+            let url = URL(fileURLWithPath: str)
+            let data = try String(contentsOf: url)
+            return data.components(separatedBy: .newlines)
+          })
+  var changedFilePaths: [String]
+
+  @Option(help: "A JSON file path conforming to the struct SDKFilePattern",
+          transform: { str in
+            let url = URL(fileURLWithPath: str)
+            let jsonData = try Data(contentsOf: url)
+            return try JSONDecoder().decode([SDKFilePattern].self, from: jsonData)
+          })
+  var codeCoverageFilePatterns: [SDKFilePattern]
+
+  func run() throws {
+    print("=============== list changed files ===============")
+    print(changedFilePaths.joined(separator: "\n"))
+    // Initiate all run_job flag to false.
+    for sdkPatterns in codeCoverageFilePatterns {
+      print("::set-output name=\(sdkPatterns.sdk)_run_job::false")
+    }
+    // Go through patterns of each sdk. Once there is a path of changed file matching
+    // any pattern of this sdk, the run_job flag of this sdk will be turned to true.
+    for sdkPatterns in codeCoverageFilePatterns {
+      var trigger_pod_test_for_coverage_report = false
+      for pattern in sdkPatterns.filePatterns {
+        let regex = try! NSRegularExpression(pattern: pattern)
+        // If one changed file path match one path of this sdk, the run_job flag of
+        // the sdk will be turned on.
+        for changedFilePath in changedFilePaths {
+          let range = NSRange(location: 0, length: changedFilePath.utf16.count)
+          if regex.firstMatch(in: changedFilePath, options: [], range: range) != nil {
+            print("=============== paths of changed files ===============")
+            print("::set-output name=\(sdkPatterns.sdk)_run_job::true")
+            print("\(sdkPatterns.sdk): \(changedFilePath) is updated under the pattern, \(pattern)")
+            trigger_pod_test_for_coverage_report = true
+            // Once this sdk run_job flag is turned to true, then the loop
+            // will skip to the next sdk.
+            break
+          }
+          if trigger_pod_test_for_coverage_report { break }
+        }
+        if trigger_pod_test_for_coverage_report { break }
+      }
+    }
+  }
+}
+
+UpdatedFilesCollector.main()

scripts/code_coverage_report/get_updated_files.sh

@@ -12,53 +12,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Updated files under the following paths will trigger code coverage workflows.
-# Updates in a pull request will generate a code coverage report in a pr.
-DATABASE_PATHS=("FirebaseDatabase.*" \
-  ".github/workflows/database\\.yml" \
-  "Example/Database/" \
-  "Interop/Auth/Public/\.\*.h")
-FUNCTIONS_PATHS=("Functions.*" \
-  ".github/workflows/functions\\.yml" \
-  "Interop/Auth/Public/\.\*.h" \
-  "FirebaseMessaging/Sources/Interop/\.\*.h")
-
-# Set default flag variables which will determine if an sdk workflow will be triggererd.
-echo "::set-output name=database_run_job::false"
-echo "::set-output name=functions_run_job::false"
+set -ex
+# Updated files in paths in code_coverage_file_list.json will trigger code coverage workflows.
+# Updates in a pull request will generate a code coverage report in a PR.
 
 # Get most rescent ancestor commit.
 common_commit=$(git merge-base remotes/origin/${pr_branch} remotes/origin/master)
 echo "The common commit is ${common_commit}."
 # Set base commit and this will be used to compare diffs of coverage to the current commit.
 echo "::set-output name=base_commit::${common_commit}"
 
+cd scripts/code_coverage_report/generate_code_coverage_report
+
 # List changed file from the base commit. This is generated by comparing the
 # head of the branch and the common commit from the master branch.
-echo "=============== list changed files ==============="
-cat < <(git diff --name-only $common_commit remotes/origin/${pr_branch})
-
-echo "============= paths of changed files ============="
 git diff --name-only $common_commit remotes/origin/${pr_branch} > updated_files.txt
 
-# Loop over updated files if their path match patterns then flags to trigger
-# SDK pod test workflow will be set to true.
-while IFS= read -r file
-do
-  for path in "${DATABASE_PATHS[@]}"
-  do
-    if [[ "${file}" =~ $path ]]; then
-      echo "This file is updated under the path, ${path}"
-      echo "::set-output name=database_run_job::true"
-      break
-    fi
-  done
-  for path in "${FUNCTIONS_PATHS[@]}"
-  do
-    if [[ "${file}" =~ $path ]]; then
-      echo "This file is updated under the path, ${path}"
-      echo "::set-output name=functions_run_job::true"
-      break
-    fi
-  done
-done < updated_files.txt
+swift run UpdatedFilesCollector --changed-file-paths updated_files.txt --code-coverage-file-patterns ../code_coverage_file_list.json