Skip to content

Commit cb4d60e

Browse files
djyaudjyau
authored
feat: add support for Row Affinity app profiles (#2341)
* Create of methods, add unit tests Change-Id: I7cdd6c9ce85f9132c0fa3db3aa8c70abac26f12b * Add unit tests for BigtableInstanceAdminClientTests Change-Id: Id2cedefd90c52c249b2b15734eb1fbbcc5db2bf4 * Add tests for Create and Update App Profile Change-Id: I01ef72617d391bdb956ae9f469f1fd5af208a2e1 * Add integration test Change-Id: I9f18991cb61d99f30b811cea0988963d9e2577cd * Rename ofWithRowAffinity to withRowAffinity Change-Id: I9f88209e04cde4f628c878fbdb659c7344aa1c3c * Run mvn com.coveo:fmt-maven-plugin:format Change-Id: Ieda39f0d9825fae649755350b4f228fe0e8985e5 * Remove extra test for cluster IDs - one is enough Change-Id: I6d8e7bd644ce2cd8f098c8ee37b4eec1a0d642e2 * Add unit test for row affinity with set of strings Change-Id: I7b072214c8b38646058d0ec668bbb469bf16f23e * Run formatter Change-Id: Ieb04b2141c8843ff59cc4d756d736b4c00609ee2
1 parent 7bd3a30 commit cb4d60e

File tree

6 files changed

+311
-1
lines changed

6 files changed

+311
-1
lines changed

‎google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/models/AppProfile.java‎

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
import com.google.api.core.InternalApi;
1919
import com.google.bigtable.admin.v2.AppProfile.DataBoostIsolationReadOnly;
2020
import com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny;
21-
import com.google.bigtable.admin.v2.AppProfile.Priority;
2221
import com.google.bigtable.admin.v2.AppProfile.StandardIsolation;
2322
import com.google.bigtable.admin.v2.AppProfileName;
2423
import com.google.common.base.Objects;
@@ -69,6 +68,10 @@ private AppProfile(@Nonnull com.google.bigtable.admin.v2.AppProfile proto) {
6968
@SuppressWarnings("WeakerAccess")
7069
public RoutingPolicy getPolicy() {
7170
if (proto.hasMultiClusterRoutingUseAny()) {
71+
if (proto.getMultiClusterRoutingUseAny().hasRowAffinity()) {
72+
return MultiClusterRoutingPolicy.withRowAffinity(
73+
ImmutableSet.copyOf(proto.getMultiClusterRoutingUseAny().getClusterIdsList()));
74+
}
7275
return MultiClusterRoutingPolicy.of(
7376
ImmutableSet.copyOf(proto.getMultiClusterRoutingUseAny().getClusterIdsList()));
7477
} else if (proto.hasSingleClusterRouting()) {
@@ -267,6 +270,34 @@ public static MultiClusterRoutingPolicy of(Set<String> clusterIds) {
267270
MultiClusterRoutingUseAny.newBuilder().addAllClusterIds(clusterIds).build());
268271
}
269272

273+
/** Creates a new instance of {@link MultiClusterRoutingPolicy}. */
274+
public static MultiClusterRoutingPolicy withRowAffinity() {
275+
return new MultiClusterRoutingPolicy(
276+
MultiClusterRoutingUseAny.newBuilder()
277+
.setRowAffinity(MultiClusterRoutingUseAny.RowAffinity.getDefaultInstance())
278+
.build());
279+
}
280+
281+
/**
282+
* Creates a new instance of {@link MultiClusterRoutingPolicy} with row affinity enabled and
283+
* specified cluster ids to route to.
284+
*/
285+
public static MultiClusterRoutingPolicy withRowAffinity(String... clusterIds) {
286+
return withRowAffinity(ImmutableSet.copyOf(clusterIds));
287+
}
288+
289+
/**
290+
* Creates a new instance of {@link MultiClusterRoutingPolicy} with specified cluster ids to
291+
* route to.
292+
*/
293+
public static MultiClusterRoutingPolicy withRowAffinity(Set<String> clusterIds) {
294+
return new MultiClusterRoutingPolicy(
295+
MultiClusterRoutingUseAny.newBuilder()
296+
.addAllClusterIds(clusterIds)
297+
.setRowAffinity(MultiClusterRoutingUseAny.RowAffinity.getDefaultInstance())
298+
.build());
299+
}
300+
270301
/*
271302
* Returns the set of clusters to route to. The order is ignored; clusters will be
272303
* tried in order of distance. If empty, all clusters are eligible.

‎google-cloud-bigtable/src/test/java/com/google/cloud/bigtable/admin/v2/BigtableInstanceAdminClientTests.java‎

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@
6565
import com.google.protobuf.FieldMask;
6666
import io.grpc.Status;
6767
import io.grpc.Status.Code;
68+
import java.util.HashSet;
6869
import java.util.List;
70+
import java.util.Set;
6971
import java.util.concurrent.atomic.AtomicBoolean;
7072
import java.util.concurrent.atomic.AtomicInteger;
7173
import org.junit.Before;
@@ -1034,6 +1036,153 @@ public void testCreateAppProfileAddPriority() {
10341036
assertThat(actualResult).isEqualTo(AppProfile.fromProto(expectedResponse));
10351037
}
10361038

1039+
@Test
1040+
public void testCreateAppProfileAddRowAffinity() {
1041+
// Setup
1042+
Mockito.when(mockStub.createAppProfileCallable()).thenReturn(mockCreateAppProfileCallable);
1043+
1044+
com.google.bigtable.admin.v2.CreateAppProfileRequest expectedRequest =
1045+
com.google.bigtable.admin.v2.CreateAppProfileRequest.newBuilder()
1046+
.setParent(NameUtil.formatInstanceName(PROJECT_ID, INSTANCE_ID))
1047+
.setAppProfileId(APP_PROFILE_ID)
1048+
.setAppProfile(
1049+
com.google.bigtable.admin.v2.AppProfile.newBuilder()
1050+
.setDescription("my description")
1051+
.setMultiClusterRoutingUseAny(
1052+
com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny
1053+
.newBuilder()
1054+
.setRowAffinity(
1055+
com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny
1056+
.RowAffinity.getDefaultInstance())))
1057+
.build();
1058+
1059+
com.google.bigtable.admin.v2.AppProfile expectedResponse =
1060+
com.google.bigtable.admin.v2.AppProfile.newBuilder()
1061+
.setName(APP_PROFILE_NAME)
1062+
.setDescription("my description")
1063+
.setMultiClusterRoutingUseAny(
1064+
com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny.newBuilder()
1065+
.setRowAffinity(
1066+
com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny
1067+
.RowAffinity.getDefaultInstance()))
1068+
.build();
1069+
1070+
Mockito.when(mockCreateAppProfileCallable.futureCall(expectedRequest))
1071+
.thenReturn(ApiFutures.immediateFuture(expectedResponse));
1072+
1073+
// Execute
1074+
AppProfile actualResult =
1075+
adminClient.createAppProfile(
1076+
CreateAppProfileRequest.of(INSTANCE_ID, APP_PROFILE_ID)
1077+
.setDescription("my description")
1078+
.setRoutingPolicy(MultiClusterRoutingPolicy.withRowAffinity()));
1079+
1080+
// Verify
1081+
assertThat(actualResult).isEqualTo(AppProfile.fromProto(expectedResponse));
1082+
}
1083+
1084+
@Test
1085+
public void testCreateAppProfileAddRowAffinityAddMultipleClusterIds() {
1086+
// Setup
1087+
Mockito.when(mockStub.createAppProfileCallable()).thenReturn(mockCreateAppProfileCallable);
1088+
1089+
com.google.bigtable.admin.v2.CreateAppProfileRequest expectedRequest =
1090+
com.google.bigtable.admin.v2.CreateAppProfileRequest.newBuilder()
1091+
.setParent(NameUtil.formatInstanceName(PROJECT_ID, INSTANCE_ID))
1092+
.setAppProfileId(APP_PROFILE_ID)
1093+
.setAppProfile(
1094+
com.google.bigtable.admin.v2.AppProfile.newBuilder()
1095+
.setDescription("my description")
1096+
.setMultiClusterRoutingUseAny(
1097+
com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny
1098+
.newBuilder()
1099+
.addClusterIds("cluster-id-1")
1100+
.addClusterIds("cluster-id-2")
1101+
.setRowAffinity(
1102+
com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny
1103+
.RowAffinity.getDefaultInstance())))
1104+
.build();
1105+
1106+
com.google.bigtable.admin.v2.AppProfile expectedResponse =
1107+
com.google.bigtable.admin.v2.AppProfile.newBuilder()
1108+
.setName(APP_PROFILE_NAME)
1109+
.setDescription("my description")
1110+
.setMultiClusterRoutingUseAny(
1111+
com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny.newBuilder()
1112+
.addClusterIds("cluster-id-1")
1113+
.addClusterIds("cluster-id-2")
1114+
.setRowAffinity(
1115+
com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny
1116+
.RowAffinity.getDefaultInstance()))
1117+
.build();
1118+
1119+
Mockito.when(mockCreateAppProfileCallable.futureCall(expectedRequest))
1120+
.thenReturn(ApiFutures.immediateFuture(expectedResponse));
1121+
1122+
// Execute
1123+
AppProfile actualResult =
1124+
adminClient.createAppProfile(
1125+
CreateAppProfileRequest.of(INSTANCE_ID, APP_PROFILE_ID)
1126+
.setDescription("my description")
1127+
.setRoutingPolicy(
1128+
MultiClusterRoutingPolicy.withRowAffinity("cluster-id-1", "cluster-id-2")));
1129+
1130+
// Verify
1131+
assertThat(actualResult).isEqualTo(AppProfile.fromProto(expectedResponse));
1132+
}
1133+
1134+
@Test
1135+
public void testCreateAppProfileAddRowAffinityAddSetOfClusterIds() {
1136+
// Setup
1137+
Mockito.when(mockStub.createAppProfileCallable()).thenReturn(mockCreateAppProfileCallable);
1138+
1139+
com.google.bigtable.admin.v2.CreateAppProfileRequest expectedRequest =
1140+
com.google.bigtable.admin.v2.CreateAppProfileRequest.newBuilder()
1141+
.setParent(NameUtil.formatInstanceName(PROJECT_ID, INSTANCE_ID))
1142+
.setAppProfileId(APP_PROFILE_ID)
1143+
.setAppProfile(
1144+
com.google.bigtable.admin.v2.AppProfile.newBuilder()
1145+
.setDescription("my description")
1146+
.setMultiClusterRoutingUseAny(
1147+
com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny
1148+
.newBuilder()
1149+
.addClusterIds("cluster-id-1")
1150+
.addClusterIds("cluster-id-2")
1151+
.setRowAffinity(
1152+
com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny
1153+
.RowAffinity.getDefaultInstance())))
1154+
.build();
1155+
1156+
com.google.bigtable.admin.v2.AppProfile expectedResponse =
1157+
com.google.bigtable.admin.v2.AppProfile.newBuilder()
1158+
.setName(APP_PROFILE_NAME)
1159+
.setDescription("my description")
1160+
.setMultiClusterRoutingUseAny(
1161+
com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny.newBuilder()
1162+
.addClusterIds("cluster-id-1")
1163+
.addClusterIds("cluster-id-2")
1164+
.setRowAffinity(
1165+
com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny
1166+
.RowAffinity.getDefaultInstance()))
1167+
.build();
1168+
1169+
Mockito.when(mockCreateAppProfileCallable.futureCall(expectedRequest))
1170+
.thenReturn(ApiFutures.immediateFuture(expectedResponse));
1171+
1172+
// Execute
1173+
Set<String> clusterIds = new HashSet<String>();
1174+
clusterIds.add("cluster-id-1");
1175+
clusterIds.add("cluster-id-2");
1176+
AppProfile actualResult =
1177+
adminClient.createAppProfile(
1178+
CreateAppProfileRequest.of(INSTANCE_ID, APP_PROFILE_ID)
1179+
.setDescription("my description")
1180+
.setRoutingPolicy(MultiClusterRoutingPolicy.withRowAffinity(clusterIds)));
1181+
1182+
// Verify
1183+
assertThat(actualResult).isEqualTo(AppProfile.fromProto(expectedResponse));
1184+
}
1185+
10371186
@Test
10381187
public void testGetAppProfile() {
10391188
// Setup

‎google-cloud-bigtable/src/test/java/com/google/cloud/bigtable/admin/v2/it/BigtableInstanceAdminClientIT.java‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,43 @@ public void appProfileTestDataBoost() {
285285
}
286286
}
287287

288+
@Test
289+
public void appProfileTestRowAffinity() {
290+
String newInstanceId = prefixGenerator.newPrefix();
291+
String newClusterId = newInstanceId + "-c1";
292+
String newClusterId2 = newInstanceId + "-c2";
293+
294+
client.createInstance(
295+
CreateInstanceRequest.of(newInstanceId)
296+
.addCluster(newClusterId, testEnvRule.env().getPrimaryZone(), 1, StorageType.SSD)
297+
.addCluster(newClusterId2, testEnvRule.env().getSecondaryZone(), 1, StorageType.SSD)
298+
.setDisplayName("Row-Affinity-Instance-Test")
299+
.addLabel("state", "readytodelete")
300+
.setType(Type.PRODUCTION));
301+
302+
try {
303+
assertThat(client.exists(newInstanceId)).isTrue();
304+
305+
String testAppProfile = prefixGenerator.newPrefix();
306+
307+
CreateAppProfileRequest request =
308+
CreateAppProfileRequest.of(newInstanceId, testAppProfile)
309+
.setRoutingPolicy(
310+
AppProfile.MultiClusterRoutingPolicy.withRowAffinity(newClusterId, newClusterId2))
311+
.setDescription("row affinity app profile");
312+
313+
AppProfile newlyCreateAppProfile = client.createAppProfile(request);
314+
AppProfile.RoutingPolicy routingPolicy = newlyCreateAppProfile.getPolicy();
315+
assertThat(routingPolicy)
316+
.isEqualTo(
317+
AppProfile.MultiClusterRoutingPolicy.withRowAffinity(newClusterId, newClusterId2));
318+
} finally {
319+
if (client.exists(newInstanceId)) {
320+
client.deleteInstance(newInstanceId);
321+
}
322+
}
323+
}
324+
288325
@Test
289326
public void iamUpdateTest() {
290327
Policy policy = client.getIamPolicy(instanceId);

‎google-cloud-bigtable/src/test/java/com/google/cloud/bigtable/admin/v2/models/AppProfileTest.java‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -291,4 +291,54 @@ public void testFromProtoWithDataBoostIsolation() {
291291
AppProfile.DataBoostIsolationReadOnlyPolicy.of(
292292
AppProfile.ComputeBillingOwner.UNSPECIFIED));
293293
}
294+
295+
@Test
296+
public void testFromProtoWithRowAffinityNoClusterGroup() {
297+
AppProfile profile =
298+
AppProfile.fromProto(
299+
com.google.bigtable.admin.v2.AppProfile.newBuilder()
300+
.setName(AppProfileName.of("my-project", "my-instance", "my-profile").toString())
301+
.setDescription("my description")
302+
.setMultiClusterRoutingUseAny(
303+
com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny.newBuilder()
304+
.setRowAffinity(
305+
com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny
306+
.RowAffinity.getDefaultInstance())
307+
.build())
308+
.setEtag("my-etag")
309+
.build());
310+
311+
assertThat(profile.getInstanceId()).isEqualTo("my-instance");
312+
assertThat(profile.getId()).isEqualTo("my-profile");
313+
assertThat(profile.getDescription()).isEqualTo("my description");
314+
System.out.println(profile.getPolicy());
315+
System.out.println(AppProfile.MultiClusterRoutingPolicy.withRowAffinity());
316+
assertThat(profile.getPolicy())
317+
.isEqualTo(AppProfile.MultiClusterRoutingPolicy.withRowAffinity());
318+
}
319+
320+
@Test
321+
public void testFromProtoWithRowAffinityClusterGroup() {
322+
AppProfile profile =
323+
AppProfile.fromProto(
324+
com.google.bigtable.admin.v2.AppProfile.newBuilder()
325+
.setName(AppProfileName.of("my-project", "my-instance", "my-profile").toString())
326+
.setDescription("my description")
327+
.setMultiClusterRoutingUseAny(
328+
com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny.newBuilder()
329+
.addAllClusterIds(ImmutableList.of("cluster-id-1", "cluster-id-2"))
330+
.setRowAffinity(
331+
com.google.bigtable.admin.v2.AppProfile.MultiClusterRoutingUseAny
332+
.RowAffinity.getDefaultInstance())
333+
.build())
334+
.setEtag("my-etag")
335+
.build());
336+
337+
assertThat(profile.getInstanceId()).isEqualTo("my-instance");
338+
assertThat(profile.getId()).isEqualTo("my-profile");
339+
assertThat(profile.getDescription()).isEqualTo("my description");
340+
assertThat(profile.getPolicy())
341+
.isEqualTo(
342+
AppProfile.MultiClusterRoutingPolicy.withRowAffinity("cluster-id-1", "cluster-id-2"));
343+
}
294344
}

‎google-cloud-bigtable/src/test/java/com/google/cloud/bigtable/admin/v2/models/CreateAppProfileRequestTest.java‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,4 +101,17 @@ public void testDataBoostIsolationReadOnly() {
101101
.setComputeBillingOwner(DataBoostIsolationReadOnly.ComputeBillingOwner.HOST_PAYS)
102102
.build());
103103
}
104+
105+
@Test
106+
public void testRowAffinity() {
107+
CreateAppProfileRequest wrapper =
108+
CreateAppProfileRequest.of("my-instance", "my-profile")
109+
.setRoutingPolicy(MultiClusterRoutingPolicy.withRowAffinity());
110+
111+
assertThat(wrapper.toProto("my-project").getAppProfile().getMultiClusterRoutingUseAny())
112+
.isEqualTo(
113+
MultiClusterRoutingUseAny.newBuilder()
114+
.setRowAffinity(MultiClusterRoutingUseAny.RowAffinity.getDefaultInstance())
115+
.build());
116+
}
104117
}

‎google-cloud-bigtable/src/test/java/com/google/cloud/bigtable/admin/v2/models/UpdateAppProfileRequestTest.java‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,4 +146,34 @@ public void testUpdateExistingDataBoostIsolationReadOnly() {
146146
.setUpdateMask(FieldMask.newBuilder().addPaths("data_boost_isolation_read_only"))
147147
.build());
148148
}
149+
150+
@Test
151+
public void testUpdateRowAffinity() {
152+
com.google.bigtable.admin.v2.AppProfile existingProto =
153+
com.google.bigtable.admin.v2.AppProfile.newBuilder()
154+
.setName("projects/my-project/instances/my-instance/appProfiles/my-profile")
155+
.setEtag("my-etag")
156+
.setDescription("description")
157+
.setMultiClusterRoutingUseAny(MultiClusterRoutingUseAny.getDefaultInstance())
158+
.build();
159+
160+
AppProfile existingWrapper = AppProfile.fromProto(existingProto);
161+
162+
UpdateAppProfileRequest updateWrapper =
163+
UpdateAppProfileRequest.of(existingWrapper)
164+
.setRoutingPolicy(AppProfile.MultiClusterRoutingPolicy.withRowAffinity());
165+
166+
assertThat(updateWrapper.toProto("my-project"))
167+
.isEqualTo(
168+
com.google.bigtable.admin.v2.UpdateAppProfileRequest.newBuilder()
169+
.setAppProfile(
170+
existingProto
171+
.toBuilder()
172+
.setMultiClusterRoutingUseAny(
173+
MultiClusterRoutingUseAny.newBuilder()
174+
.setRowAffinity(
175+
MultiClusterRoutingUseAny.RowAffinity.getDefaultInstance())))
176+
.setUpdateMask(FieldMask.newBuilder().addPaths("multi_cluster_routing_use_any"))
177+
.build());
178+
}
149179
}

0 commit comments

Comments
 (0)