Skip to content

Commit

Permalink
MAILET-104: Ensure RemoveMailAttributes has a good coverage and meet …
Browse files Browse the repository at this point in the history 
…new standards
  • Loading branch information
Quynh Nguyen committed Oct 20, 2016
1 parent 2fda869 commit 665a11a
Show file tree
Hide file tree
Showing 2 changed files with 102 additions and 75 deletions.
62 changes: 26 additions & 36 deletions mailet/standard/src/main/java/org/apache/james/transport/mailets/RemoveMailAttribute.java
View file
Expand Up @@ -21,12 +21,14 @@


package org.apache.james.transport.mailets; package org.apache.james.transport.mailets;


import com.google.common.base.Preconditions;
import com.google.common.base.Splitter;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableList;
import org.apache.mailet.base.GenericMailet; import org.apache.mailet.base.GenericMailet;
import org.apache.mailet.Mail; import org.apache.mailet.Mail;
import org.apache.mailet.MailetException; import org.apache.mailet.MailetException;


import java.util.ArrayList;
import java.util.StringTokenizer;
import javax.mail.MessagingException; import javax.mail.MessagingException;


/** /**
Expand All @@ -44,50 +46,38 @@
* @since 2.2.0 * @since 2.2.0
*/ */
public class RemoveMailAttribute extends GenericMailet { public class RemoveMailAttribute extends GenericMailet {


private final ArrayList<String> attributesToRemove = new ArrayList<String>(); private static final char ATTRIBUTE_SEPARATOR_CHAR = ',';

protected static final String MAILET_NAME_PARAMETER = "name";
/**
* Return a string describing this mailet. private ImmutableList<String> attributesToRemove;
*
* @return a string describing this mailet
*/
public String getMailetInfo() { public String getMailetInfo() {
return "Remove Mail Attribute Mailet"; return "Remove Mail Attribute Mailet";
} }


/** @Override
* Initialize the mailet public void init() throws MailetException {
* String name = getInitParameter(MAILET_NAME_PARAMETER);
* @throws MailetException if the processor parameter is missing
*/
public void init() throws MailetException
{
String name = getInitParameter("name");


if (name != null) { if (Strings.isNullOrEmpty(name)) {
StringTokenizer st = new StringTokenizer(name, ",") ;
while (st.hasMoreTokens()) {
String attribute_name = st.nextToken().trim() ;
attributesToRemove.add(attribute_name);
}
} else {
throw new MailetException("Please configure at least one attribute to remove"); throw new MailetException("Please configure at least one attribute to remove");
} }

attributesToRemove = getAttributes(name);
} }


/** private ImmutableList<String> getAttributes(String name) {
* Remove the configured attributes return ImmutableList.copyOf(Splitter.on(ATTRIBUTE_SEPARATOR_CHAR)
* .trimResults()
* @param mail the mail to process .split(name));
* }
* @throws MessagingException in all cases
*/ @Override
public void service(Mail mail) throws MessagingException { public void service(Mail mail) throws MessagingException {
for (String anAttributesToRemove : attributesToRemove) { Preconditions.checkNotNull(mail);
mail.removeAttribute(anAttributesToRemove); for (String attributeToRemove : attributesToRemove) {
mail.removeAttribute(attributeToRemove);
} }
} }


} }
115 changes: 76 additions & 39 deletions ...et/standard/src/test/java/org/apache/james/transport/mailets/RemoveMailAttributeTest.java
View file
Expand Up @@ -19,69 +19,106 @@


package org.apache.james.transport.mailets; package org.apache.james.transport.mailets;


import static org.assertj.core.api.Assertions.assertThat;
import javax.mail.MessagingException; import javax.mail.MessagingException;


import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import org.apache.mailet.Mail; import org.apache.mailet.Mail;
import org.apache.mailet.Mailet; import org.apache.mailet.Mailet;
import org.apache.mailet.MailetException;
import org.apache.mailet.base.test.FakeMail; import org.apache.mailet.base.test.FakeMail;
import org.apache.mailet.base.test.FakeMailContext; import org.apache.mailet.base.test.FakeMailContext;
import org.apache.mailet.base.test.FakeMailetConfig; import org.apache.mailet.base.test.FakeMailetConfig;
import org.junit.Assert; import org.junit.Before;
import org.junit.Test; import org.junit.Test;


public class RemoveMailAttributeTest { import java.io.Serializable;

public static final String MAIL_ATTRIBUTE_NAME1 = "org.apache.james.test.junit";


public static final String MAIL_ATTRIBUTE_NAME2 = "org.apache.james.test.junit2"; public class RemoveMailAttributeTest {


private Mail createMail() throws MessagingException { private static final String ATTRIBUTE_1 = "attribute1";
return FakeMail.builder() private static final String ATTRIBUTE_2 = "attribute2";
.attribute(MAIL_ATTRIBUTE_NAME1, "true") private static final String ATTRIBUTE_3 = "attribute3";
.attribute(MAIL_ATTRIBUTE_NAME2, "true") private static final String VALUE_1 = "value1";
.build(); private static final String VALUE_2 = "value2";
private static final String VALUE_3 = "value3";
private static final String ATTRIBUTE1_ATTRIBUTE2 = "attribute1, attribute2";
private Mailet removeMailet;
private FakeMailetConfig mailetConfig;

@Before
public void setup() throws Exception {
removeMailet = new RemoveMailAttribute();
mailetConfig = new FakeMailetConfig("Test", FakeMailContext.defaultContext());
} }


private Mailet setupMailet(String attribute) throws MessagingException { @Test
Mailet mailet = new RemoveMailAttribute(); public void getMailetInfoShouldReturnCorrectInformation() throws Exception {
FakeMailetConfig mci = new FakeMailetConfig("Test", assertThat(removeMailet.getMailetInfo()).isEqualTo("Remove Mail Attribute Mailet");
FakeMailContext.defaultContext()); }
if (attribute != null) {
mci.setProperty("name", attribute);
}


mailet.init(mci); @Test(expected = MailetException.class)
return mailet; public void initShouldThrowExceptionIfMailetConfigDoesNotContainAttribute() throws MessagingException {
removeMailet.init(mailetConfig);
} }


@Test(expected = NullPointerException.class)
public void serviceShouldThrowExceptionWithMailNull() throws MessagingException {
removeMailet.service(null);
}


@Test @Test
public void testRemoveMailAttribute() throws MessagingException { public void serviceShouldDoNothingWhenMailHasEmptyAttribute() throws MessagingException {
Mail m = createMail(); mailetConfig.setProperty(RemoveMailAttribute.MAILET_NAME_PARAMETER, ATTRIBUTE1_ATTRIBUTE2);
Mailet mailet = setupMailet(MAIL_ATTRIBUTE_NAME1); removeMailet.init(mailetConfig);

// check if the mail has a attribute
Assert.assertNotNull("Attribute exists", m.getAttribute(MAIL_ATTRIBUTE_NAME1));
Assert.assertNotNull("Attribute exists", m.getAttribute(MAIL_ATTRIBUTE_NAME2));


mailet.service(m); Mail mail = FakeMail.builder().build();
removeMailet.service(mail);


// Check if the attribute was removed assertThat(mail.getAttributeNames()).isEmpty();
Assert.assertNull("Attribute exists", m.getAttribute(MAIL_ATTRIBUTE_NAME1));
Assert.assertNotNull("Attribute deleted", m.getAttribute(MAIL_ATTRIBUTE_NAME2));
} }


@Test
public void serviceShouldDoNothingWhenMailDoNotMatchAttribute() throws MessagingException {
mailetConfig.setProperty(RemoveMailAttribute.MAILET_NAME_PARAMETER, ATTRIBUTE1_ATTRIBUTE2);
removeMailet.init(mailetConfig);

Mail mail = FakeMail.builder()
.attribute(ATTRIBUTE_3, VALUE_3)
.build();
removeMailet.service(mail);

assertThat(mail.getAttributeNames()).containsExactly(ATTRIBUTE_3);
}


@Test @Test
public void testInvalidConfig() throws MessagingException { public void serviceShouldRemoveSpecifiedAttribute() throws MessagingException {
boolean exception = false; mailetConfig.setProperty(RemoveMailAttribute.MAILET_NAME_PARAMETER, ATTRIBUTE_1);
try { removeMailet.init(mailetConfig);
setupMailet(null);
} catch (MessagingException e) { Mail mail = FakeMail.builder()
exception = true; .attribute(ATTRIBUTE_1, VALUE_1)
} .attribute(ATTRIBUTE_2, VALUE_2)

.attribute(ATTRIBUTE_3, VALUE_3)
Assert.assertTrue("invalid Config", exception); .build();
removeMailet.service(mail);

assertThat(mail.getAttributeNames()).containsOnly(ATTRIBUTE_2, ATTRIBUTE_3);
} }


@Test
public void serviceShouldRemoveSpecifiedAttributes() throws MessagingException {
mailetConfig.setProperty(RemoveMailAttribute.MAILET_NAME_PARAMETER, ATTRIBUTE1_ATTRIBUTE2);
removeMailet.init(mailetConfig);

Mail mail = FakeMail.builder()
.attribute(ATTRIBUTE_1, VALUE_1)
.attribute(ATTRIBUTE_2, VALUE_2)
.attribute(ATTRIBUTE_3, VALUE_3)
.build();
removeMailet.service(mail);

assertThat(mail.getAttributeNames()).containsExactly(ATTRIBUTE_3);
}
} }

0 comments on commit 665a11a

Please sign in to comment.