[dotnet-run] implement "device" selection logic by jonathanpeppers · Pull Request #51914 · dotnet/sdk

jonathanpeppers · 2025-11-25T20:20:18Z

Context: https://github.com/dotnet/sdk/blob/5398e10de90dc9a27e0290ad55c2ae67360ea8be/documentation/specs/dotnet-run-for-maui.md

Spec Changes

Added RuntimeIdentifier Support

Examples to include %(RuntimeIdentifier) metadata (e.g., android-arm64, ios-arm64, iossimulator-arm64)
When a device provides a %(RuntimeIdentifier), it will be passed as -p:RuntimeIdentifier to subsequent MSBuild steps (build, deploy, ComputeRunArguments, run)
%(RuntimeIdentifier) is optional but recommended

Added Binary Logs Documentation

Added new section "Binary Logs for Device Selection" explaining:
- When binlog files are created (when using -bl: with dotnet run)
- The naming pattern: <base-name>-dotnet-run-devices.binlog

Implementation

Renamed TargetFrameworkSelector to RunCommandSelector

Expanded scope from just framework selection to handle both target framework and device selection
Made it a non-static class implementing IDisposable to:
- Cache the MSBuild project instance across operations
- Avoid loading/evaluating the project multiple times, except when global properties change
- Properly manage MSBuild resources (ProjectCollection, Project, ProjectInstance) with IDisposable
Added InvalidateGlobalProperties() method to re-evaluate the project when needed with a $(TargetFramework) global property change.
Binary logger is owned by the selector instance and properly disposed.

Added Tests

Mock test project (DotnetRunDevices.csproj) implements ComputeAvailableDevices target that returns hardcoded device items based on the target framework
Test project includes GenerateDeviceInfo target that runs during build when a device is selected:
- Generates DeviceInfo.cs with constants for $(Device) and $(RuntimeIdentifier) properties
- Writes to intermediate output directory before compilation
Test application prints these generated constants, allowing tests to verify that:
- The correct device ID was passed to MSBuild
- $(RuntimeIdentifier) was propagated correctly (when provided by device)
- Multi-targeted apps can have different devices per framework

Context: https://github.com/dotnet/sdk/blob/5398e10de90dc9a27e0290ad55c2ae67360ea8be/documentation/specs/dotnet-run-for-maui.md ~~ Spec Changes ~~ **Added RuntimeIdentifier Support** - Examples to include `%(RuntimeIdentifier)` metadata (e.g., `android-arm64`, `ios-arm64`, `iossimulator-arm64`) - When a device provides a `%(RuntimeIdentifier)`, it will be passed as `-p:RuntimeIdentifier` to subsequent MSBuild steps (build, deploy, ComputeRunArguments, run) - `%(RuntimeIdentifier)` is optional but recommended **Added Binary Logs Documentation** - Added new section "Binary Logs for Device Selection" explaining: - When binlog files are created (when using `-bl:` with `dotnet run`) - The naming pattern: `<base-name>-dotnet-run-devices.binlog` ~~ Implementation ~~ **Renamed `TargetFrameworkSelector` to `RunCommandSelector`** - Expanded scope from just framework selection to handle both target framework and device selection - Made it a non-static class implementing `IDisposable` to: - Cache the MSBuild project instance across operations - Avoid loading/evaluating the project multiple times, except when global properties change - Properly manage MSBuild resources (ProjectCollection, Project, ProjectInstance) with `IDisposable` - Added `InvalidateGlobalProperties()` method to re-evaluate the project when needed with a `$(TargetFramework)` global property change. - Binary logger is owned by the `selector` instance and properly disposed. **Added Tests** - Mock test project (`DotnetRunDevices.csproj`) implements `ComputeAvailableDevices` target that returns hardcoded device items based on the target framework - Test project includes `GenerateDeviceInfo` target that runs during build when a device is selected: - Generates `DeviceInfo.cs` with constants for `$(Device)` and `$(RuntimeIdentifier)` properties - Writes to intermediate output directory before compilation - Test application prints these generated constants, allowing tests to verify that: - The correct device ID was passed to MSBuild - `$(RuntimeIdentifier)` was propagated correctly (when provided by device) - Multi-targeted apps can have different devices per framework

Copilot

Pull request overview

This PR implements device selection logic for dotnet run, enabling MAUI and other workloads to target specific devices (emulators, simulators, physical devices). The implementation renames TargetFrameworkSelector to RunCommandSelector and expands its scope to handle both target framework and device selection with efficient project instance caching.

Key changes:

Added --device and --list-devices command-line options to dotnet run
Implemented RunCommandSelector class with device enumeration via MSBuild's ComputeAvailableDevices target
Added RuntimeIdentifier propagation from device metadata to subsequent build steps
Comprehensive test coverage including multi-framework device selection scenarios

Reviewed changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/Cli/dotnet/Commands/Run/RunCommandSelector.cs	New class handling both framework and device selection with project instance caching and IDisposable pattern
src/Cli/dotnet/Commands/Run/RunCommand.cs	Integrated device selection logic into run command workflow with proper binlog support
src/Cli/dotnet/Commands/Run/RunCommandParser.cs	Added DeviceOption and ListDevicesOption to command parser
src/Cli/dotnet/Commands/CliCommandStrings.resx	Added localization strings for device-related messages and prompts
src/Cli/dotnet/Commands/xlf/*.xlf	Updated localization files with new device-related string entries (state="new")
src/Cli/Microsoft.DotNet.Cli.Utils/Constants.cs	Added ComputeAvailableDevices MSBuild target constant
test/dotnet.Tests/CommandTests/Run/GivenDotnetRunSelectsDevice.cs	Comprehensive integration tests covering device selection scenarios
test/TestAssets/TestProjects/DotnetRunDevices/*	Test project with mock device enumeration and code generation
documentation/specs/dotnet-run-for-maui.md	Updated spec with RuntimeIdentifier metadata and binlog documentation
test/dotnet.Tests/CompletionTests/snapshots/*	Updated shell completion snapshots for new device options

src/Cli/dotnet/Commands/Run/RunCommand.cs

src/Cli/dotnet/Commands/Run/RunCommandSelector.cs

src/Cli/dotnet/Commands/xlf/CliCommandStrings.ja.xlf

src/Cli/dotnet/Commands/Run/RunCommandSelector.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

net8.0 target framework was crashing due to lack of Rosetta x64 -> arm64 translation. I think we can just use net9.0 + "current" instead

Seeing if this fixes macOS arm64

documentation/specs/dotnet-run-for-maui.md

jonathanpeppers · 2025-12-02T17:33:40Z

After some manual editing workloads, end-to-end is working:

Left emulator, right is device w/ Vysor:

I need to do some cleanup in the Android workload to get the casing to match. adb -s ... emu avd name seems to just print lowercase.

Context: dotnet/sdk#51337 Context: dotnet/sdk#51914 In 63f7cba, we added the `ComputeAvailableDevices` MSBuild target, which I was able to test end-to-end: D:\src\helloandroid> D:\src\dotnet\sdk\artifacts\bin\redist\Debug\dotnet\dotnet.exe run -bl Select a device to run on: > 0A041FDD400327 - Pixel 5 emulator-5554 - pixel 7 - api 36 Type to search Unfortunately, the AVD name is returned from `adb emu avd name`, which simply returns the property: > adb -s emulator-5554 shell getprop | grep avd_name [ro.boot.qemu.avd_name]: [pixel_7_-_api_36] We can call `TextInfo.ToTitleCase()`, replace underscores with spaces, and replace "Api" with "API" to make the AVD name more user-friendly. The only other alternative I considered was parsing the `~/.android/avd/<name>.ini` file to get the `displayname` property, but it would still require calling `adb emu avd name` to *get* the path to this `.ini` file. It felt more straightforward to just format the AVD name directly.

documentation/specs/dotnet-run-for-maui.md

src/Cli/dotnet/Commands/Run/RunCommandSelector.cs

Context: dotnet/sdk#51337 Context: dotnet/sdk#51914 In 63f7cba, we added the `ComputeAvailableDevices` MSBuild target, which I was able to test end-to-end: D:\src\helloandroid> D:\src\dotnet\sdk\artifacts\bin\redist\Debug\dotnet\dotnet.exe run -bl Select a device to run on: > 0A041FDD400327 - Pixel 5 emulator-5554 - pixel 7 - api 36 Type to search Unfortunately, the AVD name is returned from `adb emu avd name`, which simply returns the property: > adb -s emulator-5554 shell getprop | grep avd_name [ro.boot.qemu.avd_name]: [pixel_7_-_api_36] We can call `TextInfo.ToTitleCase()`, replace underscores with spaces, and replace "Api" with "API" to make the AVD name more user-friendly. The only other alternative I considered was parsing the `~/.android/avd/<name>.ini` file to get the `displayname` property, but it would still require calling `adb emu avd name` to *get* the path to this `.ini` file. It felt more straightforward to just format the AVD name directly.

src/Cli/dotnet/Commands/Run/RunCommandSelector.cs

baronfel

This looks very clean, thanks for taking this on! Excited to see the end to end get better for mobile app developers :)

baronfel · 2025-12-04T15:58:03Z

I'd still like someone from SDK engineering to review as well.

Context: https://github.com/dotnet/sdk/blob/5398e10de90dc9a27e0290ad55c2ae67360ea8be/documentation/specs/dotnet-run-for-maui.md **Added RuntimeIdentifier Support** - Examples to include `%(RuntimeIdentifier)` metadata (e.g., `android-arm64`, `ios-arm64`, `iossimulator-arm64`) - When a device provides a `%(RuntimeIdentifier)`, it will be passed as `-p:RuntimeIdentifier` to subsequent MSBuild steps (build, deploy, ComputeRunArguments, run) - `%(RuntimeIdentifier)` is optional but recommended **Added Binary Logs Documentation** - Added new section "Binary Logs for Device Selection" explaining: - When binlog files are created (when using `-bl:` with `dotnet run`) **Renamed `TargetFrameworkSelector` to `RunCommandSelector`** - Expanded scope from just framework selection to handle both target framework and device selection - Made it a non-static class implementing `IDisposable` to: - Cache the MSBuild project instance across operations - Avoid loading/evaluating the project multiple times, except when global properties change - Properly manage MSBuild resources (ProjectCollection, Project, ProjectInstance) with `IDisposable` - Added `InvalidateGlobalProperties()` method to re-evaluate the project when needed with a `$(TargetFramework)` global property change. - Binary logger is owned by the `selector` instance and properly disposed. **Added Tests** - Mock test project (`DotnetRunDevices.csproj`) implements `ComputeAvailableDevices` target that returns hardcoded device items based on the target framework - Test project includes `GenerateDeviceInfo` target that runs during build when a device is selected: - Generates `DeviceInfo.cs` with constants for `$(Device)` and `$(RuntimeIdentifier)` properties - Writes to intermediate output directory before compilation - Test application prints these generated constants, allowing tests to verify that: - The correct device ID was passed to MSBuild - `$(RuntimeIdentifier)` was propagated correctly (when provided by device) - Multi-targeted apps can have different devices per framework

Context: https://github.com/dotnet/sdk/blob/5398e10de90dc9a27e0290ad55c2ae67360ea8be/documentation/specs/dotnet-run-for-maui.md **Added RuntimeIdentifier Support** - Examples to include `%(RuntimeIdentifier)` metadata (e.g., `android-arm64`, `ios-arm64`, `iossimulator-arm64`) - When a device provides a `%(RuntimeIdentifier)`, it will be passed as `-p:RuntimeIdentifier` to subsequent MSBuild steps (build, deploy, ComputeRunArguments, run) - `%(RuntimeIdentifier)` is optional but recommended **Added Binary Logs Documentation** - Added new section "Binary Logs for Device Selection" explaining: - When binlog files are created (when using `-bl:` with `dotnet run`) **Renamed `TargetFrameworkSelector` to `RunCommandSelector`** - Expanded scope from just framework selection to handle both target framework and device selection - Made it a non-static class implementing `IDisposable` to: - Cache the MSBuild project instance across operations - Avoid loading/evaluating the project multiple times, except when global properties change - Properly manage MSBuild resources (ProjectCollection, Project, ProjectInstance) with `IDisposable` - Added `InvalidateGlobalProperties()` method to re-evaluate the project when needed with a `$(TargetFramework)` global property change. - Binary logger is owned by the `selector` instance and properly disposed. **Added Tests** - Mock test project (`DotnetRunDevices.csproj`) implements `ComputeAvailableDevices` target that returns hardcoded device items based on the target framework - Test project includes `GenerateDeviceInfo` target that runs during build when a device is selected: - Generates `DeviceInfo.cs` with constants for `$(Device)` and `$(RuntimeIdentifier)` properties - Writes to intermediate output directory before compilation - Test application prints these generated constants, allowing tests to verify that: - The correct device ID was passed to MSBuild - `$(RuntimeIdentifier)` was propagated correctly (when provided by device) - Multi-targeted apps can have different devices per framework Update bash completion snapshot with trailing space

Context: dotnet/sdk#51337 Context: dotnet/sdk#51914 In 63f7cba, we added the `ComputeAvailableDevices` MSBuild target, which I was able to test end-to-end: D:\src\helloandroid> D:\src\dotnet\sdk\artifacts\bin\redist\Debug\dotnet\dotnet.exe run -bl Select a device to run on: > 0A041FDD400327 - Pixel 5 emulator-5554 - pixel 7 - api 36 Type to search Unfortunately, the AVD name is returned from `adb emu avd name`, which simply returns the property: > adb -s emulator-5554 shell getprop | grep avd_name [ro.boot.qemu.avd_name]: [pixel_7_-_api_36] We can call `TextInfo.ToTitleCase()`, replace underscores with spaces, and replace "Api" with "API" to make the AVD name more user-friendly. The only other alternative I considered was parsing the `~/.android/avd/<name>.ini` file to get the `displayname` property, but it would still require calling `adb emu avd name` to *get* the path to this `.ini` file. It felt more straightforward to just format the AVD name directly.

Backports these that are already in main/.NET 11: * #51914 * #52113 * #52046

github-actions bot added the Area-CLI label Nov 25, 2025

jonathanpeppers force-pushed the dev/peppers/dotnet-run-devices branch from 5048a76 to 43482d4 Compare November 25, 2025 21:46

jonathanpeppers marked this pull request as ready for review November 25, 2025 23:30

jonathanpeppers requested review from baronfel, Copilot and rolfbjarne November 25, 2025 23:30

Copilot started reviewing on behalf of jonathanpeppers November 25, 2025 23:30 View session

Copilot finished reviewing on behalf of jonathanpeppers November 25, 2025 23:33

Copilot AI reviewed Nov 25, 2025

View reviewed changes

jonathanpeppers and others added 3 commits November 25, 2025 19:34

Apply suggestions from code review

f184fd0

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Simplify tests for macOS arm64

94ef0e9

net8.0 target framework was crashing due to lack of Rosetta x64 -> arm64 translation. I think we can just use net9.0 + "current" instead

Make "current" target framework the default

17b0edc

Seeing if this fixes macOS arm64

baronfel reviewed Dec 1, 2025

View reviewed changes

documentation/specs/dotnet-run-for-maui.md Outdated Show resolved Hide resolved

jonathanpeppers added 6 commits December 1, 2025 16:07

Store everything in a single .binlog

e154617

Update tests

7264d8c

Fix "double-shutdown" of logger

de396aa

Remove _disposed flag, unnecessary

821ca29

Merge branch 'main' into dev/peppers/dotnet-run-devices

462c9ab

Fix logger for file-based runs (.cs files)

cae5e26

build-analysis bot mentioned this pull request Dec 2, 2025

Test failing in CI: Microsoft.DotNet.Tests.PackagedCommandTests.CanInvokeToolWhosePackageNameIsDifferentFromDllName : Tool with output name! #51146

Open

jonathanpeppers mentioned this pull request Dec 2, 2025

[Epic] vibe-coding .NET MAUI apps works out of the box dotnet/maui#32967

Open

51 tasks

jonathanpeppers mentioned this pull request Dec 2, 2025

[xabt] title case ComputeAvailableDevices dotnet/android#10623

Merged

rolfbjarne reviewed Dec 3, 2025

View reviewed changes

Suggestions from code review

5e6fbcd

Merge branch 'main' into dev/peppers/dotnet-run-devices

a26459e

baronfel reviewed Dec 4, 2025

View reviewed changes

src/Cli/dotnet/Commands/Run/RunCommandSelector.cs Show resolved Hide resolved

baronfel mentioned this pull request Dec 4, 2025

Improve the user experience when waiting for long-running Target invocations in dotnet run and other interactive experiences #52016

Open

baronfel approved these changes Dec 4, 2025

View reviewed changes

baronfel requested a review from a team December 4, 2025 15:58

marcpopMSFT requested a review from MiYanni December 4, 2025 16:53

MiYanni approved these changes Dec 4, 2025

View reviewed changes

jonathanpeppers merged commit c164a9b into main Dec 4, 2025
26 checks passed

jonathanpeppers deleted the dev/peppers/dotnet-run-devices branch December 4, 2025 19:26

dotnet-maestro bot mentioned this pull request Dec 9, 2025

[main] Source code updates from dotnet/sdk dotnet/dotnet#3754

Merged

jjonescz mentioned this pull request Dec 15, 2025

[automated] Merge branch 'release/10.0.2xx' => 'main' #52149

Merged

jonathanpeppers mentioned this pull request Jan 21, 2026

[release/10.0.3xx] backport mobile changes for dotnet run #52608

Merged

jonathanpeppers added a commit that referenced this pull request Jan 23, 2026

[release/10.0.3xx] backport mobile changes for dotnet run (#52608)

dd7c083

Backports these that are already in main/.NET 11: * #51914 * #52113 * #52046

This was referenced Feb 12, 2026

[release/10.0.3xx] Source code updates from dotnet/sdk dotnet/dotnet#4826

Merged

[main] Source code updates from dotnet/sdk dotnet/dotnet#4837

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[dotnet-run] implement "device" selection logic#51914

[dotnet-run] implement "device" selection logic#51914
jonathanpeppers merged 12 commits intomainfrom
dev/peppers/dotnet-run-devices

jonathanpeppers commented Nov 25, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jonathanpeppers commented Dec 2, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

baronfel left a comment

Uh oh!

baronfel commented Dec 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

jonathanpeppers commented Nov 25, 2025

Spec Changes

Implementation

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jonathanpeppers commented Dec 2, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

baronfel left a comment

Choose a reason for hiding this comment

Uh oh!

baronfel commented Dec 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants