Create a swift utility for uploading project health metrics from Travis (#2612)

* Create a swift utility for collecting code coverage and uploading to a database

* Update the readme

* Code clean up

* Fix line length

* Change to a still supported commandline kit

* Run swift formatter

* Add copyright

* Move example report under the Tests dir

* Add a TODO for Firestore, Functions, and InAppMessaging

* Change todo name to GitHub name

* Put line breaks in the example report

Author: Corrob

Metrics/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj

Metrics/Package.resolved

@@ -0,0 +1,39 @@
+// swift-tools-version:4.2
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+/*
+ * Copyright 2019 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.
+ */
+
+import PackageDescription
+
+let package = Package(
+  name: "Metrics",
+  dependencies: [
+    .package(url: "https://github.com/objecthub/swift-commandlinekit", from: "0.2.5"),
+  ],
+  targets: [
+    .target(
+      name: "MetricsLib"
+    ),
+    .target(
+      name: "Metrics",
+      dependencies: ["CommandLineKit", "MetricsLib"]
+    ),
+    .testTarget(
+      name: "MetricsTests",
+      dependencies: ["MetricsLib"]
+    ),
+  ]
+)

Metrics/Package.swift

@@ -0,0 +1,20 @@
+# Metrics
+
+A swift utility for collecting project health metrics on Travis and uploading to a database. It
+currently only supports parsing a Code Coverage report generated from XCov.
+
+## Run the coverage parser
+
+```
+swift build
+.build/debug/Metrics -c=example_report.json -o=database.json -p=99
+```
+
+This generates a database.json file that can be executed through a pre-existing Java uploader that
+will push the data to a Cloud SQL database.
+
+## Run the unit tests
+
+```
+swift test
+```

Metrics/README.md

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2019 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.
+ */
+
+import CommandLineKit
+import Foundation
+import MetricsLib
+
+var flags = Flags()
+let coveragePath = flags.string("c",
+                                "coverage",
+                                description: "Required - The path of the JSON coverage report generated by XCov.")
+let outputPath = flags.string("o",
+                              "output",
+                              description: "Required - The path to write the database JSON info.")
+let pullRequest = flags.int("p",
+                            "pull_request",
+                            description: "Required - The number of the pull request that corresponds to this coverage run.")
+do {
+  try flags.parse()
+  if !coveragePath.wasSet {
+    print("Please specify the path of the JSON coverage report from XCov. -c or --coverage")
+    exit(1)
+  }
+  if !outputPath.wasSet {
+    print("Please specify output location for the database JSON file. -o or --output")
+    exit(1)
+  }
+  if !pullRequest.wasSet {
+    print("Please specify the corresponding pull request number. -p or --pull_request")
+    exit(1)
+  }
+  let pullRequestTable = TableUpdate(table_name: "PullRequests",
+                                     column_names: ["pull_request_id"],
+                                     replace_measurements: [[Double(pullRequest.value!)]])
+  let coverageReport = try CoverageReport.load(path: coveragePath.value!)
+  let coverageTable = TableUpdate.createFrom(coverage: coverageReport,
+                                             pullRequest: pullRequest.value!)
+  let json = try UploadMetrics(tables: [pullRequestTable, coverageTable]).json()
+  try json.write(to: NSURL(fileURLWithPath: outputPath.value!) as URL,
+                 atomically: false,
+                 encoding: .utf8)
+  print("Successfully created \(outputPath.value!)")
+} catch {
+  print("Error occurred: \(error)")
+  exit(1)
+}

Metrics/Sources/Metrics/main.swift

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2019 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.
+ */
+
+import Foundation
+
+/// Represents a code coverage report generated by XCov (maps to the JSON report one to one).
+public struct CoverageReport: Decodable {
+  public var targets: [Target]
+  public var coverage: Double
+
+  public init(targets: [Target], coverage: Double) {
+    self.targets = targets
+    self.coverage = coverage
+  }
+
+  /// Creates a CoverageReport from a JSON file generated by XCov.
+  public static func load(path: String) throws -> CoverageReport {
+    let data = try Data(contentsOf: NSURL(fileURLWithPath: path) as URL)
+    let decoder = JSONDecoder()
+    return try decoder.decode(CoverageReport.self, from: data)
+  }
+}
+
+/// An XCov target.
+public struct Target: Decodable {
+  public var name: String
+  public var files: [File]
+  public var coverage: Double
+
+  public init(name: String, coverage: Double) {
+    self.name = name
+    self.coverage = coverage
+    files = []
+  }
+}
+
+/// An XCov file.
+public struct File: Decodable {
+  public var name: String
+  public var coverage: Double
+  public var type: String
+  public var functions: [Function]
+}
+
+/// An XCov function.
+public struct Function: Decodable {
+  public var name: String
+  public var coverage: Double
+}

Metrics/Sources/MetricsLib/CoverageReport.swift

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2019 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.
+ */
+
+import Foundation
+
+/// A mapping of SDKs to an ID that will represent that SDK in the database.
+let TARGET_TO_SDK_INDEX = [
+  "Auth_Example_iOS.app": 0.0,
+  "Core_Example_iOS.app": 1.0,
+  "Database_Example_iOS.app": 2.0,
+  "DynamicLinks_Example_iOS.app": 3.0,
+  "InstanceID_Example_iOS.app": 4.0,
+  "Messaging_Example_iOS.app": 5.0,
+  "Storage_Example_iOS.app": 6.0,
+  // TODO(Corrob): Add support for Firestore, Functions, and InAppMessaging.
+]
+
+/// Represents a set of metric table updates to upload to the database.
+public struct UploadMetrics: Encodable {
+  public var tables: [TableUpdate]
+
+  public init(tables: [TableUpdate]) {
+    self.tables = tables
+  }
+
+  /// Converts the metric table updates to a JSON format this is compatible with the Java uploader.
+  public func json() throws -> String {
+    let json = try JSONEncoder().encode(self)
+    return String(data: json, encoding: .utf8)!
+  }
+}
+
+/// An update to a metrics table with the new data to uplaod to the database.
+public struct TableUpdate: Encodable {
+  public var table_name: String
+  public var column_names: [String]
+  public var replace_measurements: [[Double]]
+
+  public init(table_name: String, column_names: [String], replace_measurements: [[Double]]) {
+    self.table_name = table_name
+    self.column_names = column_names
+    self.replace_measurements = replace_measurements
+  }
+
+  /// Creates a table update for code coverage by parsing a coverage report from XCov.
+  public static func createFrom(coverage: CoverageReport, pullRequest: Int) -> TableUpdate {
+    var metrics = [[Double]]()
+    for target in coverage.targets {
+      let sdkKey = TARGET_TO_SDK_INDEX[target.name]
+      if sdkKey == nil {
+        print("WARNING - target \(target.name) has no mapping to an SDK id. Skipping...")
+      } else {
+        var row = [Double]()
+        row.append(Double(pullRequest))
+        row.append(sdkKey!)
+        row.append(target.coverage)
+        metrics.append(row)
+      }
+    }
+    let columnNames = ["pull_request_id", "sdk_id", "coverage_percent"]
+    return TableUpdate(table_name: "Coverage1", column_names: columnNames, replace_measurements: metrics)
+  }
+}

Metrics/Sources/MetricsLib/UploadMetrics.swift

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2019 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.
+ */
+
+import MetricsLib
+import XCTest
+
+let EXAMPLE_REPORT = "Tests/MetricsTests/example_report.json"
+
+final class CoverageReportTests: XCTestCase {
+  func testShouldParseTotalCoverage() throws {
+    let report = try CoverageReport.load(path: EXAMPLE_REPORT)
+    XCTAssertEqual(report.coverage, 0.5490569575543673)
+  }
+
+  func testShouldParseTargets() throws {
+    let report = try CoverageReport.load(path: EXAMPLE_REPORT)
+    XCTAssertEqual(report.targets.count, 14)
+    XCTAssertEqual(report.targets[0].name, "Auth_Example_iOS.app")
+    XCTAssertEqual(report.targets[0].coverage, 0.8241201927002532)
+    XCTAssertEqual(report.targets[0].files.count, 97)
+  }
+
+  func testShouldFailOnMissingFile() throws {
+    XCTAssertThrowsError(try CoverageReport.load(path: "IDontExist"))
+  }
+}

Metrics/Tests/MetricsTests/CoverageReportTests.swift

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2019 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.
+ */
+
+import MetricsLib
+import XCTest
+
+let PULL_REQUEST = 777
+
+final class UploadMetricsTests: XCTestCase {
+  func testShouldCreateTableUpdateFromCoverageReport() {
+    let target_one = Target(name: "Auth_Example_iOS.app", coverage: 0.1)
+    let target_two = Target(name: "Core_Example_iOS.app", coverage: 0.2)
+    let report = CoverageReport(targets: [target_one, target_two], coverage: 0.15)
+    let metricsUpdate = TableUpdate.createFrom(coverage: report, pullRequest: PULL_REQUEST)
+    XCTAssertEqual(metricsUpdate.table_name, "Coverage1")
+    XCTAssertEqual(metricsUpdate.replace_measurements.count, 2)
+    XCTAssertEqual(metricsUpdate.replace_measurements[0],
+                   [Double(PULL_REQUEST), 0, target_one.coverage])
+    XCTAssertEqual(metricsUpdate.replace_measurements[1],
+                   [Double(PULL_REQUEST), 1, target_two.coverage])
+  }
+
+  func testShouldIgnoreUnkownTargets() {
+    let target = Target(name: "Unknown_Target", coverage: 0.3)
+    let report = CoverageReport(targets: [target], coverage: 0.15)
+    let metrics = TableUpdate.createFrom(coverage: report, pullRequest: PULL_REQUEST)
+    XCTAssertEqual(metrics.table_name, "Coverage1")
+    XCTAssertEqual(metrics.replace_measurements.count, 0)
+  }
+
+  func testShouldConvertToJson() throws {
+    let table = TableUpdate(table_name: "name",
+                            column_names: ["col"],
+                            replace_measurements: [[0], [2]])
+    let metrics = UploadMetrics(tables: [table])
+    let json = try metrics.json()
+    XCTAssertEqual(json, "{\"tables\":[{\"replace_measurements\":[[0],[2]],\"column_names\":[\"col\"],\"table_name\":\"name\"}]}")
+  }
+}