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.transport.amqp;
  
  import static org.junit.Assert.assertEquals;
  import static org.junit.Assert.assertNotNull;
  import static org.junit.Assert.assertTrue;
  import static org.junit.Assert.fail;
  import static org.junit.Assume.assumeFalse;
  
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.Collection;
  import java.util.Enumeration;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  import java.util.UUID;
  
  import jakarta.jms.BytesMessage;
  import jakarta.jms.Connection;
  import jakarta.jms.Destination;
  import jakarta.jms.MapMessage;
  import jakarta.jms.Message;
  import jakarta.jms.MessageConsumer;
  import jakarta.jms.MessageProducer;
  import jakarta.jms.ObjectMessage;
  import jakarta.jms.Session;
  import jakarta.jms.TextMessage;
  
  import org.apache.activemq.ActiveMQConnection;
  import org.apache.qpid.proton.amqp.Binary;
  import org.junit.Test;
  import org.junit.runner.RunWith;
  import org.junit.runners.Parameterized;
  import org.junit.runners.Parameterized.Parameters;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Tests interoperability between OpenWire and AMQP
   */
  @RunWith(Parameterized.class)
  public class JMSInteroperabilityTest extends JMSClientTestSupport {
  
      protected static final Logger LOG = LoggerFactory.getLogger(JMSInteroperabilityTest.class);
  
      private final String transformer;
  
      @Parameters(name="Transformer->{0}")
      public static Collection<Object[]> data() {
          return Arrays.asList(new Object[][] {
                  {"jms"},
                  {"native"},
                  {"raw"},
              });
      }
  
      public JMSInteroperabilityTest(String transformer) {
          this.transformer = transformer;
      }
  
      @Override
      protected boolean isUseOpenWireConnector() {
          return true;
      }
  
      @Override
      protected String getAmqpTransformer() {
          return transformer;
      }
  
      //----- Tests for property handling between protocols --------------------//
  
      @SuppressWarnings("unchecked")
      @Test(timeout = 60000)
      public void testMessagePropertiesArePreservedOpenWireToAMQP() throws Exception {
  
          boolean bool = true;
          byte bValue = 127;
          short nShort = 10;
          int nInt = 5;
          long nLong = 333;
          float nFloat = 1;
          double nDouble = 100;
          Enumeration<String> propertyNames = null;
          String testMessageBody = "Testing msgPropertyExistTest";
  
          Connection openwire = createJMSConnection();
          Connection amqp = createConnection();
  
          openwire.start();
          amqp.start();
  
          Session openwireSession = openwire.createSession(false, Session.AUTO_ACKNOWLEDGE);
          Session amqpSession = amqp.createSession(false, Session.AUTO_ACKNOWLEDGE);
  
          Destination queue = openwireSession.createQueue(getDestinationName());
  
          MessageProducer openwireProducer = openwireSession.createProducer(queue);
          MessageConsumer amqpConsumer = amqpSession.createConsumer(queue);
  
          TextMessage outbound = openwireSession.createTextMessage();
          outbound.setText(testMessageBody);
          outbound.setBooleanProperty("Boolean", bool);
          outbound.setByteProperty("Byte", bValue);
          outbound.setShortProperty("Short", nShort);
          outbound.setIntProperty("Integer", nInt);
          outbound.setFloatProperty("Float", nFloat);
          outbound.setDoubleProperty("Double", nDouble);
          outbound.setStringProperty("String", "test");
          outbound.setLongProperty("Long", nLong);
          outbound.setObjectProperty("BooleanObject", bool);
  
          openwireProducer.send(outbound);
  
          Message inbound = amqpConsumer.receive(2500);
  
          propertyNames = inbound.getPropertyNames();
          int propertyCount = 0;
          do {
              String propertyName = propertyNames.nextElement();
  
              if (propertyName.indexOf("JMS") != 0) {
                  propertyCount++;
                  if (propertyName.equals("Boolean") || propertyName.equals("Byte") ||
                      propertyName.equals("Integer") || propertyName.equals("Short") ||
                      propertyName.equals("Float") || propertyName.equals("Double") ||
                      propertyName.equals("String") || propertyName.equals("Long") ||
                      propertyName.equals("BooleanObject")) {
  
                      LOG.debug("Appclication Property set by client is: {}", propertyName);
                      if (!inbound.propertyExists(propertyName)) {
                          assertTrue(inbound.propertyExists(propertyName));
                          LOG.debug("Positive propertyExists test failed for {}", propertyName);
                      } else if (inbound.propertyExists(propertyName + "1")) {
                          LOG.debug("Negative propertyExists test failed for {} 1", propertyName);
                          fail("Negative propertyExists test failed for " + propertyName + "1");
                      }
                  } else {
                      LOG.debug("Appclication Property not set by client: {}", propertyName);
                      fail("Appclication Property not set by client: " + propertyName);
                  }
              } else {
                  LOG.debug("JMSProperty Name is: {}", propertyName);
              }
  
          } while (propertyNames.hasMoreElements());
  
          amqp.close();
          openwire.close();
  
          assertEquals("Unexpected number of properties in received message.", 9, propertyCount);
      }
  
      @SuppressWarnings("unchecked")
      @Test(timeout = 60000)
      public void testMessagePropertiesArePreservedAMQPToOpenWire() throws Exception {
  
          // Raw Transformer doesn't expand message properties.
          assumeFalse(transformer.equals("raw"));
  
          boolean bool = true;
          byte bValue = 127;
          short nShort = 10;
          int nInt = 5;
          long nLong = 333;
          float nFloat = 1;
          double nDouble = 100;
          Enumeration<String> propertyNames = null;
          String testMessageBody = "Testing msgPropertyExistTest";
  
          Connection openwire = createJMSConnection();
          Connection amqp = createConnection();
  
          openwire.start();
          amqp.start();
  
          Session openwireSession = openwire.createSession(false, Session.AUTO_ACKNOWLEDGE);
          Session amqpSession = amqp.createSession(false, Session.AUTO_ACKNOWLEDGE);
  
          Destination queue = openwireSession.createQueue(getDestinationName());
  
          MessageProducer amqpProducer = amqpSession.createProducer(queue);
          MessageConsumer openwireConsumer = openwireSession.createConsumer(queue);
  
          TextMessage outbound = amqpSession.createTextMessage();
          outbound.setText(testMessageBody);
          outbound.setBooleanProperty("Boolean", bool);
          outbound.setByteProperty("Byte", bValue);
          outbound.setShortProperty("Short", nShort);
          outbound.setIntProperty("Integer", nInt);
          outbound.setFloatProperty("Float", nFloat);
          outbound.setDoubleProperty("Double", nDouble);
          outbound.setStringProperty("String", "test");
          outbound.setLongProperty("Long", nLong);
          outbound.setObjectProperty("BooleanObject", bool);
  
          amqpProducer.send(outbound);
  
          Message inbound = openwireConsumer.receive(2500);
  
          propertyNames = inbound.getPropertyNames();
          int propertyCount = 0;
          do {
              String propertyName = propertyNames.nextElement();
  
              if (propertyName.indexOf("JMS") != 0) {
                  propertyCount++;
                  if (propertyName.equals("Boolean") || propertyName.equals("Byte") ||
                      propertyName.equals("Integer") || propertyName.equals("Short") ||
                      propertyName.equals("Float") || propertyName.equals("Double") ||
                      propertyName.equals("String") || propertyName.equals("Long") ||
                      propertyName.equals("BooleanObject")) {
  
                      LOG.debug("Appclication Property set by client is: {}", propertyName);
                      if (!inbound.propertyExists(propertyName)) {
                          assertTrue(inbound.propertyExists(propertyName));
                          LOG.debug("Positive propertyExists test failed for {}", propertyName);
                      } else if (inbound.propertyExists(propertyName + "1")) {
                          LOG.debug("Negative propertyExists test failed for {} 1", propertyName);
                          fail("Negative propertyExists test failed for " + propertyName + "1");
                      }
                  } else {
                      LOG.debug("Appclication Property not set by client: {}", propertyName);
                      fail("Appclication Property not set by client: " + propertyName);
                  }
              } else {
                  LOG.debug("JMSProperty Name is: {}", propertyName);
              }
  
          } while (propertyNames.hasMoreElements());
  
          amqp.close();
          openwire.close();
  
          assertEquals("Unexpected number of properties in received message.", 9, propertyCount);
      }
  
      //----- Tests for OpenWire to Qpid JMS using MapMessage ------------------//
  
      @SuppressWarnings("unchecked")
      @Test
      public void testMapMessageUsingPrimitiveSettersSendReceive() throws Exception {
          Connection openwire = createJMSConnection();
          Connection amqp = createConnection();
  
          openwire.start();
          amqp.start();
  
          Session openwireSession = openwire.createSession(false, Session.AUTO_ACKNOWLEDGE);
          Session amqpSession = amqp.createSession(false, Session.AUTO_ACKNOWLEDGE);
  
          Destination queue = openwireSession.createQueue(getDestinationName());
  
          MessageProducer openwireProducer = openwireSession.createProducer(queue);
          MessageConsumer amqpConsumer = amqpSession.createConsumer(queue);
  
          byte[] bytesValue = new byte[] { 1, 2, 3, 4, 5 };
  
          // Create the Message
          MapMessage outgoing = openwireSession.createMapMessage();
  
          outgoing.setBoolean("boolean", true);
          outgoing.setByte("byte", (byte) 10);
          outgoing.setBytes("bytes", bytesValue);
          outgoing.setChar("char", 'B');
          outgoing.setDouble("double", 24.42);
          outgoing.setFloat("float", 3.14159f);
          outgoing.setInt("integer", 1024);
          outgoing.setLong("long", 8096l);
          outgoing.setShort("short", (short) 255);
  
          openwireProducer.send(outgoing);
  
          // Now consume the MapMessage
          Message received = amqpConsumer.receive(2000);
          assertNotNull(received);
          assertTrue("Expected MapMessage but got " + received, received instanceof ObjectMessage);
          ObjectMessage incoming = (ObjectMessage) received;
  
          Map<String, Object> incomingMap = (Map<String, Object>) incoming.getObject();
  
          assertEquals(true, incomingMap.get("boolean"));
          assertEquals(10, (byte) incomingMap.get("byte"));
          assertEquals('B', incomingMap.get("char"));
          assertEquals(24.42, (double) incomingMap.get("double"), 0.5);
          assertEquals(3.14159f, (float) incomingMap.get("float"), 0.5f);
          assertEquals(1024, incomingMap.get("integer"));
          assertEquals(8096l, incomingMap.get("long"));
          assertEquals(255, (short) incomingMap.get("short"));
  
          // Test for the byte array which will be in an AMQP Binary as this message
          // is received as an ObjectMessage by Qpid JMS
          Object incomingValue = incomingMap.get("bytes");
          assertNotNull(incomingValue);
          assertTrue(incomingValue instanceof Binary);
          Binary incomingBinary = (Binary) incomingValue;
          byte[] incomingBytes = Arrays.copyOfRange(incomingBinary.getArray(), incomingBinary.getArrayOffset(), incomingBinary.getLength());
          assertTrue(Arrays.equals(bytesValue, incomingBytes));
  
          amqp.close();
          openwire.close();
      }
  
      //----- Tests for OpenWire <-> Qpid JMS using ObjectMessage --------------//
  
      @SuppressWarnings("unchecked")
      @Test
      public void testMapInObjectMessageSendReceive() throws Exception {
          Connection openwire = createJMSConnection();
          Connection amqp = createConnection();
  
          openwire.start();
          amqp.start();
  
          Session openwireSession = openwire.createSession(false, Session.AUTO_ACKNOWLEDGE);
          Session amqpSession = amqp.createSession(false, Session.AUTO_ACKNOWLEDGE);
  
          Destination queue = openwireSession.createQueue(getDestinationName());
  
          MessageProducer openwireProducer = openwireSession.createProducer(queue);
          MessageConsumer amqpConsumer = amqpSession.createConsumer(queue);
  
          // Create the Message
          ObjectMessage outgoing = openwireSession.createObjectMessage();
  
          HashMap<String, Object> outgoingMap = new HashMap<String, Object>();
  
          outgoingMap.put("none", null);
          outgoingMap.put("string", "test");
          outgoingMap.put("long", 255L);
          outgoingMap.put("empty-string", "");
          outgoingMap.put("negative-int", -1);
          outgoingMap.put("float", 0.12f);
  
          outgoing.setObject(outgoingMap);
  
          openwireProducer.send(outgoing);
  
          // Now consume the ObjectMessage
          Message received = amqpConsumer.receive(2000);
          assertNotNull(received);
          assertTrue("Expected ObjectMessage but got " + received, received instanceof ObjectMessage);
          ObjectMessage incoming = (ObjectMessage) received;
  
          Object incomingObject = incoming.getObject();
          assertNotNull(incomingObject);
          assertTrue(incomingObject instanceof Map);
          Map<String, Object> incomingMap = (Map<String, Object>) incomingObject;
          assertEquals(outgoingMap.size(), incomingMap.size());
  
          amqp.close();
          openwire.close();
      }
  
      @Test
      public void testQpidToOpenWireObjectMessage() throws Exception {
  
          // Raw Transformer doesn't expand message properties.
          assumeFalse(!transformer.equals("jms"));
  
          Connection openwire = createJMSConnection();
          Connection amqp = createConnection();
  
          openwire.start();
          amqp.start();
  
          Session openwireSession = openwire.createSession(false, Session.AUTO_ACKNOWLEDGE);
          Session amqpSession = amqp.createSession(false, Session.AUTO_ACKNOWLEDGE);
  
          Destination queue = openwireSession.createQueue(getDestinationName());
  
          MessageProducer amqpProducer = amqpSession.createProducer(queue);
          MessageConsumer openwireConsumer = openwireSession.createConsumer(queue);
  
          // Create and send the Message
          ObjectMessage outgoing = amqpSession.createObjectMessage();
          outgoing.setObject(UUID.randomUUID());
          amqpProducer.send(outgoing);
  
          // Now consume the ObjectMessage
          Message received = openwireConsumer.receive(2000);
          assertNotNull(received);
          LOG.info("Read new message: {}", received);
          assertTrue(received instanceof ObjectMessage);
          ObjectMessage incoming = (ObjectMessage) received;
          Object payload = incoming.getObject();
          assertNotNull(payload);
          assertTrue(payload instanceof UUID);
  
          amqp.close();
          openwire.close();
      }
  
      @Test
      public void testOpenWireToQpidObjectMessage() throws Exception {
  
          // Raw Transformer doesn't expand message properties.
          assumeFalse(!transformer.equals("jms"));
  
          Connection openwire = createJMSConnection();
          Connection amqp = createConnection();
  
          openwire.start();
          amqp.start();
  
          Session openwireSession = openwire.createSession(false, Session.AUTO_ACKNOWLEDGE);
          Session amqpSession = amqp.createSession(false, Session.AUTO_ACKNOWLEDGE);
  
          Destination queue = openwireSession.createQueue(getDestinationName());
  
          MessageProducer openwireProducer = openwireSession.createProducer(queue);
          MessageConsumer amqpConsumer = amqpSession.createConsumer(queue);
  
          // Create and send the Message
          ObjectMessage outgoing = amqpSession.createObjectMessage();
          outgoing.setObject(UUID.randomUUID());
          openwireProducer.send(outgoing);
  
          // Now consume the ObjectMessage
          Message received = amqpConsumer.receive(2000);
          assertNotNull(received);
          LOG.info("Read new message: {}", received);
          assertTrue(received instanceof ObjectMessage);
          ObjectMessage incoming = (ObjectMessage) received;
          Object payload = incoming.getObject();
          assertNotNull(payload);
          assertTrue(payload instanceof UUID);
  
          amqp.close();
          openwire.close();
      }
  
      @Test
      public void testOpenWireToQpidObjectMessageWithOpenWireCompression() throws Exception {
  
          // Raw Transformer doesn't expand message properties.
          assumeFalse(!transformer.equals("jms"));
  
          Connection openwire = createJMSConnection();
          ((ActiveMQConnection) openwire).setUseCompression(true);
  
          Connection amqp = createConnection();
  
          openwire.start();
          amqp.start();
  
          Session openwireSession = openwire.createSession(false, Session.AUTO_ACKNOWLEDGE);
          Session amqpSession = amqp.createSession(false, Session.AUTO_ACKNOWLEDGE);
  
          Destination queue = openwireSession.createQueue(getDestinationName());
  
          MessageProducer openwireProducer = openwireSession.createProducer(queue);
          MessageConsumer amqpConsumer = amqpSession.createConsumer(queue);
  
          // Create and send the Message
          ObjectMessage outgoing = amqpSession.createObjectMessage();
          outgoing.setObject(UUID.randomUUID());
          openwireProducer.send(outgoing);
  
          // Now consume the ObjectMessage
          Message received = amqpConsumer.receive(2000);
          assertNotNull(received);
          LOG.info("Read new message: {}", received);
          assertTrue(received instanceof ObjectMessage);
          ObjectMessage incoming = (ObjectMessage) received;
          Object payload = incoming.getObject();
          assertNotNull(payload);
          assertTrue(payload instanceof UUID);
  
          amqp.close();
          openwire.close();
      }
  
      @SuppressWarnings("unchecked")
      @Test
      public void testObjectMessageContainingList() throws Exception {
          Connection openwire = createJMSConnection();
          Connection amqp = createConnection();
  
          openwire.start();
          amqp.start();
  
          Session openwireSession = openwire.createSession(false, Session.AUTO_ACKNOWLEDGE);
          Session amqpSession = amqp.createSession(false, Session.AUTO_ACKNOWLEDGE);
  
          Destination queue = openwireSession.createQueue(getDestinationName());
  
          MessageProducer openwireProducer = openwireSession.createProducer(queue);
          MessageConsumer amqpConsumer = amqpSession.createConsumer(queue);
  
          // Create the Message
          ObjectMessage outgoing = openwireSession.createObjectMessage();
  
          ArrayList<Object> outgoingList = new ArrayList<Object>();
  
          outgoingList.add(null);
          outgoingList.add("test");
          outgoingList.add(255L);
          outgoingList.add("");
          outgoingList.add(-1);
          outgoingList.add(0.12f);
  
          outgoing.setObject(outgoingList);
  
          openwireProducer.send(outgoing);
  
          // Now consume the ObjectMessage
          Message received = amqpConsumer.receive(2000);
          assertNotNull(received);
          assertTrue(received instanceof ObjectMessage);
          ObjectMessage incoming = (ObjectMessage) received;
  
          Object incomingObject = incoming.getObject();
          assertNotNull(incomingObject);
          assertTrue(incomingObject instanceof List);
          List<Object> incomingList = (List<Object>) incomingObject;
          assertEquals(outgoingList.size(), incomingList.size());
  
          amqp.close();
          openwire.close();
      }
  
      //----- Test Qpid JMS to Qpid JMS interop with transformers --------------//
  
      @Test
      public void testQpidJMSToQpidJMSMessageSendReceive() throws Exception {
          final int SIZE = 1024;
          final int NUM_MESSAGES = 100;
  
          Connection amqpSend = createConnection("client-1");
          Connection amqpReceive = createConnection("client-2");
  
          amqpReceive.start();
  
          Session senderSession = amqpSend.createSession(false, Session.AUTO_ACKNOWLEDGE);
          Session receiverSession = amqpReceive.createSession(false, Session.AUTO_ACKNOWLEDGE);
  
          Destination queue = senderSession.createQueue(getDestinationName());
  
          MessageProducer amqpProducer = senderSession.createProducer(queue);
          MessageConsumer amqpConsumer = receiverSession.createConsumer(queue);
  
          byte[] payload = new byte[SIZE];
  
          for (int i = 0; i < NUM_MESSAGES; ++i) {
              BytesMessage outgoing = senderSession.createBytesMessage();
              outgoing.setLongProperty("SendTime", System.currentTimeMillis());
              outgoing.writeBytes(payload);
              amqpProducer.send(outgoing);
          }
  
          // Now consume the message
          for (int i = 0; i < NUM_MESSAGES; ++i) {
              Message received = amqpConsumer.receive(2000);
              assertNotNull(received);
              assertTrue("Expected BytesMessage but got " + received, received instanceof BytesMessage);
              BytesMessage incoming = (BytesMessage) received;
              assertEquals(SIZE, incoming.getBodyLength());
          }
  
          amqpReceive.close();
          amqpSend.close();
      }
  }
  