PMM-12643 consistent types in list output of pmm-admin

admin/commands/list.go

@@ -123,7 +123,7 @@ type ListCommand struct {
 	NodeID string `help:"Node ID (default is autodetected)"`
 }
 
-func (cmd *ListCommand) RunCmd() (Result, error) { //nolint:cyclop,maintidx
+func (cmd *ListCommand) RunCmd() (Result, error) {
 	if cmd.NodeID == "" {
 		status, err := agentlocal.GetStatus(agentlocal.DoNotRequestNetworkInfo)
 		if err != nil {
@@ -142,6 +142,20 @@ func (cmd *ListCommand) RunCmd() (Result, error) { //nolint:cyclop,maintidx
 		return nil, err
 	}
 
+	agentsRes, err := client.Default.Agents.ListAgents(&agents.ListAgentsParams{
+		Context: Ctx,
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	return &listResult{
+		Services: servicesList(servicesRes),
+		Agents:   agentsList(agentsRes, cmd.NodeID),
+	}, nil
+}
+
+func servicesList(servicesRes *services.ListServicesOK) []listResultService {
 	getSocketOrHost := func(socket, address string, port int64) string {
 		if socket != "" {
 			return socket
@@ -152,6 +166,7 @@ func (cmd *ListCommand) RunCmd() (Result, error) { //nolint:cyclop,maintidx
 	l := len(servicesRes.Payload.Mysql) + len(servicesRes.Payload.Mongodb) + len(servicesRes.Payload.Postgresql)
 	l += len(servicesRes.Payload.Proxysql) + len(servicesRes.Payload.Haproxy) + len(servicesRes.Payload.External)
 	servicesList := make([]listResultService, 0, l)
+
 	for _, s := range servicesRes.Payload.Mysql {
 		servicesList = append(servicesList, listResultService{
 			ServiceType: types.ServiceTypeMySQLService,
@@ -200,13 +215,10 @@ func (cmd *ListCommand) RunCmd() (Result, error) { //nolint:cyclop,maintidx
 		})
 	}
 
-	agentsRes, err := client.Default.Agents.ListAgents(&agents.ListAgentsParams{
-		Context: Ctx,
-	})
-	if err != nil {
-		return nil, err
-	}
+	return servicesList
+}
 
+func agentsList(agentsRes *agents.ListAgentsOK, nodeID string) []listResultAgent { //nolint:cyclop
 	getStatus := func(s *string) string {
 		res := pointer.GetString(s)
 		if res == "" {
@@ -222,9 +234,9 @@ func (cmd *ListCommand) RunCmd() (Result, error) { //nolint:cyclop,maintidx
 		return "pull"
 	}
 	pmmAgentIDs := make(map[string]struct{})
-	var agentsList []listResultAgent
+	agentsList := []listResultAgent{}
 	for _, a := range agentsRes.Payload.PMMAgent {
-		if a.RunsOnNodeID == cmd.NodeID {
+		if a.RunsOnNodeID == nodeID {
 			pmmAgentIDs[a.AgentID] = struct{}{}
 
 			status := "disconnected"
@@ -370,7 +382,7 @@ func (cmd *ListCommand) RunCmd() (Result, error) { //nolint:cyclop,maintidx
 		}
 	}
 	for _, a := range agentsRes.Payload.ExternalExporter {
-		if a.RunsOnNodeID == cmd.NodeID {
+		if a.RunsOnNodeID == nodeID {
 			agentsList = append(agentsList, listResultAgent{
 				AgentType:   types.AgentTypeExternalExporter,
 				AgentID:     a.AgentID,
@@ -394,8 +406,5 @@ func (cmd *ListCommand) RunCmd() (Result, error) { //nolint:cyclop,maintidx
 		}
 	}
 
-	return &listResult{
-		Services: servicesList,
-		Agents:   agentsList,
-	}, nil
+	return agentsList
 }

admin/commands/list_test.go

@@ -15,11 +15,15 @@
 package commands
 
 import (
+	"encoding/json"
 	"strings"
 	"testing"
 
+	"github.com/AlekSi/pointer"
 	"github.com/stretchr/testify/assert"
 
+	"github.com/percona/pmm/api/inventorypb/json/client/agents"
+	"github.com/percona/pmm/api/inventorypb/json/client/services"
 	"github.com/percona/pmm/api/inventorypb/types"
 )
 
@@ -119,3 +123,100 @@ func TestNiceAgentStatus(t *testing.T) {
 		})
 	}
 }
+
+func TestListJSONOutput(t *testing.T) {
+	t.Parallel()
+	t.Run("basic", func(t *testing.T) {
+		t.Parallel()
+		services := &services.ListServicesOK{
+			Payload: &services.ListServicesOKBody{
+				Mysql: []*services.ListServicesOKBodyMysqlItems0{
+					{
+						ServiceID:   "/service_id/4ff49c41-80a1-4030-bc02-cd76e3b0b84a",
+						ServiceName: "mysql-service",
+						Address:     "127.0.0.1",
+						Port:        3306,
+					},
+				},
+			},
+		}
+		agents := &agents.ListAgentsOK{
+			Payload: &agents.ListAgentsOKBody{
+				PMMAgent: []*agents.ListAgentsOKBodyPMMAgentItems0{
+					{
+						AgentID:      "/agent_id/8b732ac3-8256-40b0-a98b-0fd5fa9a1140",
+						RunsOnNodeID: "/node_id/8b732ac3-8256-40b0-a98b-0fd5fa9a1140",
+						Connected:    true,
+					},
+				},
+				MysqldExporter: []*agents.ListAgentsOKBodyMysqldExporterItems0{
+					{
+						AgentID:            "/agent_id/8b732ac3-8256-40b0-a98b-0fd5fa9a1198",
+						PMMAgentID:         "/agent_id/8b732ac3-8256-40b0-a98b-0fd5fa9a1140",
+						ServiceID:          "/service_id/4ff49c41-80a1-4030-bc02-cd76e3b0b84a",
+						Status:             pointer.ToString("RUNNING"),
+						PushMetricsEnabled: false,
+						ListenPort:         3306,
+					},
+				},
+			},
+		}
+		result := listResult{
+			Services: servicesList(services),
+			Agents:   agentsList(agents, "/node_id/8b732ac3-8256-40b0-a98b-0fd5fa9a1140"),
+		}
+
+		res, err := json.Marshal(result)
+		assert.NoError(t, err)
+		expected := `
+		{
+			"service": [
+				{
+					"service_type": "MYSQL_SERVICE",
+					"service_id": "/service_id/4ff49c41-80a1-4030-bc02-cd76e3b0b84a",
+					"service_name": "mysql-service",
+					"address_port": "127.0.0.1:3306",
+					"external_group": ""
+				}
+			],
+			"agent": [
+				{
+					"agent_type": "PMM_AGENT",
+					"agent_id": "/agent_id/8b732ac3-8256-40b0-a98b-0fd5fa9a1140",
+					"service_id": "",
+					"status": "CONNECTED",
+					"disabled": false,
+					"push_metrics_enabled": ""
+				},
+				{
+					"agent_type": "MYSQLD_EXPORTER",
+					"agent_id": "/agent_id/8b732ac3-8256-40b0-a98b-0fd5fa9a1198",
+					"service_id": "/service_id/4ff49c41-80a1-4030-bc02-cd76e3b0b84a",
+					"status": "RUNNING",
+					"disabled": false,
+					"push_metrics_enabled": "pull",
+					"port": 3306
+				}
+			]
+		}
+		`
+		expected = strings.ReplaceAll(strings.ReplaceAll(strings.ReplaceAll(expected, "\t", ""), "\n", ""), " ", "")
+		assert.Equal(t, expected, string(res))
+	})
+	t.Run("empty", func(t *testing.T) {
+		t.Parallel()
+		result := listResult{
+			Services: servicesList(&services.ListServicesOK{
+				Payload: &services.ListServicesOKBody{},
+			}),
+			Agents: agentsList(&agents.ListAgentsOK{
+				Payload: &agents.ListAgentsOKBody{},
+			}, ""),
+		}
+
+		res, err := json.Marshal(result)
+		assert.NoError(t, err)
+		expected := `{"service":[],"agent":[]}`
+		assert.Equal(t, expected, string(res))
+	})
+}