JAMES-2285 Provide a ManageableMailQueue contract
Project: http://git-wip-us.apache.org/repos/asf/james-project/repo Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/47f12512 Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/47f12512 Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/47f12512 Branch: refs/heads/master Commit: 47f125128e86ec8353d8c62e8d934cf4147a8b22 Parents: 9c13b92 Author: benwa <[email protected]> Authored: Thu Jan 11 16:16:40 2018 +0700 Committer: benwa <[email protected]> Committed: Tue Jan 16 09:04:28 2018 +0700 ---------------------------------------------------------------------- .../java/org/apache/james/queue/api/Mails.java | 6 +- .../queue/api/ManageableMailQueueContract.java | 476 +++++++++++++++++++ .../james/queue/jms/JMSMailQueueTest.java | 17 +- 3 files changed, 496 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/james-project/blob/47f12512/server/queue/queue-api/src/test/java/org/apache/james/queue/api/Mails.java ---------------------------------------------------------------------- diff --git a/server/queue/queue-api/src/test/java/org/apache/james/queue/api/Mails.java b/server/queue/queue-api/src/test/java/org/apache/james/queue/api/Mails.java index 32e986b..1c3e56e 100644 --- a/server/queue/queue-api/src/test/java/org/apache/james/queue/api/Mails.java +++ b/server/queue/queue-api/src/test/java/org/apache/james/queue/api/Mails.java @@ -34,11 +34,15 @@ import org.apache.mailet.base.test.FakeMail; public interface Mails { static FakeMail.Builder defaultMail() throws MessagingException { + return defaultMailNoRecipient() + .recipients(RECIPIENT1, RECIPIENT2); + } + + static FakeMail.Builder defaultMailNoRecipient() throws MessagingException { return FakeMail.builder() .name("name") .mimeMessage(createMimeMessage()) .sender(SENDER) - .recipients(RECIPIENT1, RECIPIENT2) .lastUpdated(new Date()); } http://git-wip-us.apache.org/repos/asf/james-project/blob/47f12512/server/queue/queue-api/src/test/java/org/apache/james/queue/api/ManageableMailQueueContract.java ---------------------------------------------------------------------- diff --git a/server/queue/queue-api/src/test/java/org/apache/james/queue/api/ManageableMailQueueContract.java b/server/queue/queue-api/src/test/java/org/apache/james/queue/api/ManageableMailQueueContract.java new file mode 100644 index 0000000..a5706bc --- /dev/null +++ b/server/queue/queue-api/src/test/java/org/apache/james/queue/api/ManageableMailQueueContract.java @@ -0,0 +1,476 @@ +/**************************************************************** + * 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.queue.api; + +import static org.apache.james.queue.api.Mails.defaultMail; +import static org.apache.james.queue.api.Mails.defaultMailNoRecipient; +import static org.apache.mailet.base.MailAddressFixture.OTHER_AT_LOCAL; +import static org.apache.mailet.base.MailAddressFixture.RECIPIENT1; +import static org.apache.mailet.base.MailAddressFixture.RECIPIENT2; +import static org.apache.mailet.base.MailAddressFixture.RECIPIENT3; +import static org.apache.mailet.base.MailAddressFixture.SENDER; +import static org.assertj.core.api.Assertions.assertThat; + +import org.apache.mailet.Mail; +import org.apache.mailet.base.MailAddressFixture; +import org.junit.jupiter.api.Test; + +public interface ManageableMailQueueContract extends MailQueueContract { + + ManageableMailQueue getManageableMailQueue(); + + @Test + default void getSizeShouldReturnZeroWhenNoMessage() throws Exception { + long size = getManageableMailQueue().getSize(); + + assertThat(size).isEqualTo(0L); + } + + @Test + default void getSizeShouldReturnMessageCount() throws Exception { + getManageableMailQueue().enQueue(defaultMail().build()); + + long size = getManageableMailQueue().getSize(); + + assertThat(size).isEqualTo(1L); + } + + @Test + default void getSizeShouldReturnMessageCountWhenSeveralMails() throws Exception { + getManageableMailQueue().enQueue(defaultMail().build()); + getManageableMailQueue().enQueue(defaultMail().build()); + + long size = getManageableMailQueue().getSize(); + + assertThat(size).isEqualTo(2L); + } + + @Test + default void dequeueShouldDecreaseQueueSize() throws Exception { + getManageableMailQueue().enQueue(defaultMail().build()); + + getManageableMailQueue().deQueue().done(true); + + long size = getManageableMailQueue().getSize(); + + assertThat(size).isEqualTo(0L); + } + + @Test + default void noAckShouldNotDecreaseSize() throws Exception { + getManageableMailQueue().enQueue(defaultMail().build()); + + getManageableMailQueue().deQueue().done(false); + + long size = getManageableMailQueue().getSize(); + + assertThat(size).isEqualTo(1L); + } + + @Test + default void processedMailsShouldNotDecreaseSize() throws Exception { + getManageableMailQueue().enQueue(defaultMail().build()); + + getManageableMailQueue().deQueue(); + + long size = getManageableMailQueue().getSize(); + + assertThat(size).isEqualTo(1L); + } + + @Test + default void browseShouldReturnEmptyByDefault() throws Exception { + ManageableMailQueue.MailQueueIterator items = getManageableMailQueue().browse(); + + assertThat(items).isEmpty(); + } + + @Test + default void browseShouldReturnSingleElement() throws Exception { + getManageableMailQueue().enQueue(defaultMail() + .name("name") + .build()); + + ManageableMailQueue.MailQueueIterator items = getManageableMailQueue().browse(); + + assertThat(items).extracting(ManageableMailQueue.MailQueueItemView::getMail) + .extracting(Mail::getName) + .containsExactly("name"); + } + + @Test + default void browseShouldReturnElementsInOrder() throws Exception { + getManageableMailQueue().enQueue(defaultMail() + .name("name1") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name2") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name3") + .build()); + + ManageableMailQueue.MailQueueIterator items = getManageableMailQueue().browse(); + + assertThat(items) + .extracting(ManageableMailQueue.MailQueueItemView::getMail) + .extracting(Mail::getName) + .containsExactly("name1", "name2", "name3"); + } + + @Test + default void concurrentDequeueShouldNotAlterBrowsing() throws Exception { + getManageableMailQueue().enQueue(defaultMail() + .name("name1") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name2") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name3") + .build()); + + ManageableMailQueue.MailQueueIterator items = getManageableMailQueue().browse(); + + getManageableMailQueue().deQueue(); + + assertThat(items) + .extracting(ManageableMailQueue.MailQueueItemView::getMail) + .extracting(Mail::getName) + .containsExactly("name1", "name2", "name3"); + } + + @Test + default void concurrentDequeueShouldNotAlterBrowsingWhenDequeueWhileIterating() throws Exception { + getManageableMailQueue().enQueue(defaultMail() + .name("name1") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name2") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name3") + .build()); + + ManageableMailQueue.MailQueueIterator items = getManageableMailQueue().browse(); + + ManageableMailQueue.MailQueueItemView firstItem = items.next(); + + getManageableMailQueue().deQueue(); + + assertThat(firstItem.getMail().getName()).isEqualTo("name1"); + assertThat(items) + .extracting(ManageableMailQueue.MailQueueItemView::getMail) + .extracting(Mail::getName) + .containsExactly("name2", "name3"); + } + + @Test + default void browsingShouldNotAffectDequeue() throws Exception { + getManageableMailQueue().enQueue(defaultMail() + .name("name1") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name2") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name3") + .build()); + + ManageableMailQueue.MailQueueIterator items = getManageableMailQueue().browse(); + items.next(); + + MailQueue.MailQueueItem mailQueueItem = getManageableMailQueue().deQueue(); + + assertThat(mailQueueItem.getMail().getName()).isEqualTo("name1"); + } + + @Test + default void concurrentEnqueueShouldNotAlterBrowsingWhenDequeueWhileIterating() throws Exception { + getManageableMailQueue().enQueue(defaultMail() + .name("name1") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name2") + .build()); + + ManageableMailQueue.MailQueueIterator items = getManageableMailQueue().browse(); + + ManageableMailQueue.MailQueueItemView firstItem = items.next(); + + getManageableMailQueue().enQueue(defaultMail() + .name("name3") + .build()); + + assertThat(firstItem.getMail().getName()).isEqualTo("name1"); + assertThat(items).extracting(ManageableMailQueue.MailQueueItemView::getMail) + .extracting(Mail::getName) + .containsExactly("name2"); + } + + @Test + default void concurrentEnqueueShouldNotAlterBrowsing() throws Exception { + getManageableMailQueue().enQueue(defaultMail() + .name("name1") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name2") + .build()); + + ManageableMailQueue.MailQueueIterator items = getManageableMailQueue().browse(); + + getManageableMailQueue().enQueue(defaultMail() + .name("name3") + .build()); + + assertThat(items).extracting(ManageableMailQueue.MailQueueItemView::getMail) + .extracting(Mail::getName) + .containsExactly("name1", "name2"); + } + + @Test + default void concurrentFlushShouldNotAlterBrowsingWhenDequeueWhileIterating() throws Exception { + getManageableMailQueue().enQueue(defaultMail() + .name("name1") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name2") + .build()); + + ManageableMailQueue.MailQueueIterator items = getManageableMailQueue().browse(); + + ManageableMailQueue.MailQueueItemView firstItem = items.next(); + + getManageableMailQueue().flush(); + + assertThat(firstItem.getMail().getName()).isEqualTo("name1"); + assertThat(items).extracting(ManageableMailQueue.MailQueueItemView::getMail) + .extracting(Mail::getName) + .containsExactly("name2"); + } + + @Test + default void concurrentFlushShouldNotAlterBrowsing() throws Exception { + getManageableMailQueue().enQueue(defaultMail() + .name("name1") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name2") + .build()); + + ManageableMailQueue.MailQueueIterator items = getManageableMailQueue().browse(); + + getManageableMailQueue().flush(); + + assertThat(items).extracting(ManageableMailQueue.MailQueueItemView::getMail) + .extracting(Mail::getName) + .containsExactly("name1", "name2"); + } + + @Test + default void concurrentClearShouldNotAlterBrowsingWhenDequeue() throws Exception { + getManageableMailQueue().enQueue(defaultMail() + .name("name1") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name2") + .build()); + + ManageableMailQueue.MailQueueIterator items = getManageableMailQueue().browse(); + + getManageableMailQueue().clear(); + + assertThat(items).extracting(ManageableMailQueue.MailQueueItemView::getMail) + .extracting(Mail::getName) + .containsExactly("name1", "name2"); + } + + @Test + default void concurrentRemoveShouldNotAlterBrowsingWhenDequeue() throws Exception { + getManageableMailQueue().enQueue(defaultMail() + .name("name1") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name2") + .build()); + + ManageableMailQueue.MailQueueIterator items = getManageableMailQueue().browse(); + + getManageableMailQueue().remove(ManageableMailQueue.Type.Name, "name2"); + + assertThat(items).extracting(ManageableMailQueue.MailQueueItemView::getMail) + .extracting(Mail::getName) + .containsExactly("name1", "name2"); + } + + @Test + default void concurrentClearShouldNotAlterBrowsingWhenDequeueWhileIterating() throws Exception { + getManageableMailQueue().enQueue(defaultMail() + .name("name1") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name2") + .build()); + + ManageableMailQueue.MailQueueIterator items = getManageableMailQueue().browse(); + ManageableMailQueue.MailQueueItemView next = items.next(); + + getManageableMailQueue().clear(); + + assertThat(next.getMail().getName()).isEqualTo("name1"); + assertThat(items).extracting(ManageableMailQueue.MailQueueItemView::getMail) + .extracting(Mail::getName) + .containsExactly("name2"); + } + + @Test + default void concurrentRemoveShouldNotAlterBrowsingWhenDequeueWhileIterating() throws Exception { + getManageableMailQueue().enQueue(defaultMail() + .name("name1") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name2") + .build()); + + ManageableMailQueue.MailQueueIterator items = getManageableMailQueue().browse(); + ManageableMailQueue.MailQueueItemView next = items.next(); + + getManageableMailQueue().remove(ManageableMailQueue.Type.Name, "name2"); + + assertThat(next.getMail().getName()).isEqualTo("name1"); + assertThat(items).extracting(ManageableMailQueue.MailQueueItemView::getMail) + .extracting(Mail::getName) + .containsExactly("name2"); + } + + @Test + default void removeByNameShouldRemoveSpecificEmail() throws Exception { + getManageableMailQueue().enQueue(defaultMail() + .name("name1") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name2") + .build()); + + getManageableMailQueue().remove(ManageableMailQueue.Type.Name, "name2"); + + assertThat(getManageableMailQueue().browse()) + .extracting(ManageableMailQueue.MailQueueItemView::getMail) + .extracting(Mail::getName) + .containsExactly("name1"); + } + + @Test + default void removeBySenderShouldRemoveSpecificEmail() throws Exception { + getManageableMailQueue().enQueue(defaultMail() + .sender(OTHER_AT_LOCAL) + .name("name1") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .sender(SENDER) + .name("name2") + .build()); + + getManageableMailQueue().remove(ManageableMailQueue.Type.Sender, OTHER_AT_LOCAL.asString()); + + assertThat(getManageableMailQueue().browse()) + .extracting(ManageableMailQueue.MailQueueItemView::getMail) + .extracting(Mail::getName) + .containsExactly("name2"); + } + + @Test + default void removeByRecipientShouldRemoveSpecificEmail() throws Exception { + getManageableMailQueue().enQueue(defaultMailNoRecipient() + .name("name1") + .recipient(RECIPIENT1) + .build()); + getManageableMailQueue().enQueue(defaultMailNoRecipient() + .name("name2") + .recipient(RECIPIENT2) + .build()); + + getManageableMailQueue().remove(ManageableMailQueue.Type.Recipient, RECIPIENT2.asString()); + + assertThat(getManageableMailQueue().browse()) + .extracting(ManageableMailQueue.MailQueueItemView::getMail) + .extracting(Mail::getName) + .containsExactly("name1"); + } + + @Test + default void removeByRecipientShouldRemoveSpecificEmailWhenMultipleRecipients() throws Exception { + getManageableMailQueue().enQueue(defaultMailNoRecipient() + .name("name1") + .recipients(RECIPIENT1, RECIPIENT2) + .build()); + getManageableMailQueue().enQueue(defaultMailNoRecipient() + .name("name2") + .recipients(RECIPIENT1, RECIPIENT3) + .build()); + + getManageableMailQueue().remove(ManageableMailQueue.Type.Recipient, RECIPIENT2.asString()); + + assertThat(getManageableMailQueue().browse()) + .extracting(ManageableMailQueue.MailQueueItemView::getMail) + .extracting(Mail::getName) + .containsExactly("name1"); + } + + @Test + default void removeByNameShouldNotFailWhenQueueIsEmpty() throws Exception { + getManageableMailQueue().remove(ManageableMailQueue.Type.Name, "NAME2"); + } + + @Test + default void removeBySenderShouldNotFailWhenQueueIsEmpty() throws Exception { + getManageableMailQueue().remove(ManageableMailQueue.Type.Sender, MailAddressFixture.OTHER_AT_LOCAL.asString()); + } + + @Test + default void removeByRecipientShouldNotFailWhenQueueIsEmpty() throws Exception { + getManageableMailQueue().remove(ManageableMailQueue.Type.Recipient, MailAddressFixture.OTHER_AT_LOCAL.asString()); + } + + @Test + default void clearShouldNotFailWhenQueueIsEmpty() throws Exception { + getManageableMailQueue().clear(); + } + + @Test + default void flushShouldNotFailWhenQueueIsEmpty() throws Exception { + getManageableMailQueue().flush(); + } + + @Test + default void clearShouldRemoveAllElements() throws Exception { + getManageableMailQueue().enQueue(defaultMail() + .name("name1") + .build()); + getManageableMailQueue().enQueue(defaultMail() + .name("name2") + .build()); + + getManageableMailQueue().clear(); + + assertThat(getManageableMailQueue().browse()).isEmpty(); + } + +} http://git-wip-us.apache.org/repos/asf/james-project/blob/47f12512/server/queue/queue-jms/src/test/java/org/apache/james/queue/jms/JMSMailQueueTest.java ---------------------------------------------------------------------- diff --git a/server/queue/queue-jms/src/test/java/org/apache/james/queue/jms/JMSMailQueueTest.java b/server/queue/queue-jms/src/test/java/org/apache/james/queue/jms/JMSMailQueueTest.java index a5708ce..59b616e 100644 --- a/server/queue/queue-jms/src/test/java/org/apache/james/queue/jms/JMSMailQueueTest.java +++ b/server/queue/queue-jms/src/test/java/org/apache/james/queue/jms/JMSMailQueueTest.java @@ -27,7 +27,8 @@ import org.apache.activemq.broker.region.policy.PolicyEntry; import org.apache.activemq.broker.region.policy.PolicyMap; import org.apache.james.metrics.api.NoopMetricFactory; import org.apache.james.queue.api.MailQueue; -import org.apache.james.queue.api.MailQueueContract; +import org.apache.james.queue.api.ManageableMailQueue; +import org.apache.james.queue.api.ManageableMailQueueContract; import org.apache.james.queue.api.RawMailQueueItemDecoratorFactory; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.BeforeEach; @@ -36,7 +37,7 @@ import org.junit.jupiter.api.Test; import com.google.common.collect.ImmutableList; -public class JMSMailQueueTest implements MailQueueContract { +public class JMSMailQueueTest implements ManageableMailQueueContract { private final static String QUEUE_NAME = "test"; @@ -83,6 +84,11 @@ public class JMSMailQueueTest implements MailQueueContract { @Test @Override + public ManageableMailQueue getManageableMailQueue() { + return mailQueue; + } + + @Override @Disabled("JAMES-2295 Disabled as test was dead-locking") public void dequeueCanBeChainedBeforeAck() { @@ -101,4 +107,11 @@ public class JMSMailQueueTest implements MailQueueContract { public void queueShouldPreservePerRecipientHeaders() { } + + @Test + @Override + @Disabled("JAMES-2296 Not handled by JMS mailqueue. Only single recipient per-recipient removal works") + public void removeByRecipientShouldRemoveSpecificEmailWhenMultipleRecipients() { + + } } --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
