Add image path tests #2199
Merged
Add image path tests #2199
+208
−0
Conversation
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
Open
Mpdreamz
approved these changes
Nov 13, 2025
Member
Mpdreamz
left a comment
Mpdreamz
left a comment
There was a problem hiding this comment.
LGTM, Another option would be to extend our integration tests since they inject docs-builder docs in the navigation we can include some more tests (referencing images from snippets comes to mind).
I might follow up with that actually.
cotti
approved these changes
Nov 13, 2025
Contributor
cotti
left a comment
cotti
left a comment
There was a problem hiding this comment.
LGTM, I was implementing this by extending InlineTest to have an assembler-mode option, but this is better.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
Added
ImagePathResolutionTests.csto verifyDiagnosticLinkInlineParser.UpdateRelativeUrlcorrectly resolves image paths in both assembler and non-assembler builds.Why: In assembler builds, documentation from multiple repos is combined with each section getting a
path_prefixfrom navigation.yml (e.g., platform, reference/elasticsearch). Image URLs must include this prefix:images/pic.png→/docs/platform/setup/images/pic.png. Non-assembler builds skip the prefix:/docs/setup/images/pic.png.How it works
Mock a minimal doc set with a markdown file at
setup/guide.mdreferencingimages/pic.pngSeed navigation metadata by injecting a stub INavigationItem into MarkdownNavigationLookup with the expected URL (e.g.,
/platform/setup/guide).. this mimics what DocumentationSetNavigation produces in real assembler buildsCall UpdateRelativeUrl which reads the stub's URL, extracts the directory path, and resolves the image relative to it
Assert the result includes (or excludes) the
path_prefixbased on AssemblerBuild flagWhy
By stubbing navigation metadata instead of building the full navigation tree, the test stays fast, isolated, and focused on UpdateRelativeUrl behavior. The stub recreates the exact state the production code sees.