Sauce: Implement CopyDeviceItem, log file parameter for RunApplication & fix issues #32

limbonaut · 2025-12-10T09:43:11Z

I tested it on iOS in Sauce Labs, and it should work on Android too. This PR also fixes some issues specific to iOS in Sauce Labs runner: splitting CLI arguments correctly and using correct Appium parameter for iOS.

These changes are sufficient to get E2E tests green on iOS in the Godot SDK.

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1

- Add optional LogFilePath parameter to Invoke-DeviceApp and RunApplication - Implement log file retrieval with fallback to system logs in SauceLabsProvider - Add method overloads to AdbProvider and XboxProvider for compatibility - Reduce code footprint by consolidating log retrieval logic - Maintain backward compatibility with existing provider implementations Co-authored-by: Claude Sonnet <claude@anthropic.com>

app-runner/Private/DeviceProviders/AdbProvider.ps1

app-runner/Public/Invoke-DeviceApp.ps1

- Replace method overloads with single method using optional LogFilePath parameter - Update base DeviceProvider class to include optional parameter - Simplify all provider implementations (SauceLabs, Adb, Xbox) - Remove conditional logic from Invoke-DeviceApp - single method call - Clean up code by eliminating method overload complexity Co-authored-by: Claude Sonnet <claude@anthropic.com>

- Add optional LogFilePath parameter to match other providers - Ensures consistent method signature across all provider implementations - Completes the refactoring to use optional parameters instead of overloads Co-authored-by: Claude Sonnet <claude@anthropic.com>

limbonaut · 2025-12-11T14:05:02Z

Test run example: test: Adjustments for iOS end-to-end testing sentry-godot#461 (comment)

vaind · 2025-12-12T15:18:04Z

On it! We are reviewing the PR and will provide feedback shortly.
_{Reference ID: 1}

vaind · 2025-12-12T19:29:35Z

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1

+
+                # Split the arguments string by spaces, but handle quoted strings (both single and double quotes)
+                $argTokens = [regex]::Matches($Arguments, '(\"[^\"]*\"|''[^'']*''|\S+)') | ForEach-Object { $_.Value.Trim('"', "'") }
+
+                foreach ($token in $argTokens) {
+                    $argumentsArray += $token
+                }
+
+                $launchBody['arguments'] = $argumentsArray


Even better, how about we change $arguments param to [object] and let users pass string or array?

Actually, [string[]] actually accepts both a string and an array of strings

We have multiple places where we represent arguments as a single string. I suppose I can refactor all of that in this PR.

you shouldn't really need to change that. a single string works the same as an array of a a single string

Ideally, we'd want to use arrays to eliminate the guesswork. But it clashes with command format string substitutions in device providers. I've converted most of our pathways to use an array of arguments, but I'm still a bit conflicted about it.

I assume you're only changing this for the invoke-app flow - I'd just join the string by a space by default, no escaping, quoting, etc.
If someone needs custom escaping or quoting, they can always pass a single string.
let's keep it simple

I would expect this to work:

Invoke-App -Exe "Game.exe" -Arguments @("start-level", "Big Mountain")

But I get your point, and we can remove the safety. If we don't want to add such guarantees, we should clearly communicate such expectations. I'll add it to the docs then.

I mean if you want, you can do some simple quoting but I probably wouldn't bother. It's not all that usual to have spaces in args for what we do here.

We can leave it as is. Is there anything else we should address before it can be merged?

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1

app-runner/Public/Invoke-DeviceApp.ps1

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1

vaind

I've found a couple of bugs and a few improvement ideas

Updated device provider APIs to consistently accept arguments as string arrays rather than pre-formatted strings, improving type safety and eliminating argument parsing ambiguities. Added ConvertArgumentsToString method to DeviceProvider base class for consistent string conversion when needed by underlying tools. Co-authored-by: Claude <claude@anthropic.com>

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1

Also relax Intent extras validation to only validate known patterns

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1

providers that don't support the LogFilePath parameter, and clarify in documentation that it's currently only supported on SauceLabs platforms.

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1

limbonaut · 2025-12-16T10:40:33Z

~~I think I broke arguments on iOS. I'll check.~~
Never mind.

vaind

Sorry for the late re-review. This looks pretty good to me but needs some tests for the new code (ideally against real SauceLabs, but unit tests would do too)

vaind · 2026-01-05T12:59:39Z

app-runner/Private/DeviceProviders/XboxProvider.ps1

+    [hashtable] RunApplication([string]$AppPath, [string[]]$Arguments, [string]$LogFilePath = $null) {
+	    if (-not ([string]::IsNullOrEmpty($LogFilePath))) {
+	        Write-Warning "LogFilePath parameter is not supported on this platform."
+	    }
+


this codeblock mixes tab & space separators, breaking the indent (2 vs 4) for some. Please use spaces instead to keep the indentation consistent across the repo.

vaind · 2026-01-05T13:01:33Z

app-runner/Private/AndroidHelpers.ps1

+
+            # Skip the key and value we just validated
+            $i += 2
+        }


Consider warning or a debug log in the "else" branch. Although, I guess since this is just a nice-to-nave anyway, maybe it's ok as is.

vaind · 2026-01-05T13:04:41Z

app-runner/Public/Invoke-DeviceApp.ps1

+    Array of arguments to pass to the executable when starting it.
+    The caller is responsible for quoting/escaping the arguments.
+    For example, if the executable requires arguments with spaces, they should be quoted:
+    Invoke-DeviceApp -ExecutablePath "Game.exe" -Arguments @('"/path/to/some file.txt"', '--debug')


Perfectly explained, thanks! 👍

vaind · 2026-01-05T13:42:44Z

app-runner/Tests/SauceLabs.Tests.ps1

        # Check iOS Fixture (not supported yet)
        # $iosFixture = Join-Path $PSScriptRoot 'Fixtures' 'iOS' 'TestApp.ipa'
        # if (Test-Path $iosFixture) {
        #     $TestTargets += Get-TestTarget `
        #         -Platform 'iOSSauceLabs' `
        #         -Target 'iPhone 13 Pro' `
        #         -FixturePath $iosFixture `
        #         -ExePath 'com.saucelabs.mydemoapp.ios' `
-        #         -Arguments '--test-arg value'
+        #         -Arguments @('--test-arg', 'value')


AFAIU this PR enables iOS support. Are you going to enable iOS tests in a followup PR? As currently the new code paths don't seem to be tested (CopyDeviceItems, LogFilePath and CheckAppFileSharingCapability)

limbonaut added 4 commits December 8, 2025 21:39

Fix argument splitting

3e5924a

Use proper parameter on iOS vs Android

663dac8

Implement CopyDeviceItem (iOS tested)

7dd6fe1

Add Android-specific diagnostics

a748051

limbonaut changed the title ~~feat: Implement CopyDeviceitem for Sauce Labs~~ feat: Implement CopyDeviceitem for Sauce Labs & fix issues Dec 10, 2025

limbonaut changed the title ~~feat: Implement CopyDeviceitem for Sauce Labs & fix issues~~ feat: Implement CopyDeviceItem for Sauce Labs & fix issues Dec 10, 2025

limbonaut marked this pull request as ready for review December 10, 2025 11:00

sentry bot reviewed Dec 10, 2025

View reviewed changes

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1 Outdated Show resolved Hide resolved

sentry bot reviewed Dec 10, 2025

View reviewed changes

app-runner/Private/DeviceProviders/AdbProvider.ps1 Outdated Show resolved Hide resolved

limbonaut changed the title ~~feat: Implement CopyDeviceItem for Sauce Labs & fix issues~~ Sauce: Implement CopyDeviceItem, log file parameter for RunApplication & fix issues Dec 10, 2025

limbonaut added 3 commits December 10, 2025 12:28

Undo changes in AdbProvider

4aee5ae

Restore comment

04087e8

Restore another comment

72f28c0

sentry bot reviewed Dec 10, 2025

View reviewed changes

app-runner/Public/Invoke-DeviceApp.ps1 Outdated Show resolved Hide resolved

limbonaut and others added 2 commits December 10, 2025 12:48

limbonaut requested review from tustanivsky and vaind December 10, 2025 12:06

Remove outdated warning - args are supported on iOS

c88f48c

limbonaut mentioned this pull request Dec 10, 2025

test: Adjustments for iOS end-to-end testing getsentry/sentry-godot#461

Open

vaind reviewed Dec 12, 2025

View reviewed changes

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1 Show resolved Hide resolved

vaind reviewed Dec 12, 2025

View reviewed changes

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1 Show resolved Hide resolved

vaind reviewed Dec 12, 2025

View reviewed changes

app-runner/Public/Invoke-DeviceApp.ps1 Show resolved Hide resolved

vaind reviewed Dec 12, 2025

View reviewed changes

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1 Outdated Show resolved Hide resolved

vaind reviewed Dec 12, 2025

View reviewed changes

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1 Outdated Show resolved Hide resolved

vaind requested changes Dec 12, 2025

View reviewed changes

sentry bot reviewed Dec 13, 2025

View reviewed changes

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1 Outdated Show resolved Hide resolved

limbonaut added 6 commits December 15, 2025 17:15

Extract argument conversion to standalone function

2b15f36

Also relax Intent extras validation to only validate known patterns

Fix app name resolution logic in SauceLabsProvider

1910626

Use Write-Warning

6352e57

Update AndroidHelpers.Tests.ps1

fc1ccac

Fix typo in test filename

8310373

Remove debug preference configuration from tests

bb84b7c

sentry bot reviewed Dec 15, 2025

View reviewed changes

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1 Outdated Show resolved Hide resolved

limbonaut added 5 commits December 15, 2025 20:10

Simplify Appium request body construction

5546947

Fix tests

57ae3b5

Print log grouped in GHA

ebb2875

Fix indentation and improve log output handling

d28c68e

Warn when LogFilePath parameter is unsupported Add warnings to device

ad71c2a

providers that don't support the LogFilePath parameter, and clarify in documentation that it's currently only supported on SauceLabs platforms.

limbonaut force-pushed the limbonaut-ios-sauce branch from 7988845 to ad71c2a Compare December 15, 2025 20:40

limbonaut added 3 commits December 15, 2025 22:39

Remove argument guarantees and document expectations

8b18f2d

Revert tests

a45e24d

Revert more tests

e20da39

sentry bot reviewed Dec 16, 2025

View reviewed changes

app-runner/Private/DeviceProviders/SauceLabsProvider.ps1 Show resolved Hide resolved

Fix test

dbbcac8

vaind self-requested a review December 19, 2025 12:10

vaind reviewed Jan 5, 2026

View reviewed changes

Uh oh!

Sauce: Implement CopyDeviceItem, log file parameter for RunApplication & fix issues #32

Are you sure you want to change the base?

Sauce: Implement CopyDeviceItem, log file parameter for RunApplication & fix issues #32

Conversation

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

limbonaut commented Dec 11, 2025

Uh oh!

vaind commented Dec 12, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vaind left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

vaind left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

limbonaut commented Dec 10, 2025 •

edited

Loading

vaind Dec 15, 2025 •

edited

Loading

vaind Dec 16, 2025 •

edited

Loading

limbonaut commented Dec 16, 2025 •

edited

Loading