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 2020/07/10 01:49:07 UTC

[james-project] 05/09: JAMES-3295 Matcher for permanent error SMTP code

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 45e9324bd3ad2923836ee51594d38e79b5bcc0b2
Author: LanKhuat <kh...@gmail.com>
AuthorDate: Tue Jul 7 11:15:50 2020 +0700

    JAMES-3295 Matcher for permanent error SMTP code
---
 .../matchers/RemoteDeliveryFailedWithSMTPCode.java |  59 +++++++
 .../RemoteDeliveryFailedWithSMTPCodeTest.java      | 173 +++++++++++++++++++++
 2 files changed, 232 insertions(+)

diff --git a/server/mailet/mailets/src/main/java/org/apache/james/transport/matchers/RemoteDeliveryFailedWithSMTPCode.java b/server/mailet/mailets/src/main/java/org/apache/james/transport/matchers/RemoteDeliveryFailedWithSMTPCode.java
new file mode 100644
index 0000000..5fbe8e3
--- /dev/null
+++ b/server/mailet/mailets/src/main/java/org/apache/james/transport/matchers/RemoteDeliveryFailedWithSMTPCode.java
@@ -0,0 +1,59 @@
+/****************************************************************
+ * 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.transport.matchers;
+
+import static org.apache.james.transport.mailets.remote.delivery.Bouncer.DELIVERY_ERROR_CODE;
+
+import java.util.Collection;
+
+import javax.mail.MessagingException;
+
+import org.apache.james.core.MailAddress;
+import org.apache.mailet.AttributeUtils;
+import org.apache.mailet.Mail;
+import org.apache.mailet.base.GenericMatcher;
+import org.apache.mailet.base.MailetUtil;
+
+import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableList;
+
+/**
+ * <p>
+ * Checks the SMTP error code attached to remote delivery failures 
+ * </p>
+ */
+public class RemoteDeliveryFailedWithSMTPCode extends GenericMatcher {
+
+    private Integer errorCode;
+
+    @Override
+    public void init() throws MessagingException {
+        this.errorCode = MailetUtil.getInitParameterAsStrictlyPositiveInteger(getCondition());
+        Preconditions.checkArgument(errorCode >= 101 && errorCode <= 554, "Invalid SMTP code");
+    }
+
+    @Override
+    public Collection<MailAddress> match(Mail mail) {
+        return AttributeUtils.getValueAndCastFromMail(mail, DELIVERY_ERROR_CODE, Integer.class)
+            .filter(errorCode::equals)
+            .map(any -> mail.getRecipients())
+            .orElse(ImmutableList.of());
+    }
+}
diff --git a/server/mailet/mailets/src/test/java/org/apache/james/transport/matchers/RemoteDeliveryFailedWithSMTPCodeTest.java b/server/mailet/mailets/src/test/java/org/apache/james/transport/matchers/RemoteDeliveryFailedWithSMTPCodeTest.java
new file mode 100644
index 0000000..95fea28
--- /dev/null
+++ b/server/mailet/mailets/src/test/java/org/apache/james/transport/matchers/RemoteDeliveryFailedWithSMTPCodeTest.java
@@ -0,0 +1,173 @@
+/****************************************************************
+ * 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.transport.matchers;
+
+import static org.apache.james.transport.mailets.remote.delivery.Bouncer.DELIVERY_ERROR_CODE;
+import static org.apache.mailet.base.MailAddressFixture.RECIPIENT1;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatCode;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+
+import java.util.Collection;
+
+import javax.mail.MessagingException;
+
+import org.apache.james.core.MailAddress;
+import org.apache.mailet.Attribute;
+import org.apache.mailet.AttributeValue;
+import org.apache.mailet.Mail;
+import org.apache.mailet.base.test.FakeMail;
+import org.apache.mailet.base.test.FakeMatcherConfig;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+
+public class RemoteDeliveryFailedWithSMTPCodeTest {
+
+    private static final String CONDITION = "521";
+    public static final int SMTP_ERROR_CODE_521 = 521;
+
+    private RemoteDeliveryFailedWithSMTPCode testee;
+
+    private Mail createMail() throws MessagingException {
+        return FakeMail.builder()
+            .name("test-message")
+            .recipient(RECIPIENT1)
+            .build();
+    }
+
+    @BeforeEach
+    void setUp() throws Exception {
+        testee = new RemoteDeliveryFailedWithSMTPCode();
+
+        FakeMatcherConfig matcherConfig = FakeMatcherConfig.builder()
+            .matcherName("RemoteDeliveryFailedWithSMTPCode")
+            .condition(CONDITION)
+            .build();
+
+        testee.init(matcherConfig);
+    }
+
+    @Test
+    void shouldMatchWhenErrorCodeIsEqual() throws Exception {
+        Mail mail = createMail();
+        mail.setAttribute(new Attribute(DELIVERY_ERROR_CODE, AttributeValue.of(SMTP_ERROR_CODE_521)));
+
+        Collection<MailAddress> actual = testee.match(mail);
+
+        assertThat(actual).containsOnly(RECIPIENT1);
+    }
+
+    @Test
+    void shouldNotMatchWhenErrorCodeIsNotEqual() throws Exception {
+        Mail mail = createMail();
+        mail.setAttribute(new Attribute(DELIVERY_ERROR_CODE, AttributeValue.of(522)));
+
+        Collection<MailAddress> actual = testee.match(mail);
+
+        assertThat(actual).isEmpty();
+    }
+
+    @Test
+    void shouldNotMatchWhenErrorCodeIsMissing() throws Exception {
+        Mail mail = createMail();
+
+        Collection<MailAddress> actual = testee.match(mail);
+
+        assertThat(actual).isEmpty();
+    }
+
+    @Test
+    void shouldNotMatchWhenErrorCodeIsInvalid() throws Exception {
+        Mail mail = createMail();
+        mail.setAttribute(new Attribute(DELIVERY_ERROR_CODE, AttributeValue.of("abc")));
+
+        Collection<MailAddress> actual = testee.match(mail);
+
+        assertThat(actual).isEmpty();
+    }
+
+    @Test
+    void shouldThrowWhenConditionIsEmpty() {
+        FakeMatcherConfig matcherConfig = FakeMatcherConfig.builder()
+            .matcherName("RemoteDeliveryFailedWithSMTPCode")
+            .build();
+
+        assertThatThrownBy(() -> testee.init(matcherConfig))
+            .isInstanceOf(MessagingException.class);
+    }
+
+    @Test
+    void shouldThrowWhenConditionIsInvalid() {
+        FakeMatcherConfig matcherConfig = FakeMatcherConfig.builder()
+            .matcherName("RemoteDeliveryFailedWithSMTPCode")
+            .condition("abc")
+            .build();
+
+        assertThatThrownBy(() -> testee.init(matcherConfig))
+            .isInstanceOf(MessagingException.class);
+    }
+
+    @Test
+    void shouldThrowWhenConditionIsNegative() {
+        FakeMatcherConfig matcherConfig = FakeMatcherConfig.builder()
+            .matcherName("RemoteDeliveryFailedWithSMTPCode")
+            .condition("-1")
+            .build();
+
+        assertThatThrownBy(() -> testee.init(matcherConfig))
+            .isInstanceOf(MessagingException.class);
+    }
+
+    @Test
+    void shouldThrowWhenConditionIsZero() {
+        FakeMatcherConfig matcherConfig = FakeMatcherConfig.builder()
+            .matcherName("RemoteDeliveryFailedWithSMTPCode")
+            .condition("0")
+            .build();
+
+        assertThatThrownBy(() -> testee.init(matcherConfig))
+            .isInstanceOf(MessagingException.class);
+    }
+
+    @ParameterizedTest
+    @ValueSource(strings = {"99", "555"})
+    void shouldThrowWhenInvalidErrorCode(String condition) {
+        FakeMatcherConfig matcherConfig = FakeMatcherConfig.builder()
+            .matcherName("RemoteDeliveryFailedWithSMTPCode")
+            .condition(condition)
+            .build();
+
+        assertThatThrownBy(() -> testee.init(matcherConfig))
+            .isInstanceOf(IllegalArgumentException.class);
+    }
+
+    @ParameterizedTest
+    @ValueSource(strings = {"101", "554"})
+    void shouldNotThrowWhenValidErrorCode(String condition) {
+        FakeMatcherConfig matcherConfig = FakeMatcherConfig.builder()
+            .matcherName("RemoteDeliveryFailedWithSMTPCode")
+            .condition(condition)
+            .build();
+
+        assertThatCode(() -> testee.init(matcherConfig)).doesNotThrowAnyException();
+    }
+}


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