You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by bt...@apache.org on 2019/11/19 02:43:15 UTC

[james-project] 13/43: [Refactoring] Review visibilities in MessageBuilder

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

commit 2dc15629c0f4fcfa183648ec8e0ff4528402c8b1
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Sat Nov 16 12:29:08 2019 +0700

    [Refactoring] Review visibilities in MessageBuilder
---
 .../LuceneMailboxMessageSearchIndexTest.java       | 55 +++++++++++-----------
 .../james/vault/DeletedMessageConverterTest.java   | 47 +++++++++++-------
 .../store/MailboxMessageResultImplTest.java        |  8 ++--
 .../apache/james/mailbox/store/MessageBuilder.java | 37 +++++++++++----
 .../store/SearchUtilsMultipartMixedTest.java       |  2 +-
 .../james/mailbox/store/SearchUtilsRFC822Test.java |  2 +-
 .../james/mailbox/store/SearchUtilsTest.java       | 16 +++----
 .../mail/model/DelegatingMailboxMessageTest.java   |  6 +--
 8 files changed, 103 insertions(+), 70 deletions(-)

diff --git a/mailbox/lucene/src/test/java/org/apache/james/mailbox/lucene/search/LuceneMailboxMessageSearchIndexTest.java b/mailbox/lucene/src/test/java/org/apache/james/mailbox/lucene/search/LuceneMailboxMessageSearchIndexTest.java
index 5b54c2b..3156f23 100644
--- a/mailbox/lucene/src/test/java/org/apache/james/mailbox/lucene/search/LuceneMailboxMessageSearchIndexTest.java
+++ b/mailbox/lucene/src/test/java/org/apache/james/mailbox/lucene/search/LuceneMailboxMessageSearchIndexTest.java
@@ -126,23 +126,23 @@ public class LuceneMailboxMessageSearchIndexTest {
         uid1 = MessageUid.of(1);
         MessageBuilder builder1 = new MessageBuilder()
             .headers(headersSubject)
-            .flags(new Flags(Flag.ANSWERED));
-        builder1.body = "My Body".getBytes(StandardCharsets.UTF_8);
-        builder1.size = 200;
-        builder1.internalDate = new Date();
-        builder1.mailboxId = TEST_ID_1;
-        builder1.uid = uid1;
+            .flags(new Flags(Flag.ANSWERED))
+            .mailboxId(TEST_ID_1)
+            .uid(uid1)
+            .internalDate(new Date())
+            .body("My Body".getBytes(StandardCharsets.UTF_8))
+            .size(200);
         index.add(session, mailbox, builder1.build(id1));
 
         uid2 = MessageUid.of(1);
         MessageBuilder builder2 = new MessageBuilder()
             .headers(headersSubject)
-            .flags(new Flags(Flag.ANSWERED));
-        builder2.body = "My Body".getBytes(StandardCharsets.UTF_8);
-        builder2.size = 20;
-        builder2.internalDate = new Date();
-        builder2.mailboxId = TEST_ID_2;
-        builder2.uid = uid2;
+            .flags(new Flags(Flag.ANSWERED))
+            .mailboxId(TEST_ID_2)
+            .uid(uid2)
+            .internalDate(new Date())
+            .body("My Body".getBytes(StandardCharsets.UTF_8))
+            .size(20);
         index.add(session, mailbox2, builder2.build(id2));
         
         uid3 = MessageUid.of(2);
@@ -150,12 +150,12 @@ public class LuceneMailboxMessageSearchIndexTest {
         cal.set(1980, 2, 10);
         MessageBuilder builder3 = new MessageBuilder()
             .headers(headersTest)
-            .flags(new Flags(Flag.DELETED));
-        builder3.body = "My Otherbody".getBytes(StandardCharsets.UTF_8);
-        builder3.size = 20;
-        builder3.internalDate = cal.getTime();
-        builder3.mailboxId = TEST_ID_1;
-        builder3.uid = uid3;
+            .flags(new Flags(Flag.DELETED))
+            .mailboxId(TEST_ID_1)
+            .uid(uid3)
+            .internalDate(cal.getTime())
+            .body("My Otherbody".getBytes(StandardCharsets.UTF_8))
+            .size(20);
         index.add(session, mailbox, builder3.build(id3));
         
         uid4 = MessageUid.of(3);
@@ -163,12 +163,12 @@ public class LuceneMailboxMessageSearchIndexTest {
         cal2.set(8000, 2, 10);
         MessageBuilder builder4 = new MessageBuilder()
             .headers(headersTestSubject)
-            .flags(new Flags(Flag.DELETED));
-        builder4.body = "My Otherbody2".getBytes(StandardCharsets.UTF_8);
-        builder4.size = 20;
-        builder4.internalDate = cal2.getTime();
-        builder4.mailboxId = TEST_ID_1;
-        builder4.uid = uid4;
+            .flags(new Flags(Flag.DELETED))
+            .mailboxId(TEST_ID_1)
+            .uid(uid4)
+            .internalDate(cal2.getTime())
+            .body("My Otherbody2".getBytes(StandardCharsets.UTF_8))
+            .size(20);
         index.add(session, mailbox, builder4.build(id4));
         
         uid5 = MessageUid.of(10);
@@ -177,10 +177,9 @@ public class LuceneMailboxMessageSearchIndexTest {
         builder.header("To", FROM_ADDRESS);
         builder.header("Subject", "A " + SUBJECT_PART + " Multipart Mail");
         builder.header("Date", "Thu, 14 Feb 2008 12:00:00 +0000 (GMT)");
-        builder.body = StandardCharsets.US_ASCII.encode(BODY).array();
-        builder.uid = uid5;
-        builder.mailboxId = (TestId) mailbox3.getMailboxId();
-        
+        builder.body(StandardCharsets.US_ASCII.encode(BODY).array());
+        builder.uid(uid5);
+        builder.mailboxId(TEST_ID_3);
         index.add(session, mailbox3, builder.build(id5));
 
     }
diff --git a/mailbox/plugin/deleted-messages-vault/src/test/java/org/apache/james/vault/DeletedMessageConverterTest.java b/mailbox/plugin/deleted-messages-vault/src/test/java/org/apache/james/vault/DeletedMessageConverterTest.java
index a3af37b..e22c8e8 100644
--- a/mailbox/plugin/deleted-messages-vault/src/test/java/org/apache/james/vault/DeletedMessageConverterTest.java
+++ b/mailbox/plugin/deleted-messages-vault/src/test/java/org/apache/james/vault/DeletedMessageConverterTest.java
@@ -81,14 +81,13 @@ class DeletedMessageConverterTest {
     private DeletedMessageConverter deletedMessageConverter;
 
     private MessageBuilder getMessageBuilder() {
-        MessageBuilder builder = new MessageBuilder();
-        builder.header(SENDER_FIELD, SENDER.asString());
-        builder.header(FROM_FIELD, "alice@james.com");
-        builder.header(TO_FIELD, RECIPIENT1.asString());
-        builder.header(CC_FIELD, RECIPIENT2.asString());
-        builder.header(SUBJECT_FIELD, SUBJECT);
-        builder.header(DATE_FIELD, "Thu, 30 Oct 2014 14:12:00 +0000 (GMT)");
-        return builder;
+        return new MessageBuilder()
+            .header(SENDER_FIELD, SENDER.asString())
+            .header(FROM_FIELD, "alice@james.com")
+            .header(TO_FIELD, RECIPIENT1.asString())
+            .header(CC_FIELD, RECIPIENT2.asString())
+            .header(SUBJECT_FIELD, SUBJECT)
+            .header(DATE_FIELD, "Thu, 30 Oct 2014 14:12:00 +0000 (GMT)");
     }
 
     private MailboxMessage buildMessage(MessageBuilder messageBuilder, Collection<MessageAttachment> attachments) throws Exception {
@@ -116,8 +115,12 @@ class DeletedMessageConverterTest {
 
     @Test
     void convertShouldReturnCorrespondingDeletedMessageWhenNoDeliveryDateInMimeMessageButInMailboxMessage() throws Exception {
-        MessageBuilder builder = getMessageBuilder();
-        builder.headers.remove(DATE_FIELD);
+        MessageBuilder builder = new MessageBuilder()
+            .header(SENDER_FIELD, SENDER.asString())
+            .header(FROM_FIELD, "alice@james.com")
+            .header(TO_FIELD, RECIPIENT1.asString())
+            .header(CC_FIELD, RECIPIENT2.asString())
+            .header(SUBJECT_FIELD, SUBJECT);
 
         assertThat(deletedMessageConverter.convert(DELETED_MESSAGE_MAILBOX_CONTEXT, buildMessage(builder, NO_ATTACHMENT), DELETION_DATE))
             .isEqualTo(DELETED_MESSAGE_WITH_SUBJECT);
@@ -125,8 +128,12 @@ class DeletedMessageConverterTest {
 
     @Test
     void convertShouldReturnCorrespondingDeletedMessageWhenNoSubject() throws Exception {
-        MessageBuilder builder = getMessageBuilder();
-        builder.headers.remove(SUBJECT_FIELD);
+        MessageBuilder builder = new MessageBuilder()
+            .header(SENDER_FIELD, SENDER.asString())
+            .header(FROM_FIELD, "alice@james.com")
+            .header(TO_FIELD, RECIPIENT1.asString())
+            .header(CC_FIELD, RECIPIENT2.asString())
+            .header(DATE_FIELD, "Thu, 30 Oct 2014 14:12:00 +0000 (GMT)");
 
         assertThat(deletedMessageConverter.convert(DELETED_MESSAGE_MAILBOX_CONTEXT, buildMessage(builder, NO_ATTACHMENT), DELETION_DATE))
             .isEqualTo(DELETED_MESSAGE);
@@ -142,9 +149,11 @@ class DeletedMessageConverterTest {
 
     @Test
     void convertShouldReturnCorrespondingDeletedMessageWhenNoRecipient() throws Exception {
-        MessageBuilder builder = getMessageBuilder();
-        builder.headers.remove(TO_FIELD);
-        builder.headers.remove(CC_FIELD);
+        MessageBuilder builder = new MessageBuilder()
+            .header(SENDER_FIELD, SENDER.asString())
+            .header(FROM_FIELD, "alice@james.com")
+            .header(SUBJECT_FIELD, SUBJECT)
+            .header(DATE_FIELD, "Thu, 30 Oct 2014 14:12:00 +0000 (GMT)");
 
         DeletedMessage deletedMessage = deletedMessageConverter.convert(DELETED_MESSAGE_MAILBOX_CONTEXT, buildMessage(builder, NO_ATTACHMENT), DELETION_DATE);
 
@@ -175,8 +184,12 @@ class DeletedMessageConverterTest {
 
     @Test
     void convertShouldReturnCorrespondingDeletedMessageWhenNoSender() throws Exception {
-        MessageBuilder builder = getMessageBuilder();
-        builder.headers.remove(SENDER_FIELD);
+        MessageBuilder builder = new MessageBuilder()
+            .header(FROM_FIELD, "alice@james.com")
+            .header(TO_FIELD, RECIPIENT1.asString())
+            .header(CC_FIELD, RECIPIENT2.asString())
+            .header(SUBJECT_FIELD, SUBJECT)
+            .header(DATE_FIELD, "Thu, 30 Oct 2014 14:12:00 +0000 (GMT)");
 
         DeletedMessage deletedMessage = deletedMessageConverter.convert(DELETED_MESSAGE_MAILBOX_CONTEXT, buildMessage(builder, NO_ATTACHMENT), DELETION_DATE);
 
diff --git a/mailbox/store/src/test/java/org/apache/james/mailbox/store/MailboxMessageResultImplTest.java b/mailbox/store/src/test/java/org/apache/james/mailbox/store/MailboxMessageResultImplTest.java
index e8baaac..a22bfe4 100644
--- a/mailbox/store/src/test/java/org/apache/james/mailbox/store/MailboxMessageResultImplTest.java
+++ b/mailbox/store/src/test/java/org/apache/james/mailbox/store/MailboxMessageResultImplTest.java
@@ -52,10 +52,10 @@ public class MailboxMessageResultImplTest {
 
 
     private MailboxMessage buildMessage(MessageUid uid, Date aDate) throws Exception {
-        MessageBuilder builder = new MessageBuilder();
-        builder.uid = uid;
-        builder.internalDate = aDate;
-        return builder.build();
+        return new MessageBuilder()
+            .uid(uid)
+            .internalDate(aDate)
+            .build();
     }
 
 
diff --git a/mailbox/store/src/test/java/org/apache/james/mailbox/store/MessageBuilder.java b/mailbox/store/src/test/java/org/apache/james/mailbox/store/MessageBuilder.java
index a100ad6..3c800a5 100644
--- a/mailbox/store/src/test/java/org/apache/james/mailbox/store/MessageBuilder.java
+++ b/mailbox/store/src/test/java/org/apache/james/mailbox/store/MessageBuilder.java
@@ -46,13 +46,33 @@ public class MessageBuilder {
     private static final char[] NEW_LINE = { 0x0D, 0x0A };
     private static final ImmutableList<MessageAttachment> NO_ATTACHMENTS = ImmutableList.of();
 
-    public TestId mailboxId = TestId.of(113);
-    public MessageUid uid = MessageUid.of(776);
-    public Date internalDate = new Date();
-    public int size = 8867;
-    public Flags flags = new Flags();
-    public byte[] body = {};
-    public final Map<String, String> headers = new HashMap<>();
+    private TestId mailboxId = TestId.of(113);
+    private MessageUid uid = MessageUid.of(776);
+    private Date internalDate = new Date();
+    private int size = 8867;
+    private Flags flags = new Flags();
+    private byte[] body = {};
+    private final Map<String, String> headers = new HashMap<>();
+
+    public MessageBuilder mailboxId(TestId testId) {
+        this.mailboxId = testId;
+        return this;
+    }
+
+    public MessageBuilder uid(MessageUid uid) {
+        this.uid = uid;
+        return this;
+    }
+
+    public MessageBuilder internalDate(Date internalDate) {
+        this.internalDate = internalDate;
+        return this;
+    }
+
+    public MessageBuilder body(byte[] body) {
+        this.body = body;
+        return this;
+    }
     
     public MailboxMessage build() throws Exception {
         return build(new DefaultMessageId());
@@ -86,8 +106,9 @@ public class MessageBuilder {
         return this;
     }
 
-    public void header(String field, String value) {
+    public MessageBuilder header(String field, String value) {
         headers.put(field, value);
+        return this;
     }
 
     public MessageBuilder headers(Map<String, String> headers) {
diff --git a/mailbox/store/src/test/java/org/apache/james/mailbox/store/SearchUtilsMultipartMixedTest.java b/mailbox/store/src/test/java/org/apache/james/mailbox/store/SearchUtilsMultipartMixedTest.java
index 0e2b6e4..60482e9 100644
--- a/mailbox/store/src/test/java/org/apache/james/mailbox/store/SearchUtilsMultipartMixedTest.java
+++ b/mailbox/store/src/test/java/org/apache/james/mailbox/store/SearchUtilsMultipartMixedTest.java
@@ -122,7 +122,7 @@ public class SearchUtilsMultipartMixedTest {
         builder.header("Subject", "A Mixed Multipart Mail");
         builder.header("Date", "Thu, 14 Feb 2008 12:00:00 +0000 (GMT)");
         builder.header("Content-Type", "multipart/mixed;boundary=1729");
-        builder.body = Charset.forName("us-ascii").encode(BODY).array();
+        builder.body(Charset.forName("us-ascii").encode(BODY).array());
         row = builder.build();
         recent = new ArrayList<>();
         
diff --git a/mailbox/store/src/test/java/org/apache/james/mailbox/store/SearchUtilsRFC822Test.java b/mailbox/store/src/test/java/org/apache/james/mailbox/store/SearchUtilsRFC822Test.java
index 2752856..f819980 100644
--- a/mailbox/store/src/test/java/org/apache/james/mailbox/store/SearchUtilsRFC822Test.java
+++ b/mailbox/store/src/test/java/org/apache/james/mailbox/store/SearchUtilsRFC822Test.java
@@ -63,7 +63,7 @@ public class SearchUtilsRFC822Test {
         builder.header("To", FROM_ADDRESS);
         builder.header("Subject", "A " + SUBJECT_PART + " Multipart Mail");
         builder.header("Date", "Thu, 14 Feb 2008 12:00:00 +0000 (GMT)");
-        builder.body = Charset.forName("us-ascii").encode(BODY).array();
+        builder.body(Charset.forName("us-ascii").encode(BODY).array());
         row = builder.build();
         
         Iterator<MailboxMessage> messages = null;
diff --git a/mailbox/store/src/test/java/org/apache/james/mailbox/store/SearchUtilsTest.java b/mailbox/store/src/test/java/org/apache/james/mailbox/store/SearchUtilsTest.java
index 5d275d1..ffb7784 100644
--- a/mailbox/store/src/test/java/org/apache/james/mailbox/store/SearchUtilsTest.java
+++ b/mailbox/store/src/test/java/org/apache/james/mailbox/store/SearchUtilsTest.java
@@ -78,8 +78,8 @@ public class SearchUtilsTest {
     @Before
     public void setUp() throws Exception {
         recent = new ArrayList<>();
-        builder = new MessageBuilder();
-        builder.uid = MessageUid.of(1009);
+        builder = new MessageBuilder()
+            .uid(MessageUid.of(1009));
         
         Iterator<MailboxMessage> messages = null;
         SearchQuery query = null; 
@@ -89,7 +89,7 @@ public class SearchUtilsTest {
     
     @Test
     public void testMatchSizeLessThan() throws Exception {
-        builder.size = SIZE;
+        builder.size(SIZE);
         MailboxMessage row = builder.build();
         assertThat(messageSearches.isMatch(SearchQuery.sizeLessThan(SIZE - 1), row,
                 recent)).isFalse();
@@ -103,7 +103,7 @@ public class SearchUtilsTest {
 
     @Test
     public void testMatchSizeMoreThan() throws Exception {
-        builder.size = SIZE;
+        builder.size(SIZE);
         MailboxMessage row = builder.build();
         assertThat(messageSearches.isMatch(SearchQuery.sizeGreaterThan(SIZE - 1), row,
                 recent)).isTrue();
@@ -117,7 +117,7 @@ public class SearchUtilsTest {
 
     @Test
     public void testMatchSizeEquals() throws Exception {
-        builder.size = SIZE;
+        builder.size(SIZE);
         MailboxMessage row = builder.build();
         assertThat(messageSearches.isMatch(SearchQuery.sizeEquals(SIZE - 1), row,
                 recent)).isFalse();
@@ -130,7 +130,7 @@ public class SearchUtilsTest {
 
     @Test
     public void testMatchInternalDateEquals() throws Exception {
-        builder.internalDate = SUN_SEP_9TH_2001;
+        builder.internalDate(SUN_SEP_9TH_2001);
         MailboxMessage row = builder.build();
         assertThat(messageSearches.isMatch(SearchQuery.internalDateOn(getDate(9, 9, 2000), DateResolution.Day),
                 row, recent)).isFalse();
@@ -147,7 +147,7 @@ public class SearchUtilsTest {
     
     @Test
     public void testMatchInternalDateBefore() throws Exception {
-        builder.internalDate = SUN_SEP_9TH_2001;
+        builder.internalDate(SUN_SEP_9TH_2001);
         MailboxMessage row = builder.build();
         assertThat(messageSearches.isMatch(
                 SearchQuery.internalDateBefore(getDate(9, 9, 2000), DateResolution.Day), row, recent)).isFalse();
@@ -163,7 +163,7 @@ public class SearchUtilsTest {
 
     @Test
     public void testMatchInternalDateAfter() throws Exception {
-        builder.internalDate = SUN_SEP_9TH_2001;
+        builder.internalDate(SUN_SEP_9TH_2001);
         MailboxMessage row = builder.build();
         assertThat(messageSearches.isMatch(SearchQuery.internalDateAfter(getDate(9, 9, 2000), DateResolution.Day),
                 row, recent)).isTrue();
diff --git a/mailbox/store/src/test/java/org/apache/james/mailbox/store/mail/model/DelegatingMailboxMessageTest.java b/mailbox/store/src/test/java/org/apache/james/mailbox/store/mail/model/DelegatingMailboxMessageTest.java
index fa60940..567c4e3 100644
--- a/mailbox/store/src/test/java/org/apache/james/mailbox/store/mail/model/DelegatingMailboxMessageTest.java
+++ b/mailbox/store/src/test/java/org/apache/james/mailbox/store/mail/model/DelegatingMailboxMessageTest.java
@@ -36,9 +36,9 @@ public class DelegatingMailboxMessageTest {
     }
 
     private MailboxMessage buildMessage(int uid) throws Exception {
-        MessageBuilder builder = new MessageBuilder();
-        builder.uid = MessageUid.of(uid);
-        return builder.build();
+        return new MessageBuilder()
+            .uid(MessageUid.of(uid))
+            .build();
     }
 
     @Test


---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org