Rename PeerName to Peer on prepared queries and exported services (…

…#14854)
hashicorp · Oct 4, 2022 · 1b56544 · 1b56544
1 parent f2d42f9
commit 1b56544
Show file tree

Hide file tree

Showing 32 changed files with 141 additions and 138 deletions.
diff --git a/.changelog/14854.txt b/.changelog/14854.txt
@@ -0,0 +1,3 @@
+```release-note:breaking-change
+peering: Rename `PeerName` to `Peer` on prepared queries and exported services.
+```
diff --git a/agent/consul/internal_endpoint_test.go b/agent/consul/internal_endpoint_test.go
@@ -3334,19 +3334,19 @@ func TestInternal_ExportedPeeredServices_ACLEnforcement(t *testing.T) {
 			{
 				Name: "web",
 				Consumers: []structs.ServiceConsumer{
-					{PeerName: "peer-1"},
+					{Peer: "peer-1"},
 				},
 			},
 			{
 				Name: "db",
 				Consumers: []structs.ServiceConsumer{
-					{PeerName: "peer-2"},
+					{Peer: "peer-2"},
 				},
 			},
 			{
 				Name: "api",
 				Consumers: []structs.ServiceConsumer{
-					{PeerName: "peer-1"},
+					{Peer: "peer-1"},
 				},
 			},
 		},
@@ -3405,7 +3405,7 @@ func TestInternal_ExportedPeeredServices_ACLEnforcement(t *testing.T) {
 				`
 			service "web" { policy = "read" }
 			service "api" { policy = "read" }
-			service "db"  { policy = "deny" }	
+			service "db"  { policy = "deny" }
 			`),
 			expect: map[string]structs.ServiceList{
 				"peer-1": {
@@ -3514,19 +3514,19 @@ func TestInternal_ExportedServicesForPeer_ACLEnforcement(t *testing.T) {
 			{
 				Name: "web",
 				Consumers: []structs.ServiceConsumer{
-					{PeerName: "peer-1"},
+					{Peer: "peer-1"},
 				},
 			},
 			{
 				Name: "db",
 				Consumers: []structs.ServiceConsumer{
-					{PeerName: "peer-2"},
+					{Peer: "peer-2"},
 				},
 			},
 			{
 				Name: "api",
 				Consumers: []structs.ServiceConsumer{
-					{PeerName: "peer-1"},
+					{Peer: "peer-1"},
 				},
 			},
 		},

diff --git a/agent/consul/leader_peering_test.go b/agent/consul/leader_peering_test.go
@@ -257,7 +257,7 @@ func TestLeader_PeeringSync_Lifecycle_UnexportWhileDown(t *testing.T) {
 				Services: []structs.ExportedService{
 					{
 						Name:      "foo",
-						Consumers: []structs.ServiceConsumer{{PeerName: "my-peer-dialer"}},
+						Consumers: []structs.ServiceConsumer{{Peer: "my-peer-dialer"}},
 					},
 				},
 			},
@@ -1014,7 +1014,7 @@ func TestLeader_Peering_ImportedExportedServicesCount(t *testing.T) {
 						Name: structs.WildcardSpecifier,
 						Consumers: []structs.ServiceConsumer{
 							{
-								PeerName: "my-peer-s2",
+								Peer: "my-peer-s2",
 							},
 						},
 					},
@@ -1042,15 +1042,15 @@ func TestLeader_Peering_ImportedExportedServicesCount(t *testing.T) {
 						Name: "a-service",
 						Consumers: []structs.ServiceConsumer{
 							{
-								PeerName: "my-peer-s2",
+								Peer: "my-peer-s2",
 							},
 						},
 					},
 					{
 						Name: "b-service",
 						Consumers: []structs.ServiceConsumer{
 							{
-								PeerName: "my-peer-s2",
+								Peer: "my-peer-s2",
 							},
 						},
 					},
@@ -1069,7 +1069,7 @@ func TestLeader_Peering_ImportedExportedServicesCount(t *testing.T) {
 						Name: "a-service",
 						Consumers: []structs.ServiceConsumer{
 							{
-								PeerName: "my-peer-s2",
+								Peer: "my-peer-s2",
 							},
 						},
 					},
@@ -1088,15 +1088,15 @@ func TestLeader_Peering_ImportedExportedServicesCount(t *testing.T) {
 						Name: "a-service",
 						Consumers: []structs.ServiceConsumer{
 							{
-								PeerName: "my-peer-s2",
+								Peer: "my-peer-s2",
 							},
 						},
 					},
 					{
 						Name: "c-service",
 						Consumers: []structs.ServiceConsumer{
 							{
-								PeerName: "my-peer-s2",
+								Peer: "my-peer-s2",
 							},
 						},
 					},

diff --git a/agent/consul/prepared_query/walk_test.go b/agent/consul/prepared_query/walk_test.go
@@ -42,7 +42,7 @@ func TestWalk_ServiceQuery(t *testing.T) {
 		".Tags[0]:tag1",
 		".Tags[1]:tag2",
 		".Tags[2]:tag3",
-		".PeerName:",
+		".Peer:",
 	}
 	expected = append(expected, entMetaWalkFields...)
 	sort.Strings(expected)

diff --git a/agent/consul/prepared_query_endpoint.go b/agent/consul/prepared_query_endpoint.go
@@ -540,7 +540,7 @@ func (p *PreparedQuery) execute(query *structs.PreparedQuery,
 		f = state.CheckConnectServiceNodes
 	}
 
-	_, nodes, err := f(nil, query.Service.Service, &query.Service.EnterpriseMeta, query.Service.PeerName)
+	_, nodes, err := f(nil, query.Service.Service, &query.Service.EnterpriseMeta, query.Service.Peer)
 	if err != nil {
 		return err
 	}
@@ -571,7 +571,7 @@ func (p *PreparedQuery) execute(query *structs.PreparedQuery,
 	reply.DNS = query.DNS
 
 	// Stamp the result with its this datacenter or peer.
-	if peerName := query.Service.PeerName; peerName != "" {
+	if peerName := query.Service.Peer; peerName != "" {
 		reply.PeerName = peerName
 		reply.Datacenter = ""
 	} else {
@@ -756,7 +756,7 @@ func queryFailover(q queryServer, query *structs.PreparedQuery,
 			}
 		}
 
-		if target.PeerName != "" {
+		if target.Peer != "" {
 			targets = append(targets, target)
 		}
 	}
@@ -777,9 +777,9 @@ func queryFailover(q queryServer, query *structs.PreparedQuery,
 
 		// Reset PeerName because it may have been set by a previous failover
 		// target.
-		query.Service.PeerName = target.PeerName
+		query.Service.Peer = target.Peer
 		dc := target.Datacenter
-		if target.PeerName != "" {
+		if target.Peer != "" {
 			dc = q.GetLocalDC()
 		}
 
@@ -798,7 +798,7 @@ func queryFailover(q queryServer, query *structs.PreparedQuery,
 		if err = q.ExecuteRemote(remote, reply); err != nil {
 			q.GetLogger().Warn("Failed querying for service in datacenter",
 				"service", query.Service.Service,
-				"peerName", query.Service.PeerName,
+				"peerName", query.Service.Peer,
 				"datacenter", dc,
 				"error", err,
 			)

diff --git a/agent/consul/prepared_query_endpoint_test.go b/agent/consul/prepared_query_endpoint_test.go
@@ -88,7 +88,7 @@ func TestPreparedQuery_Apply(t *testing.T) {
 
 	// Fix that and ensure Targets and NearestN cannot be set at the same time.
 	query.Query.Service.Failover.NearestN = 1
-	query.Query.Service.Failover.Targets = []structs.QueryFailoverTarget{{PeerName: "peer"}}
+	query.Query.Service.Failover.Targets = []structs.QueryFailoverTarget{{Peer: "peer"}}
 	err = msgpackrpc.CallWithCodec(codec, "PreparedQuery.Apply", &query, &reply)
 	if err == nil || !strings.Contains(err.Error(), "Targets cannot be populated with") {
 		t.Fatalf("bad: %v", err)
@@ -97,7 +97,7 @@ func TestPreparedQuery_Apply(t *testing.T) {
 	// Fix that and ensure Targets and Datacenters cannot be set at the same time.
 	query.Query.Service.Failover.NearestN = 0
 	query.Query.Service.Failover.Datacenters = []string{"dc2"}
-	query.Query.Service.Failover.Targets = []structs.QueryFailoverTarget{{PeerName: "peer"}}
+	query.Query.Service.Failover.Targets = []structs.QueryFailoverTarget{{Peer: "peer"}}
 	err = msgpackrpc.CallWithCodec(codec, "PreparedQuery.Apply", &query, &reply)
 	if err == nil || !strings.Contains(err.Error(), "Targets cannot be populated with") {
 		t.Fatalf("bad: %v", err)
@@ -1552,7 +1552,7 @@ func TestPreparedQuery_Execute(t *testing.T) {
 				Services: []structs.ExportedService{
 					{
 						Name:      "foo",
-						Consumers: []structs.ServiceConsumer{{PeerName: dialingPeerName}},
+						Consumers: []structs.ServiceConsumer{{Peer: dialingPeerName}},
 					},
 				},
 			},
@@ -2429,7 +2429,7 @@ func TestPreparedQuery_Execute(t *testing.T) {
 	query.Query.Service.Failover = structs.QueryFailoverOptions{
 		Targets: []structs.QueryFailoverTarget{
 			{Datacenter: "dc2"},
-			{PeerName: acceptingPeerName},
+			{Peer: acceptingPeerName},
 		},
 	}
 	require.NoError(t, msgpackrpc.CallWithCodec(codec1, "PreparedQuery.Apply", &query, &query.Query.ID))
@@ -2950,7 +2950,7 @@ func (m *mockQueryServer) GetOtherDatacentersByDistance() ([]string, error) {
 }
 
 func (m *mockQueryServer) ExecuteRemote(args *structs.PreparedQueryExecuteRemoteRequest, reply *structs.PreparedQueryExecuteResponse) error {
-	peerName := args.Query.Service.PeerName
+	peerName := args.Query.Service.Peer
 	dc := args.Datacenter
 	if peerName != "" {
 		m.QueryLog = append(m.QueryLog, fmt.Sprintf("peer:%s", peerName))
@@ -3302,15 +3302,15 @@ func TestPreparedQuery_queryFailover(t *testing.T) {
 	// Failover returns data from the first cluster peer with data.
 	query.Service.Failover.Datacenters = nil
 	query.Service.Failover.Targets = []structs.QueryFailoverTarget{
-		{PeerName: "cluster-01"},
+		{Peer: "cluster-01"},
 		{Datacenter: "dc44"},
-		{PeerName: "cluster-02"},
+		{Peer: "cluster-02"},
 	}
 	{
 		mock := &mockQueryServer{
 			Datacenters: []string{"dc44"},
 			QueryFn: func(args *structs.PreparedQueryExecuteRemoteRequest, reply *structs.PreparedQueryExecuteResponse) error {
-				if args.Query.Service.PeerName == "cluster-02" {
+				if args.Query.Service.Peer == "cluster-02" {
 					reply.Nodes = nodes()
 				}
 				return nil

diff --git a/agent/consul/state/config_entry_oss_test.go b/agent/consul/state/config_entry_oss_test.go
@@ -63,7 +63,7 @@ func TestStore_peersForService(t *testing.T) {
 						Name: "not-" + queryName,
 						Consumers: []structs.ServiceConsumer{
 							{
-								PeerName: "zip",
+								Peer: "zip",
 							},
 						},
 					},
@@ -80,18 +80,18 @@ func TestStore_peersForService(t *testing.T) {
 						Name: "not-" + queryName,
 						Consumers: []structs.ServiceConsumer{
 							{
-								PeerName: "zip",
+								Peer: "zip",
 							},
 						},
 					},
 					{
 						Name: structs.WildcardSpecifier,
 						Consumers: []structs.ServiceConsumer{
 							{
-								PeerName: "bar",
+								Peer: "bar",
 							},
 							{
-								PeerName: "baz",
+								Peer: "baz",
 							},
 						},
 					},
@@ -108,15 +108,15 @@ func TestStore_peersForService(t *testing.T) {
 						Name: queryName,
 						Consumers: []structs.ServiceConsumer{
 							{
-								PeerName: "baz",
+								Peer: "baz",
 							},
 						},
 					},
 					{
 						Name: structs.WildcardSpecifier,
 						Consumers: []structs.ServiceConsumer{
 							{
-								PeerName: "zip",
+								Peer: "zip",
 							},
 						},
 					},

diff --git a/agent/consul/state/config_entry_test.go b/agent/consul/state/config_entry_test.go
@@ -1569,7 +1569,7 @@ func TestStore_ConfigEntry_GraphValidation(t *testing.T) {
 				Name: "default",
 				Services: []structs.ExportedService{{
 					Name:      "main",
-					Consumers: []structs.ServiceConsumer{{PeerName: "my-peer"}},
+					Consumers: []structs.ServiceConsumer{{Peer: "my-peer"}},
 				}},
 			},
 			expectErr: `contains cross-datacenter resolver redirect`,
@@ -1588,7 +1588,7 @@ func TestStore_ConfigEntry_GraphValidation(t *testing.T) {
 				Name: "default",
 				Services: []structs.ExportedService{{
 					Name:      "*",
-					Consumers: []structs.ServiceConsumer{{PeerName: "my-peer"}},
+					Consumers: []structs.ServiceConsumer{{Peer: "my-peer"}},
 				}},
 			},
 			expectErr: `contains cross-datacenter resolver redirect`,
@@ -1609,7 +1609,7 @@ func TestStore_ConfigEntry_GraphValidation(t *testing.T) {
 				Name: "default",
 				Services: []structs.ExportedService{{
 					Name:      "main",
-					Consumers: []structs.ServiceConsumer{{PeerName: "my-peer"}},
+					Consumers: []structs.ServiceConsumer{{Peer: "my-peer"}},
 				}},
 			},
 			expectErr: `contains cross-datacenter failover`,
@@ -1630,7 +1630,7 @@ func TestStore_ConfigEntry_GraphValidation(t *testing.T) {
 				Name: "default",
 				Services: []structs.ExportedService{{
 					Name:      "*",
-					Consumers: []structs.ServiceConsumer{{PeerName: "my-peer"}},
+					Consumers: []structs.ServiceConsumer{{Peer: "my-peer"}},
 				}},
 			},
 			expectErr: `contains cross-datacenter failover`,
@@ -1641,7 +1641,7 @@ func TestStore_ConfigEntry_GraphValidation(t *testing.T) {
 					Name: "default",
 					Services: []structs.ExportedService{{
 						Name:      "main",
-						Consumers: []structs.ServiceConsumer{{PeerName: "my-peer"}},
+						Consumers: []structs.ServiceConsumer{{Peer: "my-peer"}},
 					}},
 				},
 			},

diff --git a/agent/consul/state/peering.go b/agent/consul/state/peering.go
@@ -794,7 +794,7 @@ func exportedServicesForPeerTxn(
 				// Service was covered by a wildcard that was already accounted for
 				continue
 			}
-			if consumer.PeerName != peering.Name {
+			if consumer.Peer != peering.Name {
 				continue
 			}
 			sawPeer = true
@@ -940,7 +940,7 @@ func listServicesExportedToAnyPeerByConfigEntry(
 
 		sawPeer := false
 		for _, consumer := range svc.Consumers {
-			if consumer.PeerName == "" {
+			if consumer.Peer == "" {
 				continue
 			}
 			sawPeer = true
@@ -1312,8 +1312,8 @@ func peersForServiceTxn(
 	}
 
 	for _, c := range entry.Services[targetIdx].Consumers {
-		if c.PeerName != "" {
-			results = append(results, c.PeerName)
+		if c.Peer != "" {
+			results = append(results, c.Peer)
 		}
 	}
 	return idx, results, nil