engineering: Propagate flexible ESP mount path by frhuelsz · Pull Request #591 · microsoft/trident

frhuelsz · 2026-04-07T00:20:31Z

🔍 Description

Allow for different ESP mount points.

Propagate the changes in #586 to all the trivial locations in trident so that we may change the ESP mount point as required by the distro.

Depends on:

engineering: Allow other ESP paths in validation #586

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

…fi-path-enginecontext

Copilot

Pull request overview

Propagates the flexible ESP (EFI System Partition) mount path work (from #586) across Trident, replacing remaining /boot/efi assumptions with a graph-/context-derived ESP mount path and adding a per-filesystem override mechanism for ESP detection.

Changes:

Introduces/propagates is_esp and overrideEspMount semantics through host-config (de)serialization, validation, and storage-graph building.
Plumbs esp_mount_path into EngineContext and updates engine/subsystem codepaths to use it instead of ESP_MOUNT_POINT_PATH.
Updates schemas/docs and removes the docbuilder “Filesystem Source Requirements” rule/section that no longer applies.

Reviewed changes

Copilot reviewed 76 out of 76 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
report/esp-constant-usages.md	Adds a tracking report for remaining ESP constant usages and migration status.
docs/Reference/Host-Configuration/Storage-Rules.md	Removes the “Filesystem Source Requirements” section from the docs.
docs/Reference/Host-Configuration/API-Reference/VerityDevice.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/VerityCorruptionOption.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/User.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/UefiFallbackMode.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/Trident.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/SystemdCheck.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/Swap.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/Storage.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/SshMode.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/SoftwareRaidArray.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/ServicingTypeSelection.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/Services.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/SelinuxMode.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/Selinux.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/Scripts.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/Script.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/RaidLevel.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/Raid.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/Pcr.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/Password.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/PartitionType.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/PartitionTableType.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/PartitionSize.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/Partition.md	Sidebar ordering update (generated doc).
docs/Reference/Host-Configuration/API-Reference/OverrideEspMount.md	Adds generated API reference page for `OverrideEspMount`.
docs/Reference/Host-Configuration/API-Reference/FileSystem.md	Documents the new `overrideEspMount` field.
crates/trident/src/subsystems/storage/osimage.rs	Uses `fs.is_esp` field and updates tests accordingly.
crates/trident/src/subsystems/storage/mod.rs	Updates tests for `FileSystem { is_esp: ... }` field.
crates/trident/src/subsystems/storage/fstab.rs	Updates tests to include `is_esp` on filesystems.
crates/trident/src/subsystems/selinux.rs	Updates tests to include `is_esp` on filesystems.
crates/trident/src/subsystems/esp.rs	Updates install-index test usage to pass `ctx.esp_mount_path`.
crates/trident/src/osimage/cosi/derived_hc.rs	Derives ESP selection from GPT partition type; warns/picks first when multiple ESPs present; adds tests.
crates/trident/src/offline_init/mod.rs	Marks ESP filesystem in generated HostStatus based on Prism partition types.
crates/trident/src/engine/storage/verity.rs	Uses `ctx.esp_mount_path` for ESP-path checks and updates tests.
crates/trident/src/engine/storage/rebuild.rs	Updates tests to include `is_esp` on filesystems.
crates/trident/src/engine/storage/partitioning/repart_mode.rs	Switches to `PartitionType::as_dps()` and removes local conversion helper.
crates/trident/src/engine/storage/image.rs	Replaces constant ESP mount path usage with `ctx.esp_mount_path`.
crates/trident/src/engine/storage/filesystem.rs	Replaces ESP detection via `is_esp()` with `ctx.esp_mount_path` comparison; updates tests.
crates/trident/src/engine/storage/encryption.rs	Replaces constant ESP mount path usage with `ctx.esp_mount_path`; updates tests/imports.
crates/trident/src/engine/rollback.rs	Updates tests to include `is_esp` on filesystems.
crates/trident/src/engine/newroot.rs	Updates tests to include `is_esp` on filesystems.
crates/trident/src/engine/install_index.rs	Makes install index computation accept ESP mount path (relative/absolute) and updates tests.
crates/trident/src/engine/context/mod.rs	Adds `esp_mount_path` to `EngineContext` derived from the storage graph.
crates/trident/src/engine/context/image.rs	Updates tests to include `is_esp` on filesystems.
crates/trident/src/engine/context/filesystem.rs	Removes constant-based ESP helpers; uses `self.esp_mount_path` to find ESP filesystem.
crates/trident/src/engine/clean_install.rs	Uses `ctx.esp_mount_path` when staging and validating ESP contents.
crates/trident/src/engine/bootentries.rs	Uses `ctx.esp_mount_path` when constructing boot entry paths; updates tests/imports.
crates/trident/src/engine/boot/grub.rs	Uses `ctx.esp_mount_path` for GRUB config path; updates functional test fixtures.
crates/trident/src/engine/ab_update.rs	Uses `ctx.esp_mount_path` when computing host-relative ESP path.
crates/trident_api/src/samples/sample_hc.rs	Updates samples to explicitly set `is_esp` on filesystems.
crates/trident_api/src/config/host/storage/storage_graph/validation_tests.rs	Adds/updates tests for ESP validation (multiple ESPs, ESP without mount point, etc.).
crates/trident_api/src/config/host/storage/storage_graph/types.rs	Removes now-unused `FileSystemSourceKind`.
crates/trident_api/src/config/host/storage/storage_graph/rules/mod.rs	Makes expected ESP partition typing depend on discovered ESP mount path.
crates/trident_api/src/config/host/storage/storage_graph/graph.rs	Stores and exposes `esp_mount_path` on the built `StorageGraph`.
crates/trident_api/src/config/host/storage/storage_graph/error.rs	Adds ESP-specific build errors; removes obsolete filesystem source/verity variants.
crates/trident_api/src/config/host/storage/storage_graph/documentation.rs	Removes `FileSystemSourceKind` doc plumbing.
crates/trident_api/src/config/host/storage/storage_graph/display.rs	Removes `FileSystemSourceKind` display formatting.
crates/trident_api/src/config/host/storage/storage_graph/conversions.rs	Uses `fs.is_esp` field for referrer-kind classification.
crates/trident_api/src/config/host/storage/storage_graph/cardinality.rs	Adds `ValidCardinality::new_any()`.
crates/trident_api/src/config/host/storage/storage_graph/builder/partition.rs	Threads `esp_mount_path` into partition-type checks.
crates/trident_api/src/config/host/storage/storage_graph/builder/mod.rs	Captures `esp_mount_path` during filesystem checks and stores it in the graph.
crates/trident_api/src/config/host/storage/storage_graph/builder/filesystems.rs	Validates ESP uniqueness and mount-point presence; returns discovered ESP mount path.
crates/trident_api/src/config/host/storage/partitions.rs	Adds `PartitionType::as_dps()` and conversion to `DiscoverablePartitionType`.
crates/trident_api/src/config/host/storage/mod.rs	Validation now requires an ESP mount path from the graph; `esp_filesystem()` uses `is_esp`.
crates/trident_api/src/config/host/storage/filesystem.rs	Adds `is_esp` to `FileSystem` and implements `overrideEspMount` via custom serde.
crates/trident_api/src/config/host/storage/filesystem_types.rs	Uses `Display` impls for filesystem-type stringification.
crates/trident_api/src/config/host/mod.rs	Minor formatting + test fixtures updated for `is_esp`.
crates/trident_api/src/config/host/error.rs	Adds `EspMountPointNotFound` static validation error.
crates/trident_api/schemas/host-config-schema.json	Adds `overrideEspMount` schema and internal doc tag usage for `PartitionType`.
crates/sysdefs/src/partition_types.rs	Adds `try_from_string_name_or_uuid` helper for partition-type parsing.
crates/docbuilder/src/schema_renderer/node.rs	Strips schema description text after `# INTERNAL` when generating docs.
crates/docbuilder/src/host_config/storage_rules/mod.rs	Removes the filesystem source-requirements rule from generated storage rules.
crates/docbuilder/src/host_config/storage_rules/filesystems.rs	Removes rule generation for filesystem source requirements.
.vscode/settings.json	Adds terminal auto-approval config for `cargo fmt`.

crates/trident/src/offline_init/mod.rs

crates/trident/src/engine/context/mod.rs

Copilot

Pull request overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (1)

crates/trident/src/engine/storage/encryption.rs:734

Issue: EngineContext is constructed in functional tests without setting esp_mount_path, but get_binary_paths_pcrlock() now derives the ESP location from ctx.esp_mount_path. With the current ..Default::default() this will be an empty path, causing the helper to look under the wrong directory and likely breaking these functional tests (and potentially hiding regressions).

Evidence: test_get_uki_paths() and test_get_binary_paths_pcrlock() build EngineContext { ..Default::default() } and never set esp_mount_path.

Suggestion: set esp_mount_path in these functional tests (e.g., to PathBuf::from(ESP_MOUNT_POINT_PATH)/esp_path.clone()), or provide a non-empty default for EngineContext in test/functional-test builds.

    use pytest_gen::functional_test;
    use trident_api::{constants::ESP_MOUNT_POINT_PATH, status::ServicingType};

    #[functional_test(feature = "helpers")]
    fn test_get_uki_paths() {
        let mut ctx = EngineContext {
            ab_active_volume: None,
            install_index: 0,
            servicing_type: ServicingType::CleanInstall,
            ..Default::default()
        };

crates/trident/src/engine/context/mod.rs

.vscode/settings.json

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

Copilot

Pull request overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 3 comments.

crates/trident/src/engine/clean_install.rs

report/esp-constant-usages.md

Copilot

Pull request overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.

crates/trident/src/engine/install_index.rs

…ndex tests

frhuelsz · 2026-04-10T00:01:25Z

/AzurePipelines run [GITHUB]-trident-pr-e2e

azure-pipelines · 2026-04-10T00:01:43Z

Azure Pipelines successfully started running 1 pipeline(s).

frhuelsz and others added 30 commits March 30, 2026 18:07

Add report

c8448ea

enhance

d3f21c7

is_esp check info

3e0377f

Enhance list

8a7bce4

Emojis for readability

86b862f

Relax EFP path validation.

479479a

Progress

3cf1477

Tests & coverage

2101bbb

Update status

9c26a22

Address issues with adopted partitions

32bd0b3

update report

e5c24c8

Apply suggestions from code review

a00a03e

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

review rename

89fa5f3

Update schema

48b513d

New HC field for ESP Boot Path

d0f2aaa

is_esp

1ffa666

Finish impl of new HC field.

cf97357

Delete unused fn

a1e8f09

Remove unused

ac6eee3

Fix indoc usages

88198ac

Fix more constant usages

ce842b6

Update report

8c09b78

Use serde from/into instead

fb3ae1c

clippy

9a7c1bb

Error for non-absolute paths

9e0a4f6

remove unused

6b32322

Update comment

e90e57d

Initialize on tests

2fe228e

initialize on offline init

a5a7530

Address concerns in derived HC

c7032e4

frhuelsz added 3 commits April 9, 2026 13:11

Merge branch 'user/frhuelsz/efi-path-validation' into user/frhuelsz/e…

fdee7e4

…fi-path-enginecontext

Update to use new API

8000c74

Update UTs

2459e75

frhuelsz changed the title ~~engineering: Use context to resolve ESP mount path~~ feature: Flexible ESP mount path Apr 9, 2026

fmt

974216e

frhuelsz marked this pull request as ready for review April 9, 2026 20:45

frhuelsz requested a review from a team as a code owner April 9, 2026 20:45

Copilot AI review requested due to automatic review settings April 9, 2026 20:45

Copilot started reviewing on behalf of frhuelsz April 9, 2026 20:46 View session

Copilot AI reviewed Apr 9, 2026

View reviewed changes

crates/trident/src/offline_init/mod.rs Show resolved Hide resolved

crates/trident/src/engine/context/mod.rs Outdated Show resolved Hide resolved

frhuelsz added 2 commits April 9, 2026 13:58

Fix typo in error

b591521

Merge branch 'main' into user/frhuelsz/efi-path-enginecontext

d0d4ca0

Copilot AI review requested due to automatic review settings April 9, 2026 22:42

Copilot started reviewing on behalf of frhuelsz April 9, 2026 22:43 View session

Copilot AI reviewed Apr 9, 2026

View reviewed changes

crates/trident/src/engine/context/mod.rs Show resolved Hide resolved

.vscode/settings.json Outdated Show resolved Hide resolved

Update .vscode/settings.json

05dc342

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

Copilot AI review requested due to automatic review settings April 9, 2026 22:48

Copilot started reviewing on behalf of frhuelsz April 9, 2026 22:49 View session

Copilot AI reviewed Apr 9, 2026

View reviewed changes

crates/trident/src/engine/clean_install.rs Outdated Show resolved Hide resolved

report/esp-constant-usages.md Show resolved Hide resolved

report/esp-constant-usages.md Show resolved Hide resolved

Update report

153298f

frhuelsz changed the title ~~feature: Flexible ESP mount path~~ engineering: Propagate flexible ESP mount path Apr 9, 2026

frhuelsz added 3 commits April 9, 2026 16:08

remove stale data

7686fa0

fix: provide custom Default for EngineContext with ESP_MOUNT_POINT_PATH

388b9d2

fix: update hardcoded ESP comment in clean_install.rs

cf7327a

Copilot AI review requested due to automatic review settings April 9, 2026 23:27

Copilot started reviewing on behalf of frhuelsz April 9, 2026 23:28 View session

Copilot AI reviewed Apr 9, 2026

View reviewed changes

crates/trident/src/engine/install_index.rs Outdated Show resolved Hide resolved

refactor: rename relative_esp_efi_path to esp_mount_path in install_i…

697e149

…ndex tests

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

engineering: Propagate flexible ESP mount path#591

engineering: Propagate flexible ESP mount path#591
frhuelsz wants to merge 87 commits intomainfrom
user/frhuelsz/efi-path-enginecontext

frhuelsz commented Apr 7, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

frhuelsz commented Apr 10, 2026

Uh oh!

azure-pipelines bot commented Apr 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

frhuelsz commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔍 Description

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!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

frhuelsz commented Apr 10, 2026

Uh oh!

azure-pipelines bot commented Apr 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

frhuelsz commented Apr 7, 2026 •

edited

Loading