Skip to content

Add regression test for complex table formatting#53

Merged
leynos merged 2 commits intomainfrom
codex/add-regression-test-for-table-formatting
Jun 25, 2025
Merged

Add regression test for complex table formatting#53
leynos merged 2 commits intomainfrom
codex/add-regression-test-for-table-formatting

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 24, 2025

Summary

  • add test data for a long table
  • ensure process_stream preserves formatting of the table

Testing

  • cargo +nightly-2025-06-10 fmt --all
  • cargo clippy -- -D warnings
  • RUSTFLAGS="-D warnings" cargo test
  • markdownlint README.md docs/*.md
  • nixie README.md docs/*.md

https://chatgpt.com/codex/tasks/task_e_685b2d494a348322b1b36c768493a63d

Summary by Sourcery

Tests:

  • Introduce test_regression_complex_table with input and expected output fixtures for complex table formatting

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 24, 2025

Reviewer's Guide

Adds a regression test for complex table formatting to verify that process_stream preserves table layout, supported by new input and expected data fixtures.

File-Level Changes

Change Details Files
Add regression test for complex table formatting
  • Introduce test_regression_complex_table function
  • Load input and expected via include_str!
  • Assert process_stream(&input) equals expected
tests/integration.rs
Add test data fixtures for regression
  • Create input fixture regression_table_input.txt
  • Create expected fixture regression_table_expected.txt
tests/data/regression_table_input.txt
tests/data/regression_table_expected.txt

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @leynos - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 24, 2025

Warning

Rate limit exceeded

@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 0 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 408f303 and 9677c17.

📒 Files selected for processing (1)
  • tests/integration.rs (1 hunks)

Summary by CodeRabbit

  • Tests
    • Added a new integration test to verify regression scenarios using external input and expected output tables.
    • Introduced test data files documenting and validating six server and message handling tasks, including improvements such as graceful shutdown, DoS protection, concurrent message re-assembly, rate limiting, dead letter queue support, and enhanced fragmentation strategies.

Walkthrough

A new integration test was introduced to verify the processing of a regression table, using newly added input and expected output data files. The test reads from these files and checks that the processing function produces the correct output. No changes were made to exported or public code declarations.

Changes

File(s) Change Summary
tests/integration.rs Added a new integration test test_regression_complex_table that validates processing of regression table data.
tests/data/regression_table_input.txt, tests/data/regression_table_expected.txt Added input and expected output files for regression table integration testing.

Suggested reviewers

  • codescene-delta-analysis

Poem

In the warren where tests abound,
New tables of input and output are found.
With files in their paws, the rabbits compare,
Ensuring the code behaves with great care.
Integration complete, the bunnies all cheer,
For regression’s defeat is now crystal clear! 🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch codex/add-regression-test-for-table-formatting

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 auto-generate unit tests to generate unit tests for 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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d294fc8 and 408f303.

📒 Files selected for processing (3)
  • tests/data/regression_table_expected.txt (1 hunks)
  • tests/data/regression_table_input.txt (1 hunks)
  • tests/integration.rs (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.rs`: Document public APIs using Rustdoc comments (///) so documentation can be generated with cargo doc. Prefer immutable data and avoid unnecessary mut bindings. Handle erro...

**/*.rs: Document public APIs using Rustdoc comments (///) so documentation can be generated with cargo doc.
Prefer immutable data and avoid unnecessary mut bindings.
Handle errors with the Result type instead of panicking where feasible.
Avoid unsafe code unless absolutely necessary and document any usage clearly.

  • tests/integration.rs
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build-test
🔇 Additional comments (2)
tests/data/regression_table_expected.txt (1)

1-9: Well-structured test data for regression testing.

The expected output file contains a properly formatted markdown table that serves well as a baseline for regression testing. The table structure is consistent and the technical content provides good complexity for testing table processing logic.

tests/data/regression_table_input.txt (1)

1-9: Appropriate regression test input data.

The input file provides the same well-formatted table as the expected output, which is correct for a regression test that verifies properly formatted tables remain unchanged during processing. This approach will catch any unintended modifications to correct formatting.

Comment thread tests/integration.rs
@leynos leynos merged commit 662e512 into main Jun 25, 2025
2 checks passed
@leynos leynos deleted the codex/add-regression-test-for-table-formatting branch June 25, 2025 00:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant