ctl: support to query the members and primary by using pdctl (tikv#9564) (tikv#10019)

close tikv#9567

Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
Signed-off-by: 童剑 <1045931706@qq.com>

Co-authored-by: tongjian <1045931706@qq.com>
Co-authored-by: 童剑 <1045931706@qq.com>

Author: ti-chi-bot

tests/cluster.go

@@ -34,6 +34,7 @@ import (
 	"github.com/tikv/pd/pkg/id"
 	"github.com/tikv/pd/pkg/keyspace"
 	scheduling "github.com/tikv/pd/pkg/mcs/scheduling/server"
+	tsoServer "github.com/tikv/pd/pkg/mcs/tso/server"
 	"github.com/tikv/pd/pkg/mcs/utils/constant"
 	"github.com/tikv/pd/pkg/schedule/schedulers"
 	"github.com/tikv/pd/pkg/swaggerserver"
@@ -458,6 +459,7 @@ type TestCluster struct {
 		pool map[uint64]struct{}
 	}
 	schedulingCluster *TestSchedulingCluster
+	tsoCluster        *TestTSOCluster
 }
 
 // ConfigOption is used to define customize settings in test.
@@ -851,6 +853,9 @@ func (c *TestCluster) Destroy() {
 	if c.schedulingCluster != nil {
 		c.schedulingCluster.Destroy()
 	}
+	if c.tsoCluster != nil {
+		c.tsoCluster.Destroy()
+	}
 }
 
 // CheckClusterDCLocation will force the cluster to do the dc-location check in order to speed up the test.
@@ -885,11 +890,24 @@ func (c *TestCluster) GetSchedulingPrimaryServer() *scheduling.Server {
 	return c.schedulingCluster.GetPrimaryServer()
 }
 
+// GetDefaultTSOPrimaryServer returns the primary TSO server for the default keyspace.
+func (c *TestCluster) GetDefaultTSOPrimaryServer() *tsoServer.Server {
+	if c.tsoCluster == nil {
+		return nil
+	}
+	return c.tsoCluster.GetPrimaryServer(constant.DefaultKeyspaceID, constant.DefaultKeyspaceGroupID)
+}
+
 // SetSchedulingCluster sets the scheduling cluster.
 func (c *TestCluster) SetSchedulingCluster(cluster *TestSchedulingCluster) {
 	c.schedulingCluster = cluster
 }
 
+// SetTSOCluster sets the TSO cluster.
+func (c *TestCluster) SetTSOCluster(cluster *TestTSOCluster) {
+	c.tsoCluster = cluster
+}
+
 // WaitOp represent the wait configuration
 type WaitOp struct {
 	retryTimes   int

tools/pd-ctl/pdctl/command/microservice_command.go

@@ -0,0 +1,96 @@
+// Copyright 2025 TiKV Project Authors.
+//
+// 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 command
+
+import (
+	"fmt"
+	"net/http"
+
+	"github.com/spf13/cobra"
+)
+
+var (
+	msPrimaryPrefix = "/pd/api/v2/ms/primary/%s"
+	msMembersPrefix = "/pd/api/v2/ms/members/%s"
+)
+
+// NewMicroServicesCommand return a microservice subcommand of rootCmd
+func NewMicroServicesCommand() *cobra.Command {
+	m := &cobra.Command{
+		Use:   "microservice <tso|scheduling>",
+		Short: "microservice commands",
+	}
+	m.AddCommand(newMSTsoCommand())
+	m.AddCommand(newMSSchedulerCommand())
+	return m
+}
+
+func newMSTsoCommand() *cobra.Command {
+	d := &cobra.Command{
+		Use:   "tso <primary|members>",
+		Short: "tso microservice commands",
+	}
+	d.AddCommand(&cobra.Command{
+		Use:   "primary",
+		Short: "show the tso primary status",
+		Run:   getPrimaryCommandFunc,
+	})
+	d.AddCommand(&cobra.Command{
+		Use:   "members",
+		Short: "show the tso members status",
+		Run:   getMembersCommandFunc,
+	})
+	return d
+}
+
+func newMSSchedulerCommand() *cobra.Command {
+	c := &cobra.Command{
+		Use:   "scheduling <primary|members>",
+		Short: "scheduling microservice commands",
+	}
+	c.AddCommand(&cobra.Command{
+		Use:   "primary",
+		Short: "show the scheduling primary member status",
+		Run:   getPrimaryCommandFunc,
+	})
+	c.AddCommand(&cobra.Command{
+		Use:   "members",
+		Short: "show the scheduling members status",
+		Run:   getMembersCommandFunc,
+	})
+	return c
+}
+
+func getMembersCommandFunc(cmd *cobra.Command, _ []string) {
+	parent := cmd.Parent().Name()
+	uri := fmt.Sprintf(msMembersPrefix, parent)
+	r, err := doRequest(cmd, uri, http.MethodGet, http.Header{})
+	if err != nil {
+		cmd.Printf("Failed to get the %s microservice members: %s\n", parent, err)
+		return
+	}
+	cmd.Println(r)
+}
+
+func getPrimaryCommandFunc(cmd *cobra.Command, _ []string) {
+	parent := cmd.Parent().Name()
+	uri := fmt.Sprintf(msPrimaryPrefix, parent)
+	r, err := doRequest(cmd, uri, http.MethodGet, http.Header{})
+	if err != nil {
+		cmd.Printf("Failed to get the %s microservice primary: %s\n", parent, err)
+		return
+	}
+	cmd.Println(r)
+}

tools/pd-ctl/pdctl/ctl.go

@@ -73,6 +73,7 @@ func GetRootCmd() *cobra.Command {
 		command.NewKeyspaceGroupCommand(),
 		command.NewKeyspaceCommand(),
 		command.NewResourceManagerCommand(),
+		command.NewMicroServicesCommand(),
 	)
 
 	return rootCmd

tools/pd-ctl/tests/helper.go

@@ -16,6 +16,7 @@ package tests
 
 import (
 	"bytes"
+	"encoding/json"
 	"sort"
 
 	"github.com/spf13/cobra"
@@ -91,3 +92,14 @@ func CheckRegionsInfoWithoutSort(re *require.Assertions, output *response.Region
 		CheckRegionInfo(re, &got[i], region)
 	}
 }
+
+// MustExec is a helper function to execute a command and unmarshal the output into the provided variable.
+func MustExec(re *require.Assertions, cmd *cobra.Command, args []string, v any) string {
+	output, err := ExecuteCommand(cmd, args...)
+	re.NoError(err)
+	if v == nil {
+		return string(output)
+	}
+	re.NoError(json.Unmarshal(output, v), string(output))
+	return ""
+}

tools/pd-ctl/tests/microservice/microservice_test.go

@@ -0,0 +1,110 @@
+// Copyright 2025 TiKV Project Authors.
+//
+// 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 microservice_test
+
+import (
+	"context"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/suite"
+
+	mcs "github.com/tikv/pd/pkg/mcs/utils/constant"
+	"github.com/tikv/pd/pkg/utils/testutil"
+	pdTests "github.com/tikv/pd/tests"
+	ctl "github.com/tikv/pd/tools/pd-ctl/pdctl"
+	"github.com/tikv/pd/tools/pd-ctl/tests"
+)
+
+// microServiceSuite is a test suite for microservice related tests.
+type microServiceSuite struct {
+	suite.Suite
+	cluster *pdTests.TestCluster
+	cancels []testutil.CleanupFunc
+}
+
+func TestMicroServiceSuite(t *testing.T) {
+	suite.Run(t, new(microServiceSuite))
+}
+
+func (suite *microServiceSuite) SetupSuite() {
+	suite.startCluster()
+}
+
+func (suite *microServiceSuite) TearDownSuite() {
+	for _, fn := range suite.cancels {
+		fn()
+	}
+	suite.cluster.Destroy()
+}
+
+func (suite *microServiceSuite) TestMicroService() {
+	cluster := suite.cluster
+	re := suite.Require()
+	cmd := ctl.GetRootCmd()
+	pdAddr := cluster.GetConfig().GetClientURL()
+	if primaryServer := cluster.GetSchedulingPrimaryServer(); primaryServer != nil {
+		address := primaryServer.GetAddr()
+		res := tests.MustExec(re, cmd, []string{"-u", pdAddr, "microservice", "scheduling", "primary"}, nil)
+		primaryAddress := strings.Trim(res, "\"\n")
+		suite.Equal(address, primaryAddress)
+
+		v := make([]any, 0)
+		tests.MustExec(re, cmd, []string{"-u", pdAddr, "microservice", "scheduling", "members"}, &v)
+		re.Len(v, 2)
+	}
+	if primaryServer := cluster.GetDefaultTSOPrimaryServer(); primaryServer != nil {
+		address := primaryServer.GetAddr()
+		res := tests.MustExec(re, cmd, []string{"-u", pdAddr, "microservice", "tso", "primary"}, nil)
+		primaryAddress := strings.Trim(res, "\"\n")
+		suite.Equal(address, primaryAddress)
+
+		v := make([]any, 0)
+		tests.MustExec(re, cmd, []string{"-u", pdAddr, "microservice", "tso", "members"}, &v)
+		re.Len(v, 2)
+	}
+}
+
+func (suite *microServiceSuite) startCluster() {
+	re := suite.Require()
+	ctx, cancel := context.WithCancel(context.Background())
+	suite.cancels = append(suite.cancels, func() {
+		cancel()
+	})
+
+	cluster, err := pdTests.NewTestAPICluster(ctx, 1)
+	re.NoError(err)
+	err = cluster.RunInitialServers()
+	re.NoError(err)
+	re.NotEmpty(cluster.WaitLeader())
+	leaderServer := cluster.GetServer(cluster.GetLeader())
+	re.NoError(leaderServer.BootstrapCluster())
+	leaderServer.GetRaftCluster().SetPrepared()
+	// start scheduling cluster
+	tc, err := pdTests.NewTestSchedulingCluster(ctx, 2, cluster.GetConfig().GetClientURL())
+	re.NoError(err)
+	tc.WaitForPrimaryServing(re)
+	tc.GetPrimaryServer().GetCluster().SetPrepared()
+	cluster.SetSchedulingCluster(tc)
+	testutil.Eventually(re, func() bool {
+		return cluster.GetLeaderServer().GetServer().IsServiceIndependent(mcs.SchedulingServiceName)
+	})
+	// start tso cluster
+	ts, err := pdTests.NewTestTSOCluster(ctx, 2, leaderServer.GetAddr())
+	ts.WaitForDefaultPrimaryServing(re)
+	re.NoError(err)
+	cluster.SetTSOCluster(ts)
+	suite.cluster = cluster
+}