software.xdev.mockserver.lifecycle.LifeCycle Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of server Show documentation
Show all versions of server Show documentation
MockServer NeoLight Netty Server
/*
* Copyright © 2024 XDEV Software (https://xdev.software)
*
* 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 software.xdev.mockserver.lifecycle;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
import static java.util.concurrent.TimeUnit.SECONDS;
import static software.xdev.mockserver.configuration.ServerConfiguration.configuration;
import static software.xdev.mockserver.mock.HttpState.setPort;
import static software.xdev.mockserver.util.StringUtils.isBlank;
import java.net.InetSocketAddress;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.Channel;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelFutureListener;
import io.netty.channel.ChannelOutboundInvoker;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import software.xdev.mockserver.configuration.ServerConfiguration;
import software.xdev.mockserver.mock.HttpState;
import software.xdev.mockserver.mock.listeners.MockServerMatcherNotifier;
import software.xdev.mockserver.scheduler.Scheduler;
import software.xdev.mockserver.scheduler.SchedulerThreadFactory;
import software.xdev.mockserver.stop.Stoppable;
public abstract class LifeCycle implements Stoppable
{
private static final Logger LOG = LoggerFactory.getLogger(LifeCycle.class);
protected final EventLoopGroup bossGroup;
protected final EventLoopGroup workerGroup;
protected final HttpState httpState;
private final ServerConfiguration configuration;
protected ServerBootstrap serverServerBootstrap;
private final List> serverChannelFutures = new ArrayList<>();
private final CompletableFuture stopFuture = new CompletableFuture<>();
private final AtomicBoolean stopping = new AtomicBoolean(false);
private final Scheduler scheduler;
protected LifeCycle(final ServerConfiguration configuration)
{
this.configuration = configuration != null ? configuration : configuration();
this.bossGroup =
new NioEventLoopGroup(5, new SchedulerThreadFactory(this.getClass().getSimpleName() + "-bossEventLoop"));
this.workerGroup = new NioEventLoopGroup(
this.configuration.nioEventLoopThreadCount(),
new SchedulerThreadFactory(this.getClass().getSimpleName() + "-workerEventLoop"));
this.scheduler = new Scheduler(this.configuration);
this.httpState = new HttpState(this.configuration, this.scheduler);
}
@SuppressWarnings("PMD.CognitiveComplexity")
public CompletableFuture stopAsync()
{
if(!this.stopFuture.isDone() && this.stopping.compareAndSet(false, true))
{
final String message = "stopped for port" + (this.getLocalPorts().size() == 1
? ": " + this.getLocalPorts().get(0)
: "s: " + this.getLocalPorts());
if(LOG.isInfoEnabled())
{
LOG.info(message);
}
new SchedulerThreadFactory("Stop").newThread(() -> {
final List collect = this.serverChannelFutures
.stream()
.flatMap(channelFuture -> {
try
{
return Stream.of(channelFuture.get());
}
catch(final Exception ex)
{
// ignore
return Stream.empty();
}
})
.map(ChannelOutboundInvoker::disconnect)
.collect(Collectors.toList());
try
{
for(final ChannelFuture channelFuture : collect)
{
channelFuture.get();
}
}
catch(final Exception ex)
{
// ignore
}
this.httpState.stop();
this.scheduler.shutdown();
// Shut down all event loops to terminate all threads.
this.bossGroup.shutdownGracefully(5, 5, MILLISECONDS);
this.workerGroup.shutdownGracefully(5, 5, MILLISECONDS);
// Wait until all threads are terminated.
this.bossGroup.terminationFuture().syncUninterruptibly();
this.workerGroup.terminationFuture().syncUninterruptibly();
this.stopFuture.complete(message);
}).start();
}
return this.stopFuture;
}
@Override
public void stop()
{
try
{
this.stopAsync().get(10, SECONDS);
}
catch(final Exception ex)
{
if(LOG.isDebugEnabled())
{
LOG.debug("Exception while stopping", ex);
}
}
}
@Override
public void close()
{
this.stop();
}
protected EventLoopGroup getEventLoopGroup()
{
return this.workerGroup;
}
public Scheduler getScheduler()
{
return this.scheduler;
}
public boolean isRunning()
{
return !this.bossGroup.isShuttingDown() || !this.workerGroup.isShuttingDown();
}
public List getLocalPorts()
{
return this.getBoundPorts(this.serverChannelFutures);
}
public int getLocalPort()
{
return this.getFirstBoundPort(this.serverChannelFutures);
}
@SuppressWarnings("checkstyle:MagicNumber")
private Integer getFirstBoundPort(final List> channelFutures)
{
for(final Future channelOpened : channelFutures)
{
try
{
return ((InetSocketAddress)channelOpened.get(15, SECONDS).localAddress()).getPort();
}
catch(final Exception ex)
{
if(LOG.isWarnEnabled())
{
LOG.warn(
"Exception while retrieving port from channel future, ignoring port for this channel",
ex);
}
}
}
return -1;
}
private List getBoundPorts(final List> channelFutures)
{
final List ports = new ArrayList<>();
for(final Future channelOpened : channelFutures)
{
try
{
ports.add(((InetSocketAddress)channelOpened.get(3, SECONDS).localAddress()).getPort());
}
catch(final Exception e)
{
if(LOG.isDebugEnabled())
{
LOG.debug(
"Exception while retrieving port from channel future, ignoring port for this channel",
e);
}
}
}
return ports;
}
public List bindServerPorts(final List requestedPortBindings)
{
return this.bindPorts(this.serverServerBootstrap, requestedPortBindings, this.serverChannelFutures);
}
@SuppressWarnings({"PMD.CognitiveComplexity", "PMD.PreserveStackTrace"})
private List bindPorts(
final ServerBootstrap serverBootstrap,
final List requestedPortBindings,
final List> channelFutures)
{
final List actualPortBindings = new ArrayList<>();
final String localBoundIP = this.configuration.localBoundIP();
for(final Integer portToBind : requestedPortBindings)
{
try
{
final CompletableFuture channelOpened = new CompletableFuture<>();
channelFutures.add(channelOpened);
new SchedulerThreadFactory("MockServer thread for port: " + portToBind, false).newThread(() -> {
try
{
final InetSocketAddress inetSocketAddress;
if(isBlank(localBoundIP))
{
inetSocketAddress = new InetSocketAddress(portToBind);
}
else
{
inetSocketAddress = new InetSocketAddress(localBoundIP, portToBind);
}
serverBootstrap
.bind(inetSocketAddress)
.addListener((ChannelFutureListener)future -> {
if(future.isSuccess())
{
channelOpened.complete(future.channel());
}
else
{
channelOpened.completeExceptionally(future.cause());
}
})
.channel().closeFuture().syncUninterruptibly();
}
catch(final Exception e)
{
channelOpened.completeExceptionally(new RuntimeException(
"Exception while binding MockServer to port " + portToBind,
e));
}
}).start();
actualPortBindings.add(((InetSocketAddress)channelOpened.get(
this.configuration.maxFutureTimeoutInMillis(),
MILLISECONDS).localAddress()).getPort());
}
catch(final Exception e)
{
throw new RuntimeException(
"Exception while binding MockServer to port " + portToBind,
e instanceof ExecutionException ? e.getCause() : e);
}
}
return actualPortBindings;
}
protected void startedServer(final List ports)
{
setPort(ports);
if(LOG.isInfoEnabled())
{
LOG.info(
"started on port{}",
ports.size() == 1 ? ": " + ports.get(0) : "s: " + ports);
}
}
public LifeCycle registerListener(final ExpectationsListener expectationsListener)
{
this.httpState.getRequestMatchers().registerListener((requestMatchers, cause) -> {
if(cause == MockServerMatcherNotifier.Cause.API)
{
expectationsListener.updated(requestMatchers.retrieveActiveExpectations(null));
}
});
return this;
}
}