Merge pull request #2617 from joshiste/health-javamail
* health-javamail: Add mail health checkpull/2527/head
Stephane Nicoll
10 years ago
commit
2c0d86f794
@ -0,0 +1,86 @@
|
||||
/*
|
||||
* Copyright 2012-2015 the original author or authors.
|
||||
*
|
||||
* 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
|
||||
*
|
||||
* 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.springframework.boot.actuate.health;
|
||||
|
||||
import javax.mail.MessagingException;
|
||||
import javax.mail.NoSuchProviderException;
|
||||
import javax.mail.Session;
|
||||
import javax.mail.Transport;
|
||||
|
||||
import org.springframework.boot.actuate.health.Health.Builder;
|
||||
import org.springframework.mail.javamail.JavaMailSenderImpl;
|
||||
|
||||
/**
|
||||
* {@link HealthIndicator} for configured smtp server(s).
|
||||
*
|
||||
* @author Johannes Stelzer
|
||||
* @since 1.3.0
|
||||
*/
|
||||
public class MailHealthIndicator extends AbstractHealthIndicator {
|
||||
|
||||
private final JavaMailSenderImpl mailSender;
|
||||
|
||||
public MailHealthIndicator(JavaMailSenderImpl mailSender) {
|
||||
this.mailSender = mailSender;
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void doHealthCheck(Builder builder) throws Exception {
|
||||
String location = String.format("%s:%d", this.mailSender.getHost(), this.mailSender.getPort());
|
||||
builder.withDetail("location", location);
|
||||
|
||||
Transport transport = null;
|
||||
try {
|
||||
transport = connectTransport();
|
||||
builder.up();
|
||||
}
|
||||
finally {
|
||||
if (transport != null) {
|
||||
transport.close();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Copy-paste from JavaMailSenderImpl - see SPR-12799
|
||||
private Transport connectTransport() throws MessagingException {
|
||||
String username = this.mailSender.getUsername();
|
||||
String password = this.mailSender.getPassword();
|
||||
if ("".equals(username)) {
|
||||
username = null;
|
||||
if ("".equals(password)) {
|
||||
password = null;
|
||||
}
|
||||
}
|
||||
|
||||
Transport transport = getTransport(this.mailSender.getSession());
|
||||
transport.connect(this.mailSender.getHost(), this.mailSender.getPort(), username,
|
||||
password);
|
||||
return transport;
|
||||
}
|
||||
|
||||
private Transport getTransport(Session session) throws NoSuchProviderException {
|
||||
String protocol = this.mailSender.getProtocol();
|
||||
if (protocol == null) {
|
||||
protocol = session.getProperty("mail.transport.protocol");
|
||||
if (protocol == null) {
|
||||
protocol = JavaMailSenderImpl.DEFAULT_PROTOCOL;
|
||||
}
|
||||
}
|
||||
return session.getTransport(protocol);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,138 @@
|
||||
/*
|
||||
* Copyright 2012-2015 the original author or authors.
|
||||
*
|
||||
* 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
|
||||
*
|
||||
* 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.springframework.boot.actuate.health;
|
||||
|
||||
import java.util.Properties;
|
||||
|
||||
import javax.mail.Address;
|
||||
import javax.mail.Message;
|
||||
import javax.mail.MessagingException;
|
||||
import javax.mail.Provider;
|
||||
import javax.mail.Provider.Type;
|
||||
import javax.mail.Session;
|
||||
import javax.mail.Transport;
|
||||
import javax.mail.URLName;
|
||||
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
import org.springframework.mail.javamail.JavaMailSenderImpl;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.when;
|
||||
|
||||
/**
|
||||
* Tests for {@link MailHealthIndicator}.
|
||||
*
|
||||
* @author Johannes Stelzer
|
||||
*/
|
||||
public class MailHealthIndicatorTest {
|
||||
|
||||
private JavaMailSenderImpl mailSender;
|
||||
private MailHealthIndicator indicator;
|
||||
|
||||
@Before
|
||||
public void setup() {
|
||||
Session session = Session.getDefaultInstance(new Properties());
|
||||
session.addProvider(new Provider(Type.TRANSPORT, "success",
|
||||
SuccessTransport.class.getName(), "Test", "1.0.0"));
|
||||
|
||||
session.addProvider(new Provider(Type.TRANSPORT, "fail", FailTransport.class
|
||||
.getName(), "Test", "1.0.0"));
|
||||
|
||||
session.addProvider(new Provider(Type.TRANSPORT, "failOnClose",
|
||||
FailOnCloseTransport.class.getName(), "Test", "1.0.0"));
|
||||
|
||||
this.mailSender = mock(JavaMailSenderImpl.class);
|
||||
when(this.mailSender.getHost()).thenReturn("smtp.acme.org");
|
||||
when(this.mailSender.getPort()).thenReturn(25);
|
||||
when(this.mailSender.getSession()).thenReturn(session);
|
||||
|
||||
this.indicator = new MailHealthIndicator(this.mailSender);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void smtpIsUp() {
|
||||
when(this.mailSender.getProtocol()).thenReturn("success");
|
||||
|
||||
Health health = this.indicator.health();
|
||||
|
||||
assertEquals(Status.UP, health.getStatus());
|
||||
assertEquals("smtp.acme.org:25", health.getDetails().get("location"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void smtpIsDown() {
|
||||
when(this.mailSender.getProtocol()).thenReturn("fail");
|
||||
|
||||
Health health = this.indicator.health();
|
||||
|
||||
assertEquals(Status.DOWN, health.getStatus());
|
||||
assertEquals("smtp.acme.org:25", health.getDetails().get("location"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void unexpectedExceptionOnClose() {
|
||||
when(this.mailSender.getProtocol()).thenReturn("failOnClose");
|
||||
|
||||
Health health = this.indicator.health();
|
||||
|
||||
assertEquals(Status.DOWN, health.getStatus());
|
||||
assertEquals("smtp.acme.org:25", health.getDetails().get("location"));
|
||||
}
|
||||
|
||||
public static class SuccessTransport extends Transport {
|
||||
public SuccessTransport(Session session, URLName urlname) {
|
||||
super(session, urlname);
|
||||
}
|
||||
|
||||
@Override
|
||||
public synchronized void connect(String host, int port, String user,
|
||||
String password) throws MessagingException {
|
||||
}
|
||||
|
||||
@Override
|
||||
public void sendMessage(Message msg, Address[] addresses)
|
||||
throws MessagingException {
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
public static class FailTransport extends SuccessTransport {
|
||||
public FailTransport(Session session, URLName urlname) {
|
||||
super(session, urlname);
|
||||
}
|
||||
|
||||
@Override
|
||||
public synchronized void connect(String host, int port, String user,
|
||||
String password) throws MessagingException {
|
||||
throw new MessagingException("fail on connect");
|
||||
}
|
||||
}
|
||||
|
||||
public static class FailOnCloseTransport extends SuccessTransport {
|
||||
public FailOnCloseTransport(Session session, URLName urlname) {
|
||||
super(session, urlname);
|
||||
}
|
||||
|
||||
@Override
|
||||
public synchronized void close() throws MessagingException {
|
||||
throw new MessagingException("fail on close");
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue