Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 修复插件商店检查插件更新问题 #1597

Merged
merged 2 commits into from
Sep 2, 2024

Conversation

AkashiCoin
Copy link
Collaborator

@AkashiCoin AkashiCoin commented Sep 2, 2024

Sourcery的总结

修复插件更新检查逻辑,并通过添加新的测试用例和重构插件加载方法来增强测试覆盖率。引入处理不存在插件的测试,并更新现有测试以使用实际的插件内容。

新功能:

  • 引入一个新的测试用例来处理插件不存在的场景,确保在尝试添加、更新或搜索不存在的插件时发送适当的消息。

错误修复:

  • 修复版本检查功能中的逻辑,以正确识别何时有插件更新可用。

增强:

  • 将检索已加载插件的方法重构为一个单独的异步函数 get_loaded_plugins,以提高代码的模块化和重用性。
  • 更新测试用例以使用插件文件的实际内容字节而不是空字节字符串,确保更真实的测试场景。

测试:

  • 为插件 github_subsearch_imagejitang 添加新的测试文件,以提供元数据和使用信息,增强这些插件的测试覆盖率。
Original summary in English

Summary by Sourcery

Fix plugin update check logic and enhance test coverage by adding new test cases and refactoring plugin loading methods. Introduce tests for handling non-existent plugins and update existing tests to use actual plugin content.

New Features:

  • Introduce a new test case to handle scenarios where a plugin does not exist, ensuring appropriate messages are sent when attempting to add, update, or search for non-existent plugins.

Bug Fixes:

  • Fix the logic in the version check function to correctly identify when a plugin update is available.

Enhancements:

  • Refactor the method for retrieving loaded plugins into a separate asynchronous function get_loaded_plugins to improve code modularity and reuse.
  • Update test cases to use actual content bytes for plugin files instead of empty byte strings, ensuring more realistic test scenarios.

Tests:

  • Add new test files for plugins github_sub, search_image, and jitang to provide metadata and usage information, enhancing the test coverage for these plugins.

Copy link
Contributor

sourcery-ai bot commented Sep 2, 2024

审核指南由 Sourcery 提供

此拉取请求修复了插件商店中检查插件更新的问题。更改主要集中在改进更新检查逻辑、增强测试覆盖率以及重构一些现有代码以提高可维护性。

文件级更改

更改 详情 文件
修复插件更新检查逻辑
  • 修改了 check_version_is_new 方法以正确识别插件是否是最新的
  • 更新了 version_check 方法以反映新的逻辑
  • 为插件已经是最新的情况添加了新的测试用例
zhenxun/builtin_plugins/plugin_store/data_source.py
改进插件商店功能的测试覆盖率
  • 为更新插件添加了新的测试用例,包括插件已经是最新的情况
  • 实现了处理不存在插件的测试
  • 创建了辅助函数 get_content_bytes 用于加载测试数据
tests/builtin_plugins/plugin_store/test_plugin_store.py
重构代码以提高可维护性
  • 引入了新方法 get_loaded_plugins 以集中检索已加载插件的逻辑
  • 更新了现有方法以使用新的 get_loaded_plugins 方法
zhenxun/builtin_plugins/plugin_store/data_source.py
添加用于测试的示例插件文件
  • 为 'github_sub'、'search_image' 和 'jitang' 插件创建了示例文件
tests/content/plugin_store/github_sub.py
tests/content/plugin_store/search_image.py
tests/content/plugin_store/jitang.py

提示
  • 通过在拉取请求中评论 @sourcery-ai review 来触发新的 Sourcery 审核。
  • 通过直接回复审核评论继续与 Sourcery 的讨论。
  • 您可以随时通过访问您的仪表板更改审核设置:
    • 启用或禁用 Sourcery 生成的拉取请求摘要或审核指南;
    • 更改审核语言;
  • 如果您有任何问题或反馈,您可以随时联系我们
Original review guide in English

Reviewer's Guide by Sourcery

This pull request fixes an issue with checking for plugin updates in the plugin store. The changes primarily focus on improving the update checking logic, enhancing test coverage, and refactoring some existing code for better maintainability.

File-Level Changes

Change Details Files
Fixed plugin update check logic
  • Modified the check_version_is_new method to correctly identify when a plugin is up-to-date
  • Updated the version_check method to reflect the new logic
  • Added a new test case for when a plugin is already up-to-date
zhenxun/builtin_plugins/plugin_store/data_source.py
Improved test coverage for plugin store functionality
  • Added new test cases for updating plugins, including when a plugin is already up-to-date
  • Implemented tests for handling non-existent plugins
  • Created helper function get_content_bytes for loading test data
tests/builtin_plugins/plugin_store/test_plugin_store.py
Refactored code for better maintainability
  • Introduced a new method get_loaded_plugins to centralize the logic for retrieving loaded plugins
  • Updated existing methods to use the new get_loaded_plugins method
zhenxun/builtin_plugins/plugin_store/data_source.py
Added sample plugin files for testing
  • Created sample files for 'github_sub', 'search_image', and 'jitang' plugins
tests/content/plugin_store/github_sub.py
tests/content/plugin_store/search_image.py
tests/content/plugin_store/jitang.py

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
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.

@AkashiCoin - 我已经审查了你的更改,看起来很棒!

这是我在审查期间查看的内容
  • 🟢 一般问题:一切看起来都很好
  • 🟢 安全性:一切看起来都很好
  • 🟡 测试:发现1个问题
  • 🟢 复杂性:一切看起来都很好
  • 🟢 文档:一切看起来都很好

Sourcery 对开源项目免费 - 如果你喜欢我们的审查,请考虑分享它们 ✨
帮助我变得更有用!请点击 👍 或 👎 在每个评论上告诉我它是否有帮助。
Original comment in English

Hey @AkashiCoin - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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 to tell me if it was helpful.

group_id=GroupId.GROUP_ID_LEVEL_5,
message_id=MessageId.MESSAGE_ID,
to_me=True,
)
Copy link
Contributor

Choose a reason for hiding this comment

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

建议(测试): 新增测试用例以处理不存在的插件

此测试用例通过检查系统如何处理无效的插件ID来提高覆盖率。考虑为边缘情况添加类似的测试,例如负ID或非数字输入。

async def test_plugin_not_exist_negative_id(app, mocker, mocked_api, create_bot, tmp_path):
    """测试处理负插件ID"""
    init_mocked_api(mocked_api=mocked_api)
    plugin_id = -1
    async with app.test_matcher(_matcher) as ctx:
        bot = create_bot(ctx)
        event = _v11_group_message_event(
            message=f"添加插件 {plugin_id}",
            self_id=BotId.QQ_BOT,
            user_id=UserId.SUPERUSER,
            group_id=GroupId.GROUP_ID_LEVEL_5,
            message_id=MessageId.MESSAGE_ID,
            to_me=True,
        )
        ctx.receive_event(bot=bot, event=event)
        ctx.should_call_send(message="无效的插件ID")
Original comment in English

suggestion (testing): New test case added for handling non-existent plugins

This test case improves coverage by checking how the system handles invalid plugin IDs. Consider adding similar tests for edge cases like negative IDs or non-numeric inputs.

async def test_plugin_not_exist_negative_id(app, mocker, mocked_api, create_bot, tmp_path):
    """Test handling of negative plugin ID"""
    init_mocked_api(mocked_api=mocked_api)
    plugin_id = -1
    async with app.test_matcher(_matcher) as ctx:
        bot = create_bot(ctx)
        event = _v11_group_message_event(
            message=f"添加插件 {plugin_id}",
            self_id=BotId.QQ_BOT,
            user_id=UserId.SUPERUSER,
            group_id=GroupId.GROUP_ID_LEVEL_5,
            message_id=MessageId.MESSAGE_ID,
            to_me=True,
        )
        ctx.receive_event(bot=bot, event=event)
        ctx.should_call_send(message="Invalid plugin ID")

@AkashiCoin AkashiCoin merged commit 9eca6a9 into HibiKier:dev Sep 2, 2024
1 check passed
@AkashiCoin AkashiCoin deleted the fix/plugin_store branch September 2, 2024 04:00
@HibiKier HibiKier mentioned this pull request Sep 30, 2024
HibiKier added a commit that referenced this pull request Sep 30, 2024
* ✨ 父级插件加载

* ✅ 添加测试:更新与添加插件 (#1594)

* ✅ 测试更新与添加插件

* ✅ Sourcery建议

* 👷 添加pytest

* 🎨 优化代码

* 🐛 bug修复

* 🐛修复添加插件返回403的问题 (#1595)

* 完善测试方法
* vscode测试配置
* 重构插件安装过程

* 🎨 修改readme

* Update README.md

* 🐛 修改bug与版本锁定

* 🐛 修复超级用户对群组功能开关

* 🐛 修复插件商店检查插件更新问题 (#1597)

* 🐛 修复插件商店检查插件更新问题

* 🐛 恶意命令检测问题

* 🐛 增加插件状态检查 (#1598)

* ✅ 优化测试用例

* 🐛 更改插件更新与安装逻辑

* 🐛 修复更新群组成员信息

* 🎨 代码优化

* 🚀 更新Dockerfile (#1599)

* 🎨 更新requirements

* ➕ 添加依赖aiocache

* ⚡ 添加github镜像

* ✨ 添加仓库目录多获取渠道

* 🐛 修复测试用例

* ✨ 添加API缓存

* 🎨 采取Sourcery建议

* 🐛 文件下载逻辑修改

* 🎨 优化代码

* 🐛 修复插件开关有时出现错误

* ✨ 重构自检ui

* 🐛 自检html修正

* 修复签到逻辑bug,并使代码更灵活以适应签到好感度等级配置 (#1606)

* 修复签到功能已知问题

* 修复签到功能已知问题

* 修改参数名称

* 修改uid判断

---------

Co-authored-by: HibiKier <[email protected]>

* 🎨 代码结构优化

* 🐛 私聊时修改插件时删除私聊帮助

* 🐛 过滤父插件

* 🐛 修复自检在ARM上的问题 (#1607)

* 🐛 修复自检在ARM上的问题

* ✅ 优化测试

* ✨ 支持mysql,psql,sqlite随机函数

* 🔧 VSCode配置修改

* 🔧 VSCode配置修改

* ✨ 添加金币排行

Co-Authored-By: HibiKier <[email protected]>

* 📝 修改README

Co-Authored-By: HibiKier <[email protected]>

* 🔨 提取GitHub相关操作 (#1609)

* 🔨 提取GitHub相关操作

* 🔨 重构API策略

* ✨ 签到/金币排行限制最大数量 (#1616)

* ✨ 签到/金币排行限制最大数量

* 🐛 修复超级用户id获取问题

* 🐛 修复路径解压与挂载 (#1619)

* 🐛 修复功能少时zhenxun帮助图片排序问题 (#1620)

* 🐛 签到文本适应 (#1622)

* 🐛 好感度排行提供默认值 (#1624)

* 🎈 优先使用github api (#1625)

* ✨ 重构帮助,限制普通用户查询管理插件 (#1626)

* 🐛 修复群权限与插件等级匹配 (#1627)

* ✨ 当管理员尝试ban真寻时将被反杀 (#1628)

* ✨ 群组发言时间检测提供开关配置 (#1630)

* 🐳 chore: 支持自动修改版本号 (#1629)

* 🎈 perf(github_utils): 支持github url下载遍历 (#1632)

* 🎈 perf(github_utils): 支持github url下载遍历

* 🐞 fix(http_utils): 修复一些下载问题

* 🦄 refactor(http_utils): 部分重构

* chore(version): Update version to v0.2.2-e6f17c4

---------

Co-authored-by: AkashiCoin <[email protected]>

* 🧪 test(auto_update): 修复测试用例 (#1633)

* 🐛 修复商店商品为空时报错 (#1634)

* 🐛 修复群权限与插件等级匹配 (#1635)

* ✨ message_build支持AtAll (#1639)

* 🎈 perf: 使用commit号下载插件 (#1641)

* 🎈 perf: 使用commit号下载插件

* chore(version): Update version to v0.2.2-f9c7360

---------

Co-authored-by: AkashiCoin <[email protected]>

* 🐳 chore: 修改运行检查触发路径 (#1642)

* 🐳 chore: 修改运行检查触发路径

* 🐳 chore: 添加tests目录

* ✨ 重构qq群事件处理 (#1643)

* 🐛 签到名称自适应 (#1644)

* 🎨  更新README (#1645)

* 🐛 fix(http_utils): 流式下载Content-Length错误 (#1647)

* 🐛 修复群组中帮助功能状态显示问题 (#1650)

* 🐛 修复群欢迎消息设置 (#1651)

* 🐛 修复webui下载后首次启动错误 (#1652)

* 🐛 修复webui下载后首次启动错误

* chore(version): Update version to v0.2.2-4a8ef85

---------

Co-authored-by: HibiKier <[email protected]>

* ✨ 移除默认图片文件夹:爬 (#1653)

* ✨ 安装/移除插件提供插件安装/卸载方法用于插件初始化 (#1654)

* ✨ 新增超级用户与管理员帮助模板 (#1655)

* ✨ 新增个人信息命令 (#1657)

* ✨ 修改个人信息菜单名称 (#1658)

* ✨ 新增插件商店api (#1659)

* ✨ 新增插件商店api

* chore(version): Update version to v0.2.2-7e15f20

---------

Co-authored-by: HibiKier <[email protected]>

* ✨ 将cd,block,count限制复原配置文件 (#1662)

* 🎨 修改README (#1663)

* 🎨 修改版本号 (#1664)

* 🎨 修改requirements (#1665)

---------

Co-authored-by: AkashiCoin <[email protected]>
Co-authored-by: fanyinrumeng <[email protected]>
Co-authored-by: AkashiCoin <[email protected]>
Co-authored-by: Elaga <[email protected]>
Co-authored-by: AkashiCoin <[email protected]>
Co-authored-by: HibiKier <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant