Skip to content

Fix Postgres test helper#136

Merged
leynos merged 1 commit intomainfrom
codex/fix-incompatible-types-in-if-else-statement
Jun 16, 2025
Merged

Fix Postgres test helper#136
leynos merged 1 commit intomainfrom
codex/fix-incompatible-types-in-if-else-statement

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 16, 2025

Summary

  • fix branch using embedded Postgres when POSTGRES_TEST_URL not set
  • gate reset_postgres_db by postgres feature
  • expose PostgresTestDb::new and add uses_embedded helper
  • use uses_embedded in postgres_env test
  • include postgres crate for postgres feature

Testing

  • cargo clippy -- -D warnings
  • RUSTFLAGS="-D warnings" cargo test --tests --workspace --features sqlite
  • RUSTFLAGS="-D warnings" cargo test --tests --workspace --no-default-features --features postgres (fails: preparing embedded PostgreSQL: cannot run as root)

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

Summary by Sourcery

Fix and enhance the PostgreSQL test helper by exposing constructors, adding an embedded-usage helper, gating feature-specific code, updating tests, and adding the required build dependency.

New Features:

  • Expose PostgresTestDb::new publicly
  • Add uses_embedded() method to indicate embedded PostgreSQL usage

Bug Fixes:

  • Correct branch logic to use embedded PostgreSQL when POSTGRES_TEST_URL is not set

Enhancements:

  • Gate reset_postgres_db() and related code behind the postgres feature
  • Refactor TestServer startup to correctly handle optional embedded Postgres

Build:

  • Add optional postgres dependency and include it in the postgres feature

Tests:

  • Update postgres_env.rs test to use uses_embedded() helper for assertions

Summary by CodeRabbit

  • New Features
    • Added a method to determine if an embedded PostgreSQL server is being used during testing.
  • Bug Fixes
    • Improved conditional compilation for PostgreSQL-related test utilities, ensuring features are only available when enabled.
  • Tests
    • Updated tests to use the new public method for checking embedded PostgreSQL usage, rather than accessing internal fields directly.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 16, 2025

Reviewer's Guide

This PR refactors the test utility to conditionally compile Postgres support behind the postgres feature, exposes and extends the PostgresTestDb API to detect embedded usage, updates the TestServer startup to pass along the embedded PostgreSQL handle, and adds the Postgres crate as an optional dependency in the Cargo manifest.

File-Level Changes

Change Details Files
Feature-gate Postgres reset helper
  • Add #[cfg(feature = "postgres")] to reset_postgres_db
  • Ensure calls to reset_postgres_db only compile under the postgres feature
test-util/src/lib.rs
Expose and extend PostgresTestDb API
  • Change PostgresTestDb::new() from private to pub
  • Add uses_embedded() helper returning whether an embedded instance is used
  • Update postgres_env test to assert via uses_embedded() instead of checking pg directly
test-util/src/lib.rs
tests/postgres_env.rs
Propagate embedded Postgres handle in TestServer
  • Capture (url, pg) tuple from start_embedded_postgres
  • Pass the pg handle into Self::launch for embedded cleanup
test-util/src/lib.rs
Add optional Postgres dependency and feature gating
  • Add postgres as an optional crate in Cargo.toml
  • Include dep:postgres in the postgres feature list
  • Update Cargo.lock to reflect the new dependency
test-util/Cargo.toml
Cargo.lock

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 16, 2025

Walkthrough

This update adds the postgres crate as an optional dependency and feature in the test-util crate. It makes the PostgresTestDb::new constructor public, introduces a uses_embedded method, and adjusts code to use this method for checking embedded PostgreSQL usage. Conditional compilation is applied to reset_postgres_db.

Changes

File(s) Change Summary
test-util/Cargo.toml Added optional postgres dependency and included it in the postgres feature list.
test-util/src/lib.rs Made PostgresTestDb::new public, added uses_embedded method, applied #[cfg(feature = "postgres")] to reset_postgres_db, and clarified embedded Postgres handling in server startup.
tests/postgres_env.rs Updated test to use uses_embedded() method instead of accessing internal struct field directly.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test
    participant PostgresTestDb as PostgresTestDb
    participant EmbeddedPg as EmbeddedPostgres (optional)
    
    Test->>PostgresTestDb: new()
    PostgresTestDb-->>Test: PostgresTestDb instance

    Test->>PostgresTestDb: uses_embedded()
    PostgresTestDb-->>Test: true/false

    Note over PostgresTestDb,EmbeddedPg: If embedded, manages EmbeddedPostgres instance internally
Loading

Possibly related PRs

Poem

In the warren of code, a new path appears,
With Postgres now optional, we hop without fears.
A public new method, to check where we dwell,
Embedded or not? Now the code can tell!
🐇 Hopping along, our tests are robust—
With features and crates, in rabbits we trust!


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d053175 and a5c1dfa.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (3)
  • test-util/Cargo.toml (2 hunks)
  • test-util/src/lib.rs (5 hunks)
  • tests/postgres_env.rs (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
tests/postgres_env.rs (1)
test-util/src/lib.rs (1)
  • uses_embedded (187-187)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: build-test (postgres)
  • GitHub Check: coverage
  • GitHub Check: build-test (sqlite)
  • GitHub Check: Analyze (actions)
🔇 Additional comments (4)
test-util/Cargo.toml (1)

19-30: I’ll fetch the latest 0.19.x patch version from crates.io to suggest an exact pin.

#!/bin/bash
# Get the highest 0.19.x release of the `postgres` crate
curl -sL https://crates.io/api/v1/crates/postgres \
  | grep -oP '"num":"0\.19\.\d+"' \
  | sed -E 's/"num":"([^"]+)"/\1/' \
  | sort -V \
  | tail -n1
tests/postgres_env.rs (1)

11-13: Nice encapsulation via uses_embedded()

Switching from a struct-field assertion to the public helper improves encapsulation and future-proofs the test. Looks good.

test-util/src/lib.rs (2)

176-187: Public constructor + uses_embedded() expose a clean minimal API

Making PostgresTestDb::new public and providing uses_embedded() remove the need for tests to poke at internals (pg field). Good move for encapsulation; no concerns.


369-371: Tuple destructure clarifies intent

Capturing (url, pg) directly and wrapping pg in Some increases readability compared with the previous nested match. Nice small tidy-up.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Commit Unit Tests in branch codex/fix-incompatible-types-in-if-else-statement
  • Post Copyable Unit Tests in Comment

🪧 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

@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 - here's some feedback:

  • Consider catching and handling failures from start_embedded_postgres (e.g. running as root) to provide a clear fallback or error message instead of causing test suite errors.
  • The Cargo.toml postgres feature currently uses “dep:postgres” alongside other flags—consider simplifying or renaming features to make it clearer which crates are being enabled.
  • Rename uses_embedded to a more idiomatic boolean accessor like is_embedded for clarity.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider catching and handling failures from start_embedded_postgres (e.g. running as root) to provide a clear fallback or error message instead of causing test suite errors.
- The Cargo.toml postgres feature currently uses “dep:postgres” alongside other flags—consider simplifying or renaming features to make it clearer which crates are being enabled.
- Rename uses_embedded to a more idiomatic boolean accessor like is_embedded for clarity.

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.

@leynos leynos merged commit 7e34dac into main Jun 16, 2025
5 of 7 checks passed
@leynos leynos deleted the codex/fix-incompatible-types-in-if-else-statement branch June 16, 2025 22:56
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