/
ETagTestUtils.java
289 lines (247 loc) · 15.3 KB
/
ETagTestUtils.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
/*
* Copyright (c) 2017-2018 Bosch Software Innovations GmbH.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/org/documents/epl-2.0/index.php
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.services.things.persistence.actors;
import org.eclipse.ditto.json.JsonObject;
import org.eclipse.ditto.json.JsonPointer;
import org.eclipse.ditto.json.JsonValue;
import org.eclipse.ditto.model.base.headers.DittoHeaders;
import org.eclipse.ditto.model.base.headers.entitytag.EntityTag;
import org.eclipse.ditto.model.things.AccessControlList;
import org.eclipse.ditto.model.things.AclEntry;
import org.eclipse.ditto.model.things.Attributes;
import org.eclipse.ditto.model.things.Feature;
import org.eclipse.ditto.model.things.FeatureDefinition;
import org.eclipse.ditto.model.things.FeatureProperties;
import org.eclipse.ditto.model.things.Features;
import org.eclipse.ditto.model.things.Thing;
import org.eclipse.ditto.services.models.things.commands.sudo.SudoRetrieveThingResponse;
import org.eclipse.ditto.signals.commands.things.modify.ModifyAclEntryResponse;
import org.eclipse.ditto.signals.commands.things.modify.ModifyAclResponse;
import org.eclipse.ditto.signals.commands.things.modify.ModifyAttributeResponse;
import org.eclipse.ditto.signals.commands.things.modify.ModifyAttributesResponse;
import org.eclipse.ditto.signals.commands.things.modify.ModifyFeatureDefinitionResponse;
import org.eclipse.ditto.signals.commands.things.modify.ModifyFeaturePropertiesResponse;
import org.eclipse.ditto.signals.commands.things.modify.ModifyFeaturePropertyResponse;
import org.eclipse.ditto.signals.commands.things.modify.ModifyFeatureResponse;
import org.eclipse.ditto.signals.commands.things.modify.ModifyFeaturesResponse;
import org.eclipse.ditto.signals.commands.things.modify.ModifyPolicyIdResponse;
import org.eclipse.ditto.signals.commands.things.modify.ModifyThingResponse;
import org.eclipse.ditto.signals.commands.things.query.RetrieveAclEntryResponse;
import org.eclipse.ditto.signals.commands.things.query.RetrieveAclResponse;
import org.eclipse.ditto.signals.commands.things.query.RetrieveAttributeResponse;
import org.eclipse.ditto.signals.commands.things.query.RetrieveAttributesResponse;
import org.eclipse.ditto.signals.commands.things.query.RetrieveFeatureDefinitionResponse;
import org.eclipse.ditto.signals.commands.things.query.RetrieveFeaturePropertiesResponse;
import org.eclipse.ditto.signals.commands.things.query.RetrieveFeaturePropertyResponse;
import org.eclipse.ditto.signals.commands.things.query.RetrieveFeatureResponse;
import org.eclipse.ditto.signals.commands.things.query.RetrieveFeaturesResponse;
import org.eclipse.ditto.signals.commands.things.query.RetrievePolicyIdResponse;
import org.eclipse.ditto.signals.commands.things.query.RetrieveThingResponse;
/**
* Provides methods to get command responses that include the correct eTag header value.
*/
public abstract class ETagTestUtils {
private ETagTestUtils() {}
// Thing
public static RetrieveThingResponse retrieveThingResponse(final Thing expectedThing,
final JsonObject expectedJsonRepresentation, final DittoHeaders dittoHeaders) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(expectedThing, dittoHeaders);
return RetrieveThingResponse.of(expectedThing.getId().get(), expectedJsonRepresentation.toString(),
dittoHeadersWithETag);
}
public static RetrieveThingResponse retrieveThingResponse(final Thing expectedThing,
final DittoHeaders dittoHeaders) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(expectedThing, dittoHeaders);
return RetrieveThingResponse.of(expectedThing.getId().get(),
expectedThing.toJsonString(dittoHeaders.getSchemaVersion().get()), dittoHeadersWithETag);
}
public static ModifyThingResponse modifyThingResponse(final Thing currentThing, final Thing modifiedThing,
final DittoHeaders dittoHeaders, final boolean created) {
final Thing modifiedThingWithUpdatedRevision = modifiedThing.toBuilder()
.setRevision(currentThing.getRevision().get().toLong() + 1)
.build();
final DittoHeaders dittoHeadersWithETag =
appendETagToDittoHeaders(modifiedThingWithUpdatedRevision, dittoHeaders);
return ModifyThingResponse.modified(modifiedThing.getId().get(), dittoHeadersWithETag);
}
public static SudoRetrieveThingResponse sudoRetrieveThingResponse(final Thing expectedThing,
final JsonObject expectedJsonRepresentation, final DittoHeaders dittoHeaders) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(expectedThing, dittoHeaders);
return SudoRetrieveThingResponse.of(expectedJsonRepresentation, dittoHeadersWithETag);
}
// Features
public static ModifyFeaturesResponse modifyFeaturesResponse(final String thingId, final Features modifiedFeatures,
final DittoHeaders dittoHeaders, final boolean created) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(modifiedFeatures, dittoHeaders);
if (created) {
return ModifyFeaturesResponse.created(thingId, modifiedFeatures, dittoHeadersWithETag);
} else {
return ModifyFeaturesResponse.modified(thingId, dittoHeadersWithETag);
}
}
public static RetrieveFeaturesResponse retrieveFeaturesResponse(final String thingId,
final Features expectedFeatures,
final JsonObject expectedJsonRepresentation, final DittoHeaders dittoHeaders) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(expectedFeatures, dittoHeaders);
return RetrieveFeaturesResponse.of(thingId, expectedJsonRepresentation, dittoHeadersWithETag);
}
// Feature
public static RetrieveFeatureResponse retrieveFeatureResponse(String thingId, final Feature expectedFeature,
final JsonObject expectedJsonRepresentation, final DittoHeaders dittoHeaders) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(expectedFeature, dittoHeaders);
return RetrieveFeatureResponse.of(thingId, expectedFeature.getId(), expectedJsonRepresentation,
dittoHeadersWithETag);
}
public static ModifyFeatureResponse modifyFeatureResponse(final String thingId, final Feature feature,
final DittoHeaders dittoHeaders, final boolean created) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(feature, dittoHeaders);
if (created) {
return ModifyFeatureResponse.created(thingId, feature, dittoHeadersWithETag);
} else {
return ModifyFeatureResponse.modified(thingId, feature.getId(), dittoHeadersWithETag);
}
}
// FeatureDefinition
public static ModifyFeatureDefinitionResponse modifyFeatureDefinitionResponse(final String thingId,
final String featureId, final FeatureDefinition definition, final DittoHeaders dittoHeaders,
final boolean created) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(definition, dittoHeaders);
if (created) {
return ModifyFeatureDefinitionResponse.created(thingId, featureId, definition, dittoHeadersWithETag);
} else {
return ModifyFeatureDefinitionResponse.modified(thingId, featureId, dittoHeadersWithETag);
}
}
public static RetrieveFeatureDefinitionResponse retrieveFeatureDefinitionResponse(final String thingId,
final String featureId, final FeatureDefinition expectedFeatureDefinition,
final DittoHeaders dittoHeaders) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(expectedFeatureDefinition, dittoHeaders);
return RetrieveFeatureDefinitionResponse.of(thingId, featureId, expectedFeatureDefinition,
dittoHeadersWithETag);
}
// FeatureProperties
public static ModifyFeaturePropertiesResponse modifyFeaturePropertiesResponse(final String thingId,
final String featureId, final FeatureProperties properties, final DittoHeaders dittoHeaders,
final boolean created) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(properties, dittoHeaders);
if (created) {
return ModifyFeaturePropertiesResponse.created(thingId, featureId, properties, dittoHeadersWithETag);
} else {
return ModifyFeaturePropertiesResponse.modified(thingId, featureId, dittoHeadersWithETag);
}
}
public static RetrieveFeaturePropertiesResponse retrieveFeaturePropertiesResponse(final String thingId,
final String featureId, final FeatureProperties expectedFeatureProperties,
final DittoHeaders dittoHeaders) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(expectedFeatureProperties, dittoHeaders);
return RetrieveFeaturePropertiesResponse.of(thingId, featureId, expectedFeatureProperties,
dittoHeadersWithETag);
}
// FeatureProperty
public static ModifyFeaturePropertyResponse modifyFeaturePropertyResponse(final String thingId,
final String featureId, final JsonPointer propertyPointer, final JsonValue propertyValue,
final DittoHeaders dittoHeaders, final boolean created) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(propertyValue, dittoHeaders);
if (created) {
return ModifyFeaturePropertyResponse.created(thingId, featureId, propertyPointer, propertyValue,
dittoHeadersWithETag);
} else {
return ModifyFeaturePropertyResponse.modified(thingId, featureId, propertyPointer, dittoHeadersWithETag);
}
}
public static RetrieveFeaturePropertyResponse retrieveFeaturePropertyResponse(final String thingId,
final String featureId, final JsonPointer propertyPointer, final JsonValue propertyValue,
final DittoHeaders dittoHeaders) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(propertyValue, dittoHeaders);
return RetrieveFeaturePropertyResponse.of(thingId, featureId, propertyPointer, propertyValue,
dittoHeadersWithETag);
}
// Attributes
public static ModifyAttributesResponse modifyAttributesResponse(final String thingId,
final Attributes modifiedAttributes, final DittoHeaders dittoHeaders, final boolean created) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(modifiedAttributes, dittoHeaders);
if (created) {
return ModifyAttributesResponse.created(thingId, modifiedAttributes, dittoHeadersWithETag);
} else {
return ModifyAttributesResponse.modified(thingId, dittoHeadersWithETag);
}
}
public static RetrieveAttributesResponse retrieveAttributesResponse(final String thingId,
final Attributes expectedAttributes, final JsonObject expectedJsonRepresentation,
final DittoHeaders dittoHeaders) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(expectedAttributes, dittoHeaders);
return RetrieveAttributesResponse.of(thingId, expectedJsonRepresentation, dittoHeadersWithETag);
}
// Attribute
public static ModifyAttributeResponse modifyAttributeResponse(final String thingId,
final JsonPointer attributePointer, final JsonValue attributeValue, final DittoHeaders dittoHeaders,
final boolean created) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(attributeValue, dittoHeaders);
if (created) {
return ModifyAttributeResponse.created(thingId, attributePointer, attributeValue, dittoHeadersWithETag);
} else {
return ModifyAttributeResponse.modified(thingId, attributePointer, dittoHeadersWithETag);
}
}
public static RetrieveAttributeResponse retrieveAttributeResponse(final String thingId,
final JsonPointer attributePointer, final JsonValue attributeValue, final DittoHeaders dittoHeaders) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(attributeValue, dittoHeaders);
return RetrieveAttributeResponse.of(thingId, attributePointer, attributeValue, dittoHeadersWithETag);
}
// Acl
public static ModifyAclResponse modifyAclResponse(final String thingId, final AccessControlList expectedAcl,
final DittoHeaders dittoHeaders, final boolean created) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(expectedAcl, dittoHeaders);
if (created) {
return ModifyAclResponse.created(thingId, expectedAcl, dittoHeadersWithETag);
} else {
return ModifyAclResponse.modified(thingId, expectedAcl, dittoHeadersWithETag);
}
}
public static RetrieveAclResponse retrieveAclResponse(final String thingId, final AccessControlList expectedAcl,
final JsonObject expectedAclJsonRepresentation, final DittoHeaders dittoHeaders) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(expectedAcl, dittoHeaders);
return RetrieveAclResponse.of(thingId, expectedAclJsonRepresentation, dittoHeadersWithETag);
}
// AclEntry
public static ModifyAclEntryResponse modifyAclEntryResponse(final String thingId, final AclEntry expectedAclEntry,
final DittoHeaders dittoHeaders, final boolean created) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(expectedAclEntry, dittoHeaders);
if (created) {
return ModifyAclEntryResponse.created(thingId, expectedAclEntry, dittoHeadersWithETag);
} else {
return ModifyAclEntryResponse.modified(thingId, expectedAclEntry, dittoHeadersWithETag);
}
}
public static RetrieveAclEntryResponse retrieveAclEntryResponse(final String thingId,
final AclEntry expectedAclEntry, final DittoHeaders dittoHeaders) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(expectedAclEntry, dittoHeaders);
return RetrieveAclEntryResponse.of(thingId, expectedAclEntry, dittoHeadersWithETag);
}
// PolicyId
public static ModifyPolicyIdResponse modifyPolicyIdResponse(final String thingId, final String policyId,
final DittoHeaders dittoHeaders, final boolean created) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(policyId, dittoHeaders);
if (created) {
return ModifyPolicyIdResponse.created(thingId, policyId, dittoHeadersWithETag);
} else {
return ModifyPolicyIdResponse.modified(thingId, dittoHeadersWithETag);
}
}
public static RetrievePolicyIdResponse retrievePolicyIdResponse(final String thingId,
final String expectedPolicyId, final DittoHeaders dittoHeaders) {
final DittoHeaders dittoHeadersWithETag = appendETagToDittoHeaders(expectedPolicyId, dittoHeaders);
return RetrievePolicyIdResponse.of(thingId, expectedPolicyId, dittoHeadersWithETag);
}
protected static DittoHeaders appendETagToDittoHeaders(final Object object, final DittoHeaders dittoHeaders) {
return dittoHeaders.toBuilder().eTag(EntityTag.fromEntity(object).get()).build();
}
}