Migrate from TestFactory to ParameterizedTest - #2188
Draft
Goooler wants to merge 11 commits into
Draft
Conversation
Goooler
force-pushed
the
g/20260813/ParameterizedTest
branch
from
August 13, 2026 11:31
a9ebba9 to
74a5556
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the documentation snippet tests to use a JUnit 5 @ParameterizedTest with a @MethodSource instead of generating DynamicTests, while simplifying the snippet execution model and improving failure diagnostics.
Changes:
- Replace the
DynamicTestfactory with@ParameterizedTestfed by asnippets()method source. - Refactor
SnippetExecutablefrom a JUnitExecutablesealed class into a sealed interface with an explicitexecute(projectRoot: Path)API. - Simplify code-snippet discovery into a
DslLang.extractCodeSnippets()extension and enhance exception messages with source location + build output.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/documentTest/kotlin/com/github/jengelman/gradle/plugins/shadow/snippet/SnippetExecutable.kt | Refactors the snippet executor API and centralizes richer error reporting within execute(Path). |
| src/documentTest/kotlin/com/github/jengelman/gradle/plugins/shadow/snippet/KotlinBuildExecutable.kt | Updates Kotlin DSL snippet executor to implement the new SnippetExecutable interface shape. |
| src/documentTest/kotlin/com/github/jengelman/gradle/plugins/shadow/snippet/GroovyBuildExecutable.kt | Updates Groovy DSL snippet executor to implement the new SnippetExecutable interface shape. |
| src/documentTest/kotlin/com/github/jengelman/gradle/plugins/shadow/snippet/CodeSnippetExtractor.kt | Reworks snippet extraction into a DslLang extension that produces SnippetExecutables with source metadata. |
| src/documentTest/kotlin/com/github/jengelman/gradle/plugins/shadow/DocCodeSnippetTest.kt | Migrates to @ParameterizedTest + @MethodSource, wiring per-invocation temp directories and named arguments. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
No description provided.