From 4872ca2e8a6afab1be50d7eadad87e560691b546 Mon Sep 17 00:00:00 2001
From: BigOrangeQWQ <2284086963@qq.com>
Date: Sun, 8 Sep 2024 23:22:02 +0800
Subject: [PATCH] =?UTF-8?q?feat:=20=E4=BF=AE=E6=94=B9=20render.jinja=20?=
=?UTF-8?q?=E7=9B=B8=E5=85=B3=E5=86=85=E5=AE=B9=E3=80=82?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
docker/docker_plugin_test.py | 32 ++++--
src/plugins/publish/__init__.py | 6 +-
src/plugins/publish/render.py | 7 +-
.../publish/templates/render_data.md.jinja | 24 ++--
.../publish/templates/render_error.md.jinja | 103 ++++++++++--------
src/plugins/publish/utils.py | 2 +-
src/plugins/publish/validation.py | 20 ++--
src/utils/store_test/store.py | 1 +
src/utils/validation/constants.py | 2 +-
src/utils/validation/models.py | 3 +-
10 files changed, 119 insertions(+), 81 deletions(-)
diff --git a/docker/docker_plugin_test.py b/docker/docker_plugin_test.py
index fad12684..3cd6747d 100644
--- a/docker/docker_plugin_test.py
+++ b/docker/docker_plugin_test.py
@@ -251,8 +251,10 @@ async def run(self):
# 创建插件测试项目
await self.create_poetry_project()
if self._create:
- await self.show_package_info()
- await self.show_plugin_dependencies()
+ await asyncio.gather(
+ self.show_package_info(),
+ self.show_plugin_dependencies(),
+ )
await self.run_poetry_project()
metadata = {}
@@ -278,8 +280,14 @@ async def run(self):
return self._run, self._lines_output
async def command(self, cmd: str, timeout: int = 300) -> tuple[bool, str, str]:
- """
- 执行命令
+ """执行命令
+
+ Args:
+ cmd (str): 命令
+ timeout (int, optional): 超时限制. Defaults to 300.
+
+ Returns:
+ tuple[bool, str, str]: 命令执行返回值，标准输出，标准错误
"""
try:
proc = await create_subprocess_shell(
@@ -299,6 +307,7 @@ async def command(self, cmd: str, timeout: int = 300) -> tuple[bool, str, str]:
return not code, stdout.decode(), stderr.decode()
async def create_poetry_project(self):
+ """创建 poetry 项目用来测试插件"""
if not self.path.exists():
self.path.mkdir()
@@ -321,6 +330,7 @@ async def create_poetry_project(self):
self._create = True
async def show_package_info(self) -> None:
+ """获取插件的版本与插件信息"""
if self.path.exists():
code, stdout, stderr = await self.command(
f"poetry show {self.project_link}"
@@ -337,6 +347,7 @@ async def show_package_info(self) -> None:
self._log_output(f"插件 {self.project_link} 信息获取失败。")
async def run_poetry_project(self) -> None:
+ """运行插件"""
if self.path.exists():
# 默认使用 fake 驱动
with open(self.path / ".env", "w", encoding="utf8") as f:
@@ -377,6 +388,7 @@ async def run_poetry_project(self) -> None:
self._log_output(f" {i}")
async def show_plugin_dependencies(self) -> None:
+ """获取插件的依赖"""
if self.path.exists():
code, stdout, stderr = await self.command("poetry export --without-hashes")
@@ -414,9 +426,15 @@ def _get_plugin_module_name(self, require: str) -> str | None:
def main():
- plugin = PluginTest(
- os.environ.get("PLUGIN_INFO", ""), os.environ.get("PLUGIN_CONFIG", None)
- )
+ """
+ 根据传入的环境变量 PLUGIN_INFO 和 PLUGIN_CONFIG 进行测试
+
+ PLUGIN_INFO 即为该插件的键
+ """
+
+ plugin_info = os.environ.get("PLUGIN_INFO", "")
+ plugin_config = os.environ.get("PLUGIN_CONFIG", None)
+ plugin = PluginTest(plugin_info, plugin_config)
asyncio.run(plugin.run())
diff --git a/src/plugins/publish/__init__.py b/src/plugins/publish/__init__.py
index 3c549bc8..f7fd4154 100644
--- a/src/plugins/publish/__init__.py
+++ b/src/plugins/publish/__init__.py
@@ -27,8 +27,6 @@
from .utils import (
process_pr_and_issue_title,
comment_issue,
- commit_and_push,
- create_pull_request,
ensure_issue_content,
ensure_issue_test_button,
resolve_conflict_pull_requests,
@@ -36,7 +34,6 @@
should_skip_plugin_publish,
should_skip_plugin_test,
trigger_registry_update,
- update_file,
)
from .validation import (
validate_adapter_info_from_issue,
@@ -206,6 +203,7 @@ async def handle_publish_plugin_check(
# 分支命名示例 publish/issue123
branch_name = f"{BRANCH_NAME_PREFIX}{issue_number}"
+ # 验证之后创建拉取请求和修改议题的标题
await process_pr_and_issue_title(
bot, repo_info, result, branch_name, issue_number, title, issue
)
@@ -251,6 +249,7 @@ async def handle_adapter_publish_check(
# 分支命名示例 publish/issue123
branch_name = f"{BRANCH_NAME_PREFIX}{issue_number}"
+ # 验证之后创建拉取请求和修改议题的标题
await process_pr_and_issue_title(
bot, repo_info, result, branch_name, issue_number, title, issue
)
@@ -292,6 +291,7 @@ async def handle_bot_publish_check(
# 分支命名示例 publish/issue123
branch_name = f"{BRANCH_NAME_PREFIX}{issue_number}"
+ # 验证之后创建拉取请求和修改议题的标题
await process_pr_and_issue_title(
bot, repo_info, result, branch_name, issue_number, title, issue
)
diff --git a/src/plugins/publish/render.py b/src/plugins/publish/render.py
index 8857fbc7..0ca22bb7 100644
--- a/src/plugins/publish/render.py
+++ b/src/plugins/publish/render.py
@@ -1,5 +1,4 @@
from pathlib import Path
-from typing import TYPE_CHECKING
import jinja2
@@ -7,9 +6,7 @@
from .config import plugin_config
from .constants import LOC_NAME_MAP
-
-if TYPE_CHECKING:
- from src.utils.validation import ValidationDict
+from src.utils.validation import ValidationDict
def tags_to_str(tags: list[dict[str, str]]) -> str:
@@ -50,7 +47,7 @@ def loc_to_name(loc: list[str | int]) -> str:
env.filters["loc_to_name"] = loc_to_name
-async def render_comment(result: "ValidationDict", reuse: bool = False) -> str:
+async def render_comment(result: ValidationDict, reuse: bool = False) -> str:
"""将验证结果转换为评论内容"""
title = f"{result.type}: {result.name}"
diff --git a/src/plugins/publish/templates/render_data.md.jinja b/src/plugins/publish/templates/render_data.md.jinja
index 3682f4ba..b035e12d 100644
--- a/src/plugins/publish/templates/render_data.md.jinja
+++ b/src/plugins/publish/templates/render_data.md.jinja
@@ -1,23 +1,23 @@
{% macro render_data(key, value, skip_plugin_test) %}
{% if key == "homepage" %}
-项目 主页 返回状态码 200。
+ 项目 主页 返回状态码 200。
{%- elif key == "tags" and value %}
-标签: {{ value|tags_to_str }}。
+ 标签: {{ value|tags_to_str }}。
{%- elif key == "project_link" %}
-项目 {{ value }} 已发布至 PyPI。
+ 项目 {{ value }} 已发布至 PyPI。
{%- elif key == "type" %}
-插件类型: {{ value }}。
+ 插件类型: {{ value }}。
{%- elif key == "load" %}
-插件加载测试: {{ value }}。
+ 插件加载测试: {{ value }}。
{%- elif key == "supported_adapters" %}
-插件支持的适配器: {{ value|supported_adapters_to_str }}。
+ 插件支持的适配器: {{ value|supported_adapters_to_str }}。
{%- elif key == "action_url" %}
-{% if skip_plugin_test %}
-插件 加载测试 已跳过。
-{%- else %}
-插件 加载测试 通过。
-{%- endif %}
+ {% if skip_plugin_test %}
+ 插件 加载测试 已跳过。
+ {%- else %}
+ 插件 加载测试 通过。
+ {%- endif %}
{% else %}
-{{ key }}: {{ value }}。
+ {{ key }}: {{ value }}。
{%- endif %}
{% endmacro %}
diff --git a/src/plugins/publish/templates/render_error.md.jinja b/src/plugins/publish/templates/render_error.md.jinja
index f6f96cd6..581572d4 100644
--- a/src/plugins/publish/templates/render_error.md.jinja
+++ b/src/plugins/publish/templates/render_error.md.jinja
@@ -1,47 +1,64 @@
{% macro render_error(error) %}
+
{% set loc = error.loc %}
{% set type = error.type %}
-{%- if loc|length == 3 and loc[0] == "tags" and type == "missing" %}
-第 {{ loc[1] + 1 }} 个标签缺少 {{ loc[2] }} 字段。请确保标签字段完整。
-{% elif loc|length == 3 and loc[0] == "tags" and type == "string_too_long" %}
-第 {{ loc[1] + 1 }} 个标签名称过长请确保标签名称不超过 10 个字符。
-{%- elif loc|length == 3 and loc[0] == "tags" and type == "color_error" %}
-第 {{ loc[1] + 1 }} 个标签颜色错误请确保标签颜色符合十六进制颜色码规则。
-{%- elif loc|length == 2 and loc[0] == "tags" and type == "model_type" %}
-第 {{ loc[1] + 1 }} 个标签格式错误。请确保标签为字典。
-{%- elif type == "homepage" and error.ctx.status_code != -1 %}
-项目 主页 返回状态码 {{ error.ctx.status_code }}。请确保你的项目主页可访问。
-{%- elif type == "homepage" and error.ctx.status_code == -1 %}
-项目 主页 访问出错。错误信息
{{ error.ctx.msg }}测试输出
{{ error.ctx.output }}{{ summary }}
{{ detail }}