Skip to content

Treat sbt.testing.TestWildcardSelectors correctly.#1327

Merged
etorreborre merged 1 commit intoetorreborre:mainfrom
dubinsky:treat-sbt.testing.TestWildcardSelector-correctly
Apr 29, 2025
Merged

Treat sbt.testing.TestWildcardSelectors correctly.#1327
etorreborre merged 1 commit intoetorreborre:mainfrom
dubinsky:treat-sbt.testing.TestWildcardSelector-correctly

Conversation

@dubinsky
Copy link
Copy Markdown
Contributor

@dubinsky dubinsky commented Apr 29, 2025 •
edited by coderabbitai Bot
Loading

When selecting examples to execute, take into account sbt.testing.TestWildcardSelectors, not just sbt.testing.TestSelectors.

Summary by CodeRabbit

  • New Features

    • Added support for selecting and running tests using wildcard patterns in addition to exact test names.

  • Bug Fixes

    • Improved handling of test selection to ensure that tests matching wildcard patterns are correctly executed and reported.

  • Tests

    • Expanded test coverage to verify correct behavior when using wildcard selectors for test execution.

@dubinsky
Treat sbt.testing.TestWildcardSelectors correctly.
ae529dc 
When selecting examples to execute, take into account `sbt.testing.TestWildcardSelector`s, not just `sbt.testing.TestSelector`s.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 29, 2025 •
edited
Loading

Walkthrough

The changes extend support for TestWildcardSelector in both the test suite and the runner logic. The test suite now includes tests for TestWildcardSelector, verifying its behavior alongside existing selectors. The runner logic is updated to recognize both TestSelector and TestWildcardSelector when constructing selection regexes for test execution. The regex construction for wildcards now surrounds the pattern with .* to match substrings. No public API signatures were changed; modifications are internal to the test and runner logic.

Changes

File(s) Change Summary
core/jvm/src/test/scala/org/specs2/runner/SbtSelectorSpec.scala Added tests for TestWildcardSelector, updated imports and specification text, introduced testWildcardSelector method, and adjusted noMatches test.
core/shared/src/main/scala/org/specs2/runner/SbtRunner.scala Updated internal logic in newTask to support TestWildcardSelector in selection regex construction and environment handling.

Sequence Diagram(s)

sequenceDiagram
    participant SBT as SBT Runner
    participant Runner as BaseSbtRunner
    participant Env as Environment
    participant Task as Test Task

    SBT->>Runner: Provide selectors (TestSelector/TestWildcardSelector)
    Runner->>Runner: Check if selection regex is defined or selectors are valid
    alt All selectors are TestSelector/TestWildcardSelector
        Runner->>Runner: Build selection regex (quote names, add .* for wildcards)
        Runner->>Env: Update selection arguments
    else
        Runner->>Env: Leave environment unchanged
    end
    Runner->>Task: Execute with updated environment
Loading

Poem

In the warren of tests, a new path we find,
Wildcards now wander, selectors combined.
Patterns with stars, and names that are neat,
The runner now matches—no test in retreat!
With regex and logic, the suite hops ahead,
🐇 Specs2 keeps running, just as the rabbit said!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 820cef6 and ae529dc.

📒 Files selected for processing (2)
  • core/jvm/src/test/scala/org/specs2/runner/SbtSelectorSpec.scala (2 hunks)
  • core/shared/src/main/scala/org/specs2/runner/SbtRunner.scala (1 hunks)
🔇 Additional comments (7)
core/shared/src/main/scala/org/specs2/runner/SbtRunner.scala (2)

45-49: Good improvement to the selector type handling

This change correctly extends the condition to check for both TestSelector and TestWildcardSelector instances, allowing the runner to handle both exact match selectors and wildcard selectors appropriately.

51-54: Well-implemented regex construction for wildcard selectors

The implementation correctly distinguishes between:

  • TestSelector: Exact match using quoted test name
  • TestWildcardSelector: Substring match by wrapping the quoted wildcard pattern with .* on both sides

This approach ensures wildcard patterns will match any test name containing the specified substring.

core/jvm/src/test/scala/org/specs2/runner/SbtSelectorSpec.scala (5)

4-14: Appropriate import addition

Adding the TestWildcardSelector import is necessary for the extended functionality being tested.

21-21: Clear specification description update

The specification description now correctly states the expanded scope, including both TestSelectors and TestWildcardSelectors.

24-24: Good test case addition

Adding a dedicated test case for TestWildcardSelector ensures the new functionality is properly tested.

48-52: Well-implemented wildcard selector test

This test validates that a wildcard selector with the pattern "as a" correctly matches both "has a successful test" and "has a failing test", confirming that substring matching works as expected.

59-61: Comprehensive negative test case

The updated noMatches test ensures that wildcard selectors correctly handle the case where no test matches the specified pattern, a good complement to the positive test case.

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@dubinsky dubinsky mentioned this pull request Apr 29, 2025
Closed
@etorreborre etorreborre merged commit 4f2fe56 into etorreborre:main Apr 29, 2025
4 checks passed
@dubinsky
Copy link
Copy Markdown
Contributor Author

dubinsky commented Apr 29, 2025

Thank you, @etorreborre!

@etorreborre
Copy link
Copy Markdown
Owner

etorreborre commented Apr 29, 2025

Thanks for the fix @dubinsky, I published it as 5.6.3.

@dubinsky
Copy link
Copy Markdown
Contributor Author

dubinsky commented Apr 29, 2025

Thanks for the fix @dubinsky, I published it as 5.6.3.

Thank you!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@dubinsky @etorreborre