-
Notifications
You must be signed in to change notification settings - Fork 18
/
GroupsADME2ESpec.scala
360 lines (315 loc) · 13.8 KB
/
GroupsADME2ESpec.scala
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
/*
* Copyright © 2021 - 2022 Swiss National Data and Service Center for the Humanities and/or DaSCH Service Platform contributors.
* SPDX-License-Identifier: Apache-2.0
*/
package org.knora.webapi.e2e.admin
import akka.actor.ActorSystem
import akka.http.scaladsl.model._
import akka.http.scaladsl.model.headers._
import akka.http.scaladsl.testkit.RouteTestTimeout
import akka.http.scaladsl.unmarshalling.Unmarshal
import com.typesafe.config.{Config, ConfigFactory}
import org.knora.webapi.E2ESpec
import org.knora.webapi.e2e.{ClientTestDataCollector, TestDataFileContent, TestDataFilePath}
import org.knora.webapi.messages.admin.responder.groupsmessages.{GroupADM, GroupsADMJsonProtocol}
import org.knora.webapi.messages.store.triplestoremessages.StringLiteralV2
import org.knora.webapi.messages.v1.responder.sessionmessages.SessionJsonProtocol
import org.knora.webapi.sharedtestdata.SharedTestDataADM
import org.knora.webapi.util.{AkkaHttpUtils, MutableTestIri}
import scala.concurrent.Await
import scala.concurrent.duration._
object GroupsADME2ESpec {
val config: Config = ConfigFactory.parseString("""
akka.loglevel = "DEBUG"
akka.stdout-loglevel = "DEBUG"
""".stripMargin)
}
/**
* End-to-End (E2E) test specification for testing groups endpoint.
*/
class GroupsADME2ESpec extends E2ESpec(GroupsADME2ESpec.config) with GroupsADMJsonProtocol with SessionJsonProtocol {
implicit def default(implicit system: ActorSystem): RouteTestTimeout = RouteTestTimeout(30.seconds)
// Directory path for generated client test data
private val clientTestDataPath: Seq[String] = Seq("admin", "groups")
// Collects client test data
private val clientTestDataCollector = new ClientTestDataCollector(settings)
private val imagesUser01Email = SharedTestDataADM.imagesUser01.email
private val testPass = SharedTestDataADM.testPass
private val groupIri = SharedTestDataADM.imagesReviewerGroup.id
private val groupIriEnc = java.net.URLEncoder.encode(groupIri, "utf-8")
"The Groups Route ('admin/groups')" when {
"used to query for group information" should {
"return all groups" in {
val request =
Get(baseApiUrl + s"/admin/groups") ~> addCredentials(BasicHttpCredentials(imagesUser01Email, testPass))
val response: HttpResponse = singleAwaitingRequest(request)
// log.debug(s"response: {}", response)
assert(response.status === StatusCodes.OK)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "get-groups-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"return the group's information" in {
val request = Get(baseApiUrl + s"/admin/groups/$groupIriEnc") ~> addCredentials(
BasicHttpCredentials(imagesUser01Email, testPass)
)
val response: HttpResponse = singleAwaitingRequest(request)
// log.debug(s"response: {}", response)
assert(response.status === StatusCodes.OK)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "get-group-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
}
"given a custom Iri" should {
val customGroupIri = "http://rdfh.ch/groups/00FF/gNdJSNYrTDu2lGpPUs94nQ"
"create a group with the provided custom IRI " in {
val createGroupWithCustomIriRequest: String =
s"""{ "id": "$customGroupIri",
| "name": "NewGroupWithCustomIri",
| "descriptions": [{"value": "A new group with a custom Iri", "language": "en"}],
| "project": "${SharedTestDataADM.IMAGES_PROJECT_IRI}",
| "status": true,
| "selfjoin": false
|}""".stripMargin
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "create-group-with-custom-Iri-request",
fileExtension = "json"
),
text = createGroupWithCustomIriRequest
)
)
val request = Post(
baseApiUrl + s"/admin/groups",
HttpEntity(ContentTypes.`application/json`, createGroupWithCustomIriRequest)
) ~> addCredentials(BasicHttpCredentials(imagesUser01Email, testPass))
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
val result: GroupADM = AkkaHttpUtils.httpResponseToJson(response).fields("group").convertTo[GroupADM]
//check that the custom IRI is correctly assigned
result.id should be(customGroupIri)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "create-group-with-custom-Iri-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"return 'BadRequest' if the supplied IRI for the group is not unique" in {
val params =
s"""{ "id": "$customGroupIri",
| "name": "NewGroupWithDuplicateCustomIri",
| "descriptions": [{"value": "A new group with a duplicate custom Iri", "language": "en"}],
| "project": "${SharedTestDataADM.IMAGES_PROJECT_IRI}",
| "status": true,
| "selfjoin": false
|}""".stripMargin
val request =
Post(baseApiUrl + s"/admin/groups", HttpEntity(ContentTypes.`application/json`, params)) ~> addCredentials(
BasicHttpCredentials(imagesUser01Email, testPass)
)
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.BadRequest)
val errorMessage: String = Await.result(Unmarshal(response.entity).to[String], 1.second)
val invalidIri: Boolean = errorMessage.contains(s"IRI: '$customGroupIri' already exists, try another one.")
invalidIri should be(true)
}
}
"used to modify group information" should {
val newGroupIri = new MutableTestIri
"CREATE a new group" in {
val createGroupRequest: String =
s"""{
| "name": "NewGroup",
| "descriptions": [{"value": "NewGroupDescription", "language": "en"}],
| "project": "${SharedTestDataADM.IMAGES_PROJECT_IRI}",
| "status": true,
| "selfjoin": false
|}""".stripMargin
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "create-group-request",
fileExtension = "json"
),
text = createGroupRequest
)
)
val request = Post(
baseApiUrl + "/admin/groups",
HttpEntity(ContentTypes.`application/json`, createGroupRequest)
) ~> addCredentials(BasicHttpCredentials(imagesUser01Email, testPass))
val response: HttpResponse = singleAwaitingRequest(request)
// log.debug(s"response: {}", response)
response.status should be(StatusCodes.OK)
val groupInfo: GroupADM = AkkaHttpUtils.httpResponseToJson(response).fields("group").convertTo[GroupADM]
groupInfo.name should be("NewGroup")
groupInfo.descriptions should be(Seq(StringLiteralV2("NewGroupDescription", Some("en"))))
groupInfo.project should be(SharedTestDataADM.imagesProject)
groupInfo.status should be(true)
groupInfo.selfjoin should be(false)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "create-group-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
val iri = groupInfo.id
newGroupIri.set(iri)
// log.debug("newGroupIri: {}", newGroupIri.get)
}
"UPDATE a group" in {
val updateGroupRequest: String =
s"""{
| "name": "UpdatedGroupName",
| "descriptions": [{"value": "UpdatedGroupDescription", "language": "en"}]
|}""".stripMargin
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "update-group-request",
fileExtension = "json"
),
text = updateGroupRequest
)
)
val groupIriEnc = java.net.URLEncoder.encode(newGroupIri.get, "utf-8")
val request = Put(
baseApiUrl + "/admin/groups/" + groupIriEnc,
HttpEntity(ContentTypes.`application/json`, updateGroupRequest)
) ~> addCredentials(BasicHttpCredentials(imagesUser01Email, testPass))
val response: HttpResponse = singleAwaitingRequest(request)
logger.debug(s"response: {}", response)
response.status should be(StatusCodes.OK)
val groupInfo: GroupADM = AkkaHttpUtils.httpResponseToJson(response).fields("group").convertTo[GroupADM]
groupInfo.name should be("UpdatedGroupName")
groupInfo.descriptions should be(Seq(StringLiteralV2("UpdatedGroupDescription", Some("en"))))
groupInfo.project should be(SharedTestDataADM.imagesProject)
groupInfo.status should be(true)
groupInfo.selfjoin should be(false)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "update-group-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"DELETE a group" in {
val groupIriEnc = java.net.URLEncoder.encode(newGroupIri.get, "utf-8")
val request = Delete(baseApiUrl + "/admin/groups/" + groupIriEnc) ~> addCredentials(
BasicHttpCredentials(imagesUser01Email, testPass)
)
val response: HttpResponse = singleAwaitingRequest(request)
logger.debug(s"response: {}", response)
response.status should be(StatusCodes.OK)
val groupInfo: GroupADM = AkkaHttpUtils.httpResponseToJson(response).fields("group").convertTo[GroupADM]
groupInfo.name should be("UpdatedGroupName")
groupInfo.descriptions should be(Seq(StringLiteralV2("UpdatedGroupDescription", Some("en"))))
groupInfo.project should be(SharedTestDataADM.imagesProject)
groupInfo.status should be(false)
groupInfo.selfjoin should be(false)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "delete-group-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"CHANGE status of a group" in {
val changeGroupStatusRequest: String =
s"""{
| "status": true
|}""".stripMargin
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "change-group-status-request",
fileExtension = "json"
),
text = changeGroupStatusRequest
)
)
val groupIriEnc = java.net.URLEncoder.encode(newGroupIri.get, "utf-8")
val request = Put(
baseApiUrl + "/admin/groups/" + groupIriEnc + "/status",
HttpEntity(ContentTypes.`application/json`, changeGroupStatusRequest)
) ~> addCredentials(BasicHttpCredentials(imagesUser01Email, testPass))
val response: HttpResponse = singleAwaitingRequest(request)
logger.debug(s"response: {}", response)
response.status should be(StatusCodes.OK)
val groupInfo: GroupADM = AkkaHttpUtils.httpResponseToJson(response).fields("group").convertTo[GroupADM]
groupInfo.name should be("UpdatedGroupName")
groupInfo.descriptions should be(Seq(StringLiteralV2("UpdatedGroupDescription", Some("en"))))
groupInfo.project should be(SharedTestDataADM.imagesProject)
groupInfo.status should be(true)
groupInfo.selfjoin should be(false)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "change-group-status-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
}
"used to query members" should {
"return all members of a group" in {
val request = Get(baseApiUrl + s"/admin/groups/$groupIriEnc/members") ~> addCredentials(
BasicHttpCredentials(imagesUser01Email, testPass)
)
val response: HttpResponse = singleAwaitingRequest(request)
// log.debug(s"response: {}", response)
assert(response.status === StatusCodes.OK)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "get-group-members-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
}
}
}