-
Notifications
You must be signed in to change notification settings - Fork 215
/
SearchConsistencyIT.java
389 lines (342 loc) · 19.1 KB
/
SearchConsistencyIT.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
/*
* Copyright (c) 2022 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.thingsearch.service.updater.actors;
import java.time.Duration;
import java.time.Instant;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.TimeUnit;
import org.awaitility.Awaitility;
import org.bson.BsonArray;
import org.bson.BsonDocument;
import org.bson.BsonInt64;
import org.bson.BsonString;
import org.bson.Document;
import org.eclipse.ditto.base.model.acks.AcknowledgementLabel;
import org.eclipse.ditto.base.model.acks.AcknowledgementRequest;
import org.eclipse.ditto.base.model.acks.DittoAcknowledgementLabel;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.base.model.headers.WithDittoHeaders;
import org.eclipse.ditto.base.model.json.FieldType;
import org.eclipse.ditto.base.model.signals.ShardedMessageEnvelope;
import org.eclipse.ditto.internal.utils.namespaces.BlockedNamespaces;
import org.eclipse.ditto.internal.utils.persistence.mongo.DittoMongoClient;
import org.eclipse.ditto.internal.utils.persistence.mongo.MongoClientWrapper;
import org.eclipse.ditto.internal.utils.test.mongo.MongoDbResource;
import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonPointer;
import org.eclipse.ditto.json.JsonValue;
import org.eclipse.ditto.policies.api.commands.sudo.SudoRetrievePolicy;
import org.eclipse.ditto.policies.api.commands.sudo.SudoRetrievePolicyResponse;
import org.eclipse.ditto.policies.model.EffectedPermissions;
import org.eclipse.ditto.policies.model.Policy;
import org.eclipse.ditto.policies.model.PolicyEntry;
import org.eclipse.ditto.policies.model.PolicyId;
import org.eclipse.ditto.policies.model.Resource;
import org.eclipse.ditto.policies.model.ResourceKey;
import org.eclipse.ditto.policies.model.Subject;
import org.eclipse.ditto.policies.model.SubjectIssuer;
import org.eclipse.ditto.things.api.commands.sudo.SudoRetrieveThing;
import org.eclipse.ditto.things.api.commands.sudo.SudoRetrieveThingResponse;
import org.eclipse.ditto.things.model.Attributes;
import org.eclipse.ditto.things.model.Thing;
import org.eclipse.ditto.things.model.ThingId;
import org.eclipse.ditto.things.model.ThingsModelFactory;
import org.eclipse.ditto.things.model.signals.events.AttributesModified;
import org.eclipse.ditto.things.model.signals.events.ThingEvent;
import org.eclipse.ditto.thingsearch.api.commands.sudo.UpdateThingResponse;
import org.eclipse.ditto.thingsearch.service.common.config.DefaultUpdaterConfig;
import org.eclipse.ditto.thingsearch.service.common.config.UpdaterConfig;
import org.eclipse.ditto.thingsearch.service.persistence.PersistenceConstants;
import org.eclipse.ditto.thingsearch.service.persistence.write.model.AbstractWriteModel;
import org.eclipse.ditto.thingsearch.service.persistence.write.model.Metadata;
import org.eclipse.ditto.thingsearch.service.persistence.write.model.ThingWriteModel;
import org.eclipse.ditto.thingsearch.service.persistence.write.streaming.ChangeQueueActor;
import org.eclipse.ditto.thingsearch.service.persistence.write.streaming.SearchUpdateMapper;
import org.eclipse.ditto.thingsearch.service.persistence.write.streaming.SearchUpdaterStream;
import org.junit.After;
import org.junit.Before;
import org.junit.ClassRule;
import org.junit.Test;
import com.mongodb.client.model.Filters;
import com.typesafe.config.ConfigFactory;
import akka.actor.AbstractActor;
import akka.actor.ActorRef;
import akka.actor.ActorRefFactory;
import akka.actor.ActorSystem;
import akka.actor.Props;
import akka.actor.RepointableActorRef;
import akka.cluster.pubsub.DistributedPubSub;
import akka.japi.pf.ReceiveBuilder;
import akka.stream.Materializer;
import akka.stream.javadsl.Sink;
import akka.stream.javadsl.Source;
import akka.testkit.TestProbe;
import akka.testkit.javadsl.TestKit;
/**
* Integration Test for search consistency with conflicting search updates.
*/
public final class SearchConsistencyIT {
@ClassRule
public static final MongoDbResource MONGO_RESOURCE = new MongoDbResource();
//Arbitrary
private static final long INITIAL_REVISION = 1L;
private static final String NAMESPACE = "abc";
private static final ThingId THING_ID = ThingId.of(NAMESPACE, "myId");
private static final PolicyId POLICY_ID = PolicyId.of(THING_ID);
private static final Policy POLICY = Policy.newBuilder(POLICY_ID)
.setRevision(INITIAL_REVISION)
.set(PolicyEntry.newInstance("test", List.of(Subject.newInstance(SubjectIssuer.INTEGRATION, "test")),
List.of(Resource.newInstance(ResourceKey.newInstance("thing:/"),
EffectedPermissions.newInstance(List.of("WRITE", "READ"), Collections.emptyList())))))
.build();
private static final long REVISION = 2L;
private static final Thing THING = ThingsModelFactory.newThingBuilder()
.setRevision(INITIAL_REVISION)
.setAttribute(JsonPointer.of("number"), JsonValue.of(22))
.setAttribute(JsonPointer.of("char"), JsonValue.of("abc"))
.setId(THING_ID)
.setPolicyId(POLICY_ID)
.build();
private static final long EXPECTED_NUMBER = 32;
private static final String EXPECTED_CHAR = "cba";
private static final Instant MODIFIED = Instant.now();
private ActorSystem actorSystem;
private ActorRef updater1;
private SearchUpdaterStream updaterStream1;
private ActorRef updater2;
private SearchUpdaterStream updaterStream2;
private DittoMongoClient mongoClient;
@Before()
public void setup() {
mongoClient = provideClientWrapper();
final var config = ConfigFactory.load("consistency-it");
final var updaterConfig = DefaultUpdaterConfig.of(ConfigFactory.load("updater-test"));
actorSystem = ActorSystem.create(getClass().getSimpleName(), config);
final var pubSubMediator = DistributedPubSub.get(actorSystem).mediator();
final ActorRef changeQueue1 = createChangeQueue(actorSystem);
final ActorRef changeQueue2 = createChangeQueue(actorSystem);
updater1 = createSearchUpdaterShardRegion(changeQueue1, pubSubMediator, updaterConfig);
updater2 = createSearchUpdaterShardRegion(changeQueue2, pubSubMediator, updaterConfig);
updaterStream1 = createSearchUpdaterStream(updaterConfig, updater1, changeQueue1);
updaterStream2 = createSearchUpdaterStream(updaterConfig, updater2, changeQueue2);
}
@After()
public void tearDown() {
TestKit.shutdownActorSystem(actorSystem);
}
private static DittoMongoClient provideClientWrapper() {
return MongoClientWrapper.getBuilder()
.connectionString(
"mongodb://" + MONGO_RESOURCE.getBindIp() + ":" + MONGO_RESOURCE.getPort() + "/testSearchDB")
.build();
}
private static ActorRef createChangeQueue(final ActorRefFactory actorSystem) {
final var changeQueueProps = ChangeQueueActor.props();
return actorSystem.actorOf(changeQueueProps);
}
private SearchUpdaterStream createSearchUpdaterStream(final UpdaterConfig updaterConfig,
final ActorRef updaterShard, final ActorRef changeQueue) {
final var thingsShard = actorSystem.actorOf(ThingShardMock.props());
final var policiesShard = actorSystem.actorOf(PolicyShardMock.props());
final var db = mongoClient.getDefaultDatabase();
final var blockedNamespaces = BlockedNamespaces.of(actorSystem);
final var updateMapper = SearchUpdateMapper.get(actorSystem);
return SearchUpdaterStream.of(updaterConfig, actorSystem, thingsShard, policiesShard, updaterShard, changeQueue,
db, blockedNamespaces, updateMapper);
}
private ActorRef createSearchUpdaterShardRegion(final ActorRef changeQueue,
final ActorRef pubSub,
final UpdaterConfig config) {
ChangeQueueActor.createSource(changeQueue, true, java.time.Duration.ofSeconds(3));
final var updaterProps = ThingUpdater.props(pubSub, changeQueue, config);
final var updater = actorSystem.actorOf(updaterProps, THING_ID.toString() + Math.random());
final var shardMockProps = UpdaterShardMock.props(updater);
return actorSystem.actorOf(shardMockProps);
}
@Test
public void assertConsistencyInCaseOfConflict() {
final var probe = TestProbe.apply(actorSystem);
updaterStream1.start(actorSystem);
updaterStream2.start(actorSystem);
probe.send(updater1, getRecoveryWriteModel());
probe.send(updater2, getRecoveryWriteModel());
probe.send(updater1, getThingEvent(ThingsModelFactory.newAttributes(JsonFactory
.newObjectBuilder().set("char", EXPECTED_CHAR).set("number", EXPECTED_NUMBER).build())));
probe.send(updater2, getThingEvent(ThingsModelFactory.newAttributes(JsonFactory
.newObjectBuilder().set("number", EXPECTED_NUMBER).set("char", EXPECTED_CHAR).build())));
assertSearchPersisted(Duration.ofSeconds(10));
}
private static ThingEvent<?> getThingEvent(final Attributes attributes) {
final var dittoHeaders = getDittoHeadersWithSearchPersistedAck();
return AttributesModified.of(THING_ID, attributes, REVISION, MODIFIED, dittoHeaders, null);
}
private static DittoHeaders getDittoHeadersWithSearchPersistedAck() {
return DittoHeaders.newBuilder()
.acknowledgementRequest(
AcknowledgementRequest.of(
AcknowledgementLabel.of(DittoAcknowledgementLabel.SEARCH_PERSISTED)))
.build();
}
private void assertSearchPersisted(final Duration timeout) {
final var materializer = Materializer.createMaterializer(actorSystem);
Awaitility.await()
.atMost(timeout)
.until(() -> {
final var persistedDocuments =
Source.fromPublisher(mongoClient.getCollection(PersistenceConstants.THINGS_COLLECTION_NAME)
.find(Filters.eq(PersistenceConstants.FIELD_ID, THING_ID.toString())))
.runWith(Sink.seq(), materializer)
.toCompletableFuture()
.get(timeout.toMillis(), TimeUnit.MILLISECONDS);
return persistedDocuments.size() == 1 &&
persistedDocuments.get(0).toString().equals(getExpectedDocument().toString());
});
}
private static AbstractWriteModel getRecoveryWriteModel() {
final Metadata metadata = Metadata.of(THING_ID, INITIAL_REVISION, POLICY_ID, INITIAL_REVISION, null);
final BsonDocument thingDocument = new BsonDocument()
.append(PersistenceConstants.FIELD_ID, new BsonString(THING_ID.toString()))
.append(PersistenceConstants.FIELD_REVISION, new BsonInt64(INITIAL_REVISION))
.append(PersistenceConstants.FIELD_POLICY_ID, new BsonString(POLICY_ID.toString()))
.append(PersistenceConstants.FIELD_POLICY_REVISION, new BsonInt64(INITIAL_REVISION))
.append(PersistenceConstants.FIELD_NAMESPACE, new BsonString(THING_ID.getNamespace()))
.append(PersistenceConstants.FIELD_GLOBAL_READ, new BsonString("integration:test"))
.append(PersistenceConstants.FIELD_SORTING, new BsonDocument())
.append(PersistenceConstants.FIELD_INTERNAL, new BsonArray());
return ThingWriteModel.of(metadata, thingDocument);
}
private static Document getExpectedDocument() {
return new Document()
.append(PersistenceConstants.FIELD_ID, THING_ID.toString())
.append(PersistenceConstants.FIELD_REVISION, REVISION)
.append(PersistenceConstants.FIELD_NAMESPACE, THING_ID.getNamespace())
.append(PersistenceConstants.FIELD_GLOBAL_READ, List.of("integration:test"))
.append(PersistenceConstants.FIELD_POLICY_ID, POLICY_ID.toString())
.append(PersistenceConstants.FIELD_POLICY_REVISION, INITIAL_REVISION)
.append(PersistenceConstants.FIELD_SORTING, new Document()
.append(PersistenceConstants.FIELD_REVISION, REVISION)
.append(PersistenceConstants.FIELD_NAMESPACE, THING_ID.getNamespace())
.append("thingId", THING_ID.toString())
.append("policyId", POLICY_ID.toString())
.append("attributes", new Document()
.append("number", EXPECTED_NUMBER)
.append("char", EXPECTED_CHAR))
.append("_modified", MODIFIED))
.append(PersistenceConstants.FIELD_INTERNAL, List.of(
new Document()
.append(PersistenceConstants.FIELD_INTERNAL_KEY,
"/" + PersistenceConstants.FIELD_REVISION)
.append(PersistenceConstants.FIELD_INTERNAL_VALUE, REVISION)
.append(PersistenceConstants.FIELD_GRANTED,
List.of("integration:test"))
.append(PersistenceConstants.FIELD_REVOKED, Collections.emptyList()),
new Document()
.append(PersistenceConstants.FIELD_INTERNAL_KEY,
"/" + PersistenceConstants.FIELD_NAMESPACE)
.append(PersistenceConstants.FIELD_INTERNAL_VALUE, THING_ID.getNamespace())
.append(PersistenceConstants.FIELD_GRANTED,
List.of("integration:test"))
.append(PersistenceConstants.FIELD_REVOKED, Collections.emptyList()),
new Document()
.append(PersistenceConstants.FIELD_INTERNAL_KEY,
"/thingId")
.append(PersistenceConstants.FIELD_INTERNAL_VALUE, THING_ID.toString())
.append(PersistenceConstants.FIELD_GRANTED,
List.of("integration:test"))
.append(PersistenceConstants.FIELD_REVOKED, Collections.emptyList()),
new Document()
.append(PersistenceConstants.FIELD_INTERNAL_KEY,
"/policyId")
.append(PersistenceConstants.FIELD_INTERNAL_VALUE, POLICY_ID.toString())
.append(PersistenceConstants.FIELD_GRANTED,
List.of("integration:test"))
.append(PersistenceConstants.FIELD_REVOKED, Collections.emptyList()),
new Document()
.append(PersistenceConstants.FIELD_INTERNAL_KEY,
"/attributes/number")
.append(PersistenceConstants.FIELD_INTERNAL_VALUE, EXPECTED_NUMBER)
.append(PersistenceConstants.FIELD_GRANTED,
List.of("integration:test"))
.append(PersistenceConstants.FIELD_REVOKED, Collections.emptyList()),
new Document()
.append(PersistenceConstants.FIELD_INTERNAL_KEY,
"/attributes/char")
.append(PersistenceConstants.FIELD_INTERNAL_VALUE, EXPECTED_CHAR)
.append(PersistenceConstants.FIELD_GRANTED,
List.of("integration:test"))
.append(PersistenceConstants.FIELD_REVOKED, Collections.emptyList()),
new Document()
.append(PersistenceConstants.FIELD_INTERNAL_KEY,
"/_modified")
.append(PersistenceConstants.FIELD_INTERNAL_VALUE, MODIFIED)
.append(PersistenceConstants.FIELD_GRANTED,
List.of("integration:test"))
.append(PersistenceConstants.FIELD_REVOKED, Collections.emptyList())));
}
private static final class UpdaterShardMock extends AbstractActor {
private final ActorRef updater;
private UpdaterShardMock(final RepointableActorRef updater) {
this.updater = updater;
}
private static Props props(final ActorRef updater) {
return Props.create(UpdaterShardMock.class, updater);
}
@Override
public Receive createReceive() {
return ReceiveBuilder.create()
.match(ThingEvent.class, event -> updater.tell(event, getSender()))
.match(AbstractWriteModel.class, writeModel -> updater.tell(writeModel, getSender()))
.match(ShardedMessageEnvelope.class,
message -> updater.tell(
UpdateThingResponse.fromJson(message.getMessage(), message.getDittoHeaders()),
getSender()))
.build();
}
}
private static final class ThingShardMock extends AbstractActor {
private ThingShardMock() {
}
private static Props props() {
return Props.create(ThingShardMock.class);
}
@Override
public Receive createReceive() {
return ReceiveBuilder.create()
.match(SudoRetrieveThing.class, this::sendSudoRetrieveThingResponse)
.build();
}
private void sendSudoRetrieveThingResponse(final WithDittoHeaders srt) {
final var thingJson = THING.toJson(FieldType.all());
final var response = SudoRetrieveThingResponse.of(thingJson, srt.getDittoHeaders());
getSender().tell(response, getSelf());
}
}
private static final class PolicyShardMock extends AbstractActor {
private PolicyShardMock() {
}
private static Props props() {
return Props.create(PolicyShardMock.class);
}
@Override
public Receive createReceive() {
return ReceiveBuilder.create()
.match(SudoRetrievePolicy.class, this::sendSudoRetrievePolicyResponse)
.build();
}
private void sendSudoRetrievePolicyResponse(final WithDittoHeaders srt) {
final var response = SudoRetrievePolicyResponse.of(POLICY_ID, POLICY, srt.getDittoHeaders());
getSender().tell(response, getSelf());
}
}
}