Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

11.5 KB
Raw Blame
"""Testcontainers integration tests for CreditPoolService."""

from unittest.mock import patch
from uuid import uuid4

import pytest
from sqlalchemy.orm import Session

from core.errors.error import QuotaExceededError
from models import TenantCreditPool
from models.enums import ProviderQuotaType
from services.credit_pool_service import CreditPoolService


class TestCreditPoolService:
    def _create_tenant_id(self) -> str:
        return str(uuid4())

    def _create_pool(
        self,
        db_session: Session,
        *,
        tenant_id: str,
        quota_limit: int = 10,
        quota_used: int = 0,
    ) -> None:
        pool = TenantCreditPool(
            tenant_id=tenant_id,
            pool_type=ProviderQuotaType.TRIAL,
            quota_limit=quota_limit,
            quota_used=quota_used,
        )
        db_session.add(pool)
        db_session.commit()

    def test_get_pool_returns_pool_when_exists(self, db_session_with_containers: Session) -> None:
        tenant_id = self._create_tenant_id()
        self._create_pool(db_session_with_containers, tenant_id=tenant_id, quota_limit=10, quota_used=0)

        result = CreditPoolService.get_pool(
            tenant_id=tenant_id, pool_type=ProviderQuotaType.TRIAL, session=db_session_with_containers
        )

        assert result is not None
        assert result.tenant_id == tenant_id
        assert result.pool_type == ProviderQuotaType.TRIAL

    def test_get_pool_uses_provided_session(self, db_session_with_containers: Session) -> None:
        tenant_id = self._create_tenant_id()
        db_session_with_containers.add(
            TenantCreditPool(
                tenant_id=tenant_id,
                pool_type=ProviderQuotaType.TRIAL,
                quota_limit=10,
                quota_used=2,
            )
        )
        db_session_with_containers.commit()

        result = CreditPoolService.get_pool(
            tenant_id=tenant_id, pool_type=ProviderQuotaType.TRIAL, session=db_session_with_containers
        )

        assert result is not None
        assert result.tenant_id == tenant_id
        assert result.pool_type == ProviderQuotaType.TRIAL
        assert result.quota_used == 2

    def test_get_pool_returns_none_when_not_exists(self, db_session_with_containers: Session) -> None:
        result = CreditPoolService.get_pool(
            tenant_id=self._create_tenant_id(), pool_type=ProviderQuotaType.TRIAL, session=db_session_with_containers
        )

        assert result is None

    def test_check_credits_available_returns_false_when_no_pool(self, db_session_with_containers: Session) -> None:
        result = CreditPoolService.check_credits_available(
            tenant_id=self._create_tenant_id(), credits_required=10, session=db_session_with_containers
        )

        assert result is False

    def test_check_credits_available_returns_true_when_sufficient(self, db_session_with_containers: Session) -> None:
        tenant_id = self._create_tenant_id()
        self._create_pool(db_session_with_containers, tenant_id=tenant_id, quota_limit=10, quota_used=0)

        result = CreditPoolService.check_credits_available(
            tenant_id=tenant_id, credits_required=10, session=db_session_with_containers
        )

        assert result is True

    def test_check_credits_available_returns_false_when_insufficient(self, db_session_with_containers: Session) -> None:
        tenant_id = self._create_tenant_id()
        self._create_pool(db_session_with_containers, tenant_id=tenant_id, quota_limit=10, quota_used=10)

        result = CreditPoolService.check_credits_available(
            tenant_id=tenant_id, credits_required=1, session=db_session_with_containers
        )

        assert result is False

    def test_check_and_deduct_credits_raises_when_no_pool(self, db_session_with_containers: Session) -> None:
        with pytest.raises(QuotaExceededError, match="Credit pool not found"):
            CreditPoolService.check_and_deduct_credits(
                tenant_id=self._create_tenant_id(), credits_required=1, session=db_session_with_containers
            )

    def test_check_and_deduct_credits_returns_zero_for_non_positive_request(
        self, db_session_with_containers: Session
    ) -> None:
        tenant_id = self._create_tenant_id()
        self._create_pool(db_session_with_containers, tenant_id=tenant_id, quota_limit=10, quota_used=2)

        result = CreditPoolService.check_and_deduct_credits(
            tenant_id=tenant_id, credits_required=0, session=db_session_with_containers
        )

        assert result == 0
        updated_pool = CreditPoolService.get_pool(tenant_id=tenant_id, session=db_session_with_containers)
        assert updated_pool is not None
        assert updated_pool.quota_used == 2

    def test_check_and_deduct_credits_raises_when_no_remaining(self, db_session_with_containers: Session) -> None:
        tenant_id = self._create_tenant_id()
        self._create_pool(db_session_with_containers, tenant_id=tenant_id, quota_limit=10, quota_used=10)

        with pytest.raises(QuotaExceededError, match="No credits remaining"):
            CreditPoolService.check_and_deduct_credits(
                tenant_id=tenant_id, credits_required=1, session=db_session_with_containers
            )

        updated_pool = CreditPoolService.get_pool(tenant_id=tenant_id, session=db_session_with_containers)
        assert updated_pool is not None
        assert updated_pool.quota_used == 10

    def test_check_and_deduct_credits_deducts_required_amount(self, db_session_with_containers: Session) -> None:
        tenant_id = self._create_tenant_id()
        self._create_pool(db_session_with_containers, tenant_id=tenant_id, quota_limit=10, quota_used=2)
        credits_required = 3

        result = CreditPoolService.check_and_deduct_credits(
            tenant_id=tenant_id, credits_required=credits_required, session=db_session_with_containers
        )

        assert result == credits_required
        pool = CreditPoolService.get_pool(tenant_id=tenant_id, session=db_session_with_containers)
        assert pool is not None
        assert pool.quota_used == 5

    def test_check_and_deduct_credits_raises_without_deducting_when_insufficient(
        self, db_session_with_containers: Session
    ) -> None:
        tenant_id = self._create_tenant_id()
        self._create_pool(db_session_with_containers, tenant_id=tenant_id, quota_limit=10, quota_used=9)

        with pytest.raises(QuotaExceededError, match="Insufficient credits remaining"):
            CreditPoolService.check_and_deduct_credits(
                tenant_id=tenant_id, credits_required=3, session=db_session_with_containers
            )

        updated_pool = CreditPoolService.get_pool(tenant_id=tenant_id, session=db_session_with_containers)
        assert updated_pool is not None
        assert updated_pool.quota_used == 9

    def test_check_and_deduct_credits_wraps_unexpected_deduction_errors(
        self, db_session_with_containers: Session
    ) -> None:
        tenant_id = self._create_tenant_id()
        self._create_pool(db_session_with_containers, tenant_id=tenant_id, quota_limit=10, quota_used=2)

        with (
            patch.object(CreditPoolService, "_get_locked_pool", side_effect=RuntimeError("database unavailable")),
            pytest.raises(QuotaExceededError, match="Failed to deduct credits"),
        ):
            CreditPoolService.check_and_deduct_credits(
                tenant_id=tenant_id, credits_required=1, session=db_session_with_containers
            )

        updated_pool = CreditPoolService.get_pool(tenant_id=tenant_id, session=db_session_with_containers)
        assert updated_pool is not None
        assert updated_pool.quota_used == 2

    def test_deduct_credits_capped_depletes_available_balance(self, db_session_with_containers: Session) -> None:
        tenant_id = self._create_tenant_id()
        self._create_pool(db_session_with_containers, tenant_id=tenant_id, quota_limit=10, quota_used=9)

        result = CreditPoolService.deduct_credits_capped(
            tenant_id=tenant_id, credits_required=3, session=db_session_with_containers
        )

        assert result == 1
        updated_pool = CreditPoolService.get_pool(tenant_id=tenant_id, session=db_session_with_containers)
        assert updated_pool is not None
        assert updated_pool.quota_used == 10

    def test_deduct_credits_capped_returns_zero_for_non_positive_request(
        self, db_session_with_containers: Session
    ) -> None:
        tenant_id = self._create_tenant_id()
        self._create_pool(db_session_with_containers, tenant_id=tenant_id, quota_limit=10, quota_used=2)

        result = CreditPoolService.deduct_credits_capped(
            tenant_id=tenant_id, credits_required=0, session=db_session_with_containers
        )

        assert result == 0
        updated_pool = CreditPoolService.get_pool(tenant_id=tenant_id, session=db_session_with_containers)
        assert updated_pool is not None
        assert updated_pool.quota_used == 2

    def test_deduct_credits_capped_returns_zero_when_no_pool(self, db_session_with_containers: Session) -> None:
        result = CreditPoolService.deduct_credits_capped(
            tenant_id=self._create_tenant_id(), credits_required=1, session=db_session_with_containers
        )

        assert result == 0

    def test_deduct_credits_capped_returns_zero_when_pool_is_empty(self, db_session_with_containers: Session) -> None:
        tenant_id = self._create_tenant_id()
        self._create_pool(db_session_with_containers, tenant_id=tenant_id, quota_limit=10, quota_used=10)

        result = CreditPoolService.deduct_credits_capped(
            tenant_id=tenant_id, credits_required=1, session=db_session_with_containers
        )

        assert result == 0
        updated_pool = CreditPoolService.get_pool(tenant_id=tenant_id, session=db_session_with_containers)
        assert updated_pool is not None
        assert updated_pool.quota_used == 10

    def test_deduct_credits_capped_wraps_unexpected_deduction_errors(self, db_session_with_containers: Session) -> None:
        tenant_id = self._create_tenant_id()
        self._create_pool(db_session_with_containers, tenant_id=tenant_id, quota_limit=10, quota_used=2)

        with (
            patch.object(CreditPoolService, "_get_locked_pool", side_effect=RuntimeError("database unavailable")),
            pytest.raises(QuotaExceededError, match="Failed to deduct credits"),
        ):
            CreditPoolService.deduct_credits_capped(
                tenant_id=tenant_id, credits_required=1, session=db_session_with_containers
            )

        updated_pool = CreditPoolService.get_pool(tenant_id=tenant_id, session=db_session_with_containers)
        assert updated_pool is not None
        assert updated_pool.quota_used == 2

    def test_deduct_credits_capped_reraises_quota_exceeded_errors(self, db_session_with_containers: Session) -> None:
        tenant_id = self._create_tenant_id()
        self._create_pool(db_session_with_containers, tenant_id=tenant_id, quota_limit=10, quota_used=2)

        with (
            patch.object(CreditPoolService, "_get_locked_pool", side_effect=QuotaExceededError("quota unavailable")),
            pytest.raises(QuotaExceededError, match="quota unavailable"),
        ):
            CreditPoolService.deduct_credits_capped(
                tenant_id=tenant_id, credits_required=1, session=db_session_with_containers
            )

        updated_pool = CreditPoolService.get_pool(tenant_id=tenant_id, session=db_session_with_containers)
        assert updated_pool is not None
        assert updated_pool.quota_used == 2