You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@james.apache.org by GitBox <gi...@apache.org> on 2023/01/09 07:28:40 UTC
[GitHub] [james-project] chibenwa commented on a diff in pull request #1375: JAMES-3756 Delegate/set create
chibenwa commented on code in PR #1375:
URL: https://github.com/apache/james-project/pull/1375#discussion_r1064341838
##########
server/protocols/jmap-rfc-8621-integration-tests/jmap-rfc-8621-integration-tests-common/src/main/scala/org/apache/james/jmap/rfc8621/contract/DelegateSetContract.scala:
##########
@@ -0,0 +1,515 @@
+/****************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one *
+ * or more contributor license agreements. See the NOTICE file *
+ * distributed with this work for additional information *
+ * regarding copyright ownership. The ASF licenses this file *
+ * to you under the Apache License, Version 2.0 (the *
+ * "License"); you may not use this file except in compliance *
+ * with the License. You may obtain a copy of the License at *
+ * *
+ * http://www.apache.org/licenses/LICENSE-2.0 *
+ * *
+ * Unless required by applicable law or agreed to in writing, *
+ * software distributed under the License is distributed on an *
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
+ * KIND, either express or implied. See the License for the *
+ * specific language governing permissions and limitations *
+ * under the License. *
+ ****************************************************************/
+
+package org.apache.james.jmap.rfc8621.contract
+
+import java.util.concurrent.TimeUnit
+
+import com.google.inject.AbstractModule
+import com.google.inject.multibindings.Multibinder
+import io.netty.handler.codec.http.HttpHeaderNames.ACCEPT
+import io.restassured.RestAssured.{`given`, requestSpecification}
+import io.restassured.http.ContentType.JSON
+import javax.inject.Inject
+import net.javacrumbs.jsonunit.assertj.JsonAssertions.assertThatJson
+import org.apache.http.HttpStatus.SC_OK
+import org.apache.james.GuiceJamesServer
+import org.apache.james.core.Username
+import org.apache.james.jmap.delegation.DelegationId
+import org.apache.james.jmap.http.UserCredential
+import org.apache.james.jmap.rfc8621.contract.Fixture.{ACCEPT_RFC8621_VERSION_HEADER, ANDRE, ANDRE_PASSWORD, BOB, BOB_PASSWORD, CEDRIC, DOMAIN, authScheme, baseRequestSpecBuilder}
+import org.apache.james.user.api.DelegationStore
+import org.apache.james.utils.{DataProbeImpl, GuiceProbe}
+import org.assertj.core.api.Assertions.assertThat
+import org.awaitility.Awaitility
+import org.awaitility.Durations.ONE_HUNDRED_MILLISECONDS
+import org.junit.jupiter.api.{BeforeEach, Test}
+import reactor.core.scala.publisher.SFlux
+
+import scala.jdk.CollectionConverters._
+
+class DelegationProbeModule extends AbstractModule {
+ override def configure(): Unit = {
+ Multibinder.newSetBinder(binder(), classOf[GuiceProbe])
+ .addBinding()
+ .to(classOf[DelegationProbe])
+ }
+}
+
+class DelegationProbe @Inject()(delegationStore: DelegationStore) extends GuiceProbe {
+ def getAuthorizedUsers(baseUser: Username): Seq[Username] =
+ SFlux.fromPublisher(delegationStore.authorizedUsers(baseUser))
+ .collectSeq()
+ .block()
+}
+
+trait DelegateSetContract {
+ private lazy val slowPacedPollInterval = ONE_HUNDRED_MILLISECONDS
+ private lazy val calmlyAwait = Awaitility.`with`
+ .pollInterval(slowPacedPollInterval)
+ .and.`with`.pollDelay(slowPacedPollInterval)
+ .await
+ private lazy val awaitAtMostTenSeconds = calmlyAwait.atMost(10, TimeUnit.SECONDS)
+
+ @BeforeEach
+ def setUp(server: GuiceJamesServer): Unit = {
+ server.getProbe(classOf[DataProbeImpl])
+ .fluent
+ .addDomain(DOMAIN.asString)
+ .addUser(BOB.asString, BOB_PASSWORD)
+ .addUser(ANDRE.asString(), ANDRE_PASSWORD)
+ .addUser(CEDRIC.asString(), "secret")
+
+ requestSpecification = baseRequestSpecBuilder(server)
+ .setAuth(authScheme(UserCredential(BOB, BOB_PASSWORD)))
+ .build
+ }
+
+ @Test
+ def delegateSetShouldSucceed(server: GuiceJamesServer): Unit = {
+ val request =
+ s"""{
+ | "using": ["urn:ietf:params:jmap:core", "urn:apache:james:params:jmap:delegation"],
+ | "methodCalls": [
+ | [
+ | "Delegate/set", {
+ | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
+ | "create": {
+ | "4f29": {
+ | "username": "andre@domain.tld"
+ | }
+ | }
+ | }, "0"
+ | ]
+ | ]
+ |}""".stripMargin
+
+ val response = `given`
+ .header(ACCEPT.toString, ACCEPT_RFC8621_VERSION_HEADER)
+ .body(request)
+ .when
+ .post
+ .`then`
+ .statusCode(SC_OK)
+ .contentType(JSON)
+ .extract
+ .body
+ .asString
+ val delegationId = DelegationId.from(BOB, ANDRE).serialize
+
+ assertThatJson(response)
+ .isEqualTo(
+ s"""{
+ | "sessionState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+ | "methodResponses": [
+ | ["Delegate/set", {
+ | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
+ | "newState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+ | "created": {
+ | "4f29": {
+ | "id": "$delegationId"
+ | }
+ | }
+ | }, "0"]
+ | ]
+ |}""".stripMargin)
+
+ awaitAtMostTenSeconds.untilAsserted(() =>
+ assertThat(server.getProbe(classOf[DelegationProbe]).getAuthorizedUsers(BOB).asJavaCollection)
+ .containsExactly(ANDRE))
+ }
+
+ @Test
+ def delegateSetWithSeveralCreationRequestsShouldSucceed(server: GuiceJamesServer): Unit = {
+ val delegationProbe = server.getProbe(classOf[DelegationProbe])
+ val request =
+ s"""{
+ | "using": ["urn:ietf:params:jmap:core", "urn:apache:james:params:jmap:delegation"],
+ | "methodCalls": [
+ | [
+ | "Delegate/set", {
+ | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
+ | "create": {
+ | "4f29": {
+ | "username": "andre@domain.tld"
+ | },
+ | "4f30": {
+ | "username": "cedric@domain.tld"
+ | }
+ | }
+ | }, "0"
+ | ]
+ | ]
+ |}""".stripMargin
+
+ val response = `given`
+ .header(ACCEPT.toString, ACCEPT_RFC8621_VERSION_HEADER)
+ .body(request)
+ .when
+ .post
+ .`then`
+ .statusCode(SC_OK)
+ .contentType(JSON)
+ .extract
+ .body
+ .asString
+ val andreDelegationId = DelegationId.from(BOB, ANDRE).serialize
+ val cedricDelegationId = DelegationId.from(BOB, CEDRIC).serialize
+
+ assertThatJson(response)
+ .isEqualTo(
+ s"""{
+ | "sessionState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+ | "methodResponses": [
+ | ["Delegate/set", {
+ | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
+ | "newState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+ | "created": {
+ | "4f29": {
+ | "id": "$andreDelegationId"
+ | },
+ | "4f30": {
+ | "id": "$cedricDelegationId"
+ | }
+ | }
+ | }, "0"]
+ | ]
+ |}""".stripMargin)
+
+ awaitAtMostTenSeconds.untilAsserted(() =>
+ assertThat(delegationProbe.getAuthorizedUsers(BOB).asJavaCollection)
+ .containsExactlyInAnyOrder(ANDRE, CEDRIC))
+ }
+
+ @Test
+ def delegateSetShouldFailWhenUsernamePropertyIsMissing(): Unit = {
+ val request =
+ s"""{
+ | "using": ["urn:ietf:params:jmap:core", "urn:apache:james:params:jmap:delegation"],
+ | "methodCalls": [
+ | [
+ | "Delegate/set", {
+ | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
+ | "create": {
+ | "4f29": {
+ | }
+ | }
+ | }, "0"
+ | ]
+ | ]
+ |}""".stripMargin
+
+ val response = `given`
+ .header(ACCEPT.toString, ACCEPT_RFC8621_VERSION_HEADER)
+ .body(request)
+ .when
+ .post
+ .`then`
+ .statusCode(SC_OK)
+ .contentType(JSON)
+ .extract
+ .body
+ .asString
+
+ assertThatJson(response)
+ .isEqualTo(
+ s"""{
+ | "sessionState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+ | "methodResponses": [
+ | [
+ | "Delegate/set",
+ | {
+ | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
+ | "newState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+ | "notCreated": {
+ | "4f29": {
+ | "type": "invalidArguments",
+ | "description": "Missing '/username' property in Delegate object"
+ | }
+ | }
+ | },
+ | "0"
+ | ]
+ | ]
+ |}""".stripMargin)
+ }
+
+ @Test
+ def delegateSetShouldFailWhenUsernameIsNull(): Unit = {
+ val request =
+ s"""{
+ | "using": ["urn:ietf:params:jmap:core", "urn:apache:james:params:jmap:delegation"],
+ | "methodCalls": [
+ | [
+ | "Delegate/set", {
+ | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
+ | "create": {
+ | "4f29": {
+ | "username": null
+ | }
+ | }
+ | }, "0"
+ | ]
+ | ]
+ |}""".stripMargin
+
+ val response = `given`
+ .header(ACCEPT.toString, ACCEPT_RFC8621_VERSION_HEADER)
+ .body(request)
+ .when
+ .post
+ .`then`
+ .statusCode(SC_OK)
+ .contentType(JSON)
+ .extract
+ .body
+ .asString
+
+ assertThatJson(response)
+ .isEqualTo(
+ s"""{
+ | "sessionState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+ | "methodResponses": [
+ | [
+ | "Delegate/set",
+ | {
+ | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
+ | "newState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+ | "notCreated": {
+ | "4f29": {
+ | "type": "invalidArguments",
+ | "description": "'/username' property in Delegate object is not valid: username needs to be represented by a JsString"
+ | }
+ | }
+ | },
+ | "0"
+ | ]
+ | ]
+ |}""".stripMargin)
+ }
+
+ @Test
+ def delegateSetShouldFailWhenWrongAccountId(): Unit = {
+ val request =
+ s"""{
+ | "using": ["urn:ietf:params:jmap:core", "urn:apache:james:params:jmap:delegation"],
+ | "methodCalls": [
+ | [
+ | "Delegate/set", {
+ | "accountId": "unknownAccountId",
+ | "create": {
+ | "4f29": {
+ | "username": "andre@domain.tld"
+ | }
+ | }
+ | }, "0"
+ | ]
+ | ]
+ |}""".stripMargin
+
+ val response = `given`
+ .header(ACCEPT.toString, ACCEPT_RFC8621_VERSION_HEADER)
+ .body(request)
+ .when
+ .post
+ .`then`
+ .statusCode(SC_OK)
+ .contentType(JSON)
+ .extract
+ .body
+ .asString
+
+ assertThatJson(response)
+ .isEqualTo(
+ s"""{
+ | "sessionState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+ | "methodResponses": [
+ | [
+ | "error",
+ | {
+ | "type": "accountNotFound"
+ | },
+ | "0"
+ | ]
+ | ]
+ |}""".stripMargin)
+ }
+
+ @Test
+ def delegateSetShouldFailWhenMissingDelegationCapability(): Unit = {
+ val request =
+ s"""{
+ | "using": ["urn:ietf:params:jmap:core"],
+ | "methodCalls": [
+ | [
+ | "Delegate/set", {
+ | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
+ | "create": {
+ | "4f29": {
+ | "username": "andre@domain.tld"
+ | }
+ | }
+ | }, "0"
+ | ]
+ | ]
+ |}""".stripMargin
+
+ val response = `given`
+ .header(ACCEPT.toString, ACCEPT_RFC8621_VERSION_HEADER)
+ .body(request)
+ .when
+ .post
+ .`then`
+ .statusCode(SC_OK)
+ .contentType(JSON)
+ .extract
+ .body
+ .asString
+
+ assertThatJson(response)
+ .isEqualTo(
+ s"""{
+ | "sessionState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+ | "methodResponses": [
+ | [
+ | "error",
+ | {
+ | "type": "unknownMethod",
+ | "description": "Missing capability(ies): urn:apache:james:params:jmap:delegation"
+ | },
+ | "0"
+ | ]
+ | ]
+ |}""".stripMargin)
+ }
+
+ @Test
+ def delegateSetShouldFailWhenUserDoesNotExist(): Unit = {
+ val request =
+ s"""{
+ | "using": ["urn:ietf:params:jmap:core", "urn:apache:james:params:jmap:delegation"],
+ | "methodCalls": [
+ | [
+ | "Delegate/set", {
+ | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
+ | "create": {
+ | "4f29": {
+ | "username": "nonexistuser@domain.tld"
+ | }
+ | }
+ | }, "0"
+ | ]
+ | ]
+ |}""".stripMargin
+
+ val response = `given`
+ .header(ACCEPT.toString, ACCEPT_RFC8621_VERSION_HEADER)
+ .body(request)
+ .when
+ .post
+ .`then`
+ .statusCode(SC_OK)
+ .contentType(JSON)
+ .extract
+ .body
+ .asString
+
+ assertThatJson(response)
+ .isEqualTo(
+ s"""{
+ | "sessionState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+ | "methodResponses": [
+ | [
+ | "Delegate/set",
+ | {
+ | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
+ | "newState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+ | "notCreated": {
+ | "4f29": {
+ | "type": "invalidArguments",
+ | "description": "User nonexistuser@domain.tld does not exist"
+ | }
+ | }
+ | },
+ | "0"
+ | ]
+ | ]
+ |}""".stripMargin)
+ }
+
+ @Test
+ def delegateSetShouldBeIdempotent(server: GuiceJamesServer): Unit = {
+ val request =
+ s"""{
+ | "using": ["urn:ietf:params:jmap:core", "urn:apache:james:params:jmap:delegation"],
+ | "methodCalls": [
+ | [
+ | "Delegate/set", {
+ | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
+ | "create": {
+ | "4f29": {
+ | "username": "andre@domain.tld"
+ | },
+ | "4f30": {
+ | "username": "andre@domain.tld"
+ | }
+ | }
+ | }, "0"
+ | ]
+ | ]
+ |}""".stripMargin
+
+ val response = `given`
+ .header(ACCEPT.toString, ACCEPT_RFC8621_VERSION_HEADER)
+ .body(request)
+ .when
+ .post
+ .`then`
+ .statusCode(SC_OK)
+ .contentType(JSON)
+ .extract
+ .body
+ .asString
+ val delegationId = DelegationId.from(BOB, ANDRE).serialize
+
+ assertThatJson(response)
+ .isEqualTo(
+ s"""{
+ | "sessionState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+ | "methodResponses": [
+ | ["Delegate/set", {
+ | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6",
+ | "newState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+ | "created": {
+ | "4f29": {
+ | "id": "$delegationId"
+ | },
+ | "4f30": {
+ | "id": "$delegationId"
+ | }
+ | }
+ | }, "0"]
+ | ]
+ |}""".stripMargin)
+
+ awaitAtMostTenSeconds.untilAsserted(() =>
+ assertThat(server.getProbe(classOf[DelegationProbe]).getAuthorizedUsers(BOB).asJavaCollection)
+ .containsExactly(ANDRE))
+ }
+}
Review Comment:
Agree. This has limited testing value as this is independant from this change set.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org