langgenius/dify
1
0
Fork 0
mirror of https://github.com/langgenius/dify.git synced 2026-07-21 20:15:31 -04:00
Code Issues 775 Packages Projects Releases 10 Wiki Activity

[PR #28885] feat: Add comprehensive unit tests for TagService with extensive docu… #32222

New Issue
Closed
opened 2026-02-21 20:50:59 -05:00 by yindo · 0 comments
yindo commented 2026-02-21 20:50:59 -05:00
Owner
Copy Link
Copy Source

Original Pull Request: https://github.com/langgenius/dify/pull/28885

State: closed
Merged: Yes

Summary

This PR adds comprehensive unit tests for the TagService class located in api/services/tag_service.py. The test suite provides complete coverage for all tag management operations, including tag creation, updates, deletion, binding operations, filtering, and retrieval.

Fix: #28884

What's Changed

  • Test Coverage: Added comprehensive unit tests covering all 12 methods in TagService
  • Documentation: Extensive inline documentation, comments, and docstrings explaining test logic and expected behavior
  • Test Organization: Tests organized into three main test classes:
    • TestTagServiceRetrieval: Tag listing, filtering, and retrieval operations
    • TestTagServiceCRUD: Tag creation, update, and deletion operations
    • TestTagServiceBindings: Tag-to-resource binding operations

Test Coverage Details

Tag Creation and Management

  • ✅ save_tags: Tag creation with validation, UUID generation, tenant isolation
  • ✅ update_tags: Tag name updates with duplicate name prevention
  • ✅ delete_tag: Tag deletion with cascade deletion of bindings
  • ✅ get_tag_binding_count: Binding count retrieval

Tag Binding to Datasets

  • ✅ save_tag_binding: Creating bindings between tags and datasets/apps
  • ✅ delete_tag_binding: Removing tag bindings
  • ✅ check_target_exists: Target validation for datasets and apps

Tag-based Filtering

  • ✅ get_tags: Tag retrieval with keyword filtering and binding counts
  • ✅ get_target_ids_by_tag_ids: Filtering datasets/apps by tag IDs

Tag Retrieval and Listing

  • ✅ get_tag_by_tag_name: Tag lookup by exact name match
  • ✅ get_tags_by_target_id: Retrieving tags bound to specific targets

Key Features

  • 100% Function Coverage: All methods in TagService are tested
  • Edge Case Handling: Tests cover empty inputs, NotFound exceptions, duplicate validation
  • Tenant Isolation: Verifies proper multi-tenancy enforcement
  • Mocking Strategy: All external dependencies (database, current_user) are properly mocked
  • Factory Pattern: Uses TagServiceTestDataFactory for consistent test data creation
  • AAA Pattern: All tests follow Arrange-Act-Assert structure

Testing Approach

  • Mocked database session and queries for fast, isolated unit tests
  • Mocked current_user from Flask-Login for authentication context
  • Comprehensive error handling tests (NotFound, ValueError)
  • Validation tests for duplicate names, empty inputs, and invalid types
  • Cascade deletion verification for data integrity

Screenshots

N/A (Backend unit tests, no UI changes)

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 dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

Related Files

  • api/services/tag_service.py - Service under test (177 lines, 12 methods)
  • api/tests/unit_tests/services/test_tag_service.py - Test suite (870+ lines)
  • api/models/model.py - Tag and TagBinding models
  • api/models/dataset.py - Dataset model

Benefits

  • Improved Code Reliability: Comprehensive test coverage ensures tag operations work correctly
  • Easier Refactoring: Tests provide confidence when making changes to tag functionality
  • Better Documentation: Extensive comments serve as documentation for expected behavior
  • Regression Prevention: Tests catch regressions when making changes to tag-related code
  • Multi-tenancy Validation: Tests verify tenant isolation is properly enforced
  • Data Integrity: Tests verify cascade deletion and validation logic

Contribution by Gittensor, learn more at https://gittensor.io/

**Original Pull Request:** https://github.com/langgenius/dify/pull/28885 **State:** closed **Merged:** Yes --- ## Summary This PR adds comprehensive unit tests for the `TagService` class located in `api/services/tag_service.py`. The test suite provides complete coverage for all tag management operations, including tag creation, updates, deletion, binding operations, filtering, and retrieval. Fix: #28884 ### What's Changed - **Test Coverage**: Added comprehensive unit tests covering all 12 methods in `TagService` - **Documentation**: Extensive inline documentation, comments, and docstrings explaining test logic and expected behavior - **Test Organization**: Tests organized into three main test classes: - `TestTagServiceRetrieval`: Tag listing, filtering, and retrieval operations - `TestTagServiceCRUD`: Tag creation, update, and deletion operations - `TestTagServiceBindings`: Tag-to-resource binding operations ### Test Coverage Details #### Tag Creation and Management - ✅ `save_tags`: Tag creation with validation, UUID generation, tenant isolation - ✅ `update_tags`: Tag name updates with duplicate name prevention - ✅ `delete_tag`: Tag deletion with cascade deletion of bindings - ✅ `get_tag_binding_count`: Binding count retrieval #### Tag Binding to Datasets - ✅ `save_tag_binding`: Creating bindings between tags and datasets/apps - ✅ `delete_tag_binding`: Removing tag bindings - ✅ `check_target_exists`: Target validation for datasets and apps #### Tag-based Filtering - ✅ `get_tags`: Tag retrieval with keyword filtering and binding counts - ✅ `get_target_ids_by_tag_ids`: Filtering datasets/apps by tag IDs #### Tag Retrieval and Listing - ✅ `get_tag_by_tag_name`: Tag lookup by exact name match - ✅ `get_tags_by_target_id`: Retrieving tags bound to specific targets ### Key Features - **100% Function Coverage**: All methods in `TagService` are tested - **Edge Case Handling**: Tests cover empty inputs, NotFound exceptions, duplicate validation - **Tenant Isolation**: Verifies proper multi-tenancy enforcement - **Mocking Strategy**: All external dependencies (database, current_user) are properly mocked - **Factory Pattern**: Uses `TagServiceTestDataFactory` for consistent test data creation - **AAA Pattern**: All tests follow Arrange-Act-Assert structure ### Testing Approach - Mocked database session and queries for fast, isolated unit tests - Mocked `current_user` from Flask-Login for authentication context - Comprehensive error handling tests (NotFound, ValueError) - Validation tests for duplicate names, empty inputs, and invalid types - Cascade deletion verification for data integrity ## Screenshots N/A (Backend unit tests, no UI changes) ## Checklist - [ ] This change requires a documentation update, included: [Dify Document](https://github.com/langgenius/dify-docs) - [x] I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!) - [x] I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change. - [x] I've updated the documentation accordingly. - [x] I ran `dev/reformat`(backend) and `cd web && npx lint-staged`(frontend) to appease the lint gods ### Related Files - `api/services/tag_service.py` - Service under test (177 lines, 12 methods) - `api/tests/unit_tests/services/test_tag_service.py` - Test suite (870+ lines) - `api/models/model.py` - Tag and TagBinding models - `api/models/dataset.py` - Dataset model ### Benefits - **Improved Code Reliability**: Comprehensive test coverage ensures tag operations work correctly - **Easier Refactoring**: Tests provide confidence when making changes to tag functionality - **Better Documentation**: Extensive comments serve as documentation for expected behavior - **Regression Prevention**: Tests catch regressions when making changes to tag-related code - **Multi-tenancy Validation**: Tests verify tenant isolation is properly enforced - **Data Integrity**: Tests verify cascade deletion and validation logic Contribution by Gittensor, learn more at https://gittensor.io/
yindo added the pull-request label 2026-02-21 20:50:59 -05:00
yindo closed this issue 2026-02-21 20:50:59 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Knowledge Pipeline
Proposal
WIP
cloud
dependencies
feat:webapp
good first issue
outdated
performance
pull-request
Mirrored from GitHub Pull Request
 python:uv
refactor
size:L
stale
status: accepting prs
status: blocked
status: in discussion
stt & tts
vulnerablity
web
wont-fix
🌊 feat:workflow
🌚 invalid
🐞 bug
👻 feat:rag
💪 enhancement
📚 documentation
🔨 feat:tools
🙋‍♂️ question
🙏 help wanted
🤔 cant-reproduce
🤖 feat:agent
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#32222
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?