Skip to content

[quick_actions_ios] Migrate XCTest to Swift Testing #10767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jmagman wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

[quick_actions_ios] Migrate XCTest to Swift Testing #10767

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0a91a03
[quick_actions_ios] Migrate XCTest to Swift Testing
jmagman Jan 10, 2026
88d4558
Review edit
jmagman Jan 10, 2026
e298c28
camel
jmagman Jan 12, 2026
15431af
more camel
jmagman Jan 12, 2026
fdfa666
Remove CHANGELOG.md
jmagman Jan 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/quick_actions/quick_actions_ios/example/ios/Runner.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,7 @@
PRODUCT_BUNDLE_IDENTIFIER = dev.flutter.plugins.RunnerTests;
PRODUCT_NAME = "$(TARGET_NAME)";
SWIFT_OPTIMIZATION_LEVEL = "-Onone";
SWIFT_VERSION = 5.0;
SWIFT_VERSION = 6.0;
TEST_HOST = "$(BUILT_PRODUCTS_DIR)/Runner.app/Runner";
};
name = Debug;
Expand All @@ -526,7 +526,7 @@
);
PRODUCT_BUNDLE_IDENTIFIER = dev.flutter.plugins.RunnerTests;
PRODUCT_NAME = "$(TARGET_NAME)";
SWIFT_VERSION = 5.0;
SWIFT_VERSION = 6.0;
TEST_HOST = "$(BUILT_PRODUCTS_DIR)/Runner.app/Runner";
};
name = Release;
Expand Down
118 changes: 60 additions & 58 deletions ...ges/quick_actions/quick_actions_ios/example/ios/RunnerTests/QuickActionsPluginTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// found in the LICENSE file.

import Flutter
import XCTest
import Testing

@testable import quick_actions_ios

Expand All @@ -19,9 +19,10 @@ class MockFlutterApi: IOSQuickActionsFlutterApiProtocol {
}
}

class QuickActionsPluginTests: XCTestCase {
@MainActor
struct QuickActionsPluginTests {

func testHandleMethodCall_setShortcutItems() {
@Test func handleMethodCallSetShortcutItems() {
let rawItem = ShortcutItemMessage(
type: "SearchTheThing",
localizedTitle: "Search the thing",
Expand All @@ -43,10 +44,10 @@ class QuickActionsPluginTests: XCTestCase {
shortcutItemProvider: mockShortcutItemProvider)

plugin.setShortcutItems(itemsList: [rawItem])
XCTAssertEqual(mockShortcutItemProvider.shortcutItems, [item], "Must set shortcut items.")
#expect(mockShortcutItemProvider.shortcutItems == [item])
}

func testHandleMethodCall_clearShortcutItems() {
@Test func handleMethodCallClearShortcutItems() {
let item = UIApplicationShortcutItem(
type: "SearchTheThing",
localizedTitle: "Search the thing",
Expand All @@ -65,11 +66,11 @@ class QuickActionsPluginTests: XCTestCase {

plugin.clearShortcutItems()

XCTAssertEqual(mockShortcutItemProvider.shortcutItems, [], "Must clear shortcut items.")
#expect(mockShortcutItemProvider.shortcutItems == [])

}

func testApplicationPerformActionForShortcutItem() {
@Test func applicationPerformActionForShortcutItem() async {
let flutterApi: MockFlutterApi = MockFlutterApi()
let mockShortcutItemProvider = MockShortcutItemProvider()

Expand All @@ -84,24 +85,24 @@ class QuickActionsPluginTests: XCTestCase {
icon: UIApplicationShortcutIcon(templateImageName: "search_the_thing.png"),
userInfo: nil)

let invokeMethodExpectation = expectation(description: "invokeMethod must be called.")
flutterApi.launchActionCallback = { aString in
XCTAssertEqual(aString, item.type)
invokeMethodExpectation.fulfill()
}
await confirmation("invokeMethod must be called") { confirmed in
flutterApi.launchActionCallback = { aString in
#expect(aString == item.type)
confirmed()
}

let actionResult = plugin.application(
UIApplication.shared,
performActionFor: item
) { success in
// noop
}
let actionResult = plugin.application(
UIApplication.shared,
performActionFor: item
) { success in
// noop
}

XCTAssert(actionResult, "performActionForShortcutItem must return true.")
waitForExpectations(timeout: 1)
#expect(actionResult, "performActionForShortcutItem must return true.")
}
}

func testApplicationDidFinishLaunchingWithOptions_launchWithShortcut() {
@Test func applicationDidFinishLaunchingWithOptionsLaunchWithShortcut() {
let flutterApi: MockFlutterApi = MockFlutterApi()
let mockShortcutItemProvider = MockShortcutItemProvider()

Expand All @@ -119,11 +120,11 @@ class QuickActionsPluginTests: XCTestCase {
let launchResult = plugin.application(
UIApplication.shared,
didFinishLaunchingWithOptions: [UIApplication.LaunchOptionsKey.shortcutItem: item])
XCTAssertFalse(
launchResult, "didFinishLaunchingWithOptions must return false if launched from shortcut.")
#expect(
!launchResult, "didFinishLaunchingWithOptions must return false if launched from shortcut.")
}

func testApplicationDidFinishLaunchingWithOptions_launchWithoutShortcut() {
@Test func applicationDidFinishLaunchingWithOptionsLaunchWithoutShortcut() {
let flutterApi: MockFlutterApi = MockFlutterApi()
let mockShortcutItemProvider = MockShortcutItemProvider()

Expand All @@ -132,11 +133,11 @@ class QuickActionsPluginTests: XCTestCase {
shortcutItemProvider: mockShortcutItemProvider)

let launchResult = plugin.application(UIApplication.shared, didFinishLaunchingWithOptions: [:])
XCTAssert(
#expect(
launchResult, "didFinishLaunchingWithOptions must return true if not launched from shortcut.")
}

func testApplicationDidBecomeActive_launchWithoutShortcut() {
@Test func applicationDidBecomeActiveLaunchWithoutShortcut() {
let flutterApi: MockFlutterApi = MockFlutterApi()
let mockShortcutItemProvider = MockShortcutItemProvider()

Expand All @@ -145,13 +146,13 @@ class QuickActionsPluginTests: XCTestCase {
shortcutItemProvider: mockShortcutItemProvider)

let launchResult = plugin.application(UIApplication.shared, didFinishLaunchingWithOptions: [:])
XCTAssert(
#expect(
launchResult, "didFinishLaunchingWithOptions must return true if not launched from shortcut.")

plugin.applicationDidBecomeActive(UIApplication.shared)
}

func testApplicationDidBecomeActive_launchWithShortcut() {
@Test func applicationDidBecomeActiveLaunchWithShortcut() async {
let item = UIApplicationShortcutItem(
type: "SearchTheThing",
localizedTitle: "Search the thing",
Expand All @@ -166,24 +167,24 @@ class QuickActionsPluginTests: XCTestCase {
flutterApi: flutterApi,
shortcutItemProvider: mockShortcutItemProvider)

let invokeMethodExpectation = expectation(description: "invokeMethod must be called.")
flutterApi.launchActionCallback = { aString in
XCTAssertEqual(aString, item.type)
invokeMethodExpectation.fulfill()
}
await confirmation("invokeMethod must be called") { confirmed in
flutterApi.launchActionCallback = { aString in
#expect(aString == item.type)
confirmed()
}

let launchResult = plugin.application(
UIApplication.shared,
didFinishLaunchingWithOptions: [UIApplication.LaunchOptionsKey.shortcutItem: item])
let launchResult = plugin.application(
UIApplication.shared,
didFinishLaunchingWithOptions: [UIApplication.LaunchOptionsKey.shortcutItem: item])

XCTAssertFalse(
launchResult, "didFinishLaunchingWithOptions must return false if launched from shortcut.")
#expect(
!launchResult, "didFinishLaunchingWithOptions must return false if launched from shortcut.")

plugin.applicationDidBecomeActive(UIApplication.shared)
waitForExpectations(timeout: 1)
plugin.applicationDidBecomeActive(UIApplication.shared)
}
}

func testApplicationDidBecomeActive_launchWithShortcut_becomeActiveTwice() {
@Test func applicationDidBecomeActiveLaunchWithShortcutBecomeActiveTwice() async {
let item = UIApplicationShortcutItem(
type: "SearchTheThing",
localizedTitle: "Search the thing",
Expand All @@ -198,25 +199,26 @@ class QuickActionsPluginTests: XCTestCase {
flutterApi: flutterApi,
shortcutItemProvider: mockShortcutItemProvider)

let invokeMethodExpectation = expectation(description: "invokeMethod must be called.")

var invokeMethodCount = 0
flutterApi.launchActionCallback = { aString in
XCTAssertEqual(aString, item.type)
invokeMethodCount += 1
invokeMethodExpectation.fulfill()
await confirmation("invokeMethod must be called") { confirmed in
flutterApi.launchActionCallback = { aString in
#expect(aString == item.type)
invokeMethodCount += 1
if invokeMethodCount == 1 {
confirmed()
}
}

let launchResult = plugin.application(
UIApplication.shared,
didFinishLaunchingWithOptions: [UIApplication.LaunchOptionsKey.shortcutItem: item])

#expect(
!launchResult, "didFinishLaunchingWithOptions must return false if launched from shortcut.")

plugin.applicationDidBecomeActive(UIApplication.shared)
}

let launchResult = plugin.application(
UIApplication.shared,
didFinishLaunchingWithOptions: [UIApplication.LaunchOptionsKey.shortcutItem: item])

XCTAssertFalse(
launchResult, "didFinishLaunchingWithOptions must return false if launched from shortcut.")

plugin.applicationDidBecomeActive(UIApplication.shared)
waitForExpectations(timeout: 1)

XCTAssertEqual(invokeMethodCount, 1, "shortcut should only be handled once per launch.")
#expect(invokeMethodCount == 1)
Copy link

@gemini-code-assist gemini-code-assist bot Jan 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This test's name implies that applicationDidBecomeActive is called twice, but it's only called once. To make the test align with its name and more robustly check that the shortcut is handled only once, consider calling applicationDidBecomeActive a second time. Additionally, the descriptive message from the original assertion was lost and should be restored.

// Call a second time to ensure the shortcut is not handled again.
plugin.applicationDidBecomeActive(UIApplication.shared)
#expect(invokeMethodCount == 1, "shortcut should only be handled once per launch.")

}
}
Loading