Merge pull request #4308 from mapbox/NAVIOS-424-api-diff-new

NAVIOS-424: Use Xcode api breaking changes detector

Author: S2Ler

.base_api

@@ -1 +1 @@
-7b8d4d56aae4d0b300f3583776bfe15040e802b6
+ae5c7bf237c12b90dd288a43c99e6eef8d827766

.breakage-allowlist

@@ -84,9 +84,9 @@ commands:
     steps:
       - when:
           condition: << parameters.is_template >>
-          steps: 
+          steps:
             - save_cache:
-                key: nav-sdk-diff-cache-v7-{{ << parameters.key >> }}
+                key: nav-sdk-diff-cache-v8-{{ << parameters.key >> }}
                 paths:
                   - api_logs
             - store_artifacts:
@@ -96,7 +96,7 @@ commands:
           condition: << parameters.is_template >>
           steps:
             - save_cache:
-                key: nav-sdk-diff-cache-v7-<< parameters.key >>
+                key: nav-sdk-diff-cache-v8-<< parameters.key >>
                 paths:
                   - api_logs
             - store_artifacts:
@@ -112,52 +112,25 @@ commands:
     steps:
       - when:
           condition: << parameters.is_template >>
-          steps: 
+          steps:
             - restore_cache:
-                key: nav-sdk-diff-cache-v7-{{ << parameters.key >> }}
+                key: nav-sdk-diff-cache-v8-{{ << parameters.key >> }}
       - unless:
           condition: << parameters.is_template >>
           steps:
             - restore_cache:
-                key: nav-sdk-diff-cache-v7-<< parameters.key >>
+                key: nav-sdk-diff-cache-v8-<< parameters.key >>
 
-  build-api-diff-cli-tool:
-    description: "Builds CLI tool which produce diff reports"
-    parameters:
-      swift-api-diff-version:
-        type: string
-        default: "v2.0.0-rc.2"
+  run_api_log_in_current_env:
     steps:
-      - add_ssh_keys:
-          fingerprints:
-            - "8c:24:d5:99:22:42:45:8f:16:6f:8d:24:ee:08:97:13"
-      - restore_cache:
-          key: swift-api-diff-v1-<<parameters.swift-api-diff-version>>
       - run:
-          name: Building API Diff Report if Needed
+          name: "Build SDK API Logs"
           command: |
-            if [ ! -f "scripts/swift-api-diff/.build/release/swift-api-diff" ]; then 
-              cd scripts && git clone [email protected]:mapbox/swift-api-diff.git --branch <<parameters.swift-api-diff-version>> --depth 1
-              cd swift-api-diff && swift build --configuration release; 
-            fi
-      - save_cache:
-          key: swift-api-diff-v1-<<parameters.swift-api-diff-version>>
-          paths:
-            - scripts/swift-api-diff/.build/release/swift-api-diff
+            set -e -o pipefail -u
+
+            mkdir $CIRCLE_WORKING_DIRECTORY/api_logs
+            $CIRCLE_WORKING_DIRECTORY/scripts/api-compatibility-check/build-api-logs.sh "12.0" $CIRCLE_WORKING_DIRECTORY $CIRCLE_WORKING_DIRECTORY/api_logs/core_navigation_log.json $CIRCLE_WORKING_DIRECTORY/api_logs/navigation_log.json
 
-  run_api_log_in_current_env:
-    parameters:
-      iOS:
-        type: string
-      device:
-        type: string
-    steps:
-      - run:
-          name: Generating MapboxCoreNavigation API Log
-          command: ./scripts/swift-api-diff/.build/release/swift-api-diff doc ./ $CIRCLE_WORKING_DIRECTORY/api_logs/core_navigation_log.json --module-name MapboxCoreNavigation -- -sdk iphonesimulator -destination 'platform=iOS Simulator,OS=<< parameters.iOS >>,name=<< parameters.device >>' -scheme MapboxNavigation-Package build
-      - run:
-          name: Generating MapboxNavigation API Log
-          command: ./scripts/swift-api-diff/.build/release/swift-api-diff doc ./ $CIRCLE_WORKING_DIRECTORY/api_logs/navigation_log.json --module-name MapboxNavigation -- -sdk iphonesimulator -destination 'platform=iOS Simulator,OS=<< parameters.iOS >>,name=<< parameters.device >>' -scheme MapboxNavigation-Package build
   run_breaking_changes_detector:
     parameters:
       module_name:
@@ -171,16 +144,7 @@ commands:
           name: Generating << parameters.module_name >> API Diff
           command: |
             export GITHUB_TOKEN=$(mbx-ci github issues public token)
-            LOG=$(./scripts/swift-api-diff/.build/release/swift-api-diff breaking_changes << parameters.base_api_path >> << parameters.new_api_path >> --ignore-undocumented true)
-            if [ ! -z "$CIRCLE_PULL_REQUEST" ]; then
-              if [ -z "$LOG" ]; then
-                echo "No breaking changes detected in << parameters.module_name >>"
-              else
-                PR_COMMENT=$'# Breaking Changes in << parameters.module_name >>\n\n'
-                PR_COMMENT+="$LOG"
-                gh pr comment -F - \<<< "$PR_COMMENT"
-              fi
-            fi
+            ./scripts/api-compatibility-check/ci-analyze-api.sh << parameters.module_name >> << parameters.base_api_path >> << parameters.new_api_path >> $CIRCLE_WORKING_DIRECTORY/.breakage-allowlist.txt
 
   carthage-bootstrap:
     steps:
@@ -216,7 +180,7 @@ step-library:
           key: 1-gems-{{ checksum "Gemfile.lock" }}
           paths:
             - vendor/bundle
-  
+
   - &save-cache-cocoapods
       save_cache:
         key: nav-cache-pod-v1-{{ .Environment.CIRCLE_JOB }}-{{ checksum "Tests/CocoaPodsTest/PodInstall/Podfile.lock" }}
@@ -454,7 +418,7 @@ jobs:
     steps:
       - checkout
       - *trigger-metrics
-  
+
   spm-test-job:
     parameters:
       xcode:
@@ -518,17 +482,11 @@ jobs:
     parameters:
       xcode:
         type: string
-        default: "13.0.0"
-      device:
-        type: string
-        default: "iPhone 12 Pro Max"
-      iOS:
-        type: string
-        default: "14.5"
+        default: "14.2.0"
       is_base_api:
         type: boolean
         default: false
-      commit_hash: 
+      commit_hash:
         description: "git hash of the commit to be used for generating logs in api_logs folder"
         type: string
     macos:
@@ -574,13 +532,7 @@ jobs:
             - run:
                 name: Checking out commit
                 command: git checkout << parameters.commit_hash >>
-      - build-api-diff-cli-tool
-      - run:
-          name: Move Xcode project aside
-          command: rm -rf *.xcodeproj
-      - run_api_log_in_current_env:
-          iOS: << parameters.iOS >>
-          device: << parameters.device >>
+      - run_api_log_in_current_env
       - when:
           condition: << parameters.is_base_api >>
           steps:
@@ -594,26 +546,15 @@ jobs:
                 key: << parameters.commit_hash >>
 
   api-diff-job:
-    parameters:
-      xcode:
-        type: string
-        default: "13.0.0"
-      device:
-        type: string
-        default: "iPhone 13 Pro Max"
-      iOS:
-        type: string
-        default: "15.0"
     macos:
-      xcode: << parameters.xcode >>
+      xcode: 14.2.0
     environment:
       HOMEBREW_NO_AUTO_UPDATE: 1
     steps:
       - checkout
       - *add-github-to-known-hosts
       - *prepare-mapbox-file
       - *prepare-netrc-file
-      - build-api-diff-cli-tool
       - install-mbx-ci
       - install-gh-cli
       - restore-api-diff-cache:

.circleci/config.yml

@@ -23,4 +23,5 @@ Examples/Swift/Navigation_Example.mobileprovision
 
 *-pre.podspec
 
-vendor/bundle/ruby/
+vendor/bundle/ruby/
+.vscode

.gitignore

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+# This script builds MapboxNavigation and MapboxCoreNavigation frameworks and then extracts their public API using swift-api-digester tool.
+
+set -e -o pipefail -u
+
+if [ $# -ne 4 ]; then
+    echo -e "Usage: $0 <ios_version> <root_dir> <core_module_logs_path> <ui_module_logs_path>\n- <ios-version>: iOS version to build the frameworks for (e.g. 12.0)"
+    exit 1
+fi
+
+IOS_VERSION=$1
+ROOT_DIR=$2
+CORE_MODULE_LOGS_PATH=$3
+UI_MODULE_LOGS_PATH=$4
+
+PROJECT_PATH=$ROOT_DIR/MapboxNavigation-SPM.xcodeproj/
+
+TARGET="arm64-apple-ios${IOS_VERSION}"
+SDK=iphoneos
+CONFIGURATION=Release
+
+xcodebuild -sdk $SDK -destination 'generic/platform=iOS' -project "$PROJECT_PATH" -scheme MapboxNavigation -configuration $CONFIGURATION build
+DERIVED_DATA_PATH=$(xcodebuild -destination 'generic/platform=iOS' -sdk $SDK -project "$PROJECT_PATH" -configuration $CONFIGURATION -showBuildSettings | grep -m 1 "CONFIGURATION_BUILD_DIR" | grep -oEi "\/.*")
+
+xcrun -sdk $SDK swift-api-digester -sdk $(xcrun --sdk $SDK --show-sdk-path) -dump-sdk -module MapboxNavigation -o $UI_MODULE_LOGS_PATH -target $TARGET -I "$DERIVED_DATA_PATH"
+xcrun -sdk $SDK swift-api-digester -sdk $(xcrun --sdk $SDK --show-sdk-path) -dump-sdk -module MapboxCoreNavigation -o $CORE_MODULE_LOGS_PATH -target $TARGET -I "$DERIVED_DATA_PATH"

scripts/api-compatibility-check/build-api-logs.sh

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+
+# This scripts compares two API logs and posts a comment to the PR with the result of the comparison.
+
+set -e -o pipefail -u
+
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+if [ $# -ne 4 ]; then
+    echo "Usage: $0 <module_name> <base_api_path> <new_api_path> <breakage_allowlist_path"
+    exit 1
+fi
+
+MODULE_NAME=$1
+BASE_API_PATH=$2
+NEW_API_PATH=$3
+BREAKAGE_ALLOWLIST_PATH=$4
+
+echo "Building API compatibility report..."
+REPORT=$(xcrun --sdk iphoneos swift-api-digester -diagnose-sdk -input-paths "$BASE_API_PATH" -input-paths "$NEW_API_PATH" -breakage-allowlist-path $BREAKAGE_ALLOWLIST_PATH 2>&1 >/dev/null)
+echo "Report is $REPORT"
+
+echo "Parsing report..."
+pushd "$SCRIPT_DIR/swift-api-compatibility" > /dev/null
+COMMENT=$(swift run -c release swift-api-compatibility parse-report "$MODULE_NAME" "$REPORT")
+popd
+
+echo "Comment is $COMMENT"
+
+if [[ ! $COMMENT == *"🟢"* ]]; then
+    gh pr comment --body "$COMMENT"
+else
+    echo "No Breaking Changes"
+fi

scripts/api-compatibility-check/ci-analyze-api.sh

@@ -0,0 +1,9 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+xcuserdata/
+DerivedData/
+.swiftpm/config/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc

scripts/api-compatibility-check/swift-api-compatibility/.gitignore

@@ -0,0 +1,29 @@
+// swift-tools-version: 5.7
+
+import PackageDescription
+
+let package = Package(
+    name: "swift-api-compatibility",
+    products: [
+        .executable(
+            name: "swift-api-compatibility",
+            targets: ["SwiftApiCompatibility"]
+        ),
+    ],
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-argument-parser", from: "1.2.0"),
+    ],
+    targets: [
+        .executableTarget(
+            name: "SwiftApiCompatibility",
+            dependencies: [
+                "SwiftApiCompatibilityKit",
+                .product(name: "ArgumentParser", package: "swift-argument-parser"),
+            ]
+        ),
+        .target(name: "SwiftApiCompatibilityKit"),
+        .testTarget(name: "SwiftApiCompatibilityKitTests", dependencies: [
+            "SwiftApiCompatibilityKit",
+        ])
+    ]
+)

scripts/api-compatibility-check/swift-api-compatibility/Package.resolved

@@ -0,0 +1,3 @@
+# swift-api-compatibility-check
+
+Helper tool for api compatibility check.