io.tapack.satisfy.steps.email.FakeEmailServerRunnerImpl Maven / Gradle / Ivy
/*
* Copyright © 2015 Tapack, and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Research Projects is dual-licensed under the GNU General Public
* License, version 2.0 (GPLv2) and the Tapack Commercial License.
*
* Solely for non-commercial purposes. A purpose is non-commercial only if
* it is in no manner primarily intended for or directed toward commercial
* advantage or private monetary compensation.
*
* This Tapack Software is supplied to you by Tapack in consideration of your
* agreement to the following terms, and your use, installation, modification
* or redistribution of this Tapack Software constitutes acceptance of these
* terms. If you do not agree with these terms, please do not use, install,
* modify or redistribute this Tapack Software.
*
* Neither the name, trademarks, service marks or logos of Tapack may be used
* to endorse or promote products derived from the Tapack Software without
* specific prior written permission from Tapack.
*
* The Tapack Software is provided by Tapack on an "AS IS" basis. TAPACK MAKES NO
* WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
* WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE, REGARDING THE TAPACK SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
* COMBINATION WITH YOUR PRODUCTS.
*
* IN NO EVENT SHALL TAPACK BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
* AND/OR DISTRIBUTION OF THE TAPACK SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
* THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
* OTHERWISE, EVEN IF TAPACK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* A copy of the GNU General Public License is included in the distribution in
* the file LICENSE and at
*
* http://www.gnu.org/licenses/gpl-2.0.html
*
* If you are using the Research Projects for commercial purposes, we
* encourage you to visit
*
* http://products.tapack.io/license
*
* for more details.
*
* This software or hardware and documentation may provide access to
* or information on content, products, and services from third parties.
* Tapack and its affiliates are not responsible for and expressly disclaim
* all warranties of any kind with respect to third-party content, products,
* and services. Tapack and its affiliates will not be responsible for any loss,
* costs, or damages incurred due to your access to or use of third-party
* content, products, or services. If a third-party content exists, the
* additional copyright notices and license terms applicable to portions of the
* software are set forth in the THIRD_PARTY_LICENSE_README file.
*
* Please contact Tapack or visit www.tapack.io if you need additional
* information or have any questions.
*/
package io.tapack.satisfy.steps.email;
import com.icegreen.greenmail.AbstractServer;
import com.icegreen.greenmail.util.GreenMail;
import com.icegreen.greenmail.util.ServerSetup;
import io.tapack.satisfy.email.props.PropertyAccessor;
import io.tapack.satisfy.steps.spi.FakeEmailServerRunner;
import net.thucydides.core.Thucydides;
import org.openqa.selenium.net.PortProber;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;
import java.net.InetSocketAddress;
import java.net.ServerSocket;
public class FakeEmailServerRunnerImpl implements FakeEmailServerRunner {
private static final Logger LOG = LoggerFactory.getLogger(FakeEmailServerRunnerImpl.class);
@Override
public void startAllFakeLocalServers() {
GreenMail greenMail;
try {
greenMail = startGreenMailServers();
} catch (RuntimeException rex) {
LOG.debug("TRY TO START FAKE EMAIL SERVERS AGAIN");
greenMail = startGreenMailServers();
}
logFakesStatus(greenMail);
}
private GreenMail startGreenMailServers() {
ServerSetup[] serverSetups = getServerSetups();
GreenMail greenMail = new GreenMail(serverSetups);
greenMail.setUser(PropertyAccessor.getTestMailBoxLogin(), PropertyAccessor.getTestMailBoxPass());
greenMail.start();
return greenMail;
}
@Override
public boolean accept(String acceptanceParam) {
return acceptanceParam.equalsIgnoreCase("default");
}
private ServerSetup[] getServerSetups() {
ServerSetup smtpSetup = createSetup(PropertyAccessor.getTestSmtpHost(), PropertyAccessor.getTestSmtpPort(), ServerSetup.PROTOCOL_SMTP);
ServerSetup smtpsSetup = createSetup(PropertyAccessor.getTestSmtpSslHost(), PropertyAccessor.getTestSmtpSslPort(), ServerSetup.PROTOCOL_SMTPS);
ServerSetup pop3Setup = createSetup(PropertyAccessor.getTestPop3Host(), PropertyAccessor.getTestPop3Port(), ServerSetup.PROTOCOL_POP3);
ServerSetup pop3sSetup = createSetup(PropertyAccessor.getTestPop3SslHost(), PropertyAccessor.getTestPop3SslPort(), ServerSetup.PROTOCOL_POP3S);
ServerSetup imapSetup = createSetup(PropertyAccessor.getTestImapHost(), PropertyAccessor.getTestImapPort(), ServerSetup.PROTOCOL_IMAP);
ServerSetup imapsSetup = createSetup(PropertyAccessor.getTestImapSslHost(), PropertyAccessor.getTestImapSslPort(), ServerSetup.PROTOCOL_IMAPS);
return new ServerSetup[]{smtpSetup, smtpsSetup, pop3Setup, pop3sSetup, imapSetup, imapsSetup};
}
private ServerSetup createSetup(String host, String port, String serverProtocol) {
int configuredPort = Integer.parseInt(port);
int actualPort = getCheckedAvailablePort(configuredPort, serverProtocol);
if (!(actualPort == configuredPort)) {
saveActualPortToTestSession(serverProtocol, actualPort);
}
return new ServerSetup(actualPort, host, serverProtocol);
}
private void saveActualPortToTestSession(String serverProtocol, int actualPort) {
String portKey = PropertyAccessor.getTestPortPropertyKey(serverProtocol);
Thucydides.getCurrentSession().put(portKey, String.valueOf(actualPort));
LOG.debug("ADDED TO SESSION IS " + portKey + " = " + Thucydides.getCurrentSession().get(portKey));
}
private int getCheckedAvailablePort(int configuredPort, String serverProtocol) {
int actualPort;
if (isAvailablePort(configuredPort)) {
actualPort = configuredPort;
} else {
actualPort = PortProber.findFreePort();
LOG.debug("Configured or default port = " + configuredPort + " for" + serverProtocol.toUpperCase() + " server is not available!!!");
LOG.debug("Founded free port for " + serverProtocol.toUpperCase() + " is " + actualPort);
}
return actualPort;
}
private boolean isAvailablePort(int port) {
ServerSocket socket;
try {
socket = new ServerSocket();
socket.setReuseAddress(true);
socket.bind(new InetSocketAddress("localhost", port));
socket.close();
return true;
} catch (IOException e) {
return false;
}
}
private void logFakesStatus(GreenMail greenMail) {
LOG.debug("----------------FAKE SERVERS STATUS---------------------");
logStatus(greenMail.getSmtp());
logStatus(greenMail.getSmtps());
logStatus(greenMail.getPop3());
logStatus(greenMail.getPop3s());
logStatus(greenMail.getImap());
logStatus(greenMail.getImaps());
LOG.debug("--------------------------------------------------------");
}
private void logStatus(AbstractServer server) {
LOG.debug(server.getProtocol().toUpperCase() + " ---" + getStatus(server.isRunning()) + " ON HOST <" + server.getBindTo() + "> AND PORT <" + server.getPort() + ">");
}
private String getStatus(boolean isRunning) {
return isRunning ? " < IS RUNNING >" : " < IS STOPPED >";
}
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy