content: /*
   * 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.artemis.tests.integration.amqp;
  
  import static org.junit.jupiter.api.Assertions.assertEquals;
  import static org.junit.jupiter.api.Assertions.assertNotNull;
  import static org.junit.jupiter.api.Assertions.assertNull;
  import static org.junit.jupiter.api.Assertions.assertTrue;
  
  import java.lang.invoke.MethodHandles;
  import java.util.HashMap;
  
  import javax.jms.Connection;
  import javax.jms.InvalidDestinationException;
  import javax.jms.Message;
  import javax.jms.MessageConsumer;
  import javax.jms.MessageProducer;
  import javax.jms.Session;
  import javax.jms.Topic;
  
  import org.apache.activemq.artemis.api.core.QueueConfiguration;
  import org.apache.activemq.artemis.api.core.RoutingType;
  import org.apache.activemq.artemis.api.core.SimpleString;
  import org.apache.activemq.artemis.api.core.TransportConfiguration;
  import org.apache.activemq.artemis.api.core.client.ServerLocator;
  import org.apache.activemq.artemis.core.postoffice.Binding;
  import org.apache.activemq.artemis.core.postoffice.Bindings;
  import org.apache.activemq.artemis.core.postoffice.impl.LocalQueueBinding;
  import org.apache.activemq.artemis.core.server.ActiveMQServer;
  import org.apache.activemq.artemis.core.server.QueueQueryResult;
  import org.apache.activemq.artemis.core.server.impl.AddressInfo;
  import org.apache.activemq.artemis.core.settings.impl.AddressSettings;
  import org.apache.activemq.artemis.tests.util.Wait;
  import org.apache.activemq.artemis.utils.CompositeAddress;
  import org.junit.jupiter.api.BeforeEach;
  import org.junit.jupiter.api.Test;
  import org.junit.jupiter.api.Timeout;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  public class AmqpFullyQualifiedNameTest extends JMSClientTestSupport {
  
     private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  
     private SimpleString anycastAddress = SimpleString.of("address.anycast");
     private SimpleString multicastAddress = SimpleString.of("address.multicast");
  
     private SimpleString anycastQ1 = SimpleString.of("q1");
     private SimpleString anycastQ2 = SimpleString.of("q2");
     private SimpleString anycastQ3 = SimpleString.of("q3");
  
     private ServerLocator locator;
  
     @Override
     @BeforeEach
     public void setUp() throws Exception {
        super.setUp();
  
        locator = createNettyNonHALocator();
     }
  
     @Override
     protected void addAdditionalAcceptors(ActiveMQServer server) throws Exception {
        server.getConfiguration().addAcceptorConfiguration(new TransportConfiguration(NETTY_ACCEPTOR_FACTORY, new HashMap<>(), "netty", new HashMap<>()));
     }
  
     @Test
     public void testFQQNTopicWhenQueueDoesNotExist() throws Exception {
        server.getAddressSettingsRepository().addMatch("#", new AddressSettings().setAutoCreateQueues(false));
        Exception e = null;
        String queueName = "testQueue";
  
        Connection connection = createConnection(false);
        try {
           connection.setClientID("FQQNconn");
           connection.start();
           Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
           Topic topic = session.createTopic(multicastAddress.toString() + "::" + queueName);
           session.createConsumer(topic);
        } catch (InvalidDestinationException ide) {
           e = ide;
        } finally {
           connection.close();
        }
        assertNotNull(e);
        assertTrue(e.getMessage().contains("Queue: '" + queueName + "' does not exist"));
     }
  
     @Test
     public void testTopicFQQNSendAndConsumeAutoCreate() throws Exception {
        internalTopicFQQNSendAndConsume(true);
     }
  
     @Test
     public void testTopicFQQNSendAndConsumeManualCreate() throws Exception {
        internalTopicFQQNSendAndConsume(false);
     }
  
     private void internalTopicFQQNSendAndConsume(boolean autocreate) throws Exception {
        if (autocreate) {
           server.getAddressSettingsRepository().addMatch("#", new AddressSettings().setAutoCreateAddresses(true).setAutoCreateQueues(true));
        } else {
           server.createQueue(QueueConfiguration.of(anycastQ1).setAddress(multicastAddress).setDurable(false));
        }
  
        try (Connection connection = createConnection(false)) {
           connection.setClientID("FQQNconn");
           connection.start();
           Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
           Topic topic = session.createTopic(CompositeAddress.toFullyQualified(multicastAddress, anycastQ1).toString());
  
           MessageConsumer consumer1 = session.createConsumer(topic);
           MessageConsumer consumer2 = session.createConsumer(topic);
           MessageConsumer consumer3 = session.createConsumer(topic);
  
           MessageProducer producer = session.createProducer(topic);
  
           producer.send(session.createMessage());
  
           //only 1 consumer receives the message as they're all connected to the same FQQN
           Message m = consumer1.receive(2000);
           assertNotNull(m);
           m = consumer2.receiveNoWait();
           assertNull(m);
           m = consumer3.receiveNoWait();
           assertNull(m);
        }
     }
  
     @Test
     public void testConsumeQueueToFQQNWrongQueueAttachedToAnotherAddress() throws Exception {
  
        // Create 2 Queues: address1::queue1, address2::queue2
        String address1 = "a1";
        String address2 = "a2";
        String queue1 = "q1";
        String queue2 = "q2";
  
        server.createQueue(QueueConfiguration.of(queue1).setAddress(address1).setRoutingType(RoutingType.ANYCAST));
        server.createQueue(QueueConfiguration.of(queue2).setAddress(address2).setRoutingType(RoutingType.ANYCAST));
  
        Exception e = null;
  
        // Wrong FQQN.  Attempt to subscribe to a queue belonging to a different address than given in the FQQN.
        String wrongFQQN = address1 + "::"  + queue2;
        Connection connection = createConnection(false);
        try {
           connection.setClientID("FQQNconn");
           connection.start();
           Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
           javax.jms.Queue queue = session.createQueue(wrongFQQN);
           session.createConsumer(queue);
        } catch (InvalidDestinationException ide) {
           e = ide;
        } finally {
           connection.close();
        }
        assertNotNull(e);
        assertTrue(e.getMessage().contains("Queue: '" + queue2 + "' does not exist for address '" + address1 + "'"));
     }
  
     @Test
     public void testSubscribeTopicToFQQNWrongQueueAttachedToAnotherAddress() throws Exception {
  
        // Create 2 Queues: address1::queue1, address2::queue2
        String address1 = "a1";
        String address2 = "a2";
        String queue1 = "q1";
        String queue2 = "q2";
  
        server.createQueue(QueueConfiguration.of(queue1).setAddress(address1));
        server.createQueue(QueueConfiguration.of(queue2).setAddress(address2));
  
        Exception e = null;
  
        // Wrong FQQN.  Attempt to subscribe to a queue belonging to a different address than given in the FQQN.
        String wrongFQQN = address1 + "::"  + queue2;
        Connection connection = createConnection(false);
        try {
           connection.setClientID("FQQNconn");
           connection.start();
           Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
           Topic topic = session.createTopic(wrongFQQN);
           session.createConsumer(topic);
        } catch (InvalidDestinationException ide) {
           e = ide;
        } finally {
           connection.close();
        }
        assertNotNull(e);
        assertTrue(e.getMessage().contains("Queue: '" + queue2 + "' does not exist for address '" + address1 + "'"));
     }
  
     @Test
     @Timeout(60)
     //there isn't much use of FQQN for topics
     //however we can test query functionality
     public void testTopic() throws Exception {
  
        SimpleString queueName = SimpleString.of("someAddress");
        server.createQueue(QueueConfiguration.of(queueName).setAddress(multicastAddress).setDurable(false));
        Connection connection = createConnection(false);
  
        try {
           connection.setClientID("FQQNconn");
           connection.start();
           Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
           Topic fqqn = session.createTopic(multicastAddress.toString() + "::" + queueName);
  
           MessageConsumer consumer1 = session.createConsumer(fqqn);
           MessageConsumer consumer2 = session.createConsumer(fqqn);
  
           Topic topic = session.createTopic(multicastAddress.toString());
           MessageProducer producer = session.createProducer(topic);
  
           producer.send(session.createMessage());
  
           //each consumer receives one
           Message m = consumer1.receive(2000);
           assertNotNull(m);
  
           // Subscribing to FQQN is akin to shared subscription
           m = consumer2.receive(2000);
           assertNull(m);
  
           Bindings bindings = server.getPostOffice().getBindingsForAddress(multicastAddress);
           for (Binding b : bindings.getBindings()) {
              logger.debug("checking binidng {} {}", b.getUniqueName(), ((LocalQueueBinding)b).getQueue().getDeliveringMessages());
              SimpleString qName = b.getUniqueName();
              //do FQQN query
              QueueQueryResult result = server.queueQuery(CompositeAddress.toFullyQualified(multicastAddress, qName));
              assertTrue(result.isExists());
              assertEquals(result.getName(), qName);
              //do qname query
              result = server.queueQuery(qName);
              assertTrue(result.isExists());
              assertEquals(result.getName(), qName);
           }
        } finally {
           connection.close();
        }
     }
  
     @Test
     public void testQueueConsumerReceiveTopicUsingFQQN() throws Exception {
  
        SimpleString queueName1 = SimpleString.of("sub.queue1");
        SimpleString queueName2 = SimpleString.of("sub.queue2");
        server.createQueue(QueueConfiguration.of(queueName1).setAddress(multicastAddress).setDurable(false));
        server.createQueue(QueueConfiguration.of(queueName2).setAddress(multicastAddress).setDurable(false));
        Connection connection = createConnection(false);
  
        try {
           connection.start();
           Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
           javax.jms.Queue fqqn1 = session.createQueue(multicastAddress.toString() + "::" + queueName1);
           javax.jms.Queue fqqn2 = session.createQueue(multicastAddress.toString() + "::" + queueName2);
  
           MessageConsumer consumer1 = session.createConsumer(fqqn1);
           MessageConsumer consumer2 = session.createConsumer(fqqn2);
  
           Topic topic = session.createTopic(multicastAddress.toString());
           MessageProducer producer = session.createProducer(topic);
  
           producer.send(session.createMessage());
  
           Message m = consumer1.receive(2000);
           assertNotNull(m);
  
           m = consumer2.receive(2000);
           assertNotNull(m);
  
        } finally {
           connection.close();
        }
     }
  
     @Test
     public void testQueue() throws Exception {
        server.getAddressSettingsRepository().addMatch("#", new AddressSettings().setAutoCreateQueues(false).setAutoCreateAddresses(false));
  
        server.addAddressInfo(new AddressInfo(anycastAddress).addRoutingType(RoutingType.ANYCAST).setAutoCreated(false));
        server.createQueue(QueueConfiguration.of(anycastQ1).setAddress(anycastAddress).setRoutingType(RoutingType.ANYCAST).setDurable(true));
        server.createQueue(QueueConfiguration.of(anycastQ2).setAddress(anycastAddress).setRoutingType(RoutingType.ANYCAST).setDurable(true));
        server.createQueue(QueueConfiguration.of(anycastQ3).setAddress(anycastAddress).setRoutingType(RoutingType.ANYCAST).setDurable(true));
  
        Connection connection = createConnection();
        try {
           connection.start();
           Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
  
           javax.jms.Queue q1 = session.createQueue(CompositeAddress.toFullyQualified(anycastAddress, anycastQ1).toString());
           javax.jms.Queue q2 = session.createQueue(CompositeAddress.toFullyQualified(anycastAddress, anycastQ2).toString());
           javax.jms.Queue q3 = session.createQueue(CompositeAddress.toFullyQualified(anycastAddress, anycastQ3).toString());
  
           MessageProducer producer1 = session.createProducer(q1);
           producer1.send(session.createMessage());
           producer1.send(session.createMessage());
           assertTrue(Wait.waitFor(() -> server.locateQueue(anycastQ1).getMessageCount() == 2, 2000, 200));
  
           MessageProducer producer2 = session.createProducer(q2);
           producer2.send(session.createMessage());
           producer2.send(session.createMessage());
           producer2.send(session.createMessage());
           assertTrue(Wait.waitFor(() -> server.locateQueue(anycastQ2).getMessageCount() == 3, 2000, 200));
  
           MessageProducer producer3 = session.createProducer(q3);
           producer3.send(session.createMessage());
           producer3.send(session.createMessage());
           producer3.send(session.createMessage());
           producer3.send(session.createMessage());
           producer3.send(session.createMessage());
           assertTrue(Wait.waitFor(() -> server.locateQueue(anycastQ3).getMessageCount() == 5, 2000, 200));
  
           logger.debug("Queue is: {}", q1);
           MessageConsumer consumer1 = session.createConsumer(q1);
           MessageConsumer consumer2 = session.createConsumer(q2);
           MessageConsumer consumer3 = session.createConsumer(q3);
  
           assertNotNull(consumer1.receive(2000));
           assertNotNull(consumer1.receive(2000));
           assertTrue(Wait.waitFor(() -> server.locateQueue(anycastQ1).getMessageCount() == 0, 2000, 200));
  
           assertNotNull(consumer2.receive(2000));
           assertNotNull(consumer2.receive(2000));
           assertNotNull(consumer2.receive(2000));
           assertTrue(Wait.waitFor(() -> server.locateQueue(anycastQ2).getMessageCount() == 0, 2000, 200));
  
           assertNotNull(consumer3.receive(2000));
           assertNotNull(consumer3.receive(2000));
           assertNotNull(consumer3.receive(2000));
           assertNotNull(consumer3.receive(2000));
           assertNotNull(consumer3.receive(2000));
           assertTrue(Wait.waitFor(() -> server.locateQueue(anycastQ3).getMessageCount() == 0, 2000, 200));
  
           connection.close();
           //queues are empty now
           for (SimpleString q : new SimpleString[]{anycastQ1, anycastQ2, anycastQ3}) {
              //FQQN query
              QueueQueryResult query = server.queueQuery(CompositeAddress.toFullyQualified(anycastAddress, q));
              assertTrue(query.isExists() || query.isAutoCreateQueues());
              assertEquals(anycastAddress, query.getAddress());
              assertEquals(q, query.getName());
              assertEquals(0, query.getMessageCount(), "Message not consumed");
              //try query again using qName
              query = server.queueQuery(q);
              assertEquals(q, query.getName());
           }
        } finally {
           connection.close();
           if (locator != null) {
              locator.close();
           }
        }
     }
  
     /**
      * Broker should return exception if no address is passed in FQQN.
      */
     @Test
     public void testQueueSpecial() throws Exception {
        server.createQueue(QueueConfiguration.of(anycastQ1).setAddress(anycastAddress).setRoutingType(RoutingType.ANYCAST));
  
        Connection connection = createConnection();
        Exception expectedException = null;
        try {
           connection.start();
           Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
  
           //::queue ok!
           String specialName = CompositeAddress.toFullyQualified(SimpleString.of(""), anycastQ1).toString();
           javax.jms.Queue q1 = session.createQueue(specialName);
           session.createConsumer(q1);
        } catch (InvalidDestinationException e) {
           expectedException = e;
        }
        assertNotNull(expectedException);
        assertTrue(expectedException.getMessage().contains("Queue: 'q1' does not exist for address ''"));
     }
  }
  