Order listeners documentation

[krmahadevan]

This PR adds documentation pertaining to how to use the ordering of listeners feature that will be made available in TestNG 7.10.0

Summary by CodeRabbit

• New Features
  • Introduced the ability for users to order TestNG listeners using a custom annotation, ensuring a deterministic sequence of listener execution.
  • Implemented org.testng.ListenerComparator to facilitate listener ordering.
  • Provided an example demonstrating the creation of the annotation, implementation of the comparator, and usage of TestNG APIs for running tests with ordered listeners.

[coderabbitai]

Walkthrough

The change introduces the ability to order listeners in TestNG, allowing control over the sequence of listener execution based on a custom annotation. An implementation of org.testng.ListenerComparator is provided to facilitate this ordering, ensuring deterministic listener execution. The example demonstrates creating the annotation, implementing the comparator, and using TestNG APIs to run tests with ordered listeners.

Changes

File Path	Change Summary
src/main/asciidoc/docs/testng_listeners.adoc	Introduced the ability to order listeners in TestNG using a custom annotation and ListenerComparator.

Related issues

• testng-team/testng#2874: This PR directly addresses the objectives outlined in the issue by enabling users to define the order of TestNG listeners and providing a mechanism for specifying a comparator to determine the execution order.

Poem

In the realm of tests where listeners play,
A rabbit hopped in with a new display.
Order and sequence, a whimsical dance,
TestNG now offers a tailored stance.
🐇 "Listeners aligned in a custom array,
Deterministic runs in the light of day."

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

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>.
  • Generate unit-tests for this file.
• 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 tests 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 generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 4

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 5811459 and e6530c5.

Files selected for processing (1)

• src/main/asciidoc/docs/testng_listeners.adoc (1 hunks)

Additional comments: 4

src/main/asciidoc/docs/testng_listeners.adoc (4)

• 232-242: The custom annotation RunOrder is well-explained and the code snippet is correct. Ensure that the annotation usage is consistent across all examples.
• 268-298: The example listeners MasterOogway, MasterShifu, and DragonWarrior are correctly annotated and demonstrate the feature well. Ensure that the example names and the concept they illustrate are clear to all readers.
• 301-312: The code snippet using TestNG APIs to run the test with ordered listeners is correct. Ensure that the method create is explained or referenced correctly if it's part of the TestNG API or user-defined.
• 357-359: The note and tip at the end provide useful insights into the behavior of the ordered listeners. Ensure that these insights are consistent with TestNG's actual behavior.

[juherr]

The feature and api looks good. Just go ahead with the implementation.

[krmahadevan]

@juherr - The cooked up poem at the end of the PR review by @coderabbitai is funny 😆

[coderabbitai]

@krmahadevan: I'm glad you enjoyed the poem! 😊 Your laughter is music to my ears. If you have any more feedback or need assistance, feel free to let me know.

(\__/) 
(•ㅅ•) 
/ 　 づ

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 5811459 and f1ed948.

Files selected for processing (1)

• src/main/asciidoc/docs/testng_listeners.adoc (1 hunks)

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

• src/main/asciidoc/docs/testng_listeners.adoc

[juherr]

Just merge when it will be available

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 69d563e and 61c886d.

Files selected for processing (1)

• src/main/asciidoc/docs/testng_listeners.adoc (1 hunks)

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

• src/main/asciidoc/docs/testng_listeners.adoc