/*
* 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.qpid.jms.integration;
import static org.hamcrest.Matchers.equalTo;
import static org.junit.Assert.assertArrayEquals;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.util.ArrayList;
import java.util.List;
import javax.jms.CompletionListener;
import javax.jms.Connection;
import javax.jms.DeliveryMode;
import javax.jms.Message;
import javax.jms.MessageConsumer;
import javax.jms.MessageFormatException;
import javax.jms.MessageNotWriteableException;
import javax.jms.MessageProducer;
import javax.jms.Queue;
import javax.jms.Session;
import javax.jms.StreamMessage;
import org.apache.qpid.jms.JmsConnection;
import org.apache.qpid.jms.provider.amqp.message.AmqpMessageSupport;
import org.apache.qpid.jms.test.QpidJmsTestCase;
import org.apache.qpid.jms.test.testpeer.TestAmqpPeer;
import org.apache.qpid.jms.test.testpeer.describedtypes.sections.AmqpValueDescribedType;
import org.apache.qpid.jms.test.testpeer.describedtypes.sections.MessageAnnotationsDescribedType;
import org.apache.qpid.jms.test.testpeer.matchers.sections.MessageAnnotationsSectionMatcher;
import org.apache.qpid.jms.test.testpeer.matchers.sections.MessageHeaderSectionMatcher;
import org.apache.qpid.jms.test.testpeer.matchers.sections.MessagePropertiesSectionMatcher;
import org.apache.qpid.jms.test.testpeer.matchers.sections.TransferPayloadCompositeMatcher;
import org.apache.qpid.jms.test.testpeer.matchers.types.EncodedAmqpSequenceMatcher;
import org.apache.qpid.proton.amqp.Binary;
import org.apache.qpid.proton.amqp.DescribedType;
import org.apache.qpid.proton.amqp.Symbol;
import org.junit.Test;
public class StreamMessageIntegrationTest extends QpidJmsTestCase {
private final IntegrationTestFixture testFixture = new IntegrationTestFixture();
/**
* Test that a message received from the test peer with an AmqpValue section containing
* a list which holds entries of the various supported entry types is returned as a
* {@link StreamMessage}, and verify the values can all be retrieved as expected.
*
* @throws Exception if an error occurs during the test.
*/
@Test(timeout = 20000)
public void testReceiveBasicStreamMessage() throws Exception {
try (TestAmqpPeer testPeer = new TestAmqpPeer();) {
Connection connection = testFixture.establishConnecton(testPeer);
connection.start();
testPeer.expectBegin();
Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
Queue queue = session.createQueue("myQueue");
//Prepare an AMQP message for the test peer to send, containing an
//AmqpValue section holding a list with entries for each supported type,
//and annotated as a JMS stream message.
boolean myBool = true;
byte myByte = Byte.MAX_VALUE;
char myChar = 'c';
double myDouble = 1234567890123456789.1234;
float myFloat = 1.1F;
int myInt = Integer.MAX_VALUE;
long myLong = Long.MAX_VALUE;
short myShort = Short.MAX_VALUE;
String myString = "myString";
byte[] myBytes = "myBytes".getBytes();
List<Object> list = new ArrayList<Object>();
list.add(myBool);
list.add(myByte);
list.add(new Binary(myBytes));//the underlying AMQP message uses Binary rather than byte[] directly.
list.add(myChar);
list.add(myDouble);
list.add(myFloat);
list.add(myInt);
list.add(myLong);
list.add(myShort);
list.add(myString);
MessageAnnotationsDescribedType msgAnnotations = new MessageAnnotationsDescribedType();
msgAnnotations.setSymbolKeyedAnnotation(AmqpMessageSupport.JMS_MSG_TYPE, AmqpMessageSupport.JMS_STREAM_MESSAGE);
DescribedType amqpValueSectionContent = new AmqpValueDescribedType(list);
//receive the message from the test peer
testPeer.expectReceiverAttach();
testPeer.expectLinkFlowRespondWithTransfer(null, msgAnnotations, null, null, amqpValueSectionContent);
testPeer.expectDispositionThatIsAcceptedAndSettled();
testPeer.expectClose();
MessageConsumer messageConsumer = session.createConsumer(queue);
Message receivedMessage = messageConsumer.receive(3000);
//verify the content is as expected
assertNotNull("Message was not received", receivedMessage);
assertTrue("Message was not a MapMessage", receivedMessage instanceof StreamMessage);
StreamMessage receivedStreamMessage = (StreamMessage) receivedMessage;
assertEquals("Unexpected boolean value", myBool, receivedStreamMessage.readBoolean());
assertEquals("Unexpected byte value", myByte, receivedStreamMessage.readByte());
byte[] readBytes = (byte[]) receivedStreamMessage.readObject();//using readObject to get a new byte[]
assertArrayEquals("Read bytes were not as expected", myBytes, readBytes);
assertEquals("Unexpected char value", myChar, receivedStreamMessage.readChar());
assertEquals("Unexpected double value", myDouble, receivedStreamMessage.readDouble(), 0.0);
assertEquals("Unexpected float value", myFloat, receivedStreamMessage.readFloat(), 0.0);
assertEquals("Unexpected int value", myInt, receivedStreamMessage.readInt());
assertEquals("Unexpected long value", myLong, receivedStreamMessage.readLong());
assertEquals("Unexpected short value", myShort, receivedStreamMessage.readShort());
assertEquals("Unexpected UTF value", myString, receivedStreamMessage.readString());
assertFalse(receivedStreamMessage.isBodyAssignableTo(String.class));
assertFalse(receivedStreamMessage.isBodyAssignableTo(Object.class));
assertFalse(receivedStreamMessage.isBodyAssignableTo(Boolean.class));
assertFalse(receivedStreamMessage.isBodyAssignableTo(byte[].class));
try {
receivedStreamMessage.getBody(Object.class);
fail("Cannot read TextMessage with this type.");
} catch (MessageFormatException mfe) {
}
try {
receivedStreamMessage.getBody(byte[].class);
fail("Cannot read TextMessage with this type.");
} catch (MessageFormatException mfe) {
}
try {
receivedStreamMessage.getBody(String.class);
fail("Cannot read TextMessage with this type.");
} catch (MessageFormatException mfe) {
}
connection.close();
testPeer.waitForAllHandlersToComplete(3000);
}
}
/*
* TODO: decide what to do about this
*
* The test below fails if a char is added, because the DataImpl-based decoder used by the test peer
* decodes the char to an Integer object and thus the EncodedAmqpValueMatcher fails the comparison
* of its contained map due to the differing types. This doesn't happen in the above test as the
* reversed roles mean it is DecoderImpl doing the decoding and it casts the output to a char.
*
* The below test has a hack to 'expect an int' to work round this currently.
/**
* Test that sending a stream message to the test peer results in receipt of a message with
* an AmqpValue section containing a list which holds entries of the various supported entry
* types with the expected values.
*/
@Test(timeout = 20000)
public void testSendBasicStreamMessage() throws Exception {
try (TestAmqpPeer testPeer = new TestAmqpPeer();) {
Connection connection = testFixture.establishConnecton(testPeer);
testPeer.expectBegin();
testPeer.expectSenderAttach();
Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
Queue queue = session.createQueue("myQueue");
MessageProducer producer = session.createProducer(queue);
boolean myBool = true;
byte myByte = Byte.MAX_VALUE;
char myChar = 'c';
double myDouble = 1234567890123456789.1234;
float myFloat = 1.1F;
int myInt = Integer.MAX_VALUE;
long myLong = Long.MAX_VALUE;
short myShort = Short.MAX_VALUE;
String myString = "myString";
byte[] myBytes = "myBytes".getBytes();
//Prepare a StreamMessage to send to the test peer to send
StreamMessage streamMessage = session.createStreamMessage();
streamMessage.writeBoolean(myBool);
streamMessage.writeByte(myByte);
streamMessage.writeBytes(myBytes);
streamMessage.writeChar(myChar);
streamMessage.writeDouble(myDouble);
streamMessage.writeFloat(myFloat);
streamMessage.writeInt(myInt);
streamMessage.writeLong(myLong);
streamMessage.writeShort(myShort);
streamMessage.writeString(myString);
//prepare a matcher for the test peer to use to receive and verify the message
List<Object> list = new ArrayList<Object>();
list.add(myBool);
list.add(myByte);
list.add(new Binary(myBytes));//the underlying AMQP message uses Binary rather than byte[] directly.
list.add((int) myChar);//TODO: see note above about chars
list.add(myDouble);
list.add(myFloat);
list.add(myInt);
list.add(myLong);
list.add(myShort);
list.add(myString);
MessageHeaderSectionMatcher headersMatcher = new MessageHeaderSectionMatcher(true).withDurable(equalTo(true));
MessageAnnotationsSectionMatcher msgAnnotationsMatcher = new MessageAnnotationsSectionMatcher(true);
msgAnnotationsMatcher.withEntry(Symbol.valueOf(AmqpMessageSupport.JMS_MSG_TYPE), equalTo(AmqpMessageSupport.JMS_STREAM_MESSAGE));
MessagePropertiesSectionMatcher propertiesMatcher = new MessagePropertiesSectionMatcher(true);
TransferPayloadCompositeMatcher messageMatcher = new TransferPayloadCompositeMatcher();
messageMatcher.setHeadersMatcher(headersMatcher);
messageMatcher.setMessageAnnotationsMatcher(msgAnnotationsMatcher);
messageMatcher.setPropertiesMatcher(propertiesMatcher);
messageMatcher.setMessageContentMatcher(new EncodedAmqpSequenceMatcher(list));
testPeer.expectTransfer(messageMatcher);
testPeer.expectClose();
//send the message
producer.send(streamMessage);
assertFalse(streamMessage.isBodyAssignableTo(String.class));
assertFalse(streamMessage.isBodyAssignableTo(Object.class));
assertFalse(streamMessage.isBodyAssignableTo(Boolean.class));
assertFalse(streamMessage.isBodyAssignableTo(byte[].class));
try {
streamMessage.getBody(Object.class);
fail("Cannot read TextMessage with this type.");
} catch (MessageFormatException mfe) {
}
try {
streamMessage.getBody(byte[].class);
fail("Cannot read TextMessage with this type.");
} catch (MessageFormatException mfe) {
}
try {
streamMessage.getBody(String.class);
fail("Cannot read TextMessage with this type.");
} catch (MessageFormatException mfe) {
}
connection.close();
testPeer.waitForAllHandlersToComplete(3000);
}
}
@Test(timeout = 20000)
public void testSentStreamMessageIsReadOnly() throws Exception {
try (TestAmqpPeer testPeer = new TestAmqpPeer();) {
Connection connection = testFixture.establishConnecton(testPeer);
testPeer.expectBegin();
testPeer.expectSenderAttach();
Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
Queue queue = session.createQueue("myQueue");
MessageProducer producer = session.createProducer(queue);
String myString = "myString";
// Prepare a StreamMessage to send to the test peer to send
StreamMessage streamMessage = session.createStreamMessage();
streamMessage.writeString(myString);
// prepare a matcher for the test peer to use to receive and verify the message
List<Object> list = new ArrayList<Object>();
list.add(myString);
MessageHeaderSectionMatcher headersMatcher = new MessageHeaderSectionMatcher(true).withDurable(equalTo(true));
MessageAnnotationsSectionMatcher msgAnnotationsMatcher = new MessageAnnotationsSectionMatcher(true);
msgAnnotationsMatcher.withEntry(Symbol.valueOf(AmqpMessageSupport.JMS_MSG_TYPE), equalTo(AmqpMessageSupport.JMS_STREAM_MESSAGE));
MessagePropertiesSectionMatcher propertiesMatcher = new MessagePropertiesSectionMatcher(true);
TransferPayloadCompositeMatcher messageMatcher = new TransferPayloadCompositeMatcher();
messageMatcher.setHeadersMatcher(headersMatcher);
messageMatcher.setMessageAnnotationsMatcher(msgAnnotationsMatcher);
messageMatcher.setPropertiesMatcher(propertiesMatcher);
messageMatcher.setMessageContentMatcher(new EncodedAmqpSequenceMatcher(list));
testPeer.expectTransfer(messageMatcher);
testPeer.expectClose();
producer.send(streamMessage);
try {
streamMessage.writeString(myString);
fail("Message should not be writable after a send.");
} catch (MessageNotWriteableException mnwe) {}
connection.close();
testPeer.waitForAllHandlersToComplete(3000);
}
}
@Test(timeout = 20000)
public void testAsyncSendDoesNotMarkStreamMessageReadOnly() throws Exception {
try(TestAmqpPeer testPeer = new TestAmqpPeer();) {
JmsConnection connection = (JmsConnection) testFixture.establishConnecton(testPeer);
connection.setSendTimeout(15000);
testPeer.expectBegin();
Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
String queueName = "myQueue";
Queue queue = session.createQueue(queueName);
StreamMessage message = session.createStreamMessage();
TransferPayloadCompositeMatcher messageMatcher = new TransferPayloadCompositeMatcher();
// Expect the producer to attach and grant it some credit, it should send
// a transfer which we will not send any response so that we can check that
// the inflight message is read-only
testPeer.expectSenderAttach();
testPeer.expectTransferButDoNotRespond(messageMatcher);
testPeer.expectClose();
MessageProducer producer = session.createProducer(queue);
producer.setDeliveryMode(DeliveryMode.NON_PERSISTENT);
try {
producer.send(message);
} catch (Throwable error) {
fail("Send should not fail for async.");
}
try {
message.setJMSCorrelationID("test");
} catch (MessageNotWriteableException mnwe) {
fail("Should be able to set properties on inflight message");
}
try {
message.setJMSCorrelationIDAsBytes(new byte[]{});
} catch (MessageNotWriteableException mnwe) {
fail("Should be able to set properties on inflight message");
}
try {
message.setJMSDeliveryMode(DeliveryMode.PERSISTENT);
} catch (MessageNotWriteableException mnwe) {
fail("Should be able to set properties on inflight message");
}
try {
message.setJMSDestination(queue);
} catch (MessageNotWriteableException mnwe) {
fail("Should be able to set properties on inflight message");
}
try {
message.setJMSExpiration(0);
} catch (MessageNotWriteableException mnwe) {
fail("Should be able to set properties on inflight message");
}
try {
message.setJMSMessageID(queueName);
} catch (MessageNotWriteableException mnwe) {
fail("Should be able to set properties on inflight message");
}
try {
message.setJMSPriority(0);
} catch (MessageNotWriteableException mnwe) {
fail("Should be able to set properties on inflight message");
}
try {
message.setJMSRedelivered(false);
} catch (MessageNotWriteableException mnwe) {
fail("Should be able to set properties on inflight message");
}
try {
message.setJMSReplyTo(queue);
} catch (MessageNotWriteableException mnwe) {
fail("Should be able to set properties on inflight message");
}
try {
message.setJMSTimestamp(0);
} catch (MessageNotWriteableException mnwe) {
fail("Should be able to set properties on inflight message");
}
try {
message.setJMSType(queueName);
} catch (MessageNotWriteableException mnwe) {
fail("Should be able to set properties on inflight message");
}
try {
message.setStringProperty("test", "test");
} catch (MessageNotWriteableException mnwe) {
fail("Should be able to set properties on inflight message");
}
try {
message.clearBody();
} catch (MessageNotWriteableException mnwe) {
fail("Should be able to clear an inflight message");
}
try {
message.writeString("test");
} catch (MessageNotWriteableException mnwe) {
fail("Should be able to write to inflight message");
}
connection.close();
testPeer.waitForAllHandlersToComplete(1000);
}
}
@Test(timeout = 20000)
public void testAsyncCompletionSendMarksStreamMessageReadOnly() throws Exception {
try(TestAmqpPeer testPeer = new TestAmqpPeer();) {
JmsConnection connection = (JmsConnection) testFixture.establishConnecton(testPeer);
connection.setSendTimeout(15000);
testPeer.expectBegin();
Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
String queueName = "myQueue";
Queue queue = session.createQueue(queueName);
StreamMessage message = session.createStreamMessage();
TransferPayloadCompositeMatcher messageMatcher = new TransferPayloadCompositeMatcher();
// Expect the producer to attach and grant it some credit, it should send
// a transfer which we will not send any response so that we can check that
// the inflight message is read-only
testPeer.expectSenderAttach();
testPeer.expectTransferButDoNotRespond(messageMatcher);
testPeer.expectClose();
MessageProducer producer = session.createProducer(queue);
TestJmsCompletionListener listener = new TestJmsCompletionListener();
try {
producer.send(message, listener);
} catch (Throwable error) {
fail("Send should not fail for async.");
}
try {
message.setJMSCorrelationID("test");
fail("Should not be able to set properties on inflight message");
} catch (MessageNotWriteableException mnwe) {}
try {
message.setJMSCorrelationIDAsBytes(new byte[]{});
fail("Should not be able to set properties on inflight message");
} catch (MessageNotWriteableException mnwe) {}
try {
message.setJMSDeliveryMode(DeliveryMode.PERSISTENT);
fail("Should not be able to set properties on inflight message");
} catch (MessageNotWriteableException mnwe) {}
try {
message.setJMSDestination(queue);
fail("Should not be able to set properties on inflight message");
} catch (MessageNotWriteableException mnwe) {}
try {
message.setJMSExpiration(0);
fail("Should not be able to set properties on inflight message");
} catch (MessageNotWriteableException mnwe) {}
try {
message.setJMSMessageID(queueName);
fail("Should not be able to set properties on inflight message");
} catch (MessageNotWriteableException mnwe) {}
try {
message.setJMSPriority(0);
fail("Should not be able to set properties on inflight message");
} catch (MessageNotWriteableException mnwe) {}
try {
message.setJMSRedelivered(false);
fail("Should not be able to set properties on inflight message");
} catch (MessageNotWriteableException mnwe) {}
try {
message.setJMSReplyTo(queue);
fail("Should not be able to set properties on inflight message");
} catch (MessageNotWriteableException mnwe) {}
try {
message.setJMSTimestamp(0);
fail("Should not be able to set properties on inflight message");
} catch (MessageNotWriteableException mnwe) {}
try {
message.setJMSType(queueName);
fail("Should not be able to set properties on inflight message");
} catch (MessageNotWriteableException mnwe) {}
try {
message.setStringProperty("test", "test");
fail("Should not be able to set properties on inflight message");
} catch (MessageNotWriteableException mnwe) {}
try {
message.writeString("test");
fail("Message should not be writable after a send.");
} catch (MessageNotWriteableException mnwe) {}
connection.close();
testPeer.waitForAllHandlersToComplete(1000);
}
}
private class TestJmsCompletionListener implements CompletionListener {
@Override
public void onCompletion(Message message) {
}
@Override
public void onException(Message message, Exception exception) {
}
}
}