zt-devops-cli 0.2.2__tar.gz → 0.2.4__tar.gz

{zt_devops_cli-0.2.2 → zt_devops_cli-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zt-devops-cli
-Version: 0.2.2
+Version: 0.2.4
 Summary: DevOps 平台迭代管理 CLI
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown

{zt_devops_cli-0.2.2 → zt_devops_cli-0.2.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "zt-devops-cli"
-version = "0.2.2"
+version = "0.2.4"
 description = "DevOps 平台迭代管理 CLI"
 readme = "README.md"
 requires-python = ">=3.10"

{zt_devops_cli-0.2.2 → zt_devops_cli-0.2.4}/src/zt_devops_cli/api.py

@@ -346,6 +346,13 @@ class DevOpsAPI:
             data=data,
         )
 
+    def get_bug(self, bug_id: str) -> dict:
+        """查询单个工作项详情（GET issue/{projectId}/{issueId}，缺陷详情页同源接口）。"""
+        return self._request(
+            "GET",
+            f"/ms/vteam/api/user/issue/{self.project_id}/{bug_id}",
+        )
+
     def bug_direction_next(
             self,
             issue_id: str,

{zt_devops_cli-0.2.2 → zt_devops_cli-0.2.4}/src/zt_devops_cli/cli.py

@@ -3,7 +3,7 @@ import os
 import click
 import json
 import shutil
-from typing import Optional
+from typing import Callable, Optional
 
 from .api import BUG_DIRECTION_NEXT_NODE_IDS, DevOpsAPI
 from .auth import login
@@ -98,6 +98,85 @@ def render_table(headers, rows, max_width=120, no_truncate_headers=None):
     click.echo(border)
 
 
+def _extract_api_message(payload) -> str:
+    if not isinstance(payload, dict):
+        return ""
+    for key in ("message", "msg", "errorMsg", "error"):
+        value = payload.get(key)
+        if isinstance(value, str) and value.strip():
+            return value.strip()
+    return ""
+
+
+def _is_api_success(payload) -> bool:
+    """兼容不同后端返回结构，判断请求是否成功。"""
+    if payload is None:
+        return False
+
+    # HTTP 2xx 但无 body 的场景，_request 会返回 {}
+    if isinstance(payload, dict) and not payload:
+        return True
+
+    if not isinstance(payload, dict):
+        return False
+
+    for key in ("success", "ok"):
+        if key in payload:
+            return bool(payload.get(key))
+
+    code = payload.get("code")
+    if code is not None:
+        if str(code).strip() in {"0", "200"}:
+            return True
+        return False
+
+    status = payload.get("status")
+    if isinstance(status, str):
+        norm_status = status.strip().lower()
+        if norm_status in {"success", "ok", "succeeded"}:
+            return True
+        if norm_status in {"fail", "failed", "error"}:
+            return False
+
+    message = _extract_api_message(payload).lower()
+    if message:
+        if any(word in message for word in ("失败", "错误", "error", "fail")):
+            return False
+        if any(word in message for word in ("成功", "success")):
+            return True
+
+    if "data" in payload:
+        return payload.get("data") is not None
+
+    return False
+
+
+def _print_action_result(
+        ctx,
+        result,
+        success_text: str = "",
+        fail_prefix: str = "操作失败",
+        success_checker: Optional[Callable[[dict], bool]] = None,
+        success_text_builder: Optional[Callable[[dict], str]] = None,
+) -> bool:
+    """统一处理命令结果输出；返回是否成功。"""
+    checker = success_checker or _is_api_success
+
+    if ctx.obj.get("output_format") == "json":
+        click.echo(json.dumps(result, ensure_ascii=False, indent=2, default=str))
+        return checker(result)
+
+    if checker(result):
+        text = success_text_builder(result) if success_text_builder else success_text
+        if text:
+            click.echo(text)
+        return True
+
+    msg = _extract_api_message(result) or "未返回成功状态"
+    click.echo(f"{fail_prefix}: {msg}", err=True)
+    return False
+
+
 @click.group()
 @click.option("--project", "-p", default=None, help="项目 ID")
 @click.option(
@@ -170,8 +249,8 @@ def zteam_project():
 @click.option("--start-date", "-s", required=True, help="开始日期 (YYYY-MM-DD)")
 @click.option("--end-date", "-e", required=True, help="结束日期 (YYYY-MM-DD)")
 @click.option("--purpose", required=True, help="迭代目标")
-@click.option("--test-start", required=True,  help="测试开始日期")
-@click.option("--test-end",required=True,  help="测试结束日期")
+@click.option("--test-start", required=True, help="测试开始日期")
+@click.option("--test-end", required=True, help="测试结束日期")
 @click.pass_context
 def create_sprint(ctx, project, title, start_date, end_date, purpose, test_start, test_end):
     """创建迭代"""
@@ -191,10 +270,15 @@ def create_sprint(ctx, project, title, start_date, end_date, purpose, test_start
             test_end_date=test_end,
         )
 
-        if result.get("0") == "0":
-            click.echo(f"创建成功! 迭代 ID: {result.get('id')}")
-        else:
-            click.echo(f"错误: {result.get('message')}", err=True)
+        _print_action_result(
+            ctx,
+            result,
+            fail_prefix="创建失败",
+            success_checker=lambda payload: bool(
+                payload.get("data", {}).get("id")
+            ) if isinstance(payload, dict) else False,
+            success_text_builder=lambda payload: f"创建成功! 迭代 ID: {payload.get('data', {}).get('id')}",
+        )
 
     except Exception as e:
         click.echo(f"错误: {e}", err=True)
@@ -225,7 +309,7 @@ def start_sprint(ctx, project, sprint_id):
             return
 
         result = api.start_sprint(sprint_data)
-        click.echo(f"启用成功!")
+        _print_action_result(ctx, result, "启用成功!", "启用失败")
     except Exception as e:
         click.echo(f"错误: {e}", err=True)
 
@@ -246,8 +330,8 @@ def delete_sprint(ctx, project, sprint_id):
         return
 
     try:
-        api.delete_sprint(sprint_id)
-        click.echo(f"删除成功!")
+        result = api.delete_sprint(sprint_id)
+        _print_action_result(ctx, result, "删除成功!", "删除失败")
     except Exception as e:
         click.echo(f"错误: {e}", err=True)
 
@@ -268,8 +352,8 @@ def done_sprint(ctx, project, sprint_id):
         return
 
     try:
-        api.done_sprint(sprint_id)
-        click.echo(f"完成成功!")
+        result = api.done_sprint(sprint_id)
+        _print_action_result(ctx, result, "完成成功!", "完成失败")
     except Exception as e:
         click.echo(f"错误: {e}", err=True)
 
@@ -798,6 +882,79 @@ def list_bugs(
         click.echo(f"错误: {e}", err=True)
 
 
+def _flatten_issue_detail_for_table(detail):
+    """将详情接口返回的 data 展平为 {字段: 显示值}，供 human 表格使用。"""
+    if not isinstance(detail, dict):
+        return {}
+
+    def _unwrap_value(v):
+        if not isinstance(v, dict):
+            return v
+        for key in ("value", "label", "name", "displayName", "text", "title"):
+            if key in v and v.get(key) not in (None, ""):
+                return v.get(key)
+        return json.dumps(v, ensure_ascii=False)
+
+    rows = {}
+    prop = detail.get("property")
+    if isinstance(prop, dict):
+        for k, v in prop.items():
+            rows[k] = _unwrap_value(v)
+
+    for k, v in detail.items():
+        if k == "property":
+            continue
+        if k in rows:
+            continue
+        if isinstance(v, (dict, list)):
+            rows[k] = json.dumps(v, ensure_ascii=False) if v else ""
+        else:
+            rows[k] = v
+
+    return rows
+
+
+@bug.command("detail")
+@click.option("--project", "-p", default=None, help="项目 ID")
+@click.option("--bug-id", "-i", required=True, help="缺陷 ID（与列表「缺陷ID」、详情页 URL 中 id 一致）")
+@click.pass_context
+def get_bug_detail(ctx, project, bug_id):
+    """查询单个缺陷详情"""
+    project_id = project or ctx.obj["project"]
+    if not project_id:
+        click.echo("错误: 请通过 -p 指定项目 ID 或在配置中设置 default_project", err=True)
+        raise click.Abort()
+
+    api = DevOpsAPI(project_id)
+    try:
+        payload = api.get_bug(bug_id)
+        data = payload.get("data") if isinstance(payload, dict) else None
+
+        if ctx.obj.get("output_format") == "json":
+            out = data if data is not None else payload
+            click.echo(json.dumps(out, ensure_ascii=False, indent=2, default=str))
+            return
+
+        if data is None:
+            msg = _extract_api_message(payload) if isinstance(payload, dict) else ""
+            click.echo(msg or "未返回详情数据", err=True)
+            return
+
+        flat = _flatten_issue_detail_for_table(data)
+        if not flat:
+            click.echo(json.dumps(data, ensure_ascii=False, indent=2, default=str))
+            return
+
+        keys = sorted(flat.keys(), key=lambda x: (str(x).lower(), str(x)))
+        render_table(
+            headers=["字段", "值"],
+            rows=[[k, flat[k]] for k in keys],
+            no_truncate_headers=["字段", "值"],
+        )
+    except Exception as e:
+        click.echo(f"错误: {e}", err=True)
+
+
 @bug.command("get-states")
 @click.option("--project", "-p", required=True, help="项目 ID")
 @click.option(
@@ -1027,12 +1184,13 @@ def list_bug_types(ctx, project, all_options, field_id):
 @click.option("--zteam-project-id", required=True, help="ZTeam 项目 ID")
 @click.option("--sprint-id", required=True, default="", show_default=True, help="迭代 id")
 @click.option("--title", "-t", required=True, help="缺陷标题")
-@click.option("--priority",  default="CENTRAL", show_default=True, help="缺陷优先级")
+@click.option("--priority", default="CENTRAL", show_default=True, help="缺陷优先级")
 @click.option("--desc-editor-type", default="RICHTEXT", show_default=True, help="缺陷描述编辑器类型")
-@click.option("--desc",default="<h2><span style=\"font-size: 16px;\">【前置条件】</span></h2>\n"
-            "<h2><span style=\"font-size: 16px;\">【操作步骤】</span></h2>\n"
-            "<h2><span style=\"font-size: 16px;\">【实际结果】</span></h2>\n"
-            "<h2><span style=\"font-size: 16px;\">【预期结果】</span></h2>",show_default=True, help="缺陷描述（支持 HTML")
+@click.option("--desc", default="<h2><span style=\"font-size: 16px;\">【前置条件】</span></h2>\n"
+                                "<h2><span style=\"font-size: 16px;\">【操作步骤】</span></h2>\n"
+                                "<h2><span style=\"font-size: 16px;\">【实际结果】</span></h2>\n"
+                                "<h2><span style=\"font-size: 16px;\">【预期结果】</span></h2>", show_default=True,
+              help="缺陷描述（支持 HTML")
 @click.option("--severity", required=True, default="", show_default=True, help="缺陷严重程度")
 @click.option("--type", required=True, default="", show_default=True, help="缺陷分类")
 @click.option("--discovery-phase", required=True, default="", show_default=True, help="缺陷发现阶段")
@@ -1090,11 +1248,15 @@ def create_bug(
             demand_classify=demand_classify,
             instance_values=instance_values,
         )
-        if ctx.obj.get("output_format") == "json":
-            click.echo(json.dumps(result, ensure_ascii=False, indent=2, default=str))
-            return
-        bug_id = result.get("data", {}).get("id") if isinstance(result, dict) else None
-        click.echo(f"创建成功! 缺陷 ID: {bug_id or '-'}")
+        _print_action_result(
+            ctx,
+            result,
+            fail_prefix="创建失败",
+            success_checker=lambda payload: bool(
+                payload.get("data", {}).get("id")
+            ) if isinstance(payload, dict) else False,
+            success_text_builder=lambda payload: f"创建成功! 缺陷 ID: {payload.get('data', {}).get('id')}",
+        )
     except Exception as e:
         click.echo(f"错误: {e}", err=True)
 
@@ -1139,16 +1301,12 @@ def _bug_direction_go(ctx, project, bug_id, target_key, comment, operators):
             operators=op_list,
             comment=comment,
         )
-        if ctx.obj.get("output_format") == "json":
-            click.echo(json.dumps(result, ensure_ascii=False, indent=2, default=str))
-            return
-        click.echo("流转请求已提交")
+        _print_action_result(ctx, result, "流转请求已提交", "流转失败")
     except Exception as e:
         click.echo(f"错误: {e}", err=True)
 
 
 def _bug_direction_options(cmd):
-
     cmd = click.option(
         "-i",
         "--bug-id",
@@ -1258,10 +1416,7 @@ def bug_delete(ctx, project, bug_id, yes):
     api = DevOpsAPI(project_id)
     try:
         result = api.delete_issue(bug_id)
-        if ctx.obj.get("output_format") == "json":
-            click.echo(json.dumps(result, ensure_ascii=False, indent=2, default=str))
-            return
-        click.echo("删除成功")
+        _print_action_result(ctx, result, "删除成功", "删除失败")
     except Exception as e:
         click.echo(f"错误: {e}", err=True)
 
@@ -1334,11 +1489,16 @@ def create_task(
             demand_classify=demand_classify,
             instance_values=instance_values,
         )
-        if ctx.obj.get("output_format") == "json":
-            click.echo(json.dumps(result, ensure_ascii=False, indent=2, default=str))
-            return
-        task_id = result.get("data", {}).get("id") if isinstance(result, dict) else None
-        click.echo(f"创建成功! 任务 ID: {task_id or '-'}")
+        _print_action_result(
+            ctx,
+            result,
+            fail_prefix="创建失败",
+            success_checker=lambda payload: bool(
+                payload.get("data", {}).get("id")
+            ) if isinstance(payload, dict) else False,
+            success_text_builder=lambda payload: f"创建成功! 任务 ID: {payload.get('data', {}).get('id')}",
+        )
+
     except Exception as e:
         click.echo(f"错误: {e}", err=True)
 

{zt_devops_cli-0.2.2 → zt_devops_cli-0.2.4}/src/zt_devops_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zt-devops-cli
-Version: 0.2.2
+Version: 0.2.4
 Summary: DevOps 平台迭代管理 CLI
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown