feat: 新建 pm 模块,添加 6 条项目管理命令 (dashboards/sprints/weekly/tags/pipelines/runs)
CI / Build, Lint, Test (pull_request) Failing after 2m9s Details

- 新增 shortcuts/pm/pm.go: 6 条 Shortcut 命令
- 新增 shortcuts/pm/pm_test.go: 单元测试覆盖
- 修改 shortcuts/register.go: 注册 pm 模块
- 修复 register.go 中 milestone 描述缺少逗号的语法问题

关联 Issue: #12
This commit is contained in:
wyxfzgg 2026-06-03 11:27:44 +08:00
parent eae0269171
commit b4cfdb753e
3 changed files with 361 additions and 1 deletions

137
shortcuts/pm/pm.go Normal file
View File

@ -0,0 +1,137 @@
package pm
import (
"net/url"
"github.com/gitlink-org/gitlink-cli/shortcuts/common"
)
// Shortcuts returns project management shortcuts for GitLink.
//
// The pm domain provides commands for viewing dashboards, sprints,
// weekly issues, tags, pipelines, and action runs associated with
// a project.
func Shortcuts() []*common.Shortcut {
return []*common.Shortcut{
{
Name: "dashboards",
Description: "查看项目仪表盘数据",
Flags: []common.Flag{
{Name: "project", Usage: "项目 ID", Required: true},
},
Run: func(ctx *common.RuntimeContext) error {
project, err := ctx.RequireArg("project")
if err != nil {
return err
}
q := url.Values{}
q.Set("project_id", project)
env, err := ctx.CallAPIWithQuery("GET", "/pm/dashboards", q)
if err != nil {
return err
}
return ctx.Output(env)
},
},
{
Name: "sprints",
Description: "查看 Sprint 任务列表",
Flags: []common.Flag{
{Name: "project", Usage: "项目 ID", Required: true},
},
Run: func(ctx *common.RuntimeContext) error {
project, err := ctx.RequireArg("project")
if err != nil {
return err
}
q := url.Values{}
q.Set("project_id", project)
env, err := ctx.CallAPIWithQuery("GET", "/pm/sprint_issues", q)
if err != nil {
return err
}
return ctx.Output(env)
},
},
{
Name: "weekly",
Description: "查看周报任务",
Flags: []common.Flag{
{Name: "project", Usage: "项目 ID", Required: true},
},
Run: func(ctx *common.RuntimeContext) error {
project, err := ctx.RequireArg("project")
if err != nil {
return err
}
q := url.Values{}
q.Set("project_id", project)
env, err := ctx.CallAPIWithQuery("GET", "/pm/weekly_issues", q)
if err != nil {
return err
}
return ctx.Output(env)
},
},
{
Name: "tags",
Description: "查看项目 Issue 标签",
Flags: []common.Flag{
{Name: "project", Usage: "项目 ID", Required: true},
},
Run: func(ctx *common.RuntimeContext) error {
project, err := ctx.RequireArg("project")
if err != nil {
return err
}
q := url.Values{}
q.Set("project_id", project)
env, err := ctx.CallAPIWithQuery("GET", "/pm/issue_tags", q)
if err != nil {
return err
}
return ctx.Output(env)
},
},
{
Name: "pipelines",
Description: "查看项目 CI/CD 流水线列表",
Flags: []common.Flag{
{Name: "project", Usage: "项目 ID", Required: true},
},
Run: func(ctx *common.RuntimeContext) error {
project, err := ctx.RequireArg("project")
if err != nil {
return err
}
q := url.Values{}
q.Set("project_id", project)
env, err := ctx.CallAPIWithQuery("GET", "/pm/pipelines", q)
if err != nil {
return err
}
return ctx.Output(env)
},
},
{
Name: "runs",
Description: "查看项目 Action 运行记录",
Flags: []common.Flag{
{Name: "project", Usage: "项目 ID", Required: true},
},
Run: func(ctx *common.RuntimeContext) error {
project, err := ctx.RequireArg("project")
if err != nil {
return err
}
q := url.Values{}
q.Set("project_id", project)
env, err := ctx.CallAPIWithQuery("GET", "/pm/action_runs", q)
if err != nil {
return err
}
return ctx.Output(env)
},
},
}
}

220
shortcuts/pm/pm_test.go Normal file
View File

@ -0,0 +1,220 @@
package pm
import (
"encoding/json"
"net/http"
"net/http/httptest"
"strings"
"testing"
"github.com/gitlink-org/gitlink-cli/internal/client"
"github.com/gitlink-org/gitlink-cli/shortcuts/common"
)
func TestPmDashboards(t *testing.T) {
tests := []struct {
name string
mockStatus int
mockBody string
wantErr bool
errContains string
}{
{"正常返回", 200, `{"dashboards": []}`, false, ""},
{"API 404", 404, `{"error": "not found"}`, true, "404"},
{"返回 HTML", 200, `<!DOCTYPE html><html><body>Login</body></html>`, true, "HTML"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method != "GET" {
t.Errorf("expected GET, got %s", r.Method)
}
if !strings.Contains(r.URL.Path, "/pm/dashboards") {
t.Errorf("expected path containing /pm/dashboards, got %s", r.URL.Path)
}
if got := r.URL.Query().Get("project_id"); got != "123" {
t.Errorf("expected project_id=123, got %s", got)
}
w.WriteHeader(tt.mockStatus)
w.Write([]byte(tt.mockBody))
}))
defer server.Close()
shortcut := findPmShortcut(t, "dashboards")
ctx := &common.RuntimeContext{
Client: &client.Client{HTTP: server.Client(), BaseURL: server.URL},
Owner: "test", Repo: "test", Format: "json",
Args: map[string]string{"project": "123"},
}
err := shortcut.Run(ctx)
if tt.wantErr && err == nil {
t.Fatal("期望错误但为 nil")
}
if !tt.wantErr && err != nil {
t.Fatalf("不期望错误: %v", err)
}
if tt.wantErr && tt.errContains != "" && err != nil {
if !strings.Contains(err.Error(), tt.errContains) {
t.Errorf("错误应包含 %q: %s", tt.errContains, err.Error())
}
}
})
}
}
func TestPmSprints(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method != "GET" {
t.Errorf("expected GET, got %s", r.Method)
}
if !strings.Contains(r.URL.Path, "/pm/sprint_issues") {
t.Errorf("expected path containing /pm/sprint_issues, got %s", r.URL.Path)
}
w.WriteHeader(200)
w.Write([]byte(`{"sprint_issues": []}`))
}))
defer server.Close()
shortcut := findPmShortcut(t, "sprints")
ctx := &common.RuntimeContext{
Client: &client.Client{HTTP: server.Client(), BaseURL: server.URL},
Owner: "test", Repo: "test", Format: "json",
Args: map[string]string{"project": "456"},
}
if err := shortcut.Run(ctx); err != nil {
t.Fatalf("sprints shortcut failed: %v", err)
}
}
func TestPmWeekly(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if !strings.Contains(r.URL.Path, "/pm/weekly_issues") {
t.Errorf("expected path containing /pm/weekly_issues, got %s", r.URL.Path)
}
w.WriteHeader(200)
w.Write([]byte(`{"weekly_issues": []}`))
}))
defer server.Close()
shortcut := findPmShortcut(t, "weekly")
ctx := &common.RuntimeContext{
Client: &client.Client{HTTP: server.Client(), BaseURL: server.URL},
Owner: "test", Repo: "test", Format: "json",
Args: map[string]string{"project": "789"},
}
if err := shortcut.Run(ctx); err != nil {
t.Fatalf("weekly shortcut failed: %v", err)
}
}
func TestPmTags(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if !strings.Contains(r.URL.Path, "/pm/issue_tags") {
t.Errorf("expected path containing /pm/issue_tags, got %s", r.URL.Path)
}
w.WriteHeader(200)
w.Write([]byte(`{"issue_tags": []}`))
}))
defer server.Close()
shortcut := findPmShortcut(t, "tags")
ctx := &common.RuntimeContext{
Client: &client.Client{HTTP: server.Client(), BaseURL: server.URL},
Owner: "test", Repo: "test", Format: "json",
Args: map[string]string{"project": "100"},
}
if err := shortcut.Run(ctx); err != nil {
t.Fatalf("tags shortcut failed: %v", err)
}
}
func TestPmPipelines(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if !strings.Contains(r.URL.Path, "/pm/pipelines") {
t.Errorf("expected path containing /pm/pipelines, got %s", r.URL.Path)
}
w.WriteHeader(200)
w.Write([]byte(`{"pipelines": []}`))
}))
defer server.Close()
shortcut := findPmShortcut(t, "pipelines")
ctx := &common.RuntimeContext{
Client: &client.Client{HTTP: server.Client(), BaseURL: server.URL},
Owner: "test", Repo: "test", Format: "json",
Args: map[string]string{"project": "200"},
}
if err := shortcut.Run(ctx); err != nil {
t.Fatalf("pipelines shortcut failed: %v", err)
}
}
func TestPmRuns(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if !strings.Contains(r.URL.Path, "/pm/action_runs") {
t.Errorf("expected path containing /pm/action_runs, got %s", r.URL.Path)
}
w.WriteHeader(200)
w.Write([]byte(`{"action_runs": []}`))
}))
defer server.Close()
shortcut := findPmShortcut(t, "runs")
ctx := &common.RuntimeContext{
Client: &client.Client{HTTP: server.Client(), BaseURL: server.URL},
Owner: "test", Repo: "test", Format: "json",
Args: map[string]string{"project": "300"},
}
if err := shortcut.Run(ctx); err != nil {
t.Fatalf("runs shortcut failed: %v", err)
}
}
func TestPmMissingProject(t *testing.T) {
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
t.Fatal("should not call API when --project is missing")
}))
defer server.Close()
shortcut := findPmShortcut(t, "dashboards")
ctx := &common.RuntimeContext{
Client: &client.Client{HTTP: server.Client(), BaseURL: server.URL},
Owner: "test", Repo: "test", Format: "json",
Args: map[string]string{},
}
err := shortcut.Run(ctx)
if err == nil {
t.Fatal("expected error when --project is missing")
}
}
func findPmShortcut(t *testing.T, name string) *common.Shortcut {
t.Helper()
for _, shortcut := range Shortcuts() {
if shortcut.Name == name {
return shortcut
}
}
t.Fatalf("shortcut %q not found", name)
return nil
}
func assertPmRequest(t *testing.T, r *http.Request, method, pathPrefix string) {
t.Helper()
if r.Method != method {
t.Fatalf("got method %s, want %s", r.Method, method)
}
if !strings.HasPrefix(r.URL.Path, pathPrefix) {
t.Fatalf("got path %s, want prefix %s", r.URL.Path, pathPrefix)
}
}
func decodePmJSON(t *testing.T, r *http.Request) map[string]interface{} {
t.Helper()
var payload map[string]interface{}
if err := json.NewDecoder(r.Body).Decode(&payload); err != nil {
t.Fatalf("failed to decode request body: %v", err)
}
return payload
}

View File

@ -14,6 +14,7 @@ import (
"github.com/gitlink-org/gitlink-cli/shortcuts/milestone"
"github.com/gitlink-org/gitlink-cli/shortcuts/notification"
"github.com/gitlink-org/gitlink-cli/shortcuts/org"
"github.com/gitlink-org/gitlink-cli/shortcuts/pm"
"github.com/gitlink-org/gitlink-cli/shortcuts/pipeline"
"github.com/gitlink-org/gitlink-cli/shortcuts/pr"
"github.com/gitlink-org/gitlink-cli/shortcuts/release"
@ -38,6 +39,7 @@ func RegisterAll(root *cobra.Command, translators ...*i18n.Translator) {
"milestone": milestone.Shortcuts(),
"notification": notification.Shortcuts(),
"pipeline": pipeline.Shortcuts(),
"pm": pm.Shortcuts(),
"pr": pr.Shortcuts(tr),
"release": release.Shortcuts(tr),
"branch": branch.Shortcuts(tr),
@ -55,9 +57,10 @@ func RegisterAll(root *cobra.Command, translators ...*i18n.Translator) {
"issue": tr.T("cmd.issue.short"),
"label": "Issue label operations",
"member": "Repository member operations",
"milestone": "Milestone operations"
"milestone": "Milestone operations",
"notification": "Notification operations",
"pipeline": "Pipeline operations",
"pm": "Project management operations",
"pr": tr.T("cmd.pr.short"),
"release": tr.T("cmd.release.short"),
"branch": tr.T("cmd.branch.short"),