/*
* 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.server;
import java.io.IOException;
import java.io.StringWriter;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;
import org.codehaus.jackson.map.ObjectMapper;
import org.apache.qpid.client.AMQConnection;
import org.apache.qpid.configuration.ClientProperties;
import org.apache.qpid.framing.ProtocolVersion;
import org.apache.qpid.server.configuration.BrokerProperties;
import org.apache.qpid.server.model.Protocol;
import org.apache.qpid.server.plugin.AMQPProtocolVersionWrapper;
import org.apache.qpid.test.utils.QpidBrokerTestCase;
/**
* Tests to validate it is possible to disable support for particular protocol
* versions entirely, rather than selectively excluding them on particular ports,
* and it is possible to configure the reply to an unsupported protocol initiation.
*<p>
*/
public class SupportedProtocolVersionsTest extends QpidBrokerTestCase
{
public void setUp() throws Exception
{
// No-op, we call super.setUp() from test methods after appropriate config overrides
}
private void clearProtocolSupportManipulations() throws Exception
{
//Remove the QBTC provided protocol manipulations, giving only the protocols which default to enabled
setSystemProperty(QpidBrokerTestCase.TEST_AMQP_PORT_PROTOCOLS_PROPERTY, getProtocolsAsString(getAllAmqpProtocols()));
}
private Collection<Protocol> getAllAmqpProtocols() throws Exception
{
Collection<Protocol> protocols = new HashSet<>();
for(Protocol p : Protocol.values())
{
if(p.getProtocolType() == Protocol.ProtocolType.AMQP)
{
protocols.add(p);
}
}
return protocols;
}
private String getProtocolsWithExclusions(Protocol... excludes) throws Exception
{
Set<Protocol> protocols = new HashSet<>(getAllAmqpProtocols());
protocols.removeAll(Arrays.asList(excludes));
return getProtocolsAsString(protocols);
}
private String getProtocolsAsString(final Collection<Protocol> protocols) throws IOException
{
ObjectMapper mapper = new ObjectMapper();
StringWriter stringWriter = new StringWriter();
mapper.writeValue(stringWriter, protocols);
return stringWriter.toString();
}
/**
* Test that 0-10, 0-9-1, 0-9, and 0-8 support is present when no
* attempt has yet been made to disable them, and forcing the client
* to negotiate from a particular protocol version returns a connection
* using the expected protocol version.
*/
public void testDefaultProtocolSupport() throws Exception
{
clearProtocolSupportManipulations();
super.setUp();
//Verify requesting a 0-10 connection works
setTestClientSystemProperty(ClientProperties.AMQP_VERSION, "0-10");
AMQConnection connection = (AMQConnection) getConnection();
assertEquals("Unexpected protocol version in use", ProtocolVersion.v0_10, connection.getProtocolVersion());
connection.close();
//Verify requesting a 0-91 connection works
setTestClientSystemProperty(ClientProperties.AMQP_VERSION, "0-9-1");
connection = (AMQConnection) getConnection();
assertEquals("Unexpected protocol version in use", ProtocolVersion.v0_91, connection.getProtocolVersion());
connection.close();
//Verify requesting a 0-9 connection works
setTestClientSystemProperty(ClientProperties.AMQP_VERSION, "0-9");
connection = (AMQConnection) getConnection();
assertEquals("Unexpected protocol version in use", ProtocolVersion.v0_9, connection.getProtocolVersion());
connection.close();
//Verify requesting a 0-8 connection works
setTestClientSystemProperty(ClientProperties.AMQP_VERSION, "0-8");
connection = (AMQConnection) getConnection();
assertEquals("Unexpected protocol version in use", ProtocolVersion.v8_0, connection.getProtocolVersion());
connection.close();
}
public void testDisabling010and10() throws Exception
{
setSystemProperty(QpidBrokerTestCase.TEST_AMQP_PORT_PROTOCOLS_PROPERTY, getProtocolsWithExclusions(Protocol.AMQP_1_0, Protocol.AMQP_0_10));
super.setUp();
//Verify initially requesting a 0-10 connection now negotiates a 0-91
//connection as the broker should reply with its highest supported protocol
setTestClientSystemProperty(ClientProperties.AMQP_VERSION, "0-10");
AMQConnection connection = (AMQConnection) getConnection();
assertEquals("Unexpected protocol version in use", ProtocolVersion.v0_91, connection.getProtocolVersion());
connection.close();
}
public void testConfiguringReplyingToUnsupported010ProtocolInitiationWith09insteadOf091() throws Exception
{
clearProtocolSupportManipulations();
//disable 0-10 support, and set the default unsupported protocol initiation reply to 0-9
setSystemProperty(QpidBrokerTestCase.TEST_AMQP_PORT_PROTOCOLS_PROPERTY, getProtocolsWithExclusions(Protocol.AMQP_1_0, Protocol.AMQP_0_10));
setSystemProperty(BrokerProperties.PROPERTY_DEFAULT_SUPPORTED_PROTOCOL_REPLY, "v0_9");
super.setUp();
//Verify initially requesting a 0-10 connection now negotiates a 0-9 connection as the
//broker should reply with its 'default unsupported protocol initiation reply' as opposed
//to the previous behaviour of the highest supported protocol version.
setTestClientSystemProperty(ClientProperties.AMQP_VERSION, "0-10");
AMQConnection connection = (AMQConnection) getConnection();
assertEquals("Unexpected protocol version in use", ProtocolVersion.v0_9, connection.getProtocolVersion());
connection.close();
//Verify requesting a 0-91 connection directly still works, as its support is still enabled
setTestClientSystemProperty(ClientProperties.AMQP_VERSION, "0-9-1");
connection = (AMQConnection) getConnection();
assertEquals("Unexpected protocol version in use", ProtocolVersion.v0_91, connection.getProtocolVersion());
connection.close();
}
public void testProtocolIsExpectedBasedOnTestProfile() throws Exception
{
super.setUp();
final AMQConnection connection = (AMQConnection) getConnection();
final Protocol expectedBrokerProtocol = getBrokerProtocol();
final AMQPProtocolVersionWrapper amqpProtocolVersionWrapper = new AMQPProtocolVersionWrapper(expectedBrokerProtocol);
final ProtocolVersion protocolVersion = connection.getProtocolVersion();
assertTrue("Connection AMQP protocol " + expectedBrokerProtocol + "is not the same as the test specified protocol " + protocolVersion,
areEquivalent(amqpProtocolVersionWrapper, protocolVersion));
connection.close();
}
private boolean areEquivalent(AMQPProtocolVersionWrapper amqpProtocolVersionWrapper, ProtocolVersion protocolVersion)
{
byte byteMajor = (byte)amqpProtocolVersionWrapper.getMajor();
byte byteMinor;
if (amqpProtocolVersionWrapper.getPatch() == 0)
{
byteMinor = (byte)amqpProtocolVersionWrapper.getMinor();
}
else
{
final StringBuilder sb = new StringBuilder();
sb.append(amqpProtocolVersionWrapper.getMinor());
sb.append(amqpProtocolVersionWrapper.getPatch());
byteMinor = Byte.valueOf(sb.toString()).byteValue();
}
return (protocolVersion.getMajorVersion() == byteMajor && protocolVersion.getMinorVersion() == byteMinor);
}
}