feat(cli): add pipeline build and view commands with authentication (#6762)

* feat(cli): add pipeline build and view commands with authentication support

- Add build command to create and run pipelines from pipeline.yml files
- Add view command to monitor pipeline status with watch and list options
- Implement authentication context with session management and token handling
- Add configuration management for global and project-level settings
- Integrate with Erda API endpoints for pipeline operations and metadata
- Provide branch detection and validation for pipeline execution context
- Support verbose output mode for debugging API requests and responses

* test(cli): add comprehensive unit tests for CLI components

- Add TestNormalizePipelineYmlName for pipeline name normalization logic
- Add TestGlobalConfigResolvedHost for config host resolution
- Add TestSetAndGetGlobalConfigFromFile for config file operations
- Add TestGetGlobalConfigFromSupportsLegacyServerField for legacy field handling
- Add TestDecodeLoginStatusWithTokenResponse for token response decoding
- Add TestDecodeLoginStatusWithLegacySessionResponse for session response decoding
- Add TestContextCurrentAuthInfoFallsBackToOpenapiHost for auth fallback logic
- Add multiple tests for resolveBaseHost function with different configuration sources
- Add TestLatestPipelineID for pipeline ID selection logic
- Add TestDeleteSessionInfoFromMap for session management
- Add TestParseGitRemoteURLWithHTTPS for HTTPS URL parsing
- Add TestParseGitRemoteURLWithSSHScpStyle for SSH URL parsing
- Add TestParseGitRemoteURLRejectsInvalidRemote for invalid URL rejection

* feat(cli): add authentication and session management features

- Implement login command with persistent host configuration
- Add logout command to remove authentication information
- Create whoami command to display current user session details
- Integrate session management with automatic token refresh
- Support environment variable and config file based host resolution
- Add interactive authentication with username/password prompts
- Implement session storage and retrieval mechanisms
- Add support

* test(cli): add comprehensive test coverage for CLI components

- Add TestNormalizePipelineYmlName for pipeline YAML name normalization
- Implement TestGlobalConfigResolvedHost and related config file tests
- Add TestDecodeLoginStatus with token and legacy session response tests
- Include host resolution fallback mechanism tests in root command
- Add TestLatestPipelineID for pipeline ID selection logic
- Implement TestDeleteSessionInfoFromMap for session management
- Add Git remote URL parsing tests with HTTPS and SSH formats

Author: iutx

apistructs/pipeline.go

@@ -565,6 +565,26 @@ func PostHandlePBQueryString(req *pipelinepb.PipelinePagingRequest) error {
 	if req.MustMatchLabelsJSON == nil {
 		req.MustMatchLabelsJSON = make(map[string]*structpb.Value)
 	}
+	// Legacy query keys appID and branch: PageListPipelines only constrains app/branch via
+	// mustMatchLabelsJSON. Without folding these fields, GET /api/pipelines?appID=&branch=
+	// would ignore them and return arbitrary pipelines matching source/status only.
+	if req.AppID > 0 {
+		v, err := appendStructValue(req.MustMatchLabelsJSON[LabelAppID], strconv.FormatUint(req.AppID, 10))
+		if err != nil {
+			return err
+		}
+		req.MustMatchLabelsJSON[LabelAppID] = v
+	}
+	for _, b := range req.Branch {
+		if b == "" {
+			continue
+		}
+		v, err := appendStructValue(req.MustMatchLabelsJSON[LabelBranch], b)
+		if err != nil {
+			return err
+		}
+		req.MustMatchLabelsJSON[LabelBranch] = v
+	}
 	if req.MustMatchLabels != "" {
 		mustMatchLabels := make(map[string]string)
 		if err := json.Unmarshal([]byte(req.MustMatchLabels), &mustMatchLabels); err != nil {

apistructs/pipeline_test.go

@@ -140,6 +140,25 @@ func TestPostHandlePBQueryString(t *testing.T) {
 	}
 	err := PostHandlePBQueryString(req)
 	assert.NoError(t, err)
-	assert.Equal(t, 5, len(req.MustMatchLabelsJSON))
+	// mustMatch: JSON keys + mustMatchLabel keys + branch folded from Branches
+	assert.Equal(t, 6, len(req.MustMatchLabelsJSON))
 	assert.Equal(t, 4, len(req.AnyMatchLabelsJSON))
 }
+
+func TestPostHandlePBQueryString_LegacyAppIDAndBranchBecomeMustMatchLabels(t *testing.T) {
+	req := &pipelinepb.PipelinePagingRequest{
+		AppID:  1003418,
+		Branch: []string{"master"},
+		Source: []string{"dice"},
+	}
+	err := PostHandlePBQueryString(req)
+	assert.NoError(t, err)
+	assert.Contains(t, req.MustMatchLabelsJSON, LabelAppID)
+	assert.Contains(t, req.MustMatchLabelsJSON, LabelBranch)
+	appVals := req.MustMatchLabelsJSON[LabelAppID].GetListValue().GetValues()
+	assert.Len(t, appVals, 1)
+	assert.Equal(t, "1003418", appVals[0].GetStringValue())
+	brVals := req.MustMatchLabelsJSON[LabelBranch].GetListValue().GetValues()
+	assert.Len(t, brVals, 1)
+	assert.Equal(t, "master", brVals[0].GetStringValue())
+}

tools/cli/cmd/build.go

@@ -15,6 +15,7 @@
 package cmd
 
 import (
+	"encoding/json"
 	"os"
 	"os/exec"
 	"path"
@@ -32,7 +33,8 @@ import (
 var PIPELINERUN = command.Command{
 	Name:      "build",
 	ShortHelp: "create a pipeline and run it",
-	Example:   "$ erda-cli build <path-to/pipeline.yml>",
+	LongHelp:  `With global -V (--verbose): prints the JSON body sent to POST /api/cicds and the full HTTP response body when the call fails or returns success=false, in addition to the HTTP client debug log.`,
+	Example:   "$ erda-cli build <path-to/pipeline.yml>\n$ erda-cli -V build <path-to/pipeline.yml>",
 	Args: []command.Arg{
 		command.StringArg{}.Name("filename"),
 	},
@@ -138,7 +140,7 @@ func PipelineRun(ctx *command.Context, filename, branch string, watch bool) erro
 		return err
 	}
 
-	repoStats, err := common.GetRepoStats(ctx, org.ID, info.Project, info.Application)
+	_, applicationID, err := common.ResolveWorkspaceApplication(ctx, org.ID, info.Project, info.Application)
 	if err != nil {
 		return err
 	}
@@ -147,27 +149,39 @@ func PipelineRun(ctx *command.Context, filename, branch string, watch bool) erro
 		request      apistructs.PipelineCreateRequest
 		pipelineResp apistructs.PipelineCreateResponse
 	)
-	request.AppID = uint64(repoStats.ApplicationID)
+	request.AppID = uint64(applicationID)
 	request.Branch = branch
 	request.Source = apistructs.PipelineSourceDice
 	request.PipelineYmlSource = apistructs.PipelineYmlSourceGittar
-	request.PipelineYmlName = filename
+	request.PipelineYmlName = normalizePipelineYmlName(filename)
 	request.AutoRun = true
 
+	if ctx.Debug {
+		if reqJSON, err := json.Marshal(request); err == nil {
+			ctx.Info("debug: cicds request body: %s", string(reqJSON))
+		}
+	}
+
 	// create pipeline
 	response, err := ctx.Post().Path("/api/cicds").JSONBody(request).Do().JSON(&pipelineResp)
 	if err != nil {
 		return err
 	}
 	if !response.IsOK() {
+		if ctx.Debug {
+			ctx.Info("debug: cicds response status=%d body=%s", response.StatusCode(), string(response.Body()))
+		}
 		return errors.Errorf("build fail, status code: %d, err: %+v", response.StatusCode(), pipelineResp.Error)
 	}
 	if !pipelineResp.Success {
+		if ctx.Debug {
+			ctx.Info("debug: cicds response status=%d body=%s", response.StatusCode(), string(response.Body()))
+		}
 		return errors.Errorf("build fail: %+v", pipelineResp.Error)
 	}
 
 	if watch {
-		err = PipelineView(ctx, branch, pipelineResp.Data.ID, true)
+		err = PipelineView(ctx, branch, pipelineResp.Data.ID, true, false, 0, 0, "", "", "")
 		if err != nil {
 			ctx.Fail("failed to watch status of pipeline %d", pipelineResp.Data.ID)
 		}
@@ -178,3 +192,9 @@ func PipelineRun(ctx *command.Context, filename, branch string, watch bool) erro
 
 	return nil
 }
+
+func normalizePipelineYmlName(filename string) string {
+	filename = strings.TrimSpace(filename)
+	filename = strings.TrimPrefix(filename, "./")
+	return path.Clean(filename)
+}

tools/cli/cmd/build_test.go

@@ -0,0 +1,38 @@
+// Copyright (c) 2021 Terminus, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package cmd
+
+import "testing"
+
+func TestNormalizePipelineYmlName(t *testing.T) {
+	tests := []struct {
+		name string
+		in   string
+		want string
+	}{
+		{name: "plain root pipeline", in: "pipeline.yml", want: "pipeline.yml"},
+		{name: "dot slash root pipeline", in: "./pipeline.yml", want: "pipeline.yml"},
+		{name: "nested pipeline", in: ".erda/pipelines/java-demo.yml", want: ".erda/pipelines/java-demo.yml"},
+		{name: "dot slash nested pipeline", in: "./.erda/pipelines/java-demo.yml", want: ".erda/pipelines/java-demo.yml"},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := normalizePipelineYmlName(tt.in); got != tt.want {
+				t.Fatalf("normalizePipelineYmlName(%q) = %q, want %q", tt.in, got, tt.want)
+			}
+		})
+	}
+}

tools/cli/cmd/login.go

@@ -0,0 +1,40 @@
+// Copyright (c) 2021 Terminus, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package cmd
+
+import "github.com/erda-project/erda/tools/cli/command"
+
+var LOGIN = command.Command{
+	Name:      "login",
+	ShortHelp: "login and persist the default erda host",
+	Example: `
+$ erda-cli login -u yourname
+$ erda-cli login --host https://erda.cloud -u yourname
+$ ERDA_HOST=https://erda.cloud erda-cli login
+$ erda-cli login --host https://openapi.erda.cloud -u yourname
+`,
+	Run: RunLogin,
+}
+
+func RunLogin(ctx *command.Context) error {
+	if err := command.Login(); err != nil {
+		return err
+	}
+
+	if authInfo, ok := command.GetContext().CurrentAuthInfo(); ok {
+		command.GetContext().Succ("logged in to %s as %s", command.GetContext().CurrentHost, authInfo.NickName)
+	}
+	return nil
+}

tools/cli/cmd/logout.go

@@ -0,0 +1,35 @@
+// Copyright (c) 2021 Terminus, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package cmd
+
+import "github.com/erda-project/erda/tools/cli/command"
+
+var LOGOUT = command.Command{
+	Name:      "logout",
+	ShortHelp: "remove current erda authentication info",
+	Example: `
+$ erda-cli logout
+$ ERDA_HOST=https://erda.cloud erda-cli logout
+`,
+	Run: RunLogout,
+}
+
+func RunLogout(ctx *command.Context) error {
+	if err := command.Logout(); err != nil {
+		return err
+	}
+	command.GetContext().Succ("logged out from %s", command.GetContext().CurrentHost)
+	return nil
+}

tools/cli/cmd/view.go

@@ -37,26 +37,25 @@ import (
 var VIEW = command.Command{
 	Name:      "view",
 	ShortHelp: "View pipeline status",
-	Example:   "$ erda-cli view -i <pipelineId>",
+	Example: ` $ erda-cli view
+  $ erda-cli view -i <pipelineId>
+  $ erda-cli view --list
+  $ erda-cli view --list --page 2 --page-size 10 --statuses Running --sources dice`,
 	Flags: []command.Flag{
-		command.StringFlag{Short: "b", Name: "branch", Doc: "specify branch to show pipeline status, default is current branch", DefaultValue: ""},
+		command.StringFlag{Short: "b", Name: "branch", Doc: "branch filter: single branch, or comma-separated branches (matches /api/cicds branches); default is current git branch", DefaultValue: ""},
 		command.Uint64Flag{Short: "i", Name: "pipelineID", Doc: "specify pipeline id to show pipeline status", DefaultValue: 0},
-		command.BoolFlag{Short: "w", Name: "watch", Doc: "watch the status", DefaultValue: false},
+		command.BoolFlag{Short: "w", Name: "watch", Doc: "watch the status (not with --list)", DefaultValue: false},
+		command.BoolFlag{Short: "l", Name: "list", Doc: "list pipelines for the workspace app via /api/cicds", DefaultValue: false},
+		command.IntFlag{Short: "", Name: "page", Doc: "for --list: page number (default 1)", DefaultValue: 0},
+		command.IntFlag{Short: "", Name: "page-size", Doc: "for --list: page size (default 20)", DefaultValue: 0},
+		command.StringFlag{Short: "", Name: "sources", Doc: "for --list: pipeline sources, comma-separated (default dice)", DefaultValue: ""},
+		command.StringFlag{Short: "", Name: "statuses", Doc: "for --list: filter by pipeline status", DefaultValue: ""},
+		command.StringFlag{Short: "", Name: "yml-names", Doc: "for --list: filter by pipeline yml name(s), comma-separated (query ymlNames)", DefaultValue: ""},
 	},
 	Run: PipelineView,
 }
 
-func PipelineView(ctx *command.Context, branch string, pipelineID uint64, watch bool) (err error) {
-	if pipelineID <= 0 {
-		return errors.New("Invalid pipeline id.")
-	}
-
-	if watch {
-		if err = common.BuildCheckLoop(ctx, pipelineID); err != nil {
-			fmt.Println("[Warn]", err)
-		}
-	}
-
+func PipelineView(ctx *command.Context, branch string, pipelineID uint64, watch bool, list bool, page int, pageSize int, sources string, statuses string, ymlNames string) (err error) {
 	if _, err := os.Stat(".git"); err != nil {
 		return errors.New("Not a valid git repository directory.")
 	}
@@ -79,15 +78,79 @@ func PipelineView(ctx *command.Context, branch string, pipelineID uint64, watch
 		return err
 	}
 
-	repoStats, err := common.GetRepoStats(ctx, org.ID, info.Project, info.Application)
+	projectID, applicationID, err := common.ResolveWorkspaceApplication(ctx, org.ID, info.Project, info.Application)
 	if err != nil {
 		return errors.Wrapf(err, "orgID: %v, projectName: %s, appName: %s", org.ID, info.Project, info.Application)
 	}
 
+	if list {
+		if watch {
+			return errors.New("cannot use --watch with --list")
+		}
+		if pipelineID > 0 {
+			ctx.Info("ignoring --pipelineID when using --list")
+		}
+		data, err := common.ListPipelinesCICD(ctx, uint64(applicationID), branch, sources, statuses, ymlNames, page, pageSize)
+		if err != nil {
+			return err
+		}
+		pn := page
+		if pn <= 0 {
+			pn = 1
+		}
+		ps := pageSize
+		if ps <= 0 {
+			ps = 20
+		}
+		fmt.Printf("pipelines (appID=%d, total=%d, page=%d, pageSize=%d)\n",
+			applicationID, data.Total, pn, ps)
+		var rows [][]string
+		for _, p := range data.Pipelines {
+			br := p.FilterLabels[apistructs.LabelBranch]
+			commit := p.Commit
+			if len(commit) > 7 {
+				commit = commit[:7]
+			}
+			tb := ""
+			if p.TimeBegin != nil {
+				tb = p.TimeBegin.Format("2006-01-02 15:04:05")
+			}
+			rows = append(rows, []string{
+				strconv.FormatUint(p.ID, 10),
+				string(p.Status),
+				br,
+				commit,
+				p.YmlName,
+				tb,
+			})
+		}
+		if err = table.NewTable().Header([]string{
+			"pipelineID", "status", "branch", "commit", "ymlName", "startedAt",
+		}).Data(rows).Flush(); err != nil {
+			return err
+		}
+		fmt.Printf("view one: erda-cli view -i <pipelineID>\n")
+		return nil
+	}
+
+	if pipelineID <= 0 {
+		pipelineID, err = common.GetLatestPipelineID(ctx, uint64(applicationID), branch)
+		if err != nil {
+			return err
+		}
+		ctx.Info("no pipeline id provided, using latest pipeline on branch %s: %d", branch, pipelineID)
+	}
+
+	if watch {
+		if err = common.BuildCheckLoop(ctx, pipelineID); err != nil {
+			fmt.Println("[Warn]", err)
+		}
+	}
+
 	// fetch ymlName path
 	var pipelineCombResp apistructs.PipelineInvokedComboResponse
 	response, err := ctx.Get().Path("/api/cicds/actions/app-invoked-combos").
-		Param("appID", strconv.FormatInt(repoStats.ApplicationID, 10)).
+		Param("appID", strconv.FormatInt(applicationID, 10)).
 		Do().JSON(&pipelineCombResp)
 	if err != nil {
 		return err
@@ -145,7 +208,7 @@ func PipelineView(ctx *command.Context, branch string, pipelineID uint64, watch
 		return err
 	}
 	printMetadata(pipelineInfo.PipelineStages)
-	seeMore(ctx, info.Org, int(repoStats.ProjectID), int(repoStats.ApplicationID), branch, pipelineID, ymlName)
+	seeMore(ctx, info.Org, int(projectID), int(applicationID), branch, pipelineID, ymlName)
 	return nil
 }