com.liferay.portal.test.mail.MailServiceTestUtil.java Source code

Introduction

Here is the source code for com.liferay.portal.test.mail.MailServiceTestUtil.java

Source

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portal.test.mail;

import com.dumbster.smtp.SmtpServer;
import com.dumbster.smtp.SmtpServerFactory;
import com.dumbster.smtp.mailstores.RollingMailStore;

import com.liferay.mail.kernel.service.MailServiceUtil;
import com.liferay.portal.kernel.service.PortalPreferencesLocalServiceUtil;
import com.liferay.portal.kernel.test.ReflectionTestUtil;
import com.liferay.portal.kernel.util.PortletKeys;
import com.liferay.portal.kernel.util.PropsKeys;
import com.liferay.portal.kernel.util.PropsUtil;
import com.liferay.portal.kernel.util.SocketUtil;
import com.liferay.portal.test.mail.impl.MailMessageImpl;

import java.io.IOException;

import java.net.InetAddress;
import java.net.ServerSocket;
import java.net.SocketException;

import java.nio.channels.ServerSocketChannel;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.portlet.PortletPreferences;
import javax.portlet.ReadOnlyException;

/**
 * @author Adam Brandizzi
 */
public class MailServiceTestUtil {

    public static void clearMessages() {
        _smtpServer.clearMessages();
    }

    public static int getInboxSize() {
        return _smtpServer.getEmailCount();
    }

    public static MailMessage getLastMailMessage() {
        com.dumbster.smtp.MailMessage[] mailMessages = _smtpServer.getMessages();

        if (mailMessages.length > 0) {
            return new MailMessageImpl(mailMessages[mailMessages.length - 1]);
        }

        throw new IndexOutOfBoundsException("There are no messages in the inbox");
    }

    public static List<MailMessage> getMailMessages(String headerName, String headerValue) {

        List<com.dumbster.smtp.MailMessage> mailMessages = new ArrayList<>();

        for (com.dumbster.smtp.MailMessage mailMessage : _smtpServer.getMessages()) {

            if (headerName.equals("Body")) {
                String body = mailMessage.getBody();

                if (body.equals(headerValue)) {
                    mailMessages.add(mailMessage);
                }
            } else {
                String messageHeaderValue = mailMessage.getFirstHeaderValue(headerName);

                if (messageHeaderValue.equals(headerValue)) {
                    mailMessages.add(mailMessage);
                }
            }
        }

        return _wrapMailMessages(mailMessages);
    }

    public static boolean lastMailMessageContains(String text) {
        MailMessage mailMessage = getLastMailMessage();

        String bodyMailMessage = mailMessage.getBody();

        return bodyMailMessage.contains(text);
    }

    public static void start() throws Exception {
        if (_smtpServer != null) {
            throw new IllegalStateException("Server is already running");
        }

        int smtpPort = _getFreePort();

        _prefsPropsTemporarySwapper = new PrefsPropsTemporarySwapper(PropsKeys.MAIL_SESSION_MAIL_SMTP_PORT,
                smtpPort, PropsKeys.MAIL_SESSION_MAIL, true);

        _smtpServer = new SmtpServer();

        _smtpServer.setMailStore(new RollingMailStore() {

            @Override
            public void addMessage(com.dumbster.smtp.MailMessage message) {
                try {
                    List<com.dumbster.smtp.MailMessage> receivedMail = ReflectionTestUtil.getFieldValue(this,
                            "receivedMail");

                    receivedMail.add(message);

                    if (getEmailCount() > 100) {
                        receivedMail.remove(0);
                    }
                } catch (Exception e) {
                    throw new RuntimeException(e);
                }
            }

        });
        _smtpServer.setPort(smtpPort);

        _smtpServer.setThreaded(false);

        ReflectionTestUtil.invoke(SmtpServerFactory.class, "startServerThread", new Class<?>[] { SmtpServer.class },
                _smtpServer);

        MailServiceUtil.clearSession();
    }

    public static void stop() throws Exception {
        if ((_smtpServer != null) && _smtpServer.isStopped()) {
            throw new IllegalStateException("Server is already stopped");
        }

        _smtpServer.stop();

        _smtpServer = null;

        _prefsPropsTemporarySwapper.close();

        MailServiceUtil.clearSession();
    }

    private static int _getFreePort() throws IOException {
        try (ServerSocketChannel serverSocketChannel = SocketUtil.createServerSocketChannel(
                InetAddress.getLocalHost(), _START_PORT, new SocketUtil.ServerSocketConfigurator() {

                    @Override
                    public void configure(ServerSocket serverSocket) throws SocketException {

                        serverSocket.setReuseAddress(true);
                    }

                })) {

            ServerSocket serverSocket = serverSocketChannel.socket();

            return serverSocket.getLocalPort();
        }
    }

    private static List<MailMessage> _wrapMailMessages(List<com.dumbster.smtp.MailMessage> mailMessages) {

        List<MailMessage> wrappedMailMessages = new ArrayList<>();

        for (com.dumbster.smtp.MailMessage mailMessage : mailMessages) {
            wrappedMailMessages.add(new MailMessageImpl(mailMessage));
        }

        return wrappedMailMessages;
    }

    private static final int _START_PORT = 3241;

    private static PrefsPropsTemporarySwapper _prefsPropsTemporarySwapper;
    private static SmtpServer _smtpServer;

    private static class PrefsPropsTemporarySwapper implements AutoCloseable {

        public PrefsPropsTemporarySwapper(String firstKey, Object firstValue, Object... keysAndValues)
                throws Exception {

            PortletPreferences portletPreferences = PortalPreferencesLocalServiceUtil.getPreferences(0,
                    PortletKeys.PREFS_OWNER_TYPE_COMPANY);

            _setTemporaryValue(portletPreferences, firstKey, String.valueOf(firstValue));

            for (int i = 0; i < keysAndValues.length; i += 2) {
                String key = String.valueOf(keysAndValues[i]);
                String value = String.valueOf(keysAndValues[i + 1]);

                _setTemporaryValue(portletPreferences, key, value);
            }

            portletPreferences.store();
        }

        @Override
        public void close() throws Exception {
            PortletPreferences portletPreferences = PortalPreferencesLocalServiceUtil.getPreferences(0,
                    PortletKeys.PREFS_OWNER_TYPE_COMPANY);

            for (Map.Entry<String, String> entry : _oldValues.entrySet()) {
                portletPreferences.setValue(entry.getKey(), entry.getValue());
            }

            portletPreferences.store();
        }

        private void _setTemporaryValue(PortletPreferences portletPreferences, String key, String value)
                throws ReadOnlyException {

            PortletPreferences preferences = PortalPreferencesLocalServiceUtil.getPreferences(0,
                    PortletKeys.PREFS_OWNER_TYPE_COMPANY);

            _oldValues.put(key, preferences.getValue(key, PropsUtil.get(key)));

            portletPreferences.setValue(key, value);
        }

        private final Map<String, String> _oldValues = new HashMap<>();

    }

}