Update testing documentation

[im-vedant]

What kind of change does this PR introduce?

Issue Number:

Fixes #258

Snapshots/Videos:

If relevant, did you update the documentation?

Summary

Does this PR introduce a breaking change?

Checklist

CodeRabbit AI Review

• I have reviewed and addressed all critical issues flagged by CodeRabbit AI
• I have implemented or provided justification for each non-critical suggestion
• I have documented my reasoning in the PR comments where CodeRabbit AI suggestions were not implemented

Test Coverage

• I have written tests for all new changes/features
• I have verified that test coverage meets or exceeds 95%
• I have run the test suite locally and all tests pass

Other information

Have you read the contributing guide?

Summary by CodeRabbit

• Documentation
  • Updated testing documentation with new instructions for running individual tests using pytest
  • Added a new section explaining how to generate test coverage reports

[coderabbitai]

Walkthrough

The pull request updates the testing documentation in docs/docs/testing.md to replace the previous test running method with pytest-based instructions. The changes focus on providing clear guidance for running individual tests, executing the entire test suite, and generating code coverage reports. The documentation now offers more modern and precise instructions for developers on how to run tests effectively.

Changes

File	Change Summary
docs/docs/testing.md	- Removed section about tests/bin/_do_all_tests.py script - Added pytest-based instructions for running tests - Introduced new section on generating coverage reports

Assessment against linked issues

Objective	Addressed	Explanation
Run a single test [#258]	✅
Run all tests [#258]	✅
View code coverage for all code files [#258]	✅
View code coverage for a single file [#258]	✅

Suggested Labels

ignore-sensitive-files-pr

Poem

🐰 A Tester's Delight

With pytest in paw, I hop and I test,
Coverage reports make my coding quest the best!
No script too complex, no test left behind,
In documentation's realm, clarity I find!
🧪✨

---

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>, 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. (Beta)
• @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.

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.

[github-actions]

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if either of these two conditions occur:

1. The overall code coverage drops below the target threshold of the repository
2. Any file in the pull request has code coverage levels below the repository threshold

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

1. comments in this PR or
2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

1. arbitrators of future discussions with other contributors about the validity of your changes
2. point of contact for evaluating the validity of your work
3. person who verifies matching issues by others that should be closed.
4. person who gives general guidance in fixing your tests

🎯 Contacting the person who assigned the mentors is not advised unless they make a request. Do not @ the person who did the assignment otherwise.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (4)

docs/docs/testing.md (4)

121-121: Fix the documentation formatting.

The standalone code fence appears to be a formatting mistake. The text should be part of the regular documentation flow.

Apply this change:

-```
You can run individual tests with this command.
-```
+You can run individual tests with this command.

🧰 Tools

🪛 Markdownlint (0.37.0)

121-121: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

123-125: Clarify the test path format.

The test path format uses underscores (switchmap_) while the module layout section shows forward slashes (switchmap/). This inconsistency might confuse developers.

Consider adding a note to explain the path format difference, or ensure consistency throughout the documentation.

---

143-150: Enhance the coverage report documentation.

While the command is correct, the section would benefit from additional context:

1. Prerequisites (e.g., installing pytest-cov)
2. Explanation of what the coverage report shows
3. Guidelines for interpreting the results
4. Location of the generated coverage files

Would you like me to provide a more detailed section that includes this information?

---

Line range hint 1-150: Consider structural improvements to enhance documentation usability.

The documentation is comprehensive but could benefit from these additions:

1. A table of contents for easier navigation
2. Version information for required tools (pytest, pytest-cov)
3. A troubleshooting section for common issues

Would you like me to provide examples of these sections?

🧰 Tools

🪛 Markdownlint (0.37.0)

121-121: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 63f224c and c713c74.

📒 Files selected for processing (1)

• docs/docs/testing.md (2 hunks)

🧰 Additional context used

🪛 Markdownlint (0.37.0)

docs/docs/testing.md

121-121: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Test Application