Uh oh!
There was an error while loading. Please reload this page.
This repository was archived by the owner on Jul 13, 2026. It is now read-only.
- Notifications
You must be signed in to change notification settings - Fork 36
Add ADB reverse port forwarding support#305
Merged
Uh oh!
There was an error while loading. Please reload this page.
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
80af309
Add ADB reverse port forwarding support to AdbRunner
rmarinho 7ed82e0
Improve ADB reverse port API: record type, string overloads, more tests
rmarinho db1fe6b
Refactor ADB port forwarding API: strongly typed AdbPortSpec + AdbPor…
rmarinho c359344
Simplify port API: keep only AdbPortSpec overloads
rmarinho 8a30a7e
Include stdout in ListReversePortsAsync error diagnostics
rmarinho c36090a
Address Copilot review: split files, throw on invalid protocol, nulla…
rmarinho 3bf763c
Address Copilot review round 3: remove null-forgiving, validate port …
rmarinho 15af817
Address Copilot review round 4: whitespace-tolerant parsing, tab test
rmarinho 733b982
Address @jonathanpeppers review: TCP-only enum, add ToSocketSpec tests
rmarinho 51f8c72
Apply suggestion from @jonathanpeppers
jonathanpeppers 1194140
Fix syntax error in FormattableString.Invariant call
rmarinho File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
22 changes: 22 additions & 0 deletions
22 src/Xamarin.Android.Tools.AndroidSdk/PublicAPI/net10.0/PublicAPI.Unshipped.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
22 changes: 22 additions & 0 deletions
22 src/Xamarin.Android.Tools.AndroidSdk/PublicAPI/netstandard2.0/PublicAPI.Unshipped.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| namespace Xamarin.Android.Tools; | ||
| /// <summary> | ||
| /// Represents an adb port forwarding rule as reported by 'adb reverse --list' or 'adb forward --list'. | ||
| /// </summary> | ||
| public record AdbPortRule (AdbPortSpec Remote, AdbPortSpec Local); | ||
49 changes: 49 additions & 0 deletions
49 src/Xamarin.Android.Tools.AndroidSdk/Runners/AdbPortSpec.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| using System; | ||
| namespace Xamarin.Android.Tools; | ||
| /// <summary> | ||
| /// Represents a port and protocol pair for adb forwarding/reverse operations. | ||
| /// </summary> | ||
| public record AdbPortSpec (AdbProtocol Protocol, int Port) | ||
| { | ||
| /// <summary> | ||
| /// Returns the adb socket spec string, e.g. "tcp:5000". | ||
| /// </summary> | ||
| public string ToSocketSpec () => Protocol switch { | ||
| AdbProtocol.Tcp => FormattableString.Invariant ($"tcp:{Port}"), | ||
| _ => throw new ArgumentOutOfRangeException (nameof (Protocol), Protocol, $"Unsupported ADB protocol: {Protocol}"), | ||
rmarinho marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. jonathanpeppers marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| }; | ||
jonathanpeppers marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| /// <summary> | ||
| /// Parses an adb socket spec string like "tcp:5000" into an <see cref="AdbPortSpec"/>. | ||
| /// Returns null if the format is unrecognized. | ||
| /// </summary> | ||
| public static AdbPortSpec? TryParse (string? socketSpec) | ||
rmarinho marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| { | ||
| if (socketSpec is not { Length: > 0 } value || string.IsNullOrWhiteSpace (value)) | ||
| return null; | ||
| var colonIndex = value.IndexOf (':'); | ||
| if (colonIndex <= 0 || colonIndex >= value.Length - 1) | ||
| return null; | ||
| var protocolStr = value.Substring (0, colonIndex); | ||
| var portStr = value.Substring (colonIndex + 1); | ||
| if (!int.TryParse (portStr, out var port) || port <= 0 || port > 65535) | ||
| return null; | ||
| var protocol = protocolStr.ToLowerInvariant () switch { | ||
| "tcp" => (AdbProtocol?) AdbProtocol.Tcp, | ||
| _ => null, | ||
| }; | ||
| return protocol.HasValue ? new AdbPortSpec (protocol.Value, port) : null; | ||
| } | ||
| public override string ToString () => ToSocketSpec (); | ||
| } | ||
15 changes: 15 additions & 0 deletions
15 src/Xamarin.Android.Tools.AndroidSdk/Runners/AdbProtocol.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
| namespace Xamarin.Android.Tools; | ||
| /// <summary> | ||
| /// Protocol types supported by adb port forwarding and reverse port forwarding. | ||
| /// </summary> | ||
| public enum AdbProtocol | ||
| { | ||
| /// <summary> | ||
| /// TCP socket spec, e.g. "tcp:5000". | ||
| /// </summary> | ||
| Tcp, | ||
| } | ||
jonathanpeppers marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
111 changes: 111 additions & 0 deletions
111 src/Xamarin.Android.Tools.AndroidSdk/Runners/AdbRunner.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -244,6 +244,117 @@ public async Task StopEmulatorAsync (string serial, CancellationToken cancellati | ||
| return null; | ||
| } | ||
| /// <summary> | ||
| /// Sets up reverse port forwarding via 'adb -s <serial> reverse <remote> <local>'. | ||
| /// </summary> | ||
| /// <param name="serial">Device serial number.</param> | ||
| /// <param name="remote">Remote (device-side) port spec.</param> | ||
| /// <param name="local">Local (host-side) port spec.</param> | ||
| /// <param name="cancellationToken">Cancellation token.</param> | ||
| public virtual async Task ReversePortAsync (string serial, AdbPortSpec remote, AdbPortSpec local, CancellationToken cancellationToken = default) | ||
| { | ||
rmarinho marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| if (string.IsNullOrWhiteSpace (serial)) | ||
| throw new ArgumentException ("Serial must not be empty.", nameof (serial)); | ||
| if (remote is null) | ||
| throw new ArgumentNullException (nameof (remote)); | ||
| if (local is null) | ||
| throw new ArgumentNullException (nameof (local)); | ||
| if (remote.Port <= 0 || remote.Port > 65535) | ||
| throw new ArgumentOutOfRangeException (nameof (remote), remote.Port, "Port must be between 1 and 65535."); | ||
| if (local.Port <= 0 || local.Port > 65535) | ||
| throw new ArgumentOutOfRangeException (nameof (local), local.Port, "Port must be between 1 and 65535."); | ||
| var psi = ProcessUtils.CreateProcessStartInfo (adbPath, "-s", serial, "reverse", remote.ToSocketSpec (), local.ToSocketSpec ()); | ||
| using var stderr = new StringWriter (); | ||
| var exitCode = await ProcessUtils.StartProcess (psi, null, stderr, cancellationToken, environmentVariables).ConfigureAwait (false); | ||
| ProcessUtils.ThrowIfFailed (exitCode, $"adb -s {serial} reverse {remote} {local}", stderr); | ||
rmarinho marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| } | ||
| /// <summary> | ||
| /// Removes a specific reverse port forwarding rule via | ||
| /// 'adb -s <serial> reverse --remove <remote>'. | ||
| /// </summary> | ||
| /// <param name="serial">Device serial number.</param> | ||
| /// <param name="remote">Remote (device-side) port spec to remove.</param> | ||
| /// <param name="cancellationToken">Cancellation token.</param> | ||
| public virtual async Task RemoveReversePortAsync (string serial, AdbPortSpec remote, CancellationToken cancellationToken = default) | ||
| { | ||
| if (string.IsNullOrWhiteSpace (serial)) | ||
| throw new ArgumentException ("Serial must not be empty.", nameof (serial)); | ||
| if (remote is null) | ||
| throw new ArgumentNullException (nameof (remote)); | ||
| if (remote.Port <= 0 || remote.Port > 65535) | ||
| throw new ArgumentOutOfRangeException (nameof (remote), remote.Port, "Port must be between 1 and 65535."); | ||
| var psi = ProcessUtils.CreateProcessStartInfo (adbPath, "-s", serial, "reverse", "--remove", remote.ToSocketSpec ()); | ||
| using var stderr = new StringWriter (); | ||
| var exitCode = await ProcessUtils.StartProcess (psi, null, stderr, cancellationToken, environmentVariables).ConfigureAwait (false); | ||
| ProcessUtils.ThrowIfFailed (exitCode, $"adb -s {serial} reverse --remove {remote}", stderr); | ||
rmarinho marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| } | ||
| /// <summary> | ||
| /// Removes all reverse port forwarding rules via | ||
| /// 'adb -s <serial> reverse --remove-all'. | ||
| /// </summary> | ||
| public virtual async Task RemoveAllReversePortsAsync (string serial, CancellationToken cancellationToken = default) | ||
| { | ||
| if (string.IsNullOrWhiteSpace (serial)) | ||
| throw new ArgumentException ("Serial must not be empty.", nameof (serial)); | ||
| var psi = ProcessUtils.CreateProcessStartInfo (adbPath, "-s", serial, "reverse", "--remove-all"); | ||
| using var stderr = new StringWriter (); | ||
| var exitCode = await ProcessUtils.StartProcess (psi, null, stderr, cancellationToken, environmentVariables).ConfigureAwait (false); | ||
| ProcessUtils.ThrowIfFailed (exitCode, $"adb -s {serial} reverse --remove-all", stderr); | ||
| } | ||
| /// <summary> | ||
| /// Lists all active reverse port forwarding rules via | ||
| /// 'adb -s <serial> reverse --list'. | ||
| /// </summary> | ||
| public virtual async Task<IReadOnlyList<AdbPortRule>> ListReversePortsAsync (string serial, CancellationToken cancellationToken = default) | ||
| { | ||
| if (string.IsNullOrWhiteSpace (serial)) | ||
| throw new ArgumentException ("Serial must not be empty.", nameof (serial)); | ||
| using var stdout = new StringWriter (); | ||
| using var stderr = new StringWriter (); | ||
| var psi = ProcessUtils.CreateProcessStartInfo (adbPath, "-s", serial, "reverse", "--list"); | ||
| var exitCode = await ProcessUtils.StartProcess (psi, stdout, stderr, cancellationToken, environmentVariables).ConfigureAwait (false); | ||
| ProcessUtils.ThrowIfFailed (exitCode, $"adb -s {serial} reverse --list", stderr, stdout); | ||
| return ParseReverseListOutput (stdout.ToString ().Split ('\n')); | ||
| } | ||
| /// <summary> | ||
| /// Parses the output of 'adb reverse --list'. | ||
| /// Each line is "(reverse) <remote> <local>", e.g. "(reverse) tcp:5000 tcp:5000". | ||
| /// Lines with unparseable socket specs are skipped. | ||
| /// </summary> | ||
| internal static IReadOnlyList<AdbPortRule> ParseReverseListOutput (IEnumerable<string> lines) | ||
| { | ||
| var rules = new List<AdbPortRule> (); | ||
| foreach (var line in lines) { | ||
| var trimmed = line.Trim (); | ||
| if (string.IsNullOrEmpty (trimmed)) | ||
| continue; | ||
| // Expected format: "(reverse) tcp:5000 tcp:5000" | ||
| if (!trimmed.StartsWith ("(reverse)", StringComparison.Ordinal)) | ||
| continue; | ||
| var parts = trimmed.Substring ("(reverse)".Length).Trim ().Split ((char[]?) null, StringSplitOptions.RemoveEmptyEntries); | ||
| if (parts.Length >= 2) { | ||
| var remote = AdbPortSpec.TryParse (parts [0]); | ||
| var local = AdbPortSpec.TryParse (parts [1]); | ||
| if (remote is { } r && local is { } l) | ||
| rules.Add (new AdbPortRule (r, l)); | ||
| } | ||
| } | ||
| return rules; | ||
| } | ||
| /// <summary> | ||
| /// Parses the output lines from 'adb devices -l'. | ||
| /// Accepts an <see cref="IEnumerable{T}"/> to avoid allocating a joined string. | ||
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.