Skip to content

Add external Postgres test and enforce features#117

Open
leynos wants to merge 1 commit intomainfrom
ymh2rj-codex/modify-setup_postgres-to-check-postgres_test_url
Open

Add external Postgres test and enforce features#117
leynos wants to merge 1 commit intomainfrom
ymh2rj-codex/modify-setup_postgres-to-check-postgres_test_url

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 12, 2025

Summary

  • enforce mutual exclusion of sqlite and postgres features in test-util
  • expose TestServer::uses_embedded_postgres to verify which database path was taken
  • add an integration test exercising the POSTGRES_TEST_URL code path

Testing

  • cargo fmt --all
  • cargo clippy -- -D warnings
  • cargo test --quiet
  • npx markdownlint-cli2 '**/*.md' '#node_modules'
  • nixie docs/chat-schema.md docs/news-schema.md docs/file-sharing-design.md docs/fuzzing.md README.md

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

Summary by Sourcery

Provide support for reusing an external PostgreSQL instance in tests via POSTGRES_TEST_URL, enforce mutually exclusive sqlite and postgres features, expose whether the server used embedded Postgres, and update docs with an integration test covering the new code path.

New Features:

  • Expose TestServer::uses_embedded_postgres to indicate if embedded Postgres is in use

Enhancements:

  • Enforce mutual exclusion of sqlite and postgres features in test-util
  • Modify setup_postgres to honor POSTGRES_TEST_URL environment variable and skip embedded startup when set

Documentation:

  • Document POSTGRES_TEST_URL usage in README to reuse an existing database URL

Tests:

  • Add integration test to verify external Postgres reuse via POSTGRES_TEST_URL

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 12, 2025

Reviewer's Guide

This PR refactors the TestServer in test-util to enforce exclusive sqlite/postgres features, add optional external Postgres support via the POSTGRES_TEST_URL environment variable, expose which database path was used, introduce a new integration test for external Postgres, and update documentation and dependencies accordingly.

Updated Class Diagram for TestServer

classDiagram
    class TestServer {
        +uses_embedded_postgres(): bool
    }
Loading

Flow Diagram for Test Database Setup

flowchart TD
    A[Start Test Setup] --> B{feature enabled?};
    B -->|sqlite| C[Use SQLite Database];
    B -->|postgres| D{POSTGRES_TEST_URL is set?};
    D -->|Yes| E[Use External PostgreSQL at URL];
    D -->|No| F[Start and Use Embedded PostgreSQL];
    C --> G[Run Tests];
    E --> G;
    F --> G;
    G --> H[End];
Loading

File-Level Changes

Change Details Files
Restructure TestServer launch logic with cfg_if to enforce sqlite vs. postgres features
  • Replace TempDir field with Option
  • Wrap startup logic in cfg_if to require exactly one feature
  • Introduce compile_error when neither feature is enabled
test-util/src/lib.rs
Enhance setup_postgres to optionally reuse an external Postgres instance
  • Check POSTGRES_TEST_URL env var and return early without spawning
  • Change return type to include Option
  • Adjust TestServer::start to handle None vs. Some(PostgreSQL)
test-util/src/lib.rs
Expose runtime check for embedded Postgres usage
  • Add public uses_embedded_postgres() returning pg.is_some()
  • Guard method under #[cfg(feature = "postgres")]
test-util/src/lib.rs
Add integration test for external Postgres via env var
  • Create tests/postgres_env.rs with setup, env var injection, and assertions
  • Verify db_url() matches and uses_embedded_postgres() is false
  • Cleanup environment and stop embedded server
tests/postgres_env.rs
Update documentation and dependencies
  • Document POSTGRES_TEST_URL behavior in README.md
  • Add cfg-if crate to test-util Cargo.toml
README.md
test-util/Cargo.toml

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 12, 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 4 minutes and 6 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 cf093db and a21595e.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (4)
  • README.md (1 hunks)
  • test-util/Cargo.toml (1 hunks)
  • test-util/src/lib.rs (7 hunks)
  • tests/postgres_env.rs (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

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

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Choose a reason for hiding this comment

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

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Quality Gate Profile: Pay Down Tech Debt
Want more control? Customize Code Health rules or catch issues early with our IDE extension and CLI tool.

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.

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