Skip to content

Commit

Permalink
refactor: Admin groups cleanup (#3011)
Browse files Browse the repository at this point in the history 
Co-authored-by: Christian Kleinbölting <[email protected]>
  • Loading branch information
@mpro7 @seakayone
mpro7 and seakayone authored Feb 5, 2024
1 parent 63fe560 commit 34fd51a
Show file tree
Hide file tree
Showing 7 changed files with 81 additions and 154 deletions.
94 changes: 39 additions & 55 deletions integration/src/test/scala/org/knora/webapi/responders/admin/GroupsResponderADMSpec.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,56 +9,43 @@ import org.apache.pekko.actor.Status.Failure

import java.util.UUID

import dsp.errors.BadRequestException
import dsp.errors.DuplicateValueException
import dsp.errors.NotFoundException
import dsp.errors.*
import dsp.valueobjects.Group.*
import dsp.valueobjects.V2
import org.knora.webapi.*
import org.knora.webapi.messages.admin.responder.groupsmessages.*
import org.knora.webapi.messages.admin.responder.usersmessages.GroupMembersGetResponseADM
import org.knora.webapi.messages.admin.responder.usersmessages.UserInformationTypeADM
import org.knora.webapi.messages.admin.responder.usersmessages.*
import org.knora.webapi.messages.store.triplestoremessages.StringLiteralV2
import org.knora.webapi.sharedtestdata.SharedTestDataADM
import org.knora.webapi.routing.UnsafeZioRun
import org.knora.webapi.sharedtestdata.SharedTestDataADM.*
import org.knora.webapi.slice.admin.domain.model.GroupIri
import org.knora.webapi.slice.admin.domain.model.KnoraProject.ProjectIri
import org.knora.webapi.util.MutableTestIri

/**
* This spec is used to test the messages received by the [[org.knora.webapi.responders.admin.GroupsResponderADMSpec]] actor.
* This spec is used to test the messages received by the [[GroupsResponderADMSpec]] actor.
*/
class GroupsResponderADMSpec extends CoreSpec {
private val imagesProject = SharedTestDataADM.imagesProject
private val imagesReviewerGroup = SharedTestDataADM.imagesReviewerGroup

"The GroupsResponder " when {
"asked about all groups" should {
"return a list" in {
appActor ! GroupsGetRequestADM()

val response = expectMsgType[GroupsGetResponseADM](timeout)
response.groups.nonEmpty should be(true)
response.groups.size should be(2)
val groups = UnsafeZioRun.runOrThrow(GroupsResponderADM.groupsGetADM)
assert(groups.nonEmpty)
assert(groups.size == 2)
}
}

"asked about a group identified by 'iri' " should {
"return group info if the group is known " in {
appActor ! GroupGetRequestADM(
groupIri = imagesReviewerGroup.id
)

expectMsg(GroupGetResponseADM(imagesReviewerGroup))
val group = UnsafeZioRun.runOrThrow(GroupsResponderADM.groupGetADM(imagesReviewerGroup.id))
assert(group.nonEmpty)
assert(group.map(_.id).contains(imagesReviewerGroup.id))
}

"return 'NotFoundException' when the group is unknown " in {
appActor ! GroupGetRequestADM(
groupIri = "http://rdfh.ch/groups/notexisting"
)

expectMsgPF(timeout) { case msg: Failure =>
msg.cause.isInstanceOf[NotFoundException] should ===(true)
}
"return 'None' when the group is unknown " in {
val iri = "http://rdfh.ch/groups/notexisting"
val response = UnsafeZioRun.runOrThrow(GroupsResponderADM.groupGetADM(iri))
assert(response.isEmpty)
}
}

Expand All @@ -80,16 +67,16 @@ class GroupsResponderADMSpec extends CoreSpec {
)
)
.fold(e => throw e.head, v => v),
project = ProjectIri.unsafeFrom(SharedTestDataADM.imagesProjectIri),
project = ProjectIri.unsafeFrom(imagesProjectIri),
status = GroupStatus.active,
selfjoin = GroupSelfJoin.make(false).fold(e => throw e.head, v => v)
),
requestingUser = SharedTestDataADM.imagesUser01,
requestingUser = imagesUser01,
apiRequestID = UUID.randomUUID
)

val received: GroupOperationResponseADM = expectMsgType[GroupOperationResponseADM](timeout)
val newGroupInfo = received.group
val received: GroupGetResponseADM = expectMsgType[GroupGetResponseADM](timeout)
val newGroupInfo = received.group

newGroupInfo.name should equal("NewGroup")
newGroupInfo.descriptions should equal(
Expand All @@ -111,11 +98,11 @@ class GroupsResponderADMSpec extends CoreSpec {
descriptions = GroupDescriptions
.make(Seq(V2.StringLiteralV2(value = "NewGroupDescription", language = Some("en"))))
.fold(e => throw e.head, v => v),
project = ProjectIri.unsafeFrom(SharedTestDataADM.imagesProjectIri),
project = ProjectIri.unsafeFrom(imagesProjectIri),
status = GroupStatus.active,
selfjoin = GroupSelfJoin.make(false).fold(e => throw e.head, v => v)
),
requestingUser = SharedTestDataADM.imagesUser01,
requestingUser = imagesUser01,
apiRequestID = UUID.randomUUID
)

Expand All @@ -137,12 +124,12 @@ class GroupsResponderADMSpec extends CoreSpec {
.fold(e => throw e.head, v => v)
)
),
requestingUser = SharedTestDataADM.imagesUser01,
requestingUser = imagesUser01,
apiRequestID = UUID.randomUUID
)

val received: GroupOperationResponseADM = expectMsgType[GroupOperationResponseADM](timeout)
val updatedGroupInfo = received.group
val received: GroupGetResponseADM = expectMsgType[GroupGetResponseADM](timeout)
val updatedGroupInfo = received.group

updatedGroupInfo.name should equal("UpdatedGroupName")
updatedGroupInfo.descriptions should equal(
Expand All @@ -164,7 +151,7 @@ class GroupsResponderADMSpec extends CoreSpec {
.fold(e => throw e.head, v => v)
)
),
requestingUser = SharedTestDataADM.imagesUser01,
requestingUser = imagesUser01,
apiRequestID = UUID.randomUUID
)

Expand All @@ -184,7 +171,7 @@ class GroupsResponderADMSpec extends CoreSpec {
.fold(e => throw e.head, v => v)
)
),
requestingUser = SharedTestDataADM.imagesUser01,
requestingUser = imagesUser01,
apiRequestID = UUID.randomUUID
)

Expand All @@ -200,41 +187,38 @@ class GroupsResponderADMSpec extends CoreSpec {

"used to query members" should {
"return all members of a group identified by IRI" in {
appActor ! GroupMembersGetRequestADM(
groupIri = SharedTestDataADM.imagesReviewerGroup.id,
requestingUser = SharedTestDataADM.rootUser
)

val received: GroupMembersGetResponseADM = expectMsgType[GroupMembersGetResponseADM](timeout)
val iri = (GroupIri.unsafeFrom(imagesReviewerGroup.id))
val received =
UnsafeZioRun.runOrThrow(GroupsResponderADM.groupMembersGetRequest(iri, rootUser))

received.members.map(_.id) should contain allElementsOf Seq(
SharedTestDataADM.multiuserUser.ofType(UserInformationTypeADM.Restricted),
SharedTestDataADM.imagesReviewerUser.ofType(UserInformationTypeADM.Restricted)
multiuserUser.ofType(UserInformationTypeADM.Restricted),
imagesReviewerUser.ofType(UserInformationTypeADM.Restricted)
).map(_.id)
}

"remove all members when group is deactivated" in {
appActor ! GroupMembersGetRequestADM(
groupIri = SharedTestDataADM.imagesReviewerGroup.id,
requestingUser = SharedTestDataADM.rootUser
groupIri = imagesReviewerGroup.id,
requestingUser = rootUser
)

val membersBeforeStatusChange: GroupMembersGetResponseADM = expectMsgType[GroupMembersGetResponseADM](timeout)
membersBeforeStatusChange.members.size shouldBe 2

appActor ! GroupChangeStatusRequestADM(
groupIri = SharedTestDataADM.imagesReviewerGroup.id,
groupIri = imagesReviewerGroup.id,
changeGroupRequest = ChangeGroupApiRequestADM(status = Some(false)),
requestingUser = SharedTestDataADM.imagesUser01,
requestingUser = imagesUser01,
apiRequestID = UUID.randomUUID
)

val statusChangeResponse = expectMsgType[GroupOperationResponseADM](timeout)
val statusChangeResponse = expectMsgType[GroupGetResponseADM](timeout)
statusChangeResponse.group.status shouldBe false

appActor ! GroupMembersGetRequestADM(
groupIri = SharedTestDataADM.imagesReviewerGroup.id,
requestingUser = SharedTestDataADM.rootUser
groupIri = imagesReviewerGroup.id,
requestingUser = rootUser
)

val noMembers: GroupMembersGetResponseADM = expectMsgType[GroupMembersGetResponseADM](timeout)
Expand All @@ -244,7 +228,7 @@ class GroupsResponderADMSpec extends CoreSpec {
"return 'NotFound' when the group IRI is unknown" in {
appActor ! GroupMembersGetRequestADM(
groupIri = "http://rdfh.ch/groups/notexisting",
requestingUser = SharedTestDataADM.rootUser
requestingUser = rootUser
)

expectMsgPF(timeout) { case msg: Failure =>
Expand Down
25 changes: 0 additions & 25 deletions ...in/scala/org/knora/webapi/messages/admin/responder/groupsmessages/GroupsMessagesADM.scala
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ import org.knora.webapi.IRI
import org.knora.webapi.core.RelayedMessage
import org.knora.webapi.messages.ResponderRequest.KnoraRequestADM
import org.knora.webapi.messages.admin.responder.AdminKnoraResponseADM
import org.knora.webapi.messages.admin.responder.KnoraResponseADM
import org.knora.webapi.messages.admin.responder.projectsmessages.ProjectADM
import org.knora.webapi.messages.admin.responder.projectsmessages.ProjectsADMJsonProtocol
import org.knora.webapi.messages.store.triplestoremessages.StringLiteralV2
Expand Down Expand Up @@ -104,11 +103,6 @@ sealed trait GroupsResponderRequestADM extends KnoraRequestADM with RelayedMessa
*/
case class GroupsGetADM() extends GroupsResponderRequestADM

/**
* Get all information about all groups.
*/
case class GroupsGetRequestADM() extends GroupsResponderRequestADM

/**
* Get everything about a single group identified through its IRI. A successful response will be
* an [[Option[GroupADM] ]], which will be `None` if the group was not found.
Expand All @@ -117,14 +111,6 @@ case class GroupsGetRequestADM() extends GroupsResponderRequestADM
*/
case class GroupGetADM(groupIri: IRI) extends GroupsResponderRequestADM

/**
* Get everything about a single group identified through its IRI. The response will be a
* [[GroupGetResponseADM]], or an error if the group was not found.
*
* @param groupIri IRI of the group.
*/
case class GroupGetRequestADM(groupIri: IRI) extends GroupsResponderRequestADM

/**
* Get everything about a multiple groups identified by their IRIs. The response will be a
* [[Set[GroupGetResponseADM] ]], or an error if one or more groups was not found.
Expand Down Expand Up @@ -205,15 +191,6 @@ case class GroupGetResponseADM(group: GroupADM) extends AdminKnoraResponseADM wi
def toJsValue = groupResponseADMFormat.write(this)
}

/**
* Represents an answer to a group creating/modifying operation.
*
* @param group the new group information of the created/modified group.
*/
case class GroupOperationResponseADM(group: GroupADM) extends KnoraResponseADM with GroupsADMJsonProtocol {
def toJsValue = groupOperationResponseADMFormat.write(this)
}

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Components of messages

Expand Down Expand Up @@ -257,6 +234,4 @@ trait GroupsADMJsonProtocol extends SprayJsonSupport with DefaultJsonProtocol wi
jsonFormat(CreateGroupApiRequestADM, "id", "name", "descriptions", "project", "status", "selfjoin")
implicit val changeGroupApiRequestADMFormat: RootJsonFormat[ChangeGroupApiRequestADM] =
jsonFormat(ChangeGroupApiRequestADM, "name", "descriptions", "status", "selfjoin")
implicit val groupOperationResponseADMFormat: RootJsonFormat[GroupOperationResponseADM] =
jsonFormat(GroupOperationResponseADM, "group")
}
Loading

0 comments on commit 34fd51a

Please sign in to comment.