/**
 * 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.broker.policy;

import java.util.Iterator;

import jakarta.jms.MessageConsumer;

import org.apache.activemq.broker.BrokerService;
import org.apache.activemq.broker.TopicSubscriptionTest;
import org.apache.activemq.broker.region.policy.PolicyEntry;
import org.apache.activemq.broker.region.policy.PolicyMap;
import org.apache.activemq.broker.region.policy.StrictOrderDispatchPolicy;
import org.apache.activemq.util.MessageIdList;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.BlockJUnit4ClassRunner;

import static org.junit.Assert.*;
import org.apache.activemq.test.annotations.ParallelTest;
import org.junit.experimental.categories.Category;

@RunWith(BlockJUnit4ClassRunner.class)
@Category(ParallelTest.class)
public class StrictOrderDispatchPolicyTest extends TopicSubscriptionTest {

    @Override
    protected BrokerService createBroker() throws Exception {
        BrokerService broker = super.createBroker();

        PolicyEntry policy = new PolicyEntry();
        policy.setDispatchPolicy(new StrictOrderDispatchPolicy());

        PolicyMap pMap = new PolicyMap();
        pMap.setDefaultEntry(policy);

        broker.setDestinationPolicy(pMap);

        return broker;
    }

    @Test
    @Override
    public void testOneProducerTwoConsumersLargeMessagesOnePrefetch() throws Exception {
        super.testOneProducerTwoConsumersLargeMessagesOnePrefetch();

        assertReceivedMessagesAreOrdered();
    }

    @Test
    @Override
    public void testOneProducerTwoConsumersSmallMessagesOnePrefetch() throws Exception {
        super.testOneProducerTwoConsumersSmallMessagesOnePrefetch();

        assertReceivedMessagesAreOrdered();
    }

    @Test
    @Override
    public void testOneProducerTwoConsumersSmallMessagesLargePrefetch() throws Exception {
        super.testOneProducerTwoConsumersSmallMessagesLargePrefetch();

        assertReceivedMessagesAreOrdered();
    }

    @Test
    @Override
    public void testOneProducerTwoConsumersLargeMessagesLargePrefetch() throws Exception {
        super.testOneProducerTwoConsumersLargeMessagesLargePrefetch();

        assertReceivedMessagesAreOrdered();
    }

    @Test
    @Override
    public void testOneProducerManyConsumersFewMessages() throws Exception {
        super.testOneProducerManyConsumersFewMessages();

        assertReceivedMessagesAreOrdered();
    }


    @Test
    @Override
    public void testOneProducerManyConsumersManyMessages() throws Exception {
        super.testOneProducerManyConsumersManyMessages();

        assertReceivedMessagesAreOrdered();
    }

    @Test
    @Override
    public void testManyProducersOneConsumer() throws Exception {
        super.testManyProducersOneConsumer();

        assertReceivedMessagesAreOrdered();
    }

    @Test
    @Override
    public void testManyProducersManyConsumers() throws Exception {
        super.testManyProducersManyConsumers();

        assertReceivedMessagesAreOrdered();
    }

    public void assertReceivedMessagesAreOrdered() throws Exception {
        // If there is only one consumer, messages is definitely ordered
        if (consumers.size() <= 1) {
            return;
        }

        // Get basis of order
        Iterator<MessageConsumer> i = consumers.keySet().iterator();
        MessageIdList messageOrder = (MessageIdList)consumers.get(i.next());

        for (; i.hasNext();) {
            MessageIdList messageIdList = (MessageIdList)consumers.get(i.next());
            assertTrue("Messages are not ordered.", messageOrder.equals(messageIdList));
        }
    }
}
