BrowserStack CLI support by fylyppo · Pull Request #2860 · leancodepl/patrol

fylyppo · 2025-12-30T22:09:32Z

Summary

This PR adds native BrowserStack App Automate integration to the Patrol CLI, enabling users to build, upload, and run Patrol tests on BrowserStack's directly from the CLI.

New Commands

patrol bs android - Build and upload Android APKs to BrowserStack for Espresso testing
patrol bs ios - Build and upload iOS apps to BrowserStack for XCUITest testing
patrol bs outputs <build_id> - Get outputs and artifacts from a completed BrowserStack build

Features

Building and scheduling runs
Downloads instrumentation logs, device logs, session videos, and test reports
Support for custom API parameters via --api-params for advanced BrowserStack configuration

Configuration

Credentials and devices can be set via CLI options or environment variables:

Option	Environment Variable
`--credentials`	`PATROL_BS_CREDENTIALS` (format: `username:access_key`)
`--devices`	`PATROL_BS_ANDROID_DEVICES` / `PATROL_BS_IOS_DEVICES`
`--api-params`	`PATROL_BS_ANDROID_API_PARAMS` / `PATROL_BS_IOS_API_PARAMS`
`--project`	`PATROL_BS_PROJECT`

Usage Example

Run Android tests on BrowserStack

patrol bs android
--target patrol_test/app_test.dart
--credentials "user:key"
--devices '["Google Pixel 8-14.0"]'
--download-outputs

Run iOS tests on BrowserStack

patrol bs ios
--target patrol_test/app_test.dart
--credentials "user:key"
--devices '["iPhone 15-17"]'
-d

The --download-outputs (-d) flag makes the command wait for the test run to complete, download all artifacts (logs, videos, reports), and exit with an appropriate code based on test results.

Get outputs from existing build

patrol bs outputs abc123def --output-dir ./results

This reverts commit d49abd5.

This reverts commit 998cca7.

Copilot

Pull request overview

Adds native BrowserStack App Automate support to patrol_cli via new patrol bs ... commands, and refactors existing build commands/backends to better support artifact discovery and reuse.

Changes:

Introduces patrol bs android, patrol bs ios, and patrol bs outputs commands (build/upload/schedule + optional artifact download).
Refactors build command wiring (reuses BuildAndroidCommand/BuildIOSCommand instances) and adjusts iOS .xctestrun discovery.
Updates CLI version and dependencies (adds archive).

Reviewed changes

Copilot reviewed 19 out of 20 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
packages/patrol_cli/lib/src/runner/patrol_command_runner.dart	Wires new BrowserStack command group and reuses build subcommands.
packages/patrol_cli/lib/src/commands/browserstack/*	Adds BrowserStack API client + commands for Android/iOS uploads and outputs/artifact downloads.
packages/patrol_cli/lib/src/commands/build_android.dart	Improves APK path discovery and logging for build outputs.
packages/patrol_cli/lib/src/commands/build_ios.dart	Adds flavor-aware output paths; updates `.xctestrun` path logging.
packages/patrol_cli/lib/src/ios/ios_test_backend.dart	Changes `.xctestrun` discovery implementation and return type.
packages/patrol_cli/lib/src/runner/patrol_command.dart	Adds arg/global-results override hooks for command reuse.
packages/patrol_cli/test/**	Updates/extends tests for iOS backend and iOS build output paths.
packages/patrol_cli/pubspec.yaml	Bumps version and adds `archive` dependency.
packages/patrol_cli/lib/src/base/constants.dart	Keeps CLI version constant in sync.
packages/patrol_devtools_extension/pubspec.lock	Updates locked transitive dependencies.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-26T12:03:56Z

packages/patrol_cli/lib/src/ios/ios_test_backend.dart


-    _logger.detail(
-      'Found ${files.length} match(es), the first one will be used',
+    throw FileSystemException(


xcTestRunPath() now throws a raw FileSystemException when no match is found. Call sites like IOSTestBackend.execute() don't catch this, so users may get an unhandled exception instead of a clean throwToolExit(...) message. Consider converting the failure back to a ToolExit (or catching FileSystemException at call sites and rethrowing with throwToolExit).

Suggested change

throw FileSystemException(

throwToolExit(

Copilot · 2026-02-26T12:03:57Z

packages/patrol_cli/lib/src/commands/build_android.dart

+    for (final root in [Directory('build'), Directory('android')]) {
+      if (!root.existsSync()) {
+        continue;
+      }
+      try {
+        for (final entity in root.listSync(recursive: true)) {
+          if (entity is File &&
+              entity.path.contains('outputs/apk/') &&
+              entity.path.endsWith(apkName)) {
+            return entity.path;


_findApkPath() searches for alternative APK locations by checking entity.path.contains('outputs/apk/'). This uses a hard-coded forward slash and will fail on Windows paths (e.g. outputs\apk\...), preventing fallback discovery. Consider normalizing paths or using package:path utilities to perform this check in a platform-independent way.

Copilot · 2026-02-26T12:03:57Z

packages/patrol_cli/lib/src/commands/browserstack/bs_outputs_command.dart

+      // Get session ID
+      final devices = currentBuildData['devices'] as List<dynamic>?;
+      if (devices == null || devices.isEmpty) {
+        _logger.err('No devices found in build data');
+        return BsExitCodes.buildError;
+      }
+
+      final sessions =
+          (devices.first as Map<String, dynamic>)['sessions'] as List<dynamic>?;
+      if (sessions == null || sessions.isEmpty) {
+        _logger.err('No sessions found in build data');
+        return BsExitCodes.buildError;
+      }
+
+      final sessionId =
+          (sessions.first as Map<String, dynamic>)['id'] as String?;
+      if (sessionId == null) {
+        _logger.err('Could not find session ID in build data');
+        return BsExitCodes.buildError;
+      }


BsOutputsCommand picks only devices.first and sessions.first, so for multi-device runs it will download artifacts for just one session while silently ignoring the rest. This contradicts --devices allowing multiple devices. Consider iterating over all devices/sessions and naming outputs per device/session (e.g., include device name + session id) so users get complete artifacts.

Copilot · 2026-02-26T12:03:57Z

packages/patrol_cli/lib/src/commands/browserstack/browserstack_client.dart

+    final multipartFile = http.MultipartFile(
+      'file',
+      fileStream,
+      fileLength,
+      filename: file.path.split('/').last,
+    );


filename: file.path.split('/').last is not platform-independent (Windows uses \). Use package:path's basename(file.path) to ensure correct filenames across OSes.

Copilot · 2026-02-26T12:03:57Z

packages/patrol_cli/lib/src/commands/browserstack/bs_ios_command.dart

+  Future<void> _createZip(
+    String sourceDir,
+    String outputPath,
+    String rootDirName,
+  ) async {


_createZip() takes rootDirName but never uses it, which is confusing (and may trigger lint for unused parameters). Either remove the parameter or use it to control how paths are stored inside the archive.

Copilot · 2026-02-26T12:03:58Z

packages/patrol_cli/lib/src/runner/patrol_command.dart

+          'Environment configuration from a provided path that will be available '
          'to the app under test.',


There is a trailing space in this help text (after available). This can lead to inconsistent formatting in --help output; remove the extra whitespace.

Suggested change

'Environment configuration from a provided path that will be available '

'to the app under test.',

'Environment configuration from a provided path that will be available'

' to the app under test.',

Copilot · 2026-02-26T12:03:58Z

packages/patrol_cli/test/commands/patrol_build_ios_print_path_test.dart

+      test('prints correct paths for simulator build with flavor', () {
+        command.printBinaryPaths(
+          simulator: true,
+          buildMode: 'Debug',
+          flavor: 'dev',
+        );
+
+        verify(
+          () => mockLogger.info(
+            '${join('build', 'ios_integ', 'Build', 'Products', 'Debug-dev-iphonesimulator', 'Runner.app')} (app under test)',
+          ),
+        ).called(1);
+        verify(
+          () => mockLogger.info(
+            '${join('build', 'ios_integ', 'Build', 'Products', 'Debug-dev-iphonesimulator', 'RunnerUITests-Runner.app')} (test instrumentation app)',
+          ),
+        ).called(1);


BuildIOSCommand.printBinaryPaths() now logs App: ... / Test App: ... (see build_ios.dart), but these new tests still assert the old output format with (<app under test>) suffixes. Align the expectations with the new log output (or keep the previous log format if it’s part of the CLI contract).

Copilot · 2026-02-26T12:03:58Z

packages/patrol_cli/lib/src/commands/build_ios.dart

    );

-    _logger.info('$xcTestRunPath (xctestrun file)');
+    _logger.info('Test Plan: $xcTestRunPath');


The log label Test Plan: is misleading here because the value is the .xctestrun path. Consider logging something like xctestrun file: (and keep naming consistent with other platforms, e.g. macOS currently logs (... xctestrun file)).

Suggested change

_logger.info('Test Plan: $xcTestRunPath');

_logger.info('xctestrun file: $xcTestRunPath');

Copilot · 2026-02-26T12:03:59Z

packages/patrol_cli/lib/src/ios/ios_test_backend.dart

+    for (final entity in directory.listSync()) {
+      final name = entity.basename;
+      if (name.startsWith(prefix) &&
+          name.contains(platformSdk) &&
+          name.endsWith('.xctestrun')) {


entity.basename is not a member of FileSystemEntity and there is no local extension providing it (searching the repo shows no basename extension). This will not compile; use basename(entity.path) from package:path/path.dart (or p.basename).

fylyppo added 4 commits December 30, 2025 11:05

Create bs commands

e306420

Fix printing paths

ed82781

Rename to android_paths

89740eb

Clean up solution for paths

77ffbba

github-actions bot added the package: patrol_cli Related to the patrol_cli package label Dec 30, 2025

fylyppo added 25 commits December 30, 2025 23:19

Move paths logic back to build commands

22bb8f3

Remove unwanted change

c8ce578

Handle search if default path to apk not exist

2502ad1

Read flavor

44f1dd1

Bump version

7b66f40

Add progress

68f86c6

Fix release mode

0fc222b

Dont print errors twice

998cca7

Print in real order

d49abd5

Revert "Print in real order"

60c2f9a

This reverts commit d49abd5.

Revert "Dont print errors twice"

02cb457

This reverts commit 998cca7.

Be more future proof with devices

99b964b

Make help cleaner

6ddd45f

Add project option

96bdd68

Change misleading name of waiting and getting outputs

817a46c

Remove dev ending in version

222ac1c

Remove code duplication and store common logic in mixin

9803e96

Remove extra underscore

115ebd5

Make nicer outputs

8a75123

Add TODO for BS docs

0191c39

Synce version in pubspec

64a0829

Make devices help message clear

5d2ac53

Add pre-building validation

ed9b9fd

Add sharding capability for Android

fb44452

Restore clear-permissions

dbd3cb7

fylyppo marked this pull request as ready for review February 2, 2026 09:11

fylyppo requested review from mateuszwojtczak, pdenert and piotruela as code owners February 2, 2026 09:11

Merge branch 'master' into feature/browserstack-support

870d811

pdenert requested a review from Copilot February 26, 2026 11:53

Copilot started reviewing on behalf of pdenert February 26, 2026 11:53 View session

Copilot AI reviewed Feb 26, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BrowserStack CLI support#2860

BrowserStack CLI support#2860
fylyppo wants to merge 30 commits intomasterfrom
feature/browserstack-support

fylyppo commented Dec 30, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 26, 2026

Uh oh!

Copilot AI Feb 26, 2026

Uh oh!

Copilot AI Feb 26, 2026

Uh oh!

Copilot AI Feb 26, 2026

Uh oh!

Copilot AI Feb 26, 2026

Uh oh!

Copilot AI Feb 26, 2026

Uh oh!

Copilot AI Feb 26, 2026

Uh oh!

Copilot AI Feb 26, 2026

Uh oh!

Copilot AI Feb 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		'Environment configuration from a provided path that will be available '
		'to the app under test.',

	_logger.info('Test Plan: $xcTestRunPath');
	_logger.info('xctestrun file: $xcTestRunPath');

Conversation

fylyppo commented Dec 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

New Commands

Features

Configuration

Usage Example

Run Android tests on BrowserStack

Run iOS tests on BrowserStack

Get outputs from existing build

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

fylyppo commented Dec 30, 2025 •

edited

Loading