Skip to content

Commit

Permalink
More readability improvements for xctest
Browse files Browse the repository at this point in the history
  • Loading branch information
si-net committed Jan 16, 2025
1 parent ad757b3 commit 3e5dcd5
Showing 1 changed file with 6 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ import TabItem from '@theme/TabItem';

Flutter compiles iOS [integration tests](https://docs.flutter.dev/cookbook/testing/integration/introduction) into [XCTests](https://developer.apple.com/documentation/xctest) so that they can be executed on apple devices. In the following we will explain how to run your XCTests on Sauce Labs infrastructure.

To run a XCTest (or 'flutter test') on Sauce Labs we need two test artifacts from you. First, your flutter-ios app compiled as an `.ipa` file, and second we need the `.xctestrun` file for that app. The [.xctestrun file](https://keith.github.io/xcode-man-pages/xcodebuild.xctestrun.5.html) is the config for your test, this is the same config that xcode uses when it runs your tests on your development machine.
**To run a XCTest (or 'flutter test') on Sauce Labs we need two test artifacts from you:**

Check warning on line 14 in docs/mobile-apps/automated-testing/flutter/flutter-integration-testing-ios.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/automated-testing/flutter/flutter-integration-testing-ios.md#L14

[sauce.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[sauce.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/mobile-apps/automated-testing/flutter/flutter-integration-testing-ios.md", "range": {"start": {"line": 14, "column": 91}}}, "severity": "WARNING"}
1. Your flutter-ios app compiled as an `.ipa` or `.app` file.

Check warning on line 15 in docs/mobile-apps/automated-testing/flutter/flutter-integration-testing-ios.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/automated-testing/flutter/flutter-integration-testing-ios.md#L15

[sauce.WordList] Use 'iOS' instead of 'ios'.
Raw output
{"message": "[sauce.WordList] Use 'iOS' instead of 'ios'.", "location": {"path": "docs/mobile-apps/automated-testing/flutter/flutter-integration-testing-ios.md", "range": {"start": {"line": 15, "column": 17}}}, "severity": "WARNING"}
2. The`.xctestrun` file for that app. The [.xctestrun file](https://keith.github.io/xcode-man-pages/xcodebuild.xctestrun.5.html) is the config for your test, this is the same config that xcode uses when it runs your tests on your development machine.


## Contents
1. [How to compile your flutter-ios app into an `.ipa` file.](#1-how-to-compile-your-flutter-ios-app-into-an-ipa-file)

Check warning on line 20 in docs/mobile-apps/automated-testing/flutter/flutter-integration-testing-ios.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/automated-testing/flutter/flutter-integration-testing-ios.md#L20

[sauce.WordList] Use 'iOS' instead of 'ios'.
Raw output
{"message": "[sauce.WordList] Use 'iOS' instead of 'ios'.", "location": {"path": "docs/mobile-apps/automated-testing/flutter/flutter-integration-testing-ios.md", "range": {"start": {"line": 20, "column": 33}}}, "severity": "WARNING"}
Expand All @@ -27,9 +30,8 @@ To run a XCTest (or 'flutter test') on Sauce Labs we need two test artifacts fro
- Access to Sauce Labs Real Devices. Sauce Labs currently only supports XCTests on Real Devices, not virtual.

Check warning on line 30 in docs/mobile-apps/automated-testing/flutter/flutter-integration-testing-ios.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/automated-testing/flutter/flutter-integration-testing-ios.md#L30

[sauce.CurrentStatus] Remove 'currently'. The documentation reflects the current state of the product.
Raw output
{"message": "[sauce.CurrentStatus] Remove 'currently'. The documentation reflects the current state of the product.", "location": {"path": "docs/mobile-apps/automated-testing/flutter/flutter-integration-testing-ios.md", "range": {"start": {"line": 30, "column": 49}}}, "severity": "WARNING"}
- Flutter mobile app. If you don't have one, you could use our Flutter Demo App:
- [Sauce Labs Flutter Demo App](https://github.com/saucelabs/my-demo-app-flutter)
- `xcode` build tools
- possibly `zip`
- possibly `saucectl`
- `xcodebuild` tools
- `zip` and/or `saucectl`


## 1. How to compile your flutter-ios app into an `.ipa` file

Check warning on line 37 in docs/mobile-apps/automated-testing/flutter/flutter-integration-testing-ios.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/mobile-apps/automated-testing/flutter/flutter-integration-testing-ios.md#L37

[sauce.WordList] Use 'iOS' instead of 'ios'.
Raw output
{"message": "[sauce.WordList] Use 'iOS' instead of 'ios'.", "location": {"path": "docs/mobile-apps/automated-testing/flutter/flutter-integration-testing-ios.md", "range": {"start": {"line": 37, "column": 35}}}, "severity": "WARNING"}
Expand Down

0 comments on commit 3e5dcd5

Please sign in to comment.