Run unit tests also on iOS Simulator (#641)

Task/Issue URL: https://app.asana.com/0/1203301625297703/1205092817771289/f Description: Update PR checks pipeline to run tests on iOS Simulator. Disable Navigation tests on iOS because it's not in use there (and not fully tested).
duckduckgo · Jan 30, 2024 · 8e8ffb4 · 8e8ffb4
1 parent 872090e
commit 8e8ffb4
Show file tree

Hide file tree

Showing 29 changed files with 345 additions and 183 deletions.
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -20,7 +20,7 @@ jobs:
 
   unit-tests:
 
-      name: Run unit tests
+      name: Run unit tests (macOS)
 
       runs-on: macos-13-xlarge
       timeout-minutes: 30
@@ -71,7 +71,7 @@ jobs:
         uses: mikepenz/action-junit-report@v3
         if: always()
         with:
-          check_name: Test Report
+          check_name: Test Report (macOS)
           report_paths: tests.xml
           require_tests: true
 
@@ -105,9 +105,96 @@ jobs:
           author=$(gh api https://api.github.com/repos/${{ github.repository }}/commits/${head_commit} --jq .author.login)
           echo "commit_author=${author}" >> $GITHUB_OUTPUT
 
+  unit-tests-ios:
+
+      name: Run unit tests (iOS)
+
+      runs-on: macos-13-xlarge
+      timeout-minutes: 30
+
+      steps:
+
+      - name: Check out the code
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Set cache key hash
+        run: |
+          has_only_tags=$(jq '[ .pins[].state | has("version") ] | all' Package.resolved)
+          if [[ "$has_only_tags" == "true" ]]; then
+            echo "cache_key_hash=${{ hashFiles('Package.resolved') }}" >> $GITHUB_ENV
+          else
+            echo "Package.resolved contains dependencies specified by branch or commit, skipping cache."
+          fi
+
+      - name: Cache SPM
+        if: env.cache_key_hash
+        uses: actions/cache@v3
+        with:
+          path: DerivedData/SourcePackages
+          key: ${{ runner.os }}-spm-ios-${{ env.cache_key_hash }}
+          restore-keys: |
+            ${{ runner.os }}-spm-ios-
+
+      - name: Select Xcode
+        run: sudo xcode-select -s /Applications/Xcode_$(<.xcode-version).app/Contents/Developer
+
+      - name: Resolve package dependencies
+        run: |
+          while xcodebuild -resolvePackageDependencies \
+            -scheme BrowserServicesKit-Package \
+            -destination 'platform=iOS Simulator,name=iPhone 15' \
+            -derivedDataPath DerivedData \
+            2>&1 | grep Error; do :; done
+
+          # you just can't have good things
+          # set -o pipefail && swift package resolve | tee ios-build-log.txt | xcbeautify
+          # mkdir -p DerivedData/SourcePackages
+          # mv .build/* DerivedData/SourcePackages
+
+      - name: Run tests
+        run: |
+          set -o pipefail && xcodebuild test \
+            -scheme BrowserServicesKit \
+            -destination 'platform=iOS Simulator,name=iPhone 15' \
+            -derivedDataPath DerivedData \
+            -skipPackagePluginValidation \
+            CODE_SIGNING_ALLOWED=NO \
+            | tee -a ios-build-log.txt \
+            | xcbeautify --report junit --report-path . --junit-report-filename ios-unittests.xml 
+
+      - name: Publish Unit Tests Report
+        uses: mikepenz/action-junit-report@v3
+        if: always()
+        with:
+          check_name: Test Report (iOS)
+          report_paths: ios-unittests.xml
+          require_tests: true
+
+      - name: Update Asana with failed unit tests
+        if: always() # always run even if the previous step fails
+        env:
+          ASANA_ACCESS_TOKEN: ${{ secrets.ASANA_ACCESS_TOKEN }}
+          WORKFLOW_URL: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}/attempts/${{ github.run_attempt }}
+        run: |
+          # Extract failed tests from the junit report
+          # Only keep failures unique by classname and name (column 1 and 2 of the yq output)
+          yq < ios-unittests.xml -p xml -o json -r \
+            $'[.testsuites.testsuite[].testcase] | flatten | map(select(.failure) | .+@classname + " " + .+@name + " \'" + .failure.+@message + "\' ${{ env.WORKFLOW_URL }}") | .[]' \
+            | sort -u -k 1,2 \
+            | xargs -L 1 ./scripts/report-failed-unit-test.sh -s ${{ vars.APPLE_CI_FAILING_TESTS_FAILED_TESTS_SECTION_ID }}
+
+      - name: Upload logs
+        uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: ios-build-log.txt
+          path: ios-build-log.txt
+
   create-asana-task:
     name: Create Asana Task
-    needs: [swiftlint, unit-tests]
+    needs: [swiftlint, unit-tests, unit-tests-ios]
 
     if: failure() && github.ref_name == 'main' && github.run_attempt == 1
 
@@ -126,7 +213,7 @@ jobs:
 
   close-asana-task:
     name: Close Asana Task
-    needs: [swiftlint, unit-tests]
+    needs: [swiftlint, unit-tests, unit-tests-ios]
 
     if: success() && github.ref_name == 'main' && github.run_attempt > 1
 

diff --git a/Package.resolved b/Package.resolved
@@ -14,8 +14,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/duckduckgo/content-scope-scripts",
       "state" : {
-        "revision" : "0b68b0d404d8d4f32296cd84fa160b18b0aeaf44",
-        "version" : "4.59.1"
+        "revision" : "38ee7284bac7fa12d822fcaf0677ea3969d15fb1",
+        "version" : "4.59.2"
       }
     },
     {

diff --git a/Sources/BookmarksTestDBBuilder/BookmarksTestDBBuilder.swift b/Sources/BookmarksTestDBBuilder/BookmarksTestDBBuilder.swift
@@ -16,7 +16,6 @@
 //  limitations under the License.
 //
 
-import Cocoa
 import Foundation
 import CoreData
 import Persistence

diff --git a/Tests/BookmarksTests/BookmarkDatabaseCleanerTests.swift b/Tests/BookmarksTests/BookmarkDatabaseCleanerTests.swift
@@ -16,9 +16,11 @@
 //  limitations under the License.
 //
 
-import XCTest
 import Common
+import CoreData
+import Foundation
 import Persistence
+import XCTest
 @testable import Bookmarks
 
 final class MockEventMapper: EventMapping<BookmarksCleanupError> {
@@ -51,7 +53,7 @@ final class BookmarkDatabaseCleanerTests: XCTestCase {
             XCTFail("Failed to load model")
             return
         }
-        bookmarksDatabase = CoreDataDatabase(name: className, containerLocation: location, model: model)
+        bookmarksDatabase = CoreDataDatabase(name: type(of: self).description(), containerLocation: location, model: model)
         bookmarksDatabase.loadStore()
 
         eventMapper = MockEventMapper()

diff --git a/Tests/BookmarksTests/BookmarkEntityTests.swift b/Tests/BookmarksTests/BookmarkEntityTests.swift
@@ -16,6 +16,8 @@
 //  limitations under the License.
 //
 
+import CoreData
+import Foundation
 import XCTest
 import Persistence
 @testable import Bookmarks
@@ -34,7 +36,7 @@ final class BookmarkEntityTests: XCTestCase {
             XCTFail("Failed to load model")
             return
         }
-        bookmarksDatabase = CoreDataDatabase(name: className, containerLocation: location, model: model)
+        bookmarksDatabase = CoreDataDatabase(name: type(of: self).description(), containerLocation: location, model: model)
         bookmarksDatabase.loadStore()
     }
 

diff --git a/Tests/BookmarksTests/BookmarkListViewModelTests.swift b/Tests/BookmarksTests/BookmarkListViewModelTests.swift
@@ -18,6 +18,8 @@
 
 import BookmarksTestsUtils
 import Common
+import CoreData
+import Foundation
 import Persistence
 import XCTest
 @testable import Bookmarks
@@ -52,7 +54,7 @@ final class BookmarkListViewModelTests: XCTestCase {
             XCTFail("Failed to load model")
             return
         }
-        bookmarksDatabase = CoreDataDatabase(name: className, containerLocation: location, model: model)
+        bookmarksDatabase = CoreDataDatabase(name: type(of: self).description(), containerLocation: location, model: model)
         bookmarksDatabase.loadStore()
         eventMapping = MockBookmarksModelErrorEventMapping { [weak self] event in
             self?.firedEvents.append(event)

diff --git a/Tests/BookmarksTests/BookmarkUtilsTests.swift b/Tests/BookmarksTests/BookmarkUtilsTests.swift
@@ -17,8 +17,9 @@
 //
 
 import BookmarksTestsUtils
-import XCTest
+import Foundation
 import Persistence
+import XCTest
 @testable import Bookmarks
 
 final class BookmarkUtilsTests: XCTestCase {
@@ -35,7 +36,7 @@ final class BookmarkUtilsTests: XCTestCase {
             XCTFail("Failed to load model")
             return
         }
-        bookmarksDatabase = CoreDataDatabase(name: className, containerLocation: location, model: model)
+        bookmarksDatabase = CoreDataDatabase(name: type(of: self).description(), containerLocation: location, model: model)
         bookmarksDatabase.loadStore()
     }
 

diff --git a/Tests/BookmarksTests/FaviconsFetcher/BookmarkDomainsTests.swift b/Tests/BookmarksTests/FaviconsFetcher/BookmarkDomainsTests.swift
@@ -17,6 +17,7 @@
 //
 
 import BookmarksTestsUtils
+import CoreData
 import Foundation
 import Persistence
 import XCTest
@@ -36,7 +37,7 @@ final class BookmarkDomainsTests: XCTestCase {
             XCTFail("Failed to load model")
             return
         }
-        bookmarksDatabase = CoreDataDatabase(name: className, containerLocation: location, model: model)
+        bookmarksDatabase = CoreDataDatabase(name: type(of: self).description(), containerLocation: location, model: model)
         bookmarksDatabase.loadStore()
     }
 

diff --git a/Tests/BookmarksTests/FaviconsFetcher/BookmarksFaviconsFetcherTests.swift b/Tests/BookmarksTests/FaviconsFetcher/BookmarksFaviconsFetcherTests.swift
@@ -58,7 +58,7 @@ final class BookmarksFaviconsFetcherTests: XCTestCase {
             XCTFail("Failed to load model")
             return
         }
-        bookmarksDatabase = CoreDataDatabase(name: className, containerLocation: location, model: model)
+        bookmarksDatabase = CoreDataDatabase(name: type(of: self).description(), containerLocation: location, model: model)
         bookmarksDatabase.loadStore()
 
         faviconStore = MockFaviconStore()

diff --git a/Tests/BookmarksTests/FaviconsFetcher/FaviconsFetchOperationTests.swift b/Tests/BookmarksTests/FaviconsFetcher/FaviconsFetchOperationTests.swift
@@ -43,7 +43,7 @@ final class FaviconsFetchOperationTests: XCTestCase {
             XCTFail("Failed to load model")
             return
         }
-        bookmarksDatabase = CoreDataDatabase(name: className, containerLocation: location, model: model)
+        bookmarksDatabase = CoreDataDatabase(name: type(of: self).description(), containerLocation: location, model: model)
         bookmarksDatabase.loadStore()
 
         faviconStore = MockFaviconStore()

diff --git a/Tests/BookmarksTests/FavoriteListViewModelTests.swift b/Tests/BookmarksTests/FavoriteListViewModelTests.swift
@@ -18,6 +18,7 @@
 
 import BookmarksTestsUtils
 import Common
+import Foundation
 import Persistence
 import XCTest
 @testable import Bookmarks
@@ -39,7 +40,7 @@ final class FavoriteListViewModelTests: XCTestCase {
             XCTFail("Failed to load model")
             return
         }
-        bookmarksDatabase = CoreDataDatabase(name: className, containerLocation: location, model: model)
+        bookmarksDatabase = CoreDataDatabase(name: type(of: self).description(), containerLocation: location, model: model)
         bookmarksDatabase.loadStore()
         eventMapping = MockBookmarksModelErrorEventMapping { [weak self] event in
             self?.firedEvents.append(event)

diff --git a/Tests/BrowserServicesKitTests/RemoteMessaging/RemoteMessagingConfigMatcherTests.swift b/Tests/BrowserServicesKitTests/RemoteMessaging/RemoteMessagingConfigMatcherTests.swift
@@ -196,7 +196,7 @@ class RemoteMessagingConfigMatcherTests: XCTestCase {
     func testWhenDeviceMatchesAnyRuleThenReturnFirstMatch() {
         let remoteConfig = RemoteConfigModel(messages: [mediumMessage(matchingRules: [1, 2], exclusionRules: [])],
                                         rules: [1: [LocaleMatchingAttribute(value: [Locale.current.identifier], fallback: nil)],
-                                                2: [OSMatchingAttribute(min: "0", max: "15", fallback: nil)]])
+                                                2: [OSMatchingAttribute(min: "0", max: "100", fallback: nil)]])
 
         XCTAssertEqual(matcher.evaluate(remoteConfig: remoteConfig), mediumMessage(matchingRules: [1, 2], exclusionRules: []))
     }

diff --git a/Tests/BrowserServicesKitTests/SmarterEncryption/AppHTTPSUpgradeStoreTests.swift b/Tests/BrowserServicesKitTests/SmarterEncryption/AppHTTPSUpgradeStoreTests.swift
@@ -16,6 +16,7 @@
 //  limitations under the License.
 //
 
+import Foundation
 import XCTest
 @testable import BrowserServicesKit
 import class Persistence.CoreDataDatabase
@@ -38,7 +39,7 @@ final class AppHTTPSUpgradeStoreTests: XCTestCase {
 
         location = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
         bloomFilterUrl = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
-        database = CoreDataDatabase(name: className, containerLocation: location, model: HTTPSUpgrade.managedObjectModel)
+        database = CoreDataDatabase(name: type(of: self).description(), containerLocation: location, model: HTTPSUpgrade.managedObjectModel)
         database.loadStore { _, error in
             if let e = error {
                 XCTFail("Could not load store: \(e.localizedDescription)")

diff --git a/Tests/NavigationTests/ClosureNavigationResponderTests.swift b/Tests/NavigationTests/ClosureNavigationResponderTests.swift
@@ -16,6 +16,8 @@
 //  limitations under the License.
 //
 
+#if os(macOS)
+
 import Combine
 import Common
 import Swifter
@@ -434,3 +436,5 @@ class ClosureNavigationResponderTests: DistributedNavigationDelegateTestsBase {
 
 // swiftlint:enable unused_closure_parameter
 // swiftlint:enable opening_brace
+
+#endif