Added a friendlier error message on failing to send test email.

arvindsv · varshavaradarajan · commit d05746b57a1b · 2016-07-26T11:52:51.000+05:30
diff --git a/server/src/com/thoughtworks/go/config/BackgroundMailSender.java b/server/src/com/thoughtworks/go/config/BackgroundMailSender.java
@@ -1,36 +1,37 @@
-/*************************GO-LICENSE-START*********************************
- * Copyright 2014 ThoughtWorks, Inc.
+/*
+ * Copyright 2016 ThoughtWorks, Inc.
  *
  * Licensed 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
+ *     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.
- *************************GO-LICENSE-END***********************************/
+ */
 
 package com.thoughtworks.go.config;
 
 import com.thoughtworks.go.domain.materials.ValidationBean;
 import com.thoughtworks.go.server.messaging.SendEmailMessage;
 import com.thoughtworks.go.util.GoConstants;
 import com.thoughtworks.go.util.SystemEnvironment;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 
 public class BackgroundMailSender implements GoMailSender {
+    private static final Log LOGGER = LogFactory.getLog(BackgroundMailSender.class);
 
     private static final Integer CRUISE_MAIL_SENDER_TIMEOUT = Integer.parseInt(
             SystemEnvironment.getProperty("cruise.mail.sender.timeout", String.valueOf(GoConstants.DEFAULT_TIMEOUT)));
 
     private ValidationBean validation;
     private GoMailSender mailSender;
     private int timeout;
-    private static final String ERROR_MESSAGE = "Timeout when sending email."
-            + " Make sure your host, port, username, password and tls configuration are correct";
 
     public BackgroundMailSender(GoMailSender sender) {
         this(sender, CRUISE_MAIL_SENDER_TIMEOUT);
@@ -60,13 +61,12 @@ private ValidationBean execute(Runnable action) {
             thread.join(timeout);
             if (thread.isAlive()) {
                 thread.interrupt();
-                return ValidationBean.notValid(
-                        ERROR_MESSAGE);
+                return ValidationBean.notValid(ERROR_MESSAGE);
             }
             return validation;
         } catch (InterruptedException e) {
-            return ValidationBean.notValid(
-                    ERROR_MESSAGE);
+            LOGGER.error("Timed out when sending an email. Please check email configuration.");
+            return ValidationBean.notValid(ERROR_MESSAGE);
         }
     }
 
diff --git a/server/src/com/thoughtworks/go/config/GoMailSender.java b/server/src/com/thoughtworks/go/config/GoMailSender.java
@@ -1,25 +1,26 @@
-/*************************GO-LICENSE-START*********************************
- * Copyright 2014 ThoughtWorks, Inc.
+/*
+ * Copyright 2016 ThoughtWorks, Inc.
  *
  * Licensed 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
+ *     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.
- *************************GO-LICENSE-END***********************************/
+ */
 
 package com.thoughtworks.go.config;
 
 import com.thoughtworks.go.domain.materials.ValidationBean;
 import com.thoughtworks.go.server.messaging.SendEmailMessage;
 
 public interface GoMailSender {
+    String ERROR_MESSAGE = "Failed to send an email. Please check the GoCD server logs for any extra information that might be present.";
 
     ValidationBean send(String subject, String body, String to);
 
diff --git a/server/src/com/thoughtworks/go/config/GoSmtpMailSender.java b/server/src/com/thoughtworks/go/config/GoSmtpMailSender.java
@@ -1,18 +1,18 @@
-/*************************GO-LICENSE-START*********************************
- * Copyright 2014 ThoughtWorks, Inc.
+/*
+ * Copyright 2016 ThoughtWorks, Inc.
  *
  * Licensed 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
+ *     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.
- *************************GO-LICENSE-END***********************************/
+ */
 
 package com.thoughtworks.go.config;
 
@@ -90,18 +90,9 @@ public ValidationBean send(String subject, String body, String to) {
             MimeMessage msg = session.createMessage(from, to, subject, body);
             transport.sendMessage(msg, msg.getRecipients(TO));
             return ValidationBean.valid();
-        } catch (AuthenticationFailedException e) {
-            LOGGER.error(String.format("Sending failed for email [%s] to [%s]", subject, to), e);
-            return ValidationBean.notValid("Failed to send the email. Caused by: Authentication failed");
-        } catch (NoSuchProviderException e) {
-            LOGGER.error(String.format("Sending failed for email [%s] to [%s]", subject, to), e);
-            return ValidationBean.notValid("Failed to send the email. Caused by: " + e.getMessage());
-        } catch (MessagingException e) {
-            LOGGER.error(String.format("Sending failed for email [%s] to [%s]", subject, to), e);
-            return ValidationBean.notValid("Failed to send the email. Caused by: " + e.getMessage());
         } catch (Exception e) {
             LOGGER.error(String.format("Sending failed for email [%s] to [%s]", subject, to), e);
-            return ValidationBean.notValid("Failed to send the email. Caused by: " + e.getMessage());
+            return ValidationBean.notValid(ERROR_MESSAGE);
         } finally {
             if (transport != null) {
                 try {
diff --git a/server/test/unit/com/thoughtworks/go/config/BackgroundEmailSenderTest.java b/server/test/unit/com/thoughtworks/go/config/BackgroundEmailSenderTest.java
@@ -1,18 +1,18 @@
-/*************************GO-LICENSE-START*********************************
- * Copyright 2014 ThoughtWorks, Inc.
+/*
+ * Copyright 2016 ThoughtWorks, Inc.
  *
  * Licensed 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
+ *     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.
- *************************GO-LICENSE-END***********************************/
+ */
 
 package com.thoughtworks.go.config;
 
@@ -61,7 +61,7 @@ public void shouldReturnNotValidIfSendingTimesout() {
         BackgroundMailSender background = new BackgroundMailSender(neverReturns, 1);
         ValidationBean validationBean = background.send("Subject", "body", "to@someone");
         assertThat(validationBean.isValid(), is(false));
-        assertThat(validationBean.getError(), containsString("Timeout when sending email"));
+        assertThat(validationBean.getError(), containsString("Failed to send an email. Please check the GoCD server logs for any extra information that might be present."));
     }
 
     @Test
diff --git a/server/webapp/localize.xml b/server/webapp/localize.xml
@@ -241,7 +241,7 @@
     <entry key="INVALID_ADMIN_ADDRESS">Admin address is not a valid email address.</entry>
     <entry key="INVALID_EMAIL">Not a valid email address.</entry>
     <entry key="VALID_VALUE">Valid</entry>
-    <entry key="FAILED_TO_SEND_TEST_MAIL">Failed to send test mail because: {0}</entry>
+    <entry key="FAILED_TO_SEND_TEST_MAIL">Email: {0}</entry>
     <entry key="SENT_TEST_MAIL_SUCCESSFULLY">Sent test email successfully.</entry>
     <entry key="INVALID_TLS">TLS should be selected.</entry>
     <entry key="ADMIN_ADDRESS_REQUIRED">Admin email address is required.</entry>
diff --git a/server/webapp/localize_ja.xml b/server/webapp/localize_ja.xml
@@ -239,7 +239,7 @@
     <entry key="INVALID_ADMIN_ADDRESS">Admin address is not a valid email address.</entry>
     <entry key="INVALID_EMAIL">Not a valid email address.</entry>
     <entry key="VALID_VALUE">Valid</entry>
-    <entry key="FAILED_TO_SEND_TEST_MAIL">Failed to send test mail because: {0}</entry>
+    <entry key="FAILED_TO_SEND_TEST_MAIL">Email: {0}</entry>
     <entry key="SENT_TEST_MAIL_SUCCESSFULLY">Sent test email successfully.</entry>
     <entry key="INVALID_TLS">TLS should be selected.</entry>
     <entry key="ADMIN_ADDRESS_REQUIRED">Admin email address is required.</entry>
