| /**************************************************************** |
| * 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.nio.charset.StandardCharsets |
| |
| import io.netty.handler.codec.http.HttpHeaderNames.ACCEPT |
| import io.restassured.RestAssured._ |
| import net.javacrumbs.jsonunit.assertj.JsonAssertions.assertThatJson |
| import net.javacrumbs.jsonunit.core.Option |
| import net.javacrumbs.jsonunit.core.internal.Options |
| import org.apache.http.HttpStatus.SC_OK |
| import org.apache.james.GuiceJamesServer |
| import org.apache.james.jmap.http.UserCredential |
| import org.apache.james.jmap.rfc8621.contract.Fixture._ |
| import org.apache.james.mailbox.MessageManager.AppendCommand |
| import org.apache.james.mailbox.model.{MailboxId, MailboxPath, MessageId} |
| import org.apache.james.mime4j.dom.Message |
| import org.apache.james.modules.MailboxProbeImpl |
| import org.apache.james.utils.DataProbeImpl |
| import org.junit.jupiter.api.{BeforeEach, Test} |
| |
| trait BackReferenceContract { |
| @BeforeEach |
| def setUp(server: GuiceJamesServer): Unit = { |
| server.getProbe(classOf[DataProbeImpl]) |
| .fluent |
| .addDomain(DOMAIN.asString) |
| .addUser(BOB.asString, BOB_PASSWORD) |
| .addUser(ANDRE.asString, ANDRE_PASSWORD) |
| |
| requestSpecification = baseRequestSpecBuilder(server) |
| .setAuth(authScheme(UserCredential(BOB, BOB_PASSWORD))) |
| .build |
| } |
| |
| @Test |
| def backReferenceResolvingShouldWork(): Unit = { |
| val response = `given` |
| .header(ACCEPT.toString, ACCEPT_RFC8621_VERSION_HEADER) |
| .body( |
| s"""{ |
| | "using": [ |
| | "urn:ietf:params:jmap:core", |
| | "urn:ietf:params:jmap:mail"], |
| | "methodCalls": [[ |
| | "Mailbox/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "ids": null, |
| | "properties": ["id"] |
| | }, |
| | "c1"],[ |
| | "Mailbox/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "properties": ["id"], |
| | "#ids": { |
| | "resultOf":"c1", |
| | "name":"Mailbox/get", |
| | "path":"list/*/id" |
| | } |
| | }, |
| | "c2"]] |
| |}""".stripMargin) |
| .when |
| .post |
| .`then` |
| .statusCode(SC_OK) |
| .extract() |
| .body() |
| .asString() |
| |
| assertThatJson(response).isEqualTo( |
| s"""{ |
| | "sessionState": "75128aab4b1b", |
| | "methodResponses": [ |
| | [ |
| | "Mailbox/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "state": "000001", |
| | "list": [ |
| | {"id": "1"}, |
| | {"id": "5"}, |
| | {"id": "2"}, |
| | {"id": "3"}, |
| | {"id": "4"}, |
| | {"id": "6"} |
| | ], |
| | "notFound": [] |
| | }, |
| | "c1" |
| | ], |
| | [ |
| | "Mailbox/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "state": "000001", |
| | "list": [ |
| | {"id": "1"}, |
| | {"id": "5"}, |
| | {"id": "2"}, |
| | {"id": "3"}, |
| | {"id": "4"}, |
| | {"id": "6"} |
| | ], |
| | "notFound": [] |
| | }, |
| | "c2" |
| | ] |
| | ] |
| |}""".stripMargin) |
| } |
| |
| @Test |
| def pathShouldBeResolvable(): Unit = { |
| val response = `given` |
| .header(ACCEPT.toString, ACCEPT_RFC8621_VERSION_HEADER) |
| .body( |
| s"""{ |
| | "using": [ |
| | "urn:ietf:params:jmap:core", |
| | "urn:ietf:params:jmap:mail"], |
| | "methodCalls": [[ |
| | "Mailbox/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "ids": null, |
| | "properties": ["id"] |
| | }, |
| | "c1"],[ |
| | "Mailbox/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "properties": ["id"], |
| | "#ids": { |
| | "resultOf":"c1", |
| | "name":"Mailbox/get", |
| | "path":"unknown/*/id" |
| | } |
| | }, |
| | "c2"]] |
| |}""".stripMargin) |
| .when |
| .post |
| .`then` |
| .statusCode(SC_OK) |
| .extract() |
| .body() |
| .asString() |
| |
| assertThatJson(response).isEqualTo( |
| s"""{ |
| | "sessionState": "75128aab4b1b", |
| | "methodResponses": [ |
| | [ |
| | "Mailbox/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "state": "000001", |
| | "list": [ |
| | {"id": "1"}, |
| | {"id": "5"}, |
| | {"id": "2"}, |
| | {"id": "3"}, |
| | {"id": "4"}, |
| | {"id": "6"} |
| | ], |
| | "notFound": [] |
| | }, |
| | "c1" |
| | ], |
| | [ |
| | "error", |
| | { |
| | "type": "invalidResultReference", |
| | "description": "Failed resolving back-reference: List((,List(JsonValidationError(List(Expected path unknown was missing),ArraySeq()))))" |
| | }, |
| | "c2" |
| | ] |
| | ] |
| |}""".stripMargin) |
| } |
| |
| @Test |
| def wildcardRequiresAnArray(): Unit = { |
| val response = `given` |
| .header(ACCEPT.toString, ACCEPT_RFC8621_VERSION_HEADER) |
| .body( |
| s"""{ |
| | "using": [ |
| | "urn:ietf:params:jmap:core", |
| | "urn:ietf:params:jmap:mail"], |
| | "methodCalls": [[ |
| | "Mailbox/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "ids": null, |
| | "properties": ["id"] |
| | }, |
| | "c1"],[ |
| | "Mailbox/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "properties": ["id"], |
| | "#ids": { |
| | "resultOf":"c1", |
| | "name":"Mailbox/get", |
| | "path":"*/*/id" |
| | } |
| | }, |
| | "c2"]] |
| |}""".stripMargin) |
| .when |
| .post |
| .`then` |
| .statusCode(SC_OK) |
| .extract() |
| .body() |
| .asString() |
| |
| assertThatJson(response).isEqualTo( |
| s"""{ |
| | "sessionState": "75128aab4b1b", |
| | "methodResponses": [ |
| | [ |
| | "Mailbox/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "state": "000001", |
| | "list": [ |
| | {"id": "1"}, |
| | {"id": "5"}, |
| | {"id": "2"}, |
| | {"id": "3"}, |
| | {"id": "4"}, |
| | {"id": "6"} |
| | ], |
| | "notFound": [] |
| | }, |
| | "c1" |
| | ], |
| | [ |
| | "error", |
| | { |
| | "type": "invalidResultReference", |
| | "description": "Failed resolving back-reference: List((,List(JsonValidationError(List(Expecting an array),ArraySeq()))))" |
| | }, |
| | "c2" |
| | ] |
| | ] |
| |}""".stripMargin) |
| } |
| |
| @Test |
| def resolvedBackReferenceShouldHaveTheRightMethodName(): Unit = { |
| val response = `given` |
| .header(ACCEPT.toString, ACCEPT_RFC8621_VERSION_HEADER) |
| .body( |
| s"""{ |
| | "using": [ |
| | "urn:ietf:params:jmap:core", |
| | "urn:ietf:params:jmap:mail"], |
| | "methodCalls": [[ |
| | "Mailbox/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "ids": null, |
| | "properties": ["id"] |
| | }, |
| | "c1"],[ |
| | "Mailbox/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "properties": ["id"], |
| | "#ids": { |
| | "resultOf":"c1", |
| | "name":"Mailbox/set", |
| | "path":"list/*/id" |
| | } |
| | }, |
| | "c2"]] |
| |}""".stripMargin) |
| .when |
| .post |
| .`then` |
| .statusCode(SC_OK) |
| .extract() |
| .body() |
| .asString() |
| |
| assertThatJson(response).isEqualTo( |
| s"""{ |
| | "sessionState": "75128aab4b1b", |
| | "methodResponses": [ |
| | [ |
| | "Mailbox/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "state": "000001", |
| | "list": [ |
| | {"id": "1"}, |
| | {"id": "5"}, |
| | {"id": "2"}, |
| | {"id": "3"}, |
| | {"id": "4"}, |
| | {"id": "6"} |
| | ], |
| | "notFound": [] |
| | }, |
| | "c1" |
| | ], |
| | [ |
| | "error", |
| | { |
| | "type": "invalidResultReference", |
| | "description": "Failed resolving back-reference: List((,List(JsonValidationError(List(MethodCallId(c1) references a MethodName(Mailbox/get) method),ArraySeq()))))" |
| | }, |
| | "c2" |
| | ] |
| | ] |
| |}""".stripMargin) |
| } |
| |
| @Test |
| def resolvingAnUnexistingMethodCallIdShouldFail(): Unit = { |
| val response = `given` |
| .header(ACCEPT.toString, ACCEPT_RFC8621_VERSION_HEADER) |
| .body( |
| s"""{ |
| | "using": [ |
| | "urn:ietf:params:jmap:core", |
| | "urn:ietf:params:jmap:mail"], |
| | "methodCalls": [[ |
| | "Mailbox/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "ids": null, |
| | "properties": ["id"] |
| | }, |
| | "c1"],[ |
| | "Mailbox/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "properties": ["id"], |
| | "#ids": { |
| | "resultOf":"c42", |
| | "name":"Mailbox/get", |
| | "path":"list/*/id" |
| | } |
| | }, |
| | "c2"]] |
| |}""".stripMargin) |
| .when |
| .post |
| .`then` |
| .statusCode(SC_OK) |
| .extract() |
| .body() |
| .asString() |
| |
| assertThatJson(response).isEqualTo( |
| s"""{ |
| | "sessionState": "75128aab4b1b", |
| | "methodResponses": [ |
| | [ |
| | "Mailbox/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "state": "000001", |
| | "list": [ |
| | {"id": "1"}, |
| | {"id": "5"}, |
| | {"id": "2"}, |
| | {"id": "3"}, |
| | {"id": "4"}, |
| | {"id": "6"} |
| | ], |
| | "notFound": [] |
| | }, |
| | "c1" |
| | ], |
| | [ |
| | "error", |
| | { |
| | "type": "invalidResultReference", |
| | "description": "Failed resolving back-reference: List((,List(JsonValidationError(List(Back reference could not be resolved),ArraySeq()))))" |
| | }, |
| | "c2" |
| | ] |
| | ] |
| |}""".stripMargin) |
| } |
| |
| @Test |
| def loadingAccountWithBackReferences(server: GuiceJamesServer): Unit = { |
| val mailboxProbe: MailboxProbeImpl = server.getProbe(classOf[MailboxProbeImpl]) |
| val mailboxId: MailboxId = mailboxProbe |
| .createMailbox(MailboxPath.inbox(BOB)) |
| val messageId1: MessageId = server.getProbe(classOf[MailboxProbeImpl]) |
| .appendMessage(BOB.asString, MailboxPath.inbox(BOB), AppendCommand.from(Message.Builder |
| .of.setSubject("message 1") |
| .setBody("testmail", StandardCharsets.UTF_8) |
| .build)) |
| .getMessageId |
| val messageId2: MessageId = server.getProbe(classOf[MailboxProbeImpl]) |
| .appendMessage(BOB.asString, MailboxPath.inbox(BOB), AppendCommand.from(Message.Builder |
| .of.setSubject("message 2") |
| .setBody("testmail", StandardCharsets.UTF_8) |
| .build)) |
| .getMessageId |
| val messageId3: MessageId = server.getProbe(classOf[MailboxProbeImpl]) |
| .appendMessage(BOB.asString, MailboxPath.inbox(BOB), AppendCommand.from(Message.Builder |
| .of.setSubject("message 3") |
| .setBody("testmail", StandardCharsets.UTF_8) |
| .build)) |
| .getMessageId |
| |
| val response = `given` |
| .header(ACCEPT.toString, ACCEPT_RFC8621_VERSION_HEADER) |
| .body( |
| s"""{ |
| | "using": [ |
| | "urn:ietf:params:jmap:core", |
| | "urn:ietf:params:jmap:mail"], |
| | "methodCalls": [[ |
| | "Mailbox/query", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "filter": {"role":"Inbox"} |
| | }, |
| | "c1"],[ |
| | "Email/query", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "filter": { |
| | "#inMailbox": { |
| | "resultOf":"c1", |
| | "name":"Mailbox/query", |
| | "path":"ids[0]" |
| | } |
| | } |
| | }, |
| | "c2"], [ |
| | "Email/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "properties": ["id", "subject"], |
| | "#ids": { |
| | "resultOf":"c2", |
| | "name":"Email/query", |
| | "path":"ids/*" |
| | } |
| | }, |
| | "c3"]] |
| |}""".stripMargin) |
| .when |
| .post |
| .`then` |
| .statusCode(SC_OK) |
| .extract() |
| .body() |
| .asString() |
| |
| assertThatJson(response) |
| .withOptions(new Options(Option.IGNORING_ARRAY_ORDER)) |
| .isEqualTo( |
| s"""{ |
| | "sessionState": "75128aab4b1b", |
| | "methodResponses": [ |
| | [ |
| | "Mailbox/query", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "queryState": "33cc79f8", |
| | "canCalculateChanges": false, |
| | "ids": ["${mailboxId.serialize}"], |
| | "position": 0, |
| | "limit": 256 |
| | }, |
| | "c1" |
| | ], |
| | [ |
| | "Email/query", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "queryState": "a6904f19", |
| | "canCalculateChanges": false, |
| | "ids": ["${messageId1.serialize}", "${messageId2.serialize}", "${messageId3.serialize}"], |
| | "position": 0, |
| | "limit": 256 |
| | }, |
| | "c2" |
| | ], |
| | [ |
| | "Email/get", |
| | { |
| | "accountId": "29883977c13473ae7cb7678ef767cbfbaffc8a44a6e463d971d23a65c1dc4af6", |
| | "state": "000001", |
| | "list": [ |
| | {"id": "${messageId3.serialize}", "subject": "message 3"}, |
| | {"id": "${messageId2.serialize}", "subject": "message 2"}, |
| | {"id": "${messageId1.serialize}", "subject": "message 1"} |
| | ], |
| | "notFound": [] |
| | }, |
| | "c3" |
| | ] |
| | ] |
| |}""".stripMargin) |
| } |
| } |
