Skip to content

Add AvdManagerRunner.ListDeviceProfilesAsync() for device profile enumeration #325

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

Merged
jonathanpeppers merged 2 commits into from
May 4, 2026
Merged

Add AvdManagerRunner.ListDeviceProfilesAsync() for device profile enumeration #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca2c633
Add AvdManagerRunner.ListDeviceProfilesAsync() for device profile enu…
rmarinho Apr 8, 2026
1a02529
Merge branch 'main' into features/321-list-device-profiles
rmarinho Apr 30, 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
9 changes: 9 additions & 0 deletions src/Xamarin.Android.Tools.AndroidSdk/Models/AvdDeviceProfile.cs
View file
Open in desktop
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 a hardware device profile (e.g., "pixel_7", "Nexus 5X") from <c>avdmanager list device --compact</c>.
/// </summary>
public record AvdDeviceProfile (string Id);
Comment thread
jonathanpeppers marked this conversation as resolved.
5 changes: 5 additions & 0 deletions src/Xamarin.Android.Tools.AndroidSdk/PublicAPI/net10.0/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,3 +199,8 @@ virtual Xamarin.Android.Tools.AdbRunner.ListReversePortsAsync(string! serial, Sy
virtual Xamarin.Android.Tools.AdbRunner.RemoveAllReversePortsAsync(string! serial, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
virtual Xamarin.Android.Tools.AdbRunner.RemoveReversePortAsync(string! serial, Xamarin.Android.Tools.AdbPortSpec! remote, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
virtual Xamarin.Android.Tools.AdbRunner.ReversePortAsync(string! serial, Xamarin.Android.Tools.AdbPortSpec! remote, Xamarin.Android.Tools.AdbPortSpec! local, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
Xamarin.Android.Tools.AvdManagerRunner.ListDeviceProfilesAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Xamarin.Android.Tools.AvdDeviceProfile!>!>!
Xamarin.Android.Tools.AvdDeviceProfile
Xamarin.Android.Tools.AvdDeviceProfile.AvdDeviceProfile(string! Id) -> void
Xamarin.Android.Tools.AvdDeviceProfile.Id.get -> string!
Xamarin.Android.Tools.AvdDeviceProfile.Id.init -> void
Comment thread
jonathanpeppers marked this conversation as resolved.
5 changes: 5 additions & 0 deletions src/Xamarin.Android.Tools.AndroidSdk/PublicAPI/netstandard2.0/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,3 +199,8 @@ virtual Xamarin.Android.Tools.AdbRunner.ListReversePortsAsync(string! serial, Sy
virtual Xamarin.Android.Tools.AdbRunner.RemoveAllReversePortsAsync(string! serial, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
virtual Xamarin.Android.Tools.AdbRunner.RemoveReversePortAsync(string! serial, Xamarin.Android.Tools.AdbPortSpec! remote, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
virtual Xamarin.Android.Tools.AdbRunner.ReversePortAsync(string! serial, Xamarin.Android.Tools.AdbPortSpec! remote, Xamarin.Android.Tools.AdbPortSpec! local, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
Xamarin.Android.Tools.AvdManagerRunner.ListDeviceProfilesAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Xamarin.Android.Tools.AvdDeviceProfile!>!>!
Xamarin.Android.Tools.AvdDeviceProfile
Xamarin.Android.Tools.AvdDeviceProfile.AvdDeviceProfile(string! Id) -> void
Xamarin.Android.Tools.AvdDeviceProfile.Id.get -> string!
Xamarin.Android.Tools.AvdDeviceProfile.Id.init -> void
Comment thread
jonathanpeppers marked this conversation as resolved.
29 changes: 29 additions & 0 deletions src/Xamarin.Android.Tools.AndroidSdk/Runners/AvdManagerRunner.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,35 @@ public async Task DeleteAvdAsync (string name, CancellationToken cancellationTok
ProcessUtils.ThrowIfFailed (exitCode, $"avdmanager delete avd --name {name}", stderr);
}

/// <summary>
/// Lists available device profiles (hardware definitions) using <c>avdmanager list device --compact</c>.
/// </summary>
public async Task<IReadOnlyList<AvdDeviceProfile>> ListDeviceProfilesAsync (CancellationToken cancellationToken = default)
{
Comment on lines +125 to +129
using var stdout = new StringWriter ();
using var stderr = new StringWriter ();
var psi = ProcessUtils.CreateProcessStartInfo (avdManagerPath, "list", "device", "--compact");
logger.Invoke (TraceLevel.Verbose, "Running: avdmanager list device --compact");
var exitCode = await ProcessUtils.StartProcess (psi, stdout, stderr, cancellationToken, environmentVariables).ConfigureAwait (false);

ProcessUtils.ThrowIfFailed (exitCode, "avdmanager list device --compact", stderr, stdout);
Copy link
Copy Markdown

@github-actions github-actions Bot Apr 30, 2026

Choose a reason for hiding this comment

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

🤖 💡 Pattern — Nice: passing both stderr and stdout to ThrowIfFailed follows the recommended convention for including all output in error diagnostics. Worth noting that the existing ListAvdsAsync (line 46) only passes stderr — a follow-up PR could bring it in line with this improved pattern.

Rule: Include stdout in error diagnostics (Postmortem #48)


return ParseCompactDeviceListOutput (stdout.ToString ());
}

internal static IReadOnlyList<AvdDeviceProfile> ParseCompactDeviceListOutput (string output)
{
var profiles = new List<AvdDeviceProfile> ();

foreach (var line in output.Split ('\n')) {
var trimmed = line.Trim ();
if (trimmed.Length > 0)
profiles.Add (new AvdDeviceProfile (trimmed));
}

return profiles;
}

internal static IReadOnlyList<AvdInfo> ParseAvdListOutput (string output)
{
var avds = new List<AvdInfo> ();
Expand Down
57 changes: 57 additions & 0 deletions tests/Xamarin.Android.Tools.AndroidSdk-Tests/AvdManagerRunnerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,4 +293,61 @@ public void FindCmdlineTool_PrefersStableOverPreRelease ()
Directory.Delete (tempDir, true);
}
}

[Test]
public void ParseCompactDeviceListOutput_MultipleProfiles ()
{
var output =
"automotive_1024p_landscape\n" +
"pixel_7\n" +
"Nexus 5X\n" +
"Galaxy Nexus\n";

var profiles = AvdManagerRunner.ParseCompactDeviceListOutput (output);

Assert.AreEqual (4, profiles.Count);
Assert.AreEqual ("automotive_1024p_landscape", profiles [0].Id);
Assert.AreEqual ("pixel_7", profiles [1].Id);
Assert.AreEqual ("Nexus 5X", profiles [2].Id);
Assert.AreEqual ("Galaxy Nexus", profiles [3].Id);
}

[Test]
public void ParseCompactDeviceListOutput_EmptyOutput ()
{
var profiles = AvdManagerRunner.ParseCompactDeviceListOutput ("");
Assert.AreEqual (0, profiles.Count);
}

[Test]
public void ParseCompactDeviceListOutput_WindowsNewlines ()
{
var output =
"pixel_fold\r\n" +
"pixel_9_pro\r\n";

var profiles = AvdManagerRunner.ParseCompactDeviceListOutput (output);

Assert.AreEqual (2, profiles.Count);
Assert.AreEqual ("pixel_fold", profiles [0].Id);
Assert.AreEqual ("pixel_9_pro", profiles [1].Id);
}

[Test]
public void ParseCompactDeviceListOutput_SkipsBlankLines ()
{
var output = "\n\npixel_7\n\n";

var profiles = AvdManagerRunner.ParseCompactDeviceListOutput (output);

Assert.AreEqual (1, profiles.Count);
Assert.AreEqual ("pixel_7", profiles [0].Id);
}

[Test]
public void ParseCompactDeviceListOutput_ReturnsIReadOnlyList ()
{
var profiles = AvdManagerRunner.ParseCompactDeviceListOutput ("");
Assert.IsInstanceOf<IReadOnlyList<AvdDeviceProfile>> (profiles);
}
}