Skip to content

Use unique DB name for Postgres test fixture#164

Merged
leynos merged 6 commits intomainfrom
7makti-codex/use-unique-db-name-for-postgres-test-fixture
Jun 18, 2025
Merged

Use unique DB name for Postgres test fixture#164
leynos merged 6 commits intomainfrom
7makti-codex/use-unique-db-name-for-postgres-test-fixture

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Jun 18, 2025

Summary

  • generate unique DB names for embedded Postgres databases
  • document that PostgresTestDb uses per-test database names
  • clarify mermaid validation instructions

Testing

  • cargo clippy -- -D warnings
  • RUSTFLAGS="-D warnings" cargo test
  • cargo clippy --no-default-features --features postgres -- -D warnings (fails: could not compile postgres-setup-unpriv)
  • RUSTFLAGS="-D warnings" cargo test --no-default-features --features postgres (fails: could not compile postgres-setup-unpriv)
  • markdownlint '**/*.md'
  • nixie **/*.md

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

Summary by Sourcery

Generate unique per-test database names for embedded Postgres fixtures and update documentation for mermaid validation and test fixtures.

Enhancements:

  • Generate timestamp-based unique database names in PostgresTestDb fixture to avoid name collisions during parallel tests

Documentation:

  • Clarify mermaid code block validation instructions in mermaid-validation.md
  • Document per-test unique database naming for PostgresTestDb in rust-testing-with-rstest-fixtures.md

Summary by CodeRabbit

  • Documentation

    • Improved clarity and formatting in the mermaid validation guide.
    • Added documentation on project-specific test fixtures, detailing the use of uniquely named databases for parallel test execution and automatic cleanup.
  • New Features

    • Embedded PostgreSQL test databases now use unique names per test and are automatically dropped after tests, preventing orphaned databases and enabling parallel test runs.
  • Chores

    • Added a new optional dependency on the uuid crate for generating unique database names.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 18, 2025

Reviewer's Guide

This PR enhances the PostgresTestDb fixture by generating unique per-test database names using UTC timestamps and updates the corresponding documentation for Mermaid validation and Rust testing fixtures.

Class diagram for updated PostgresTestDb fixture

classDiagram
    class PostgresTestDb {
        +String db_name
        +new() PostgresTestDb
        +connect() Connection
    }
    note for PostgresTestDb "db_name is now unique per test (e.g., includes UTC timestamp)"
Loading

File-Level Changes

Change Details Files
Generate unique database names for the embedded Postgres test fixture
  • Compute db_name with current UTC timestamp
  • Use dynamic db_name instead of static "test" for database creation
  • Reference db_name when constructing the connection URL
test-util/src/lib.rs
Clarify Mermaid validation instructions in documentation
  • Consolidate multiple lines into a single descriptive paragraph
  • Adjust wording to specify mermaid code-block extraction
  • Refine explanation of syntax-error reporting
docs/mermaid-validation.md
Document per-test unique Postgres database naming
  • Add a “Project-Specific Fixtures” section
  • Describe unique database generation in PostgresTestDb
  • Highlight parallel-test conflict avoidance
docs/rust-testing-with-rstest-fixtures.md

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

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes introduce dynamic naming and explicit cleanup for embedded PostgreSQL test databases by generating a unique database name per test using a UUID. The embedded database is dropped during fixture cleanup. Documentation is updated to reflect these changes, and the uuid crate is added as an optional dependency.

Changes

File(s) Change Summary
docs/mermaid-validation.md Revised documentation for clarity and formatting; improved description of mermaid block extraction.
docs/rust-testing-with-rstest-fixtures.md Added subsection detailing project-specific fixture with dynamic test database naming and cleanup.
test-util/Cargo.toml Added optional dependency on uuid crate with v4 feature enabled.
test-util/src/lib.rs EmbeddedPg and PostgresTestDb structs extended with database name tracking; unique DB creation and drop logic added; updated embedded Postgres startup and teardown to manage dynamic DB names.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test
    participant Fixture as PostgresTestDb
    participant Embedded as EmbeddedPg
    participant Postgres as PostgreSQL

    Test->>Fixture: Request test DB
    Fixture->>Embedded: Start embedded Postgres
    Embedded->>Postgres: Create DB with unique UUID name
    Embedded->>Fixture: Return DB URL and name
    Fixture->>Test: Provide DB connection

    Note over Test,Fixture: Test executes using unique DB

    Test->>Fixture: Test ends, cleanup
    Fixture->>Postgres: DROP DATABASE <unique_name>
Loading

Possibly related PRs

Poem

In the warren where test code grows,
Each database now uniquely flows.
With UUIDs they’re named anew,
And dropped when tests are all but through.
No orphaned DBs left behind—
Just tidy code, by rabbits designed!
🐇✨

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch 7makti-codex/use-unique-db-name-for-postgres-test-fixture

🪧 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 using a UUID or random suffix instead of just timestamp_nanos to guarantee uniqueness even when multiple tests start within the same nanosecond.
  • Ensure that the dynamically created test databases are reliably dropped or cleaned up on panic or test suite exit to avoid orphaned databases consuming resources.
  • You might extract the database‐naming logic into a configurable helper (e.g. allowing a custom prefix) to make it more reusable and clearer in intent.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider using a UUID or random suffix instead of just `timestamp_nanos` to guarantee uniqueness even when multiple tests start within the same nanosecond.
- Ensure that the dynamically created test databases are reliably dropped or cleaned up on panic or test suite exit to avoid orphaned databases consuming resources.
- You might extract the database‐naming logic into a configurable helper (e.g. allowing a custom prefix) to make it more reusable and clearer in intent.

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.

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

@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: 3

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 24fed6c and a189bc7.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (4)
  • docs/mermaid-validation.md (1 hunks)
  • docs/rust-testing-with-rstest-fixtures.md (1 hunks)
  • test-util/Cargo.toml (1 hunks)
  • test-util/src/lib.rs (6 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/mermaid-validation.md

[style] ~39-~39: Consider using a different verb for a more formal wording.
Context: ... error location are printed to help you fix the issue. If nixie is not found on ...

(FIX_RESOLVE)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: coverage
  • GitHub Check: windows-build (sqlite)
🔇 Additional comments (5)
docs/rust-testing-with-rstest-fixtures.md (1)

1320-1326: Good addition

The new subsection clearly explains the UUID-based per-test database and its
cleanup behaviour.

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

92-96: Struct update looks sensible

Storing db_name alongside the URL gives the cleanup code the information it
needs without changing external APIs.


157-166: Unique DB name generation ✔

Using test_<UUIDv4> guarantees uniqueness and stays inside Postgres’
identifier rules (<63 chars, starts with a letter). Good call.


300-305: Propagation of db_name

Passing the database name up to the fixture ensures the Drop impl can clean up.
All fine here.


512-513: Pattern update

Using .. in the destructure keeps the signature future-proof and avoids an
unused-field warning – good.

Comment thread test-util/Cargo.toml Outdated
Comment thread docs/mermaid-validation.md Outdated
Comment thread test-util/src/lib.rs Outdated
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

@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 Failed
Prevent hotspot decline (1 hotspot with Deep, Nested Complexity)
Enforce critical code health rules (1 file with Deep, Nested Complexity)

Gates Passed
3 Quality Gates Passed

See analysis details in CodeScene

Reason for failure
Prevent hotspot decline Violations Code Health Impact
lib.rs 1 rule in this hotspot 9.10 → 8.55 Suppress
Enforce critical code health rules Violations Code Health Impact
lib.rs 1 critical rule 9.10 → 8.55 Suppress

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

@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

@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.

@leynos leynos merged commit a9a99db into main Jun 18, 2025
5 of 8 checks passed
@leynos leynos deleted the 7makti-codex/use-unique-db-name-for-postgres-test-fixture branch June 18, 2025 23:22
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