AMQPMessageIdHelperTest.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.artemis.protocol.amqp.converter.message;

import java.util.UUID;

import org.apache.activemq.artemis.protocol.amqp.converter.AMQPMessageIdHelper;
import org.apache.activemq.artemis.protocol.amqp.exceptions.ActiveMQAMQPException;
import org.apache.qpid.proton.amqp.Binary;
import org.apache.qpid.proton.amqp.UnsignedLong;
import org.junit.Before;
import org.junit.Test;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.fail;

public class AMQPMessageIdHelperTest {

   private AMQPMessageIdHelper messageIdHelper;

   @Before
   public void setUp() throws Exception {
      messageIdHelper = new AMQPMessageIdHelper();
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toBaseMessageIdString(Object)} returns null if given
    * null
    */
   @Test
   public void testToBaseMessageIdStringWithNull() {
      String nullString = null;
      assertNull("null string should have been returned", messageIdHelper.toBaseMessageIdString(nullString));
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toBaseMessageIdString(Object)} throws an IAE if given
    * an unexpected object type.
    */
   @Test
   public void testToBaseMessageIdStringThrowsIAEWithUnexpectedType() {
      try {
         messageIdHelper.toBaseMessageIdString(new Object());
         fail("expected exception not thrown");
      } catch (IllegalArgumentException iae) {
         // expected
      }
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toBaseMessageIdString(Object)} returns the given
    * basic string unchanged
    */
   @Test
   public void testToBaseMessageIdStringWithString() {
      String stringMessageId = "myIdString";

      String baseMessageIdString = messageIdHelper.toBaseMessageIdString(stringMessageId);
      assertNotNull("null string should not have been returned", baseMessageIdString);
      assertEquals("expected base id string was not returned", stringMessageId, baseMessageIdString);
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toBaseMessageIdString(Object)} returns a string
    * indicating an AMQP encoded string, when the given string happens to already begin with the
    * {@link AMQPMessageIdHelper#AMQP_UUID_PREFIX}.
    */
   @Test
   public void testToBaseMessageIdStringWithStringBeginningWithEncodingPrefixForUUID() {
      String uuidStringMessageId = AMQPMessageIdHelper.AMQP_UUID_PREFIX + UUID.randomUUID();
      String expected = AMQPMessageIdHelper.AMQP_STRING_PREFIX + uuidStringMessageId;

      String baseMessageIdString = messageIdHelper.toBaseMessageIdString(uuidStringMessageId);
      assertNotNull("null string should not have been returned", baseMessageIdString);
      assertEquals("expected base id string was not returned", expected, baseMessageIdString);
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toBaseMessageIdString(Object)} returns a string
    * indicating an AMQP encoded string, when the given string happens to already begin with the
    * {@link AMQPMessageIdHelper#AMQP_ULONG_PREFIX}.
    */
   @Test
   public void testToBaseMessageIdStringWithStringBeginningWithEncodingPrefixForLong() {
      String longStringMessageId = AMQPMessageIdHelper.AMQP_ULONG_PREFIX + Long.valueOf(123456789L);
      String expected = AMQPMessageIdHelper.AMQP_STRING_PREFIX + longStringMessageId;

      String baseMessageIdString = messageIdHelper.toBaseMessageIdString(longStringMessageId);
      assertNotNull("null string should not have been returned", baseMessageIdString);
      assertEquals("expected base id string was not returned", expected, baseMessageIdString);
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toBaseMessageIdString(Object)} returns a string
    * indicating an AMQP encoded string, when the given string happens to already begin with the
    * {@link AMQPMessageIdHelper#AMQP_BINARY_PREFIX}.
    */
   @Test
   public void testToBaseMessageIdStringWithStringBeginningWithEncodingPrefixForBinary() {
      String binaryStringMessageId = AMQPMessageIdHelper.AMQP_BINARY_PREFIX + "0123456789ABCDEF";
      String expected = AMQPMessageIdHelper.AMQP_STRING_PREFIX + binaryStringMessageId;

      String baseMessageIdString = messageIdHelper.toBaseMessageIdString(binaryStringMessageId);
      assertNotNull("null string should not have been returned", baseMessageIdString);
      assertEquals("expected base id string was not returned", expected, baseMessageIdString);
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toBaseMessageIdString(Object)} returns a string
    * indicating an AMQP encoded string (effectively twice), when the given string happens to
    * already begin with the {@link AMQPMessageIdHelper#AMQP_STRING_PREFIX}.
    */
   @Test
   public void testToBaseMessageIdStringWithStringBeginningWithEncodingPrefixForString() {
      String stringMessageId = AMQPMessageIdHelper.AMQP_STRING_PREFIX + "myStringId";
      String expected = AMQPMessageIdHelper.AMQP_STRING_PREFIX + stringMessageId;

      String baseMessageIdString = messageIdHelper.toBaseMessageIdString(stringMessageId);
      assertNotNull("null string should not have been returned", baseMessageIdString);
      assertEquals("expected base id string was not returned", expected, baseMessageIdString);
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toBaseMessageIdString(Object)} returns a string
    * indicating an AMQP encoded UUID when given a UUID object.
    */
   @Test
   public void testToBaseMessageIdStringWithUUID() {
      UUID uuidMessageId = UUID.randomUUID();
      String expected = AMQPMessageIdHelper.AMQP_UUID_PREFIX + uuidMessageId.toString();

      String baseMessageIdString = messageIdHelper.toBaseMessageIdString(uuidMessageId);
      assertNotNull("null string should not have been returned", baseMessageIdString);
      assertEquals("expected base id string was not returned", expected, baseMessageIdString);
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toBaseMessageIdString(Object)} returns a string
    * indicating an AMQP encoded ulong when given a UnsignedLong object.
    */
   @Test
   public void testToBaseMessageIdStringWithUnsignedLong() {
      UnsignedLong uLongMessageId = UnsignedLong.valueOf(123456789L);
      String expected = AMQPMessageIdHelper.AMQP_ULONG_PREFIX + uLongMessageId.toString();

      String baseMessageIdString = messageIdHelper.toBaseMessageIdString(uLongMessageId);
      assertNotNull("null string should not have been returned", baseMessageIdString);
      assertEquals("expected base id string was not returned", expected, baseMessageIdString);
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toBaseMessageIdString(Object)} returns a string
    * indicating an AMQP encoded binary when given a Binary object.
    */
   @Test
   public void testToBaseMessageIdStringWithBinary() {
      byte[] bytes = new byte[] {(byte) 0x00, (byte) 0xAB, (byte) 0x09, (byte) 0xFF};
      Binary binary = new Binary(bytes);

      String expected = AMQPMessageIdHelper.AMQP_BINARY_PREFIX + "00AB09FF";

      String baseMessageIdString = messageIdHelper.toBaseMessageIdString(binary);
      assertNotNull("null string should not have been returned", baseMessageIdString);
      assertEquals("expected base id string was not returned", expected, baseMessageIdString);
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toIdObject(String)} returns an UnsignedLong when
    * given a string indicating an encoded AMQP ulong id.
    *
    * @throws Exception
    *         if an error occurs during the test.
    */
   @Test
   public void testToIdObjectWithEncodedUlong() throws Exception {
      UnsignedLong longId = UnsignedLong.valueOf(123456789L);
      String provided = AMQPMessageIdHelper.AMQP_ULONG_PREFIX + "123456789";

      Object idObject = messageIdHelper.toIdObject(provided);
      assertNotNull("null object should not have been returned", idObject);
      assertEquals("expected id object was not returned", longId, idObject);
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toIdObject(String)} returns a Binary when given a
    * string indicating an encoded AMQP binary id, using upper case hex characters
    *
    * @throws Exception
    *         if an error occurs during the test.
    */
   @Test
   public void testToIdObjectWithEncodedBinaryUppercaseHexString() throws Exception {
      byte[] bytes = new byte[] {(byte) 0x00, (byte) 0xAB, (byte) 0x09, (byte) 0xFF};
      Binary binaryId = new Binary(bytes);

      String provided = AMQPMessageIdHelper.AMQP_BINARY_PREFIX + "00AB09FF";

      Object idObject = messageIdHelper.toIdObject(provided);
      assertNotNull("null object should not have been returned", idObject);
      assertEquals("expected id object was not returned", binaryId, idObject);
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toIdObject(String)} returns null when given null.
    *
    * @throws Exception
    *         if an error occurs during the test.
    */
   @Test
   public void testToIdObjectWithNull() throws Exception {
      assertNull("null object should have been returned", messageIdHelper.toIdObject(null));
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toIdObject(String)} returns a Binary when given a
    * string indicating an encoded AMQP binary id, using lower case hex characters.
    *
    * @throws Exception
    *         if an error occurs during the test.
    */
   @Test
   public void testToIdObjectWithEncodedBinaryLowercaseHexString() throws Exception {
      byte[] bytes = new byte[] {(byte) 0x00, (byte) 0xAB, (byte) 0x09, (byte) 0xFF};
      Binary binaryId = new Binary(bytes);

      String provided = AMQPMessageIdHelper.AMQP_BINARY_PREFIX + "00ab09ff";

      Object idObject = messageIdHelper.toIdObject(provided);
      assertNotNull("null object should not have been returned", idObject);
      assertEquals("expected id object was not returned", binaryId, idObject);
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toIdObject(String)} returns a UUID when given a
    * string indicating an encoded AMQP uuid id.
    *
    * @throws Exception
    *         if an error occurs during the test.
    */
   @Test
   public void testToIdObjectWithEncodedUuid() throws Exception {
      UUID uuid = UUID.randomUUID();
      String provided = AMQPMessageIdHelper.AMQP_UUID_PREFIX + uuid.toString();

      Object idObject = messageIdHelper.toIdObject(provided);
      assertNotNull("null object should not have been returned", idObject);
      assertEquals("expected id object was not returned", uuid, idObject);
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toIdObject(String)} returns a string when given a
    * string without any type encoding prefix.
    *
    * @throws Exception
    *         if an error occurs during the test.
    */
   @Test
   public void testToIdObjectWithStringContainingNoEncodingPrefix() throws Exception {
      String stringId = "myStringId";

      Object idObject = messageIdHelper.toIdObject(stringId);
      assertNotNull("null object should not have been returned", idObject);
      assertEquals("expected id object was not returned", stringId, idObject);
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toIdObject(String)} returns the remainder of the
    * provided string after removing the {@link AMQPMessageIdHelper#AMQP_STRING_PREFIX} prefix.
    *
    * @throws Exception
    *         if an error occurs during the test.
    */
   @Test
   public void testToIdObjectWithStringContainingStringEncodingPrefix() throws Exception {
      String suffix = "myStringSuffix";
      String stringId = AMQPMessageIdHelper.AMQP_STRING_PREFIX + suffix;

      Object idObject = messageIdHelper.toIdObject(stringId);
      assertNotNull("null object should not have been returned", idObject);
      assertEquals("expected id object was not returned", suffix, idObject);
   }

   /**
    * Test that when given a string with with the {@link AMQPMessageIdHelper#AMQP_STRING_PREFIX}
    * prefix and then additionally the {@link AMQPMessageIdHelper#AMQP_UUID_PREFIX}, the
    * {@link AMQPMessageIdHelper#toIdObject(String)} method returns the remainder of the
    * provided string after removing the {@link AMQPMessageIdHelper#AMQP_STRING_PREFIX} prefix.
    *
    * @throws Exception
    *         if an error occurs during the test.
    */
   @Test
   public void testToIdObjectWithStringContainingStringEncodingPrefixAndThenUuidPrefix() throws Exception {
      String encodedUuidString = AMQPMessageIdHelper.AMQP_UUID_PREFIX + UUID.randomUUID().toString();
      String stringId = AMQPMessageIdHelper.AMQP_STRING_PREFIX + encodedUuidString;

      Object idObject = messageIdHelper.toIdObject(stringId);
      assertNotNull("null object should not have been returned", idObject);
      assertEquals("expected id object was not returned", encodedUuidString, idObject);
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toIdObject(String)} throws an
    * {@link IdConversionException} when presented with an encoded binary hex string of uneven
    * length (after the prefix) that thus can't be converted due to each byte using 2 characters
    */
   @Test
   public void testToIdObjectWithStringContainingBinaryHexThrowsWithUnevenLengthString() {
      String unevenHead = AMQPMessageIdHelper.AMQP_BINARY_PREFIX + "123";

      try {
         messageIdHelper.toIdObject(unevenHead);
         fail("expected exception was not thrown");
      } catch (ActiveMQAMQPException ex) {
         // expected
      }
   }

   /**
    * Test that {@link AMQPMessageIdHelper#toIdObject(String)} throws an
    * {@link IdConversionException} when presented with an encoded binary hex string (after the
    * prefix) that contains characters other than 0-9 and A-F and a-f, and thus can't be
    * converted
    */
   @Test
   public void testToIdObjectWithStringContainingBinaryHexThrowsWithNonHexCharacters() {

      // char before '0'
      char nonHexChar = '/';
      String nonHexString = AMQPMessageIdHelper.AMQP_BINARY_PREFIX + nonHexChar + nonHexChar;

      try {
         messageIdHelper.toIdObject(nonHexString);
         fail("expected exception was not thrown");
      } catch (ActiveMQAMQPException ex) {
         // expected
      }

      // char after '9', before 'A'
      nonHexChar = ':';
      nonHexString = AMQPMessageIdHelper.AMQP_BINARY_PREFIX + nonHexChar + nonHexChar;

      try {
         messageIdHelper.toIdObject(nonHexString);
         fail("expected exception was not thrown");
      } catch (ActiveMQAMQPException ex) {
         // expected
      }

      // char after 'F', before 'a'
      nonHexChar = 'G';
      nonHexString = AMQPMessageIdHelper.AMQP_BINARY_PREFIX + nonHexChar + nonHexChar;

      try {
         messageIdHelper.toIdObject(nonHexString);
         fail("expected exception was not thrown");
      } catch (ActiveMQAMQPException ex) {
         // expected
      }

      // char after 'f'
      nonHexChar = 'g';
      nonHexString = AMQPMessageIdHelper.AMQP_BINARY_PREFIX + nonHexChar + nonHexChar;

      try {
         messageIdHelper.toIdObject(nonHexString);
         fail("expected exception was not thrown");
      } catch (ActiveMQAMQPException ex) {
         // expected
      }
   }
}