Skip to content

refactor: migrate credit pool service tests to testcontainers#33898

Merged
asukaminato0721 merged 3 commits intolanggenius:mainfrom
Desel72:refactor/migrate-credit-pool-service-tests-to-testcontainers
Mar 23, 2026
Merged

refactor: migrate credit pool service tests to testcontainers#33898
asukaminato0721 merged 3 commits intolanggenius:mainfrom
Desel72:refactor/migrate-credit-pool-service-tests-to-testcontainers

Conversation

@Desel72
Copy link
Copy Markdown
Contributor

@Desel72 Desel72 commented Mar 23, 2026

Important

  1. Make sure you have read our contribution guidelines
  2. Ensure there is an associated issue and you have been assigned to it
  3. Use the correct syntax to link this PR: Fixes #<issue number>.

Summary

Migrate SQL-related tests from api/tests/unit_tests/services/test_credit_pool_service.py
to testcontainers integration tests at
api/tests/test_containers_integration_tests/services/test_credit_pool_service.py.

This PR removes the mock-based unit test file that relied on MagicMock, patch, and
SimpleNamespace to fake database sessions, and replaces it with integration tests that
run against a real PostgreSQL instance via testcontainers.

Part of #32454

Screenshots

Before After
... ...

Checklist

  • This change requires a documentation update, included: Dify Document
  • I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.
  • I ran make lint and make type-check (backend) and cd web && npx lint-staged (frontend) to appease the lint gods

@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. refactor labels Mar 23, 2026
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refactors the testing strategy for the CreditPoolService by transitioning from isolated, mock-dependent unit tests to comprehensive integration tests. This change ensures that the service's interactions with the database are validated against a real PostgreSQL instance, significantly improving the accuracy and reliability of the test suite.

Highlights

  • Test Migration: Migrated CreditPoolService tests from mock-based unit tests to integration tests.
  • Real Database Testing: Replaced mocked database interactions with testing against a real PostgreSQL instance using Testcontainers.
  • Improved Reliability: Enhanced test reliability and realism by removing reliance on MagicMock, patch, and SimpleNamespace for faking database sessions.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions
Copy link
Copy Markdown
Contributor

Pyrefly Diff

base → PR
--- /tmp/pyrefly_base.txt	2026-03-23 05:33:34.119490823 +0000
+++ /tmp/pyrefly_pr.txt	2026-03-23 05:33:24.364514407 +0000
@@ -1133,6 +1133,10 @@
     --> tests/test_containers_integration_tests/services/test_app_service.py:1141:68
 ERROR Argument `Literal['owner']` is not assignable to parameter `role` with type `SQLCoreOperations[TenantAccountRole] | TenantAccountRole` in function `models.account.TenantAccountJoin.__init__` [bad-argument-type]
   --> tests/test_containers_integration_tests/services/test_conversation_service.py:43:18
+ERROR Object of class `NoneType` has no attribute `quota_used` [missing-attribute]
+  --> tests/test_containers_integration_tests/services/test_credit_pool_service.py:95:16
+ERROR Object of class `NoneType` has no attribute `quota_used` [missing-attribute]
+   --> tests/test_containers_integration_tests/services/test_credit_pool_service.py:111:16
 ERROR Argument `Literal['active']` is not assignable to parameter `status` with type `AccountStatus | SQLCoreOperations[AccountStatus]` in function `models.account.Account.__init__` [bad-argument-type]
   --> tests/test_containers_integration_tests/services/test_dataset_permission_service.py:37:20
 ERROR Argument `Literal['normal']` is not assignable to parameter `status` with type `SQLCoreOperations[TenantStatus] | TenantStatus` in function `models.account.Tenant.__init__` [bad-argument-type]

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request is a great step forward in improving test quality by migrating the CreditPoolService tests from mocks to testcontainers-based integration tests. The new tests are comprehensive and correctly validate the service's behavior against a real database. I've added a suggestion to refactor the test setup using pytest fixtures to reduce code duplication and improve maintainability. Additionally, while reviewing the related service code, I identified a potential critical race condition in the CreditPoolService.check_and_deduct_credits method. I highly recommend addressing this concurrency issue in a follow-up pull request to prevent incorrect credit deductions.

@github-actions
Copy link
Copy Markdown
Contributor

Pyrefly Diff

base → PR
--- /tmp/pyrefly_base.txt	2026-03-23 05:35:27.778420613 +0000
+++ /tmp/pyrefly_pr.txt	2026-03-23 05:35:17.561051833 +0000
@@ -1133,6 +1133,10 @@
     --> tests/test_containers_integration_tests/services/test_app_service.py:1141:68
 ERROR Argument `Literal['owner']` is not assignable to parameter `role` with type `SQLCoreOperations[TenantAccountRole] | TenantAccountRole` in function `models.account.TenantAccountJoin.__init__` [bad-argument-type]
   --> tests/test_containers_integration_tests/services/test_conversation_service.py:43:18
+ERROR Object of class `NoneType` has no attribute `quota_used` [missing-attribute]
+  --> tests/test_containers_integration_tests/services/test_credit_pool_service.py:89:16
+ERROR Object of class `NoneType` has no attribute `quota_used` [missing-attribute]
+   --> tests/test_containers_integration_tests/services/test_credit_pool_service.py:103:16
 ERROR Argument `Literal['active']` is not assignable to parameter `status` with type `AccountStatus | SQLCoreOperations[AccountStatus]` in function `models.account.Account.__init__` [bad-argument-type]
   --> tests/test_containers_integration_tests/services/test_dataset_permission_service.py:37:20
 ERROR Argument `Literal['normal']` is not assignable to parameter `status` with type `SQLCoreOperations[TenantStatus] | TenantStatus` in function `models.account.Tenant.__init__` [bad-argument-type]

@github-actions
Copy link
Copy Markdown
Contributor

Pyrefly Diff

base → PR
--- /tmp/pyrefly_base.txt	2026-03-23 06:02:32.812469603 +0000
+++ /tmp/pyrefly_pr.txt	2026-03-23 06:02:22.676396185 +0000
@@ -1133,6 +1133,10 @@
     --> tests/test_containers_integration_tests/services/test_app_service.py:1141:68
 ERROR Argument `Literal['owner']` is not assignable to parameter `role` with type `SQLCoreOperations[TenantAccountRole] | TenantAccountRole` in function `models.account.TenantAccountJoin.__init__` [bad-argument-type]
   --> tests/test_containers_integration_tests/services/test_conversation_service.py:43:18
+ERROR Object of class `NoneType` has no attribute `quota_used` [missing-attribute]
+  --> tests/test_containers_integration_tests/services/test_credit_pool_service.py:89:16
+ERROR Object of class `NoneType` has no attribute `quota_used` [missing-attribute]
+   --> tests/test_containers_integration_tests/services/test_credit_pool_service.py:103:16
 ERROR Argument `Literal['active']` is not assignable to parameter `status` with type `AccountStatus | SQLCoreOperations[AccountStatus]` in function `models.account.Account.__init__` [bad-argument-type]
   --> tests/test_containers_integration_tests/services/test_dataset_permission_service.py:37:20
 ERROR Argument `Literal['normal']` is not assignable to parameter `status` with type `SQLCoreOperations[TenantStatus] | TenantStatus` in function `models.account.Tenant.__init__` [bad-argument-type]

@asukaminato0721 asukaminato0721 merged commit 6ecf89e into langgenius:main Mar 23, 2026
12 of 14 checks passed
@Desel72 Desel72 deleted the refactor/migrate-credit-pool-service-tests-to-testcontainers branch March 23, 2026 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

refactor size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants