activemq-unit-tests/src/test/java/org/apache/activemq/network/CustomBridgeFactoryTest.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.activemq.network;

import static org.junit.Assert.*;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoMoreInteractions;

import java.util.Arrays;
import java.util.List;
import java.util.concurrent.TimeUnit;
import java.util.function.Supplier;

import org.apache.activemq.command.ActiveMQQueue;
import org.apache.activemq.command.Message;
import org.apache.activemq.transport.Transport;
import org.junit.Ignore;
import org.junit.Test;
import org.mockito.Mockito;

import javax.jms.JMSException;
import javax.jms.MessageConsumer;
import javax.jms.MessageProducer;
import javax.jms.Session;
import javax.jms.TextMessage;

/**
 * Basic test which verify if custom bridge factory receives any interactions when configured.
 */
@Ignore // AMQ-8977 -- can't find class due to xbean or mockito upgrade
public class CustomBridgeFactoryTest extends BaseNetworkTest {

    private ActiveMQQueue outgoing = new ActiveMQQueue("outgoing");

    /**
     * Verification of outgoing communication - from local broker (with customized bridge configured) to remote one.
     */
    @Test(timeout = 60000)
    public void verifyOutgoingCommunication() throws JMSException {
        CustomNetworkBridgeFactory bridgeFactory = getCustomNetworkBridgeFactory();
        NetworkBridgeListener listener = bridgeFactory.getListener();

        verify(listener).onStart(any(NetworkBridge.class));
        verifyNoMoreInteractions(listener);

        send(localSession, outgoing, localSession.createTextMessage("test message"));
        assertNotNull("Message didn't arrive", receive(remoteSession, outgoing));

        verify(listener).onOutboundMessage(any(NetworkBridge.class), any(Message.class));
        verifyNoMoreInteractions(listener);
    }

    /**
     * Additional test which makes sure that custom bridge receives notification about broker shutdown.
     */
    @Test(timeout = 60000)
    public void verifyBrokerShutdown() {
        shutdownTest(() -> {
            try {
                localBroker.stop();
            } catch (Exception e) {
                return e;
            }
            return null;
        });
    }

    /**
     * Verification of network connector shutdown.
     */
    @Test(timeout = 60000)
    public void verifyConnectorShutdown() {
        shutdownTest(() -> {
            try {
                getLocalConnector(0).stop();
            } catch (Exception e) {
                return e;
            }
            return null;
        });
    }

    private void shutdownTest(Supplier<Throwable> callback) {
        CustomNetworkBridgeFactory bridgeFactory = getCustomNetworkBridgeFactory();
        NetworkBridgeListener listener = bridgeFactory.getListener();

        verify(listener).onStart(any(NetworkBridge.class));
        verifyNoMoreInteractions(listener);

        Throwable throwable = callback.get();
        assertNull("Unexpected error", throwable);

        verify(listener).onStop(any(NetworkBridge.class));
        verifyNoMoreInteractions(listener);
    }

    // helper methods
    private void send(Session session, ActiveMQQueue destination, TextMessage message) throws JMSException {
        MessageProducer producer = session.createProducer(destination);
        try {
            producer.send(message);
        } finally {
            producer.close();
        }
    }

    private javax.jms.Message receive(Session session, ActiveMQQueue destination) throws JMSException {
        MessageConsumer consumer = session.createConsumer(destination);
        try {
            return consumer.receive(TimeUnit.SECONDS.toMillis(5));
        } finally {
            consumer.close();
        }
    }

    // infrastructure operations digging for connectors in running broker
    private CustomNetworkBridgeFactory getCustomNetworkBridgeFactory() {
        NetworkConnector connector = getLocalConnector(0);

        assertTrue(connector.getBridgeFactory() instanceof CustomNetworkBridgeFactory);

        return (CustomNetworkBridgeFactory) connector.getBridgeFactory();
    }

    private NetworkConnector getLocalConnector(int index) {
        return localBroker.getNetworkConnectors().get(index);
    }

    // customizations
    protected String getLocalBrokerURI() {
        return "org/apache/activemq/network/localBroker-custom-factory.xml";
    }

    // test classes
    static class CustomNetworkBridgeFactory implements BridgeFactory {

        private final NetworkBridgeListener listener;

        CustomNetworkBridgeFactory() {
            this(Mockito.mock(NetworkBridgeListener.class));
        }

        CustomNetworkBridgeFactory(NetworkBridgeListener listener) {
            this.listener = listener;
        }

        public NetworkBridgeListener getListener() {
            return listener;
        }

        @Override
        public DemandForwardingBridge createNetworkBridge(NetworkBridgeConfiguration configuration, Transport localTransport, Transport remoteTransport, NetworkBridgeListener listener) {
            DemandForwardingBridge bridge = new DemandForwardingBridge(configuration, localTransport, remoteTransport);
            bridge.setNetworkBridgeListener(new CompositeNetworkBridgeListener(this.listener, listener));
            return bridge;
        }

    }

    static class CompositeNetworkBridgeListener implements NetworkBridgeListener {

        private final List<NetworkBridgeListener> listeners;

        public CompositeNetworkBridgeListener(NetworkBridgeListener ... wrapped) {
            this.listeners = Arrays.asList(wrapped);
        }

        @Override
        public void bridgeFailed() {
            for (NetworkBridgeListener listener : listeners) {
                listener.bridgeFailed();
            }
        }

        @Override
        public void onStart(NetworkBridge bridge) {
            for (NetworkBridgeListener listener : listeners) {
                listener.onStart(bridge);
            }
        }

        @Override
        public void onStop(NetworkBridge bridge) {
            for (NetworkBridgeListener listener : listeners) {
                listener.onStop(bridge);
            }
        }

        @Override
        public void onOutboundMessage(NetworkBridge bridge, Message message) {
            for (NetworkBridgeListener listener : listeners) {
                listener.onOutboundMessage(bridge, message);
            }
        }

        @Override
        public void onInboundMessage(NetworkBridge bridge, Message message) {
            for (NetworkBridgeListener listener : listeners) {
                listener.onInboundMessage(bridge, message);
            }
        }
    }

}