rpc,*: sanitize the configuration of rpc.Context

The main goal of this change is to offer a `.RPCClientConn()` method
on test servers.

To achieve this, it was necessary to lift the code previously in
`cli.getClientGRPCConn` into a more reusable version of it,
now hosted in `rpc.NewClientContext()`.

I also took the opportunity to remove the dependency of `rpc.Context`
on `base.Config`, by spelling out precisely which fields are necessary
to RPC connections.

Numerous tests could be simplified as a result. In particular:

- Complex sequences of calls to open a client RPC connection to a test
  server can be simplified to a single call to `.RPCClientConn()`.

- `testutils.NewNodeTestContext` and `NewTestBaseContext` are not
  necessary any more. They were previously used as input to
  build instances of `rpc.ContextOptions`. The latter can now
  be built using `rpc.DefaultContextOptions()` instead.

- `(*localestcluster.LocalTestCluster).Start()` does
  not need a `*base.Config` any more and so its call sites can be
  simplified.

Release note: None

Author: knz

pkg/acceptance/localcluster/BUILD.bazel

@@ -11,11 +11,9 @@ go_library(
     visibility = ["//visibility:public"],
     deps = [
         "//pkg/acceptance/cluster",
-        "//pkg/base",
         "//pkg/config/zonepb",
         "//pkg/roachpb",
         "//pkg/rpc",
-        "//pkg/security/username",
         "//pkg/server/serverpb",
         "//pkg/settings/cluster",
         "//pkg/testutils",

pkg/acceptance/localcluster/cluster.go

@@ -29,11 +29,9 @@ import (
 	"text/tabwriter"
 	"time"
 
-	"github.com/cockroachdb/cockroach/pkg/base"
 	"github.com/cockroachdb/cockroach/pkg/config/zonepb"
 	"github.com/cockroachdb/cockroach/pkg/roachpb"
 	"github.com/cockroachdb/cockroach/pkg/rpc"
-	"github.com/cockroachdb/cockroach/pkg/security/username"
 	"github.com/cockroachdb/cockroach/pkg/server/serverpb"
 	"github.com/cockroachdb/cockroach/pkg/settings/cluster"
 	"github.com/cockroachdb/cockroach/pkg/testutils"
@@ -265,20 +263,12 @@ func (c *Cluster) RPCPort(nodeIdx int) string {
 }
 
 func (c *Cluster) makeNode(ctx context.Context, nodeIdx int, cfg NodeConfig) (*Node, <-chan error) {
-	baseCtx := &base.Config{
-		User:     username.NodeUserName(),
-		Insecure: true,
-	}
-	rpcCtx := rpc.NewContext(ctx, rpc.ContextOptions{
-		TenantID:        roachpb.SystemTenantID,
-		Config:          baseCtx,
-		Clock:           &timeutil.DefaultTimeSource{},
-		ToleratedOffset: 0,
-		Stopper:         c.stopper,
-		Settings:        cluster.MakeTestingClusterSettings(),
-
-		ClientOnly: true,
-	})
+	opts := rpc.DefaultContextOptions()
+	opts.Insecure = true
+	opts.Stopper = c.stopper
+	opts.Settings = cluster.MakeTestingClusterSettings()
+	opts.ClientOnly = true
+	rpcCtx := rpc.NewContext(ctx, opts)
 
 	n := &Node{
 		Cfg:    cfg,

pkg/base/addr_validation_test.go

@@ -156,12 +156,12 @@ func TestValidateAddrs(t *testing.T) {
 	for i, test := range testData {
 		t.Run(fmt.Sprintf("%d/%s", i, test.in), func(t *testing.T) {
 			cfg := base.Config{
-				Addr:              test.in.listen,
-				AdvertiseAddr:     test.in.adv,
-				HTTPAddr:          test.in.http,
-				HTTPAdvertiseAddr: test.in.advhttp,
-				SQLAddr:           test.in.sql,
-				SQLAdvertiseAddr:  test.in.advsql,
+				Addr:               test.in.listen,
+				HTTPAddr:           test.in.http,
+				SQLAddr:            test.in.sql,
+				AdvertiseAddrH:     base.AdvertiseAddrH{AdvertiseAddr: test.in.adv},
+				HTTPAdvertiseAddrH: base.HTTPAdvertiseAddrH{HTTPAdvertiseAddr: test.in.advhttp},
+				SQLAdvertiseAddrH:  base.SQLAdvertiseAddrH{SQLAdvertiseAddr: test.in.advsql},
 			}
 
 			if err := cfg.ValidateAddrs(context.Background()); err != nil {

pkg/base/config.go

@@ -192,7 +192,7 @@ var (
 	defaultRangeLeaseDuration = envutil.EnvOrDefaultDuration(
 		"COCKROACH_RANGE_LEASE_DURATION", 6*time.Second)
 
-	// defaultRPCHeartbeatTimeout is the default RPC heartbeat timeout. It is set
+	// DefaultRPCHeartbeatTimeout is the default RPC heartbeat timeout. It is set
 	// very high at 3 * NetworkTimeout for several reasons: the gRPC transport may
 	// need to complete a dial/handshake before sending the heartbeat, the
 	// heartbeat has occasionally been seen to require 3 RTTs even post-dial (for
@@ -212,7 +212,7 @@ var (
 	// heartbeats and reduce this to NetworkTimeout (plus DialTimeout for the
 	// initial heartbeat), see:
 	// https://github.com/cockroachdb/cockroach/issues/93397.
-	defaultRPCHeartbeatTimeout = 3 * NetworkTimeout
+	DefaultRPCHeartbeatTimeout = 3 * NetworkTimeout
 
 	// defaultRaftTickInterval is the default resolution of the Raft timer.
 	defaultRaftTickInterval = envutil.EnvOrDefaultDuration(
@@ -341,10 +341,13 @@ type Config struct {
 	// Addr is the address the server is listening on.
 	Addr string
 
-	// AdvertiseAddr is the address advertised by the server to other nodes
-	// in the cluster. It should be reachable by all other nodes and should
-	// route to an interface that Addr is listening on.
-	AdvertiseAddr string
+	// AdvertiseAddrH contains the address advertised by the server to
+	// other nodes in the cluster. It should be reachable by all other
+	// nodes and should route to an interface that Addr is listening on.
+	//
+	// It is set after the server instance has been created, when the
+	// network listeners are being set up.
+	AdvertiseAddrH
 
 	// ClusterName is the name used as a sanity check when a node joins
 	// an uninitialized cluster, or when an uninitialized node joins an
@@ -367,9 +370,12 @@ type Config struct {
 	// This is used if SplitListenSQL is set to true.
 	SQLAddr string
 
-	// SQLAdvertiseAddr is the advertised SQL address.
+	// SQLAdvertiseAddrH contains the advertised SQL address.
 	// This is computed from SQLAddr if specified otherwise Addr.
-	SQLAdvertiseAddr string
+	//
+	// It is set after the server instance has been created, when the
+	// network listeners are being set up.
+	SQLAdvertiseAddrH
 
 	// SocketFile, if non-empty, sets up a TLS-free local listener using
 	// a unix datagram socket at the specified path for SQL clients.
@@ -382,9 +388,12 @@ type Config struct {
 	// DisableTLSForHTTP, if set, disables TLS for the HTTP listener.
 	DisableTLSForHTTP bool
 
-	// HTTPAdvertiseAddr is the advertised HTTP address.
+	// HTTPAdvertiseAddrH contains the advertised HTTP address.
 	// This is computed from HTTPAddr if specified otherwise Addr.
-	HTTPAdvertiseAddr string
+	//
+	// It is set after the server instance has been created, when the
+	// network listeners are being set up.
+	HTTPAdvertiseAddrH
 
 	// RPCHeartbeatInterval controls how often Ping requests are sent on peer
 	// connections to determine connection health and update the local view of
@@ -421,6 +430,21 @@ type Config struct {
 	LocalityAddresses []roachpb.LocalityAddress
 }
 
+// AdvertiseAddr is the type of the AdvertiseAddr field in Config.
+type AdvertiseAddrH struct {
+	AdvertiseAddr string
+}
+
+// SQLAdvertiseAddr is the type of the SQLAdvertiseAddr field in Config.
+type SQLAdvertiseAddrH struct {
+	SQLAdvertiseAddr string
+}
+
+// HTTPAdvertiseAddr is the type of the HTTPAdvertiseAddr field in Config.
+type HTTPAdvertiseAddrH struct {
+	HTTPAdvertiseAddr string
+}
+
 // HistogramWindowInterval is used to determine the approximate length of time
 // that individual samples are retained in in-memory histograms. Currently,
 // it is set to the arbitrary length of six times the Metrics sample interval.
@@ -455,7 +479,7 @@ func (cfg *Config) InitDefaults() {
 	cfg.SocketFile = ""
 	cfg.SSLCertsDir = DefaultCertsDirectory
 	cfg.RPCHeartbeatInterval = PingInterval
-	cfg.RPCHeartbeatTimeout = defaultRPCHeartbeatTimeout
+	cfg.RPCHeartbeatTimeout = DefaultRPCHeartbeatTimeout
 	cfg.ClusterName = ""
 	cfg.DisableClusterNameVerification = false
 	cfg.ClockDevicePath = ""

pkg/ccl/oidcccl/BUILD.bazel

@@ -48,20 +48,17 @@ go_test(
         "//pkg/base",
         "//pkg/ccl",
         "//pkg/roachpb",
-        "//pkg/rpc",
         "//pkg/security/securityassets",
         "//pkg/security/securitytest",
         "//pkg/security/username",
         "//pkg/server",
         "//pkg/server/serverpb",
-        "//pkg/testutils",
         "//pkg/testutils/serverutils",
         "//pkg/testutils/sqlutils",
         "//pkg/testutils/testcluster",
         "//pkg/util/leaktest",
         "//pkg/util/log",
         "//pkg/util/randutil",
-        "//pkg/util/timeutil",
         "@com_github_stretchr_testify//require",
     ],
 )

pkg/ccl/oidcccl/authentication_oidc_test.go

@@ -24,15 +24,12 @@ import (
 
 	"github.com/cockroachdb/cockroach/pkg/base"
 	"github.com/cockroachdb/cockroach/pkg/roachpb"
-	"github.com/cockroachdb/cockroach/pkg/rpc"
 	"github.com/cockroachdb/cockroach/pkg/security/username"
 	"github.com/cockroachdb/cockroach/pkg/server/serverpb"
-	"github.com/cockroachdb/cockroach/pkg/testutils"
 	"github.com/cockroachdb/cockroach/pkg/testutils/serverutils"
 	"github.com/cockroachdb/cockroach/pkg/testutils/sqlutils"
 	"github.com/cockroachdb/cockroach/pkg/util/leaktest"
 	"github.com/cockroachdb/cockroach/pkg/util/log"
-	"github.com/cockroachdb/cockroach/pkg/util/timeutil"
 	"github.com/stretchr/testify/require"
 )
 
@@ -51,22 +48,7 @@ func TestOIDCBadRequestIfDisabled(t *testing.T) {
 	s := serverutils.StartServerOnly(t, base.TestServerArgs{})
 	defer s.Stopper().Stop(ctx)
 
-	newRPCContext := func(cfg *base.Config) *rpc.Context {
-		return rpc.NewContext(ctx,
-			rpc.ContextOptions{
-				TenantID:        roachpb.SystemTenantID,
-				Config:          cfg,
-				Clock:           &timeutil.DefaultTimeSource{},
-				ToleratedOffset: 1,
-				Stopper:         s.Stopper(),
-				Settings:        s.ClusterSettings(),
-
-				ClientOnly: true,
-			})
-	}
-
-	plainHTTPCfg := testutils.NewTestBaseContext(username.TestUserName())
-	testCertsContext := newRPCContext(plainHTTPCfg)
+	testCertsContext := s.NewClientRPCContext(ctx, username.TestUserName())
 
 	client, err := testCertsContext.GetHTTPClient()
 	require.NoError(t, err)
@@ -90,19 +72,6 @@ func TestOIDCEnabled(t *testing.T) {
 	s, db, _ := serverutils.StartServer(t, base.TestServerArgs{})
 	defer s.Stopper().Stop(ctx)
 
-	newRPCContext := func(cfg *base.Config) *rpc.Context {
-		return rpc.NewContext(ctx, rpc.ContextOptions{
-			TenantID:        roachpb.SystemTenantID,
-			Config:          cfg,
-			Clock:           &timeutil.DefaultTimeSource{},
-			ToleratedOffset: 1,
-			Stopper:         s.Stopper(),
-			Settings:        s.ClusterSettings(),
-
-			ClientOnly: true,
-		})
-	}
-
 	// Set up a test OIDC server that serves the JSON discovery document
 	var issuer string
 	oidcHandler := func(w http.ResponseWriter, r *http.Request) {
@@ -184,8 +153,7 @@ func TestOIDCEnabled(t *testing.T) {
 	sqlDB.Exec(t, `SET CLUSTER SETTING server.oidc_authentication.redirect_url = "https://cockroachlabs.com/oidc/v1/callback"`)
 	sqlDB.Exec(t, `SET CLUSTER SETTING server.oidc_authentication.enabled = "true"`)
 
-	plainHTTPCfg := testutils.NewTestBaseContext(username.TestUserName())
-	testCertsContext := newRPCContext(plainHTTPCfg)
+	testCertsContext := s.NewClientRPCContext(ctx, username.TestUserName())
 
 	client, err := testCertsContext.GetHTTPClient()
 	require.NoError(t, err)

pkg/ccl/serverccl/statusccl/tenant_grpc_test.go

@@ -59,15 +59,7 @@ func TestTenantGRPCServices(t *testing.T) {
 	t.Logf("subtests starting")
 
 	t.Run("gRPC is running", func(t *testing.T) {
-		grpcAddr := tenant.RPCAddr()
-		rpcCtx := tenant.RPCContext()
-
-		nodeID := roachpb.NodeID(tenant.SQLInstanceID())
-		conn, err := rpcCtx.GRPCDialNode(grpcAddr, nodeID, rpc.DefaultClass).Connect(ctx)
-		require.NoError(t, err)
-
-		client := serverpb.NewStatusClient(conn)
-
+		client := tenant.GetStatusClient(t)
 		resp, err := client.Statements(ctx, &serverpb.StatementsRequest{NodeID: "local"})
 		require.NoError(t, err)
 		require.NotEmpty(t, resp.Statements)

pkg/cli/BUILD.bazel

@@ -378,7 +378,6 @@ go_test(
         "//pkg/kv/kvserver/loqrecovery/loqrecoverypb",
         "//pkg/kv/kvserver/stateloader",
         "//pkg/roachpb",
-        "//pkg/rpc",
         "//pkg/security/securityassets",
         "//pkg/security/securitytest",
         "//pkg/security/username",
@@ -405,6 +404,7 @@ go_test(
         "//pkg/util/log",
         "//pkg/util/log/logconfig",
         "//pkg/util/log/logpb",
+        "//pkg/util/netutil/addr",
         "//pkg/util/protoutil",
         "//pkg/util/randutil",
         "//pkg/util/stop",

pkg/cli/debug_recover_loss_of_quorum_test.go

@@ -26,7 +26,6 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/kv/kvserver/loqrecovery"
 	"github.com/cockroachdb/cockroach/pkg/kv/kvserver/loqrecovery/loqrecoverypb"
 	"github.com/cockroachdb/cockroach/pkg/roachpb"
-	"github.com/cockroachdb/cockroach/pkg/rpc"
 	"github.com/cockroachdb/cockroach/pkg/server"
 	"github.com/cockroachdb/cockroach/pkg/server/serverpb"
 	"github.com/cockroachdb/cockroach/pkg/testutils"
@@ -258,10 +257,7 @@ func TestLossOfQuorumRecovery(t *testing.T) {
 	// attempt. That would increase number of replicas on system ranges to 5 and we
 	// would not be able to upreplicate properly. So we need to decommission old nodes
 	// first before proceeding.
-	grpcConn, err := tcAfter.Server(0).RPCContext().GRPCDialNode(
-		tcAfter.Server(0).AdvRPCAddr(), tcAfter.Server(0).NodeID(), rpc.DefaultClass).Connect(ctx)
-	require.NoError(t, err, "Failed to create test cluster after recovery")
-	adminClient := serverpb.NewAdminClient(grpcConn)
+	adminClient := tcAfter.Server(0).GetAdminClient(t)
 
 	require.NoError(t, runDecommissionNodeImpl(
 		ctx, adminClient, nodeDecommissionWaitNone, nodeDecommissionChecksSkip, false,
@@ -353,10 +349,7 @@ func TestStageVersionCheck(t *testing.T) {
 	defer tc.Stopper().Stop(ctx)
 	tc.StopServer(3)
 
-	grpcConn, err := tc.Server(0).RPCContext().GRPCDialNode(tc.Server(0).AdvRPCAddr(),
-		tc.Server(0).NodeID(), rpc.DefaultClass).Connect(ctx)
-	require.NoError(t, err, "Failed to create test cluster after recovery")
-	adminClient := serverpb.NewAdminClient(grpcConn)
+	adminClient := tc.Server(0).GetAdminClient(t)
 	v := clusterversion.ByKey(clusterversion.BinaryVersionKey)
 	v.Internal++
 	// To avoid crafting real replicas we use StaleLeaseholderNodeIDs to force
@@ -369,7 +362,7 @@ func TestStageVersionCheck(t *testing.T) {
 		StaleLeaseholderNodeIDs: []roachpb.NodeID{1},
 	}
 	// Attempts to stage plan with different internal version must fail.
-	_, err = adminClient.RecoveryStagePlan(ctx, &serverpb.RecoveryStagePlanRequest{
+	_, err := adminClient.RecoveryStagePlan(ctx, &serverpb.RecoveryStagePlanRequest{
 		Plan:                      &p,
 		AllNodes:                  true,
 		ForcePlan:                 false,
@@ -559,8 +552,7 @@ func TestHalfOnlineLossOfQuorumRecovery(t *testing.T) {
 
 	// Verifying that post start cleanup performed node decommissioning that
 	// prevents old nodes from rejoining.
-	ac, err := tc.GetAdminClient(ctx, t, 0)
-	require.NoError(t, err, "failed to get admin client")
+	ac := tc.GetAdminClient(t, 0)
 	testutils.SucceedsSoon(t, func() error {
 		dr, err := ac.DecommissionStatus(ctx,
 			&serverpb.DecommissionStatusRequest{NodeIDs: []roachpb.NodeID{2, 3}})

pkg/cli/demo.go

@@ -233,7 +233,6 @@ func runDemoInternal(
 			serverCfg.Stores.Specs = nil
 			return setupAndInitializeLoggingAndProfiling(ctx, cmd, false /* isServerCmd */)
 		},
-		getAdminClient,
 		func(ctx context.Context, ac serverpb.AdminClient) error {
 			return drainAndShutdown(ctx, ac, "local" /* targetNode */)
 		},