This is an automated email from the ASF dual-hosted git repository. btellier pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/james-project.git
View the commit online: https://github.com/apache/james-project/commit/d7816a6e30a47a4cba149d23920955276f2ecbaa commit d7816a6e30a47a4cba149d23920955276f2ecbaa Author: Rene Cordier <[email protected]> AuthorDate: Mon Nov 18 16:05:36 2019 +0700 [Refactoring] Refactor abstract test class AbstractSubscriptionManagerTest to interface SubscriptionManagerContract --- .../mailbox/AbstractSubscriptionManagerTest.java | 107 --------------------- .../james/mailbox/SubscriptionManagerContract.java | 84 ++++++++++++++++ .../CassandraSubscriptionManagerTest.java | 17 +++- .../mailbox/jpa/JPASubscriptionManagerTest.java | 22 +++-- .../maildir/MaildirSubscriptionManagerTest.java | 26 ++++- 5 files changed, 134 insertions(+), 122 deletions(-) diff --git a/mailbox/api/src/test/java/org/apache/james/mailbox/AbstractSubscriptionManagerTest.java b/mailbox/api/src/test/java/org/apache/james/mailbox/AbstractSubscriptionManagerTest.java deleted file mode 100644 index 2a0b5a3..0000000 --- a/mailbox/api/src/test/java/org/apache/james/mailbox/AbstractSubscriptionManagerTest.java +++ /dev/null @@ -1,107 +0,0 @@ -/**************************************************************** - * 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.mailbox; - -import static org.assertj.core.api.Assertions.assertThat; - -import org.apache.james.core.Username; -import org.apache.james.mailbox.exception.SubscriptionException; -import org.junit.jupiter.api.AfterEach; -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Test; - -/** - * Abstract base class to test {@link SubscriptionManager} implementations - * - * - */ -public abstract class AbstractSubscriptionManagerTest { - - private static final Username USER1 = Username.of("test"); - private static final String MAILBOX1 = "test1"; - private static final String MAILBOX2 = "test2"; - private SubscriptionManager manager; - private MailboxSession session; - - protected abstract SubscriptionManager createSubscriptionManager(); - - @BeforeEach - void setup() { - manager = createSubscriptionManager(); - session = MailboxSessionUtil.create(USER1); - manager.startProcessingRequest(session); - } - - @AfterEach - void teardown() throws SubscriptionException { - manager.unsubscribe(session, MAILBOX1); - manager.unsubscribe(session, MAILBOX2); - manager.endProcessingRequest(session); - } - - @Test - void user1ShouldNotHaveAnySubscriptionByDefault() throws SubscriptionException { - assertThat(manager.subscriptions(session)).isEmpty(); - } - - - @Test - void user1ShouldBeAbleToSubscribeOneMailbox() throws SubscriptionException { - manager.subscribe(session, MAILBOX1); - - assertThat(manager.subscriptions(session)).containsExactly(MAILBOX1); - } - - @Test - void subscribeShouldBeIdempotent() throws SubscriptionException { - manager.subscribe(session, MAILBOX1); - manager.subscribe(session, MAILBOX1); - - assertThat(manager.subscriptions(session)).containsExactly(MAILBOX1); - } - - @Test - void user1ShouldBeAbleToSubscribeTwoMailbox() throws SubscriptionException { - manager.subscribe(session, MAILBOX1); - manager.subscribe(session, MAILBOX2); - - assertThat(manager.subscriptions(session)).containsOnly(MAILBOX1, MAILBOX2); - } - - @Test - void user1ShouldBeAbleToUnsubscribeOneMailbox() throws SubscriptionException { - manager.subscribe(session, MAILBOX1); - manager.subscribe(session, MAILBOX2); - - manager.unsubscribe(session, MAILBOX1); - - assertThat(manager.subscriptions(session)).containsExactly(MAILBOX2); - } - - @Test - void unsubscribeShouldBeIdempotent() throws SubscriptionException { - manager.subscribe(session, MAILBOX1); - manager.subscribe(session, MAILBOX2); - manager.unsubscribe(session, MAILBOX1); - manager.unsubscribe(session, MAILBOX1); - - assertThat(manager.subscriptions(session)).containsExactly(MAILBOX2); - } - -} diff --git a/mailbox/api/src/test/java/org/apache/james/mailbox/SubscriptionManagerContract.java b/mailbox/api/src/test/java/org/apache/james/mailbox/SubscriptionManagerContract.java new file mode 100644 index 0000000..ef5a19a --- /dev/null +++ b/mailbox/api/src/test/java/org/apache/james/mailbox/SubscriptionManagerContract.java @@ -0,0 +1,84 @@ +/**************************************************************** + * 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.mailbox; + +import static org.assertj.core.api.Assertions.assertThat; + +import org.apache.james.core.Username; +import org.apache.james.mailbox.exception.SubscriptionException; +import org.junit.jupiter.api.Test; + +public interface SubscriptionManagerContract { + + Username USER1 = Username.of("test"); + String MAILBOX1 = "test1"; + String MAILBOX2 = "test2"; + MailboxSession SESSION = MailboxSessionUtil.create(USER1); + + SubscriptionManager getSubscriptionManager(); + + @Test + default void user1ShouldNotHaveAnySubscriptionByDefault() throws SubscriptionException { + assertThat(getSubscriptionManager().subscriptions(SESSION)).isEmpty(); + } + + @Test + default void user1ShouldBeAbleToSubscribeOneMailbox() throws SubscriptionException { + getSubscriptionManager().subscribe(SESSION, MAILBOX1); + + assertThat(getSubscriptionManager().subscriptions(SESSION)).containsExactly(MAILBOX1); + } + + @Test + default void subscribeShouldBeIdempotent() throws SubscriptionException { + getSubscriptionManager().subscribe(SESSION, MAILBOX1); + getSubscriptionManager().subscribe(SESSION, MAILBOX1); + + assertThat(getSubscriptionManager().subscriptions(SESSION)).containsExactly(MAILBOX1); + } + + @Test + default void user1ShouldBeAbleToSubscribeTwoMailbox() throws SubscriptionException { + getSubscriptionManager().subscribe(SESSION, MAILBOX1); + getSubscriptionManager().subscribe(SESSION, MAILBOX2); + + assertThat(getSubscriptionManager().subscriptions(SESSION)).containsOnly(MAILBOX1, MAILBOX2); + } + + @Test + default void user1ShouldBeAbleToUnsubscribeOneMailbox() throws SubscriptionException { + getSubscriptionManager().subscribe(SESSION, MAILBOX1); + getSubscriptionManager().subscribe(SESSION, MAILBOX2); + + getSubscriptionManager().unsubscribe(SESSION, MAILBOX1); + + assertThat(getSubscriptionManager().subscriptions(SESSION)).containsExactly(MAILBOX2); + } + + @Test + default void unsubscribeShouldBeIdempotent() throws SubscriptionException { + getSubscriptionManager().subscribe(SESSION, MAILBOX1); + getSubscriptionManager().subscribe(SESSION, MAILBOX2); + getSubscriptionManager().unsubscribe(SESSION, MAILBOX1); + getSubscriptionManager().unsubscribe(SESSION, MAILBOX1); + + assertThat(getSubscriptionManager().subscriptions(SESSION)).containsExactly(MAILBOX2); + } + +} diff --git a/mailbox/cassandra/src/test/java/org/apache/james/mailbox/cassandra/CassandraSubscriptionManagerTest.java b/mailbox/cassandra/src/test/java/org/apache/james/mailbox/cassandra/CassandraSubscriptionManagerTest.java index 8dc2ad8..d3b5376 100644 --- a/mailbox/cassandra/src/test/java/org/apache/james/mailbox/cassandra/CassandraSubscriptionManagerTest.java +++ b/mailbox/cassandra/src/test/java/org/apache/james/mailbox/cassandra/CassandraSubscriptionManagerTest.java @@ -24,8 +24,8 @@ import org.apache.james.backends.cassandra.CassandraRestartExtension; import org.apache.james.backends.cassandra.init.configuration.CassandraConfiguration; import org.apache.james.backends.cassandra.utils.CassandraUtils; import org.apache.james.blob.api.BlobStore; -import org.apache.james.mailbox.AbstractSubscriptionManagerTest; import org.apache.james.mailbox.SubscriptionManager; +import org.apache.james.mailbox.SubscriptionManagerContract; import org.apache.james.mailbox.cassandra.mail.CassandraACLMapper; import org.apache.james.mailbox.cassandra.mail.CassandraApplicableFlagDAO; import org.apache.james.mailbox.cassandra.mail.CassandraAttachmentDAO; @@ -47,6 +47,7 @@ import org.apache.james.mailbox.cassandra.mail.CassandraUidProvider; import org.apache.james.mailbox.cassandra.mail.CassandraUserMailboxRightsDAO; import org.apache.james.mailbox.cassandra.modules.CassandraSubscriptionModule; import org.apache.james.mailbox.store.StoreSubscriptionManager; +import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.extension.ExtendWith; import org.junit.jupiter.api.extension.RegisterExtension; @@ -54,13 +55,20 @@ import org.junit.jupiter.api.extension.RegisterExtension; * Test Cassandra subscription against some general purpose written code. */ @ExtendWith(CassandraRestartExtension.class) -class CassandraSubscriptionManagerTest extends AbstractSubscriptionManagerTest { +class CassandraSubscriptionManagerTest implements SubscriptionManagerContract { @RegisterExtension static CassandraClusterExtension cassandraCluster = new CassandraClusterExtension(CassandraSubscriptionModule.MODULE); + private SubscriptionManager subscriptionManager; + @Override - protected SubscriptionManager createSubscriptionManager() { + public SubscriptionManager getSubscriptionManager() { + return subscriptionManager; + } + + @BeforeEach + void setUp() { CassandraMessageIdToImapUidDAO imapUidDAO = null; CassandraMessageDAO messageDAO = null; CassandraMessageIdDAO messageIdDAO = null; @@ -81,7 +89,8 @@ class CassandraSubscriptionManagerTest extends AbstractSubscriptionManagerTest { BlobStore blobStore = null; CassandraUidProvider uidProvider = null; CassandraModSeqProvider modSeqProvider = null; - return new StoreSubscriptionManager( + + subscriptionManager = new StoreSubscriptionManager( new CassandraMailboxSessionMapperFactory( uidProvider, modSeqProvider, diff --git a/mailbox/jpa/src/test/java/org/apache/james/mailbox/jpa/JPASubscriptionManagerTest.java b/mailbox/jpa/src/test/java/org/apache/james/mailbox/jpa/JPASubscriptionManagerTest.java index 7b84db4..d799321 100644 --- a/mailbox/jpa/src/test/java/org/apache/james/mailbox/jpa/JPASubscriptionManagerTest.java +++ b/mailbox/jpa/src/test/java/org/apache/james/mailbox/jpa/JPASubscriptionManagerTest.java @@ -21,28 +21,38 @@ package org.apache.james.mailbox.jpa; import javax.persistence.EntityManagerFactory; import org.apache.james.backends.jpa.JpaTestCluster; -import org.apache.james.mailbox.AbstractSubscriptionManagerTest; import org.apache.james.mailbox.SubscriptionManager; +import org.apache.james.mailbox.SubscriptionManagerContract; import org.apache.james.mailbox.jpa.mail.JPAModSeqProvider; import org.apache.james.mailbox.jpa.mail.JPAUidProvider; import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; -class JPASubscriptionManagerTest extends AbstractSubscriptionManagerTest { +class JPASubscriptionManagerTest implements SubscriptionManagerContract { private static final JpaTestCluster JPA_TEST_CLUSTER = JpaTestCluster.create(JPAMailboxFixture.MAILBOX_PERSISTANCE_CLASSES); - + + private SubscriptionManager subscriptionManager; + @Override - protected SubscriptionManager createSubscriptionManager() { + public SubscriptionManager getSubscriptionManager() { + return subscriptionManager; + } + + @BeforeEach + void setUp() { EntityManagerFactory entityManagerFactory = JPA_TEST_CLUSTER.getEntityManagerFactory(); - JPAMailboxSessionMapperFactory mf = new JPAMailboxSessionMapperFactory(entityManagerFactory, + + JPAMailboxSessionMapperFactory mapperFactory = new JPAMailboxSessionMapperFactory(entityManagerFactory, new JPAUidProvider(entityManagerFactory), new JPAModSeqProvider(entityManagerFactory)); - return new JPASubscriptionManager(mf); + subscriptionManager = new JPASubscriptionManager(mapperFactory); } @AfterEach void close() { JPA_TEST_CLUSTER.clear(JPAMailboxFixture.MAILBOX_TABLE_NAMES); } + } diff --git a/mailbox/maildir/src/test/java/org/apache/james/mailbox/maildir/MaildirSubscriptionManagerTest.java b/mailbox/maildir/src/test/java/org/apache/james/mailbox/maildir/MaildirSubscriptionManagerTest.java index 48e4664..474ad74 100644 --- a/mailbox/maildir/src/test/java/org/apache/james/mailbox/maildir/MaildirSubscriptionManagerTest.java +++ b/mailbox/maildir/src/test/java/org/apache/james/mailbox/maildir/MaildirSubscriptionManagerTest.java @@ -20,22 +20,38 @@ package org.apache.james.mailbox.maildir; import java.io.File; -import org.apache.james.mailbox.AbstractSubscriptionManagerTest; import org.apache.james.mailbox.SubscriptionManager; +import org.apache.james.mailbox.SubscriptionManagerContract; +import org.apache.james.mailbox.exception.SubscriptionException; import org.apache.james.mailbox.store.JVMMailboxPathLocker; import org.apache.james.mailbox.store.StoreSubscriptionManager; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.io.TempDir; -class MaildirSubscriptionManagerTest extends AbstractSubscriptionManagerTest { +class MaildirSubscriptionManagerTest implements SubscriptionManagerContract { @TempDir File tmpFolder; - + + private SubscriptionManager subscriptionManager; + @Override - protected SubscriptionManager createSubscriptionManager() { + public SubscriptionManager getSubscriptionManager() { + return subscriptionManager; + } + + @BeforeEach + void setUp() { MaildirStore store = new MaildirStore(tmpFolder + "/Maildir/%domain/%user", new JVMMailboxPathLocker()); MaildirMailboxSessionMapperFactory factory = new MaildirMailboxSessionMapperFactory(store); - return new StoreSubscriptionManager(factory); + + subscriptionManager = new StoreSubscriptionManager(factory); } + @AfterEach + void tearDown() throws SubscriptionException { + subscriptionManager.unsubscribe(SESSION, MAILBOX1); + subscriptionManager.unsubscribe(SESSION, MAILBOX2); + } } --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
