Update some docs still referencing Sputnik and JUnit runner and clarify situation of Jupiter extensions by Vampire · Pull Request #2322 · spockframework/spock

Vampire · 2026-03-15T02:44:00Z

Summary by CodeRabbit

Documentation
- Clarified JUnit Platform integration language across the guides.
- Expanded Third‑Party Extensions guidance, noting community maintenance and potential incompleteness.
- Added a prominent NOTE explaining differences and compatibility limits between JUnit Jupiter and Spock extensions.
- Strengthened guidance to prefer native Spock extensions or port Jupiter extensions when needed.
- Expanded JUnit comparison table with additional setup/cleanup mappings and equivalences.

Vampire · 2026-03-15T02:44:14Z

This stack of pull requests is managed by Graphite. Learn more about stacking.

coderabbitai · 2026-03-15T02:44:15Z

📝 Walkthrough

Walkthrough

Documentation updates across multiple AsciiDoc files: clarified Spock's JUnit Platform engine role, expanded guidance on third‑party extensions and their community maintenance, adjusted terminologies, and extended JUnit comparison mappings; changes are documentation-only.

Changes

Cohort / File(s)	Summary
Introduction & Primer `docs/introduction.adoc`, `docs/spock_primer.adoc`	Rephrased JUnit runner → JUnit Platform engine; marked Specification classes as `@Testable` and updated execution wording. Adjusted SUS terminology and reflowed specification language.
Extensions Documentation `docs/extensions.adoc`, `docs/spock_primer.adoc`	Replaced generic link with contextual NOTE and expanded guidance: clarified Spock Wiki is community‑driven, explained JUnit Jupiter vs Spock extension distinctions, noted partial/non‑maintained Jupiter integration, and recommended preferring/native porting.
JUnit Comparison Table `docs/spock_primer.adoc`	Expanded mapping table to include Before/BeforeEach and BeforeClass/BeforeAll (JUnit 5) equivalents and added rows for Condition, Exception condition, and Interaction mappings.
Parallel Execution Note `docs/parallel_execution.adoc`	Minor whitespace/formatting fix in NOTE URL reference.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐇 I nibble notes in margins neat,
I tidy docs with tiny feet.
JUnit Platform now in view,
Extensions told—both old and new.
A hopping cheer for clarity sweet!

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main changes: updating documentation that references outdated technologies (Sputnik and JUnit runner) and clarifying the handling of JUnit Jupiter extensions.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch vampire/doc-updates

📝 Coding Plan

Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

greptile-apps · 2026-03-15T02:45:44Z

Greptile Summary

Documentation-only PR that modernizes references from the legacy Sputnik/JUnit runner terminology to the current JUnit Platform engine terminology, and adds guidance on JUnit Jupiter extension compatibility with Spock.

Replaces "JUnit runner" / "Sputnik" references with "JUnit Platform engine" in introduction.adoc and spock_primer.adoc
Updates the Spock-to-JUnit comparison table to include both JUnit 4 (@Before) and Jupiter (@BeforeEach) annotations
Adds a detailed NOTE block (in both spock_primer.adoc and extensions.adoc) clarifying that JUnit Jupiter extensions do not work in Spock out of the box
Expands the Third-Party Extensions section with a community-driven disclaimer
Fixes minor whitespace and punctuation issues
Issue found: Typo "featurews" introduced in spock_primer.adoc line 851 (should be "features")

Confidence Score: 4/5

This documentation-only PR is safe to merge after fixing one typo.
All changes are confined to AsciiDoc documentation files with no code impact. The content updates are accurate and improve clarity. One typo ("featurews") was introduced that should be fixed before merging.
docs/spock_primer.adoc has a typo on line 851 ("featurews" → "features")

Important Files Changed

Filename	Overview
docs/extensions.adoc	Expands Third-Party Extensions section with community-driven disclaimer and a NOTE block clarifying JUnit Jupiter vs Spock extension compatibility. No issues found.
docs/introduction.adoc	Replaces outdated "JUnit runner" reference with "JUnit Platform engine". Clean, accurate change.
docs/parallel_execution.adoc	Removes an extra space before a URL. Trivial whitespace fix, no issues.
docs/spock_primer.adoc	Replaces Sputnik/JUnit runner references with JUnit Platform terminology, updates JUnit comparison table with Jupiter annotations, adds JUnit Jupiter extensions NOTE. Contains a typo: "featurews" on the `@IgnoreRest` line.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["introduction.adoc"] -->|"Updated: JUnit runner → JUnit Platform engine"| B["Terminology Modernization"]
    C["spock_primer.adoc"] -->|"Updated: Sputnik → @Testable / JUnit Platform"| B
    C -->|"Updated: JUnit comparison table with Jupiter annotations"| D["JUnit 4 + Jupiter Annotations"]
    C -->|"Added: JUnit Jupiter extensions NOTE"| E["Jupiter Extension Compatibility Warning"]
    F["extensions.adoc"] -->|"Added: JUnit Jupiter extensions NOTE"| E
    F -->|"Added: community-driven disclaimer"| G["Third-Party Extensions Clarity"]
    H["parallel_execution.adoc"] -->|"Fixed: extra whitespace"| I["Minor Cleanup"]

_{Last reviewed commit: 41e1127}

docs/spock_primer.adoc

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

docs/spock_primer.adoc (1)

860-875: Consider linking to shared extension guidance instead of duplicating the full NOTE.

This block substantially duplicates the third-party/Jupiter guidance already present in docs/extensions.adoc (Line 794-809), which may drift over time.

Refactor direction

-[NOTE]
---
-...long Jupiter/3rd-party compatibility note...
---
+[NOTE]
+--
+For details on JUnit Jupiter extension compatibility and third-party Spock extension recommendations, see
+<<extensions.adoc#extensions,Extensions>> and especially the
+<<extensions.adoc#third-party-extensions,Third-Party Extensions>> section.
+--

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/spock_primer.adoc` around lines 860 - 875, The NOTE about JUnit
Jupiter/third‑party integration is a duplicate of the guidance in the shared
extensions doc; remove this duplicated NOTE block in docs/spock_primer.adoc and
replace it with a cross‑reference to the canonical guidance (the existing
"Extensions" / third‑party Jupiter guidance section) so the content is
maintained in one place; ensure the referenced section/anchor exists and update
the link text to clearly point readers to the shared guidance instead of copying
the full paragraph.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/spock_primer.adoc`:
- Line 851: Typo in docs: update the sentence describing the `@IgnoreRest`
annotation in docs/spock_primer.adoc so "featurews" is corrected to "features"
(the line that reads "`@IgnoreRest`:: Any feature method carrying this
annotation will be executed, all others will be ignored. Useful for quickly
running just a few featurews."). Leave the rest of the sentence and punctuation
unchanged and only replace the misspelled word.

---

Nitpick comments:
In `@docs/spock_primer.adoc`:
- Around line 860-875: The NOTE about JUnit Jupiter/third‑party integration is a
duplicate of the guidance in the shared extensions doc; remove this duplicated
NOTE block in docs/spock_primer.adoc and replace it with a cross‑reference to
the canonical guidance (the existing "Extensions" / third‑party Jupiter guidance
section) so the content is maintained in one place; ensure the referenced
section/anchor exists and update the link text to clearly point readers to the
shared guidance instead of copying the full paragraph.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 22f534db-55dc-43fb-b303-ebf2b8d5e550

📥 Commits

Reviewing files that changed from the base of the PR and between 9c6342c and 41e1127.

📒 Files selected for processing (4)

docs/extensions.adoc
docs/introduction.adoc
docs/parallel_execution.adoc
docs/spock_primer.adoc

docs/spock_primer.adoc

…fy situation of Jupiter extensions

coderabbitai

♻️ Duplicate comments (1)

docs/spock_primer.adoc (1)

851-851: ⚠️ Potential issue | 🟡 Minor

Fix the typo "featurews" → "features".

While updating this line's description, the existing typo "featurews" should also be corrected to "features". A past review already flagged this typo.

🔤 Proposed fix

-`@IgnoreRest`:: Any feature method carrying this annotation will be executed, all others will be ignored. Useful for quickly running just a few featurews.
+`@IgnoreRest`:: Any feature method carrying this annotation will be executed, all others will be ignored. Useful for quickly running just a few features.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/spock_primer.adoc` at line 851, Typo in the `@IgnoreRest` docstring:
replace "featurews" with "features" and update the sentence to read
"`@IgnoreRest`:: Any feature method carrying this annotation will be executed,
all others will be ignored. Useful for quickly running just a few features."
Locate the line describing `@IgnoreRest` and correct the misspelling and ensure
the sentence grammar matches the proposed text.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@docs/spock_primer.adoc`:
- Line 851: Typo in the `@IgnoreRest` docstring: replace "featurews" with
"features" and update the sentence to read "`@IgnoreRest`:: Any feature method
carrying this annotation will be executed, all others will be ignored. Useful
for quickly running just a few features." Locate the line describing
`@IgnoreRest` and correct the misspelling and ensure the sentence grammar
matches the proposed text.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 98538821-5cfe-4847-a274-bdb3e543397d

📥 Commits

Reviewing files that changed from the base of the PR and between 41e1127 and ca3745f.

📒 Files selected for processing (4)

docs/extensions.adoc
docs/introduction.adoc
docs/parallel_execution.adoc
docs/spock_primer.adoc

🚧 Files skipped from review as they are similar to previous changes (3)

docs/extensions.adoc
docs/parallel_execution.adoc
docs/introduction.adoc

codecov · 2026-03-15T03:38:51Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.16%. Comparing base (9c6342c) to head (ca3745f).

Additional details and impacted files

@@             Coverage Diff              @@
##             master    #2322      +/-   ##
============================================
- Coverage     82.16%   82.16%   -0.01%     
+ Complexity     4822     4821       -1     
============================================
  Files           472      472              
  Lines         15036    15036              
  Branches       1905     1905              
============================================
- Hits          12355    12354       -1     
  Misses         1989     1989              
- Partials        692      693       +1

see 1 file with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

greptile-apps bot reviewed Mar 15, 2026

View reviewed changes

docs/spock_primer.adoc Outdated Show resolved Hide resolved

coderabbitai bot reviewed Mar 15, 2026

View reviewed changes

docs/spock_primer.adoc Outdated Show resolved Hide resolved

Update some docs still referencing Sputnik and JUnit runner and clari…

ca3745f

…fy situation of Jupiter extensions

Vampire force-pushed the vampire/doc-updates branch from 41e1127 to ca3745f Compare March 15, 2026 02:48

coderabbitai bot reviewed Mar 15, 2026

View reviewed changes

This was referenced Mar 15, 2026

Spring Boot 4 wiremock-spring-boot support for spock-spring #2295

Closed

Document Spring Boot 4 and JUnit 6 compatibility for Spock Spring module #2308

Open

AndreasTu approved these changes Mar 15, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update some docs still referencing Sputnik and JUnit runner and clarify situation of Jupiter extensions#2322

Update some docs still referencing Sputnik and JUnit runner and clarify situation of Jupiter extensions#2322
Vampire wants to merge 1 commit intomasterfrom
vampire/doc-updates

Vampire commented Mar 15, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

Vampire commented Mar 15, 2026

Uh oh!

coderabbitai bot commented Mar 15, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

greptile-apps bot commented Mar 15, 2026

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

codecov bot commented Mar 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Vampire commented Mar 15, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

Vampire commented Mar 15, 2026

Uh oh!

coderabbitai bot commented Mar 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

greptile-apps bot commented Mar 15, 2026

Greptile Summary

Confidence Score: 4/5

Important Files Changed

Flowchart

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Mar 15, 2026

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Vampire commented Mar 15, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 15, 2026 •

edited

Loading