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 java.io.IOException;
+import java.util.Queue;
-import javax.xml.parsers.ParserConfigurationException;
+import io.netty.buffer.ByteBuf;
+import io.netty.channel.embedded.EmbeddedChannel;
-import org.custommonkey.xmlunit.XMLAssert;
import org.junit.Before;
-import org.junit.Ignore;
import org.junit.Test;
import org.opendaylight.controller.netconf.api.NetconfMessage;
+import org.opendaylight.controller.netconf.util.handler.FramingMechanismHandlerFactory;
+import org.opendaylight.controller.netconf.util.handler.NetconfMessageAggregator;
+import org.opendaylight.controller.netconf.util.handler.NetconfMessageChunkDecoder;
import org.opendaylight.controller.netconf.util.messages.FramingMechanism;
+import org.opendaylight.controller.netconf.util.messages.NetconfMessageConstants;
import org.opendaylight.controller.netconf.util.messages.NetconfMessageFactory;
+import org.opendaylight.controller.netconf.util.messages.NetconfMessageHeader;
import org.opendaylight.controller.netconf.util.test.XmlFileLoader;
-import org.opendaylight.controller.netconf.util.xml.XmlUtil;
-import org.opendaylight.protocol.framework.DeserializerException;
-import org.opendaylight.protocol.framework.DocumentedException;
-import org.opendaylight.protocol.util.ByteArray;
-import org.w3c.dom.Document;
-import org.xml.sax.SAXException;
+import org.opendaylight.protocol.framework.ProtocolMessageDecoder;
+import org.opendaylight.protocol.framework.ProtocolMessageEncoder;
public class MessageParserTest {
- private NetconfMessageFactory parser = null;
+ private NetconfMessage msg;
+ private NetconfMessageFactory msgFactory = new NetconfMessageFactory();
@Before
- public void setUp() {
- this.parser = new NetconfMessageFactory();
+ public void setUp() throws Exception {
+ this.msg = XmlFileLoader.xmlFileToNetconfMessage("netconfMessages/getConfig.xml");
}
@Test
- public void testPutEOM() throws IOException, SAXException, ParserConfigurationException {
- final NetconfMessage msg = XmlFileLoader.xmlFileToNetconfMessage("netconfMessages/client_hello.xml");
- final byte[] bytes = this.parser.put(msg);
- assertArrayEquals(NetconfMessageFactory.endOfMessage, ByteArray.subByte(bytes, bytes.length
- - NetconfMessageFactory.endOfMessage.length, NetconfMessageFactory.endOfMessage.length));
- }
+ public void testChunkedFramingMechanismOnPipeline() throws Exception {
+ EmbeddedChannel testChunkChannel = new EmbeddedChannel(
+ FramingMechanismHandlerFactory.createHandler(FramingMechanism.CHUNK),
+ new ProtocolMessageEncoder<NetconfMessage>(msgFactory),
- @Ignore
- @Test
- // TODO not working on WINDOWS
- // arrays first differed at element [4]; expected:<49> but was:<53>
- // at
- // org.junit.internal.ComparisonCriteria.arrayEquals(ComparisonCriteria.java:52)
- public void testPutChunk() throws IOException, SAXException, ParserConfigurationException {
- final NetconfMessage msg = XmlFileLoader.xmlFileToNetconfMessage("netconfMessages/client_hello.xml");
- this.parser.setFramingMechanism(FramingMechanism.CHUNK);
- final byte[] bytes = this.parser.put(msg);
- final byte[] header = new byte[] { (byte) 0x0a, (byte) 0x23 , (byte) 0x32, (byte) 0x31, (byte) 0x31, (byte) 0x0a};
- assertArrayEquals(header, ByteArray.subByte(bytes, 0, header.length));
- assertArrayEquals(NetconfMessageFactory.endOfChunk, ByteArray.subByte(bytes, bytes.length
- - NetconfMessageFactory.endOfChunk.length, NetconfMessageFactory.endOfChunk.length));
- }
+ new NetconfMessageAggregator(FramingMechanism.CHUNK), new NetconfMessageChunkDecoder(),
+ new ProtocolMessageDecoder<NetconfMessage>(msgFactory));
- @Test
- public void testParseEOM() throws IOException, SAXException, DeserializerException, DocumentedException,
- ParserConfigurationException {
- final Document msg = XmlFileLoader.xmlFileToDocument("netconfMessages/client_hello.xml");
- final byte[] bytes = this.parser.put(new NetconfMessage(msg));
- final Document doc = this.parser
- .parse(ByteArray.subByte(bytes, 0, bytes.length - NetconfMessageFactory.endOfMessage.length))
- .getDocument();
- assertEquals(XmlUtil.toString(msg), XmlUtil.toString(doc));
- XMLAssert.assertXMLEqual(msg, doc);
+ testChunkChannel.writeOutbound(this.msg);
+ Queue<Object> messages = testChunkChannel.outboundMessages();
+ assertFalse(messages.isEmpty());
+
+ int msgLength = this.msgFactory.put(this.msg).length;
+ int chunkCount = msgLength / NetconfMessageConstants.MAX_CHUNK_SIZE;
+ if ((msgLength % NetconfMessageConstants.MAX_CHUNK_SIZE) != 0) {
+ chunkCount++;
+ }
+ for (int i = 1; i <= chunkCount; i++) {
+ ByteBuf recievedOutbound = (ByteBuf) messages.poll();
+ int exptHeaderLength = NetconfMessageConstants.MAX_CHUNK_SIZE;
+ if (i == chunkCount) {
+ exptHeaderLength = msgLength - (NetconfMessageConstants.MAX_CHUNK_SIZE * (i - 1));
+ byte[] eom = new byte[NetconfMessageConstants.endOfChunk.length];
+ recievedOutbound.getBytes(recievedOutbound.readableBytes() - NetconfMessageConstants.endOfChunk.length,
+ eom);
+ assertArrayEquals(NetconfMessageConstants.endOfChunk, eom);
+ }
+
+ byte[] header = new byte[String.valueOf(exptHeaderLength).length()
+ + NetconfMessageConstants.MIN_HEADER_LENGTH - 1];
+ recievedOutbound.getBytes(0, header);
+ NetconfMessageHeader messageHeader = new NetconfMessageHeader();
+ messageHeader.fromBytes(header);
+ assertEquals(exptHeaderLength, messageHeader.getLength());
+
+ testChunkChannel.writeInbound(recievedOutbound);
+ }
+ assertTrue(messages.isEmpty());
+
+ NetconfMessage receivedMessage = (NetconfMessage) testChunkChannel.readInbound();
+ assertNotNull(receivedMessage);
+ assertTrue(this.msg.getDocument().isEqualNode(receivedMessage.getDocument()));
}
@Test
- public void testParseChunk() throws IOException, SAXException, DeserializerException, DocumentedException,
- ParserConfigurationException {
- final Document msg = XmlFileLoader.xmlFileToDocument("netconfMessages/client_hello.xml");
- this.parser.setFramingMechanism(FramingMechanism.CHUNK);
- final byte[] bytes = this.parser.put(new NetconfMessage(msg));
- final Document doc = this.parser
- .parse(ByteArray.subByte(bytes, 6, bytes.length - NetconfMessageFactory.endOfChunk.length - 6))
- .getDocument();
- assertEquals(XmlUtil.toString(msg), XmlUtil.toString(doc));
- XMLAssert.assertXMLEqual(msg, doc);
- }
+ public void testEOMFramingMechanismOnPipeline() throws Exception {
+ EmbeddedChannel testChunkChannel = new EmbeddedChannel(
+ FramingMechanismHandlerFactory.createHandler(FramingMechanism.EOM),
+ new ProtocolMessageEncoder<NetconfMessage>(msgFactory), new NetconfMessageAggregator(
+ FramingMechanism.EOM), new ProtocolMessageDecoder<NetconfMessage>(msgFactory));
+ testChunkChannel.writeOutbound(this.msg);
+ ByteBuf recievedOutbound = (ByteBuf) testChunkChannel.readOutbound();
+
+ byte[] eom = new byte[NetconfMessageConstants.endOfMessage.length];
+ recievedOutbound.getBytes(recievedOutbound.readableBytes() - NetconfMessageConstants.endOfMessage.length, eom);
+ assertArrayEquals(NetconfMessageConstants.endOfMessage, eom);
+
+ testChunkChannel.writeInbound(recievedOutbound);
+ NetconfMessage receivedMessage = (NetconfMessage) testChunkChannel.readInbound();
+ assertNotNull(receivedMessage);
+ assertTrue(this.msg.getDocument().isEqualNode(receivedMessage.getDocument()));
+ }
}
package org.opendaylight.controller.netconf.util.handler;
-import org.opendaylight.controller.netconf.util.messages.NetconfMessageFactory;
+import org.opendaylight.controller.netconf.util.messages.NetconfMessageConstants;
import org.opendaylight.controller.netconf.util.messages.NetconfMessageHeader;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
public class ChunkedFramingMechanismEncoder extends MessageToByteEncoder<ByteBuf> {
- private final static Logger logger = LoggerFactory.getLogger(ChunkedFramingMechanismEncoder.class);
-
private NetconfMessageHeader messageHeader = new NetconfMessageHeader();
+ private final static int MAX_CHUNK_SIZE = NetconfMessageConstants.MAX_CHUNK_SIZE;
+
@Override
protected void encode(ChannelHandlerContext ctx, ByteBuf msg, ByteBuf out) throws Exception {
- while (msg.readableBytes() > NetconfMessageFactory.MAX_CHUNK_SIZE) {
- ByteBuf chunk = Unpooled.buffer(NetconfMessageFactory.MAX_CHUNK_SIZE);
- chunk.writeBytes(createChunkHeader(NetconfMessageFactory.MAX_CHUNK_SIZE));
- chunk.writeBytes(msg.readBytes(NetconfMessageFactory.MAX_CHUNK_SIZE));
+ while (msg.readableBytes() > MAX_CHUNK_SIZE) {
+ ByteBuf chunk = Unpooled.buffer(MAX_CHUNK_SIZE);
+ chunk.writeBytes(createChunkHeader(MAX_CHUNK_SIZE));
+ chunk.writeBytes(msg.readBytes(MAX_CHUNK_SIZE));
ctx.write(chunk);
}
out.writeBytes(createChunkHeader(msg.readableBytes()));
out.writeBytes(msg.readBytes(msg.readableBytes()));
- out.writeBytes(NetconfMessageFactory.endOfChunk);
- logger.debug("Output message size is {}", out.readableBytes());
+ out.writeBytes(NetconfMessageConstants.endOfChunk);
}
private ByteBuf createChunkHeader(int chunkSize) {
messageHeader.setLength(chunkSize);
- logger.debug("Chunked data length is {}.", chunkSize);
return Unpooled.wrappedBuffer(messageHeader.toBytes());
}
import com.google.common.base.Charsets;
import com.google.common.base.Optional;
-import io.netty.buffer.Unpooled;
-import io.netty.channel.ChannelHandler;
-import io.netty.handler.codec.DelimiterBasedFrameDecoder;
import org.opendaylight.controller.netconf.api.NetconfDeserializerException;
import org.opendaylight.controller.netconf.api.NetconfMessage;
import org.opendaylight.controller.netconf.util.xml.XmlUtil;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.util.Arrays;
-import java.util.List;
/**
* NetconfMessageFactory for (de)serializing DOM documents.
private static final Logger logger = LoggerFactory.getLogger(NetconfMessageFactory.class);
- public static final byte[] endOfMessage = "]]>]]>".getBytes(Charsets.UTF_8);
-
- public static final byte[] endOfChunk = "\n##\n".getBytes(Charsets.UTF_8);
-
- public static final int MAX_CHUNK_SIZE = 1024; // Bytes
-
- private FramingMechanism framing = FramingMechanism.EOM;
-
private final Optional<String> clientId;
public NetconfMessageFactory() {
this.clientId = clientId;
}
- public static ChannelHandler getDelimiterFrameDecoder() {
- return new DelimiterBasedFrameDecoder(Integer.MAX_VALUE, Unpooled.copiedBuffer(endOfMessage));
- }
-
@Override
public NetconfMessage parse(byte[] bytes) throws DeserializerException, DocumentedException {
String s = Charsets.UTF_8.decode(ByteBuffer.wrap(bytes)).toString();
Comment comment = netconfMessage.getDocument().createComment("clientId:" + clientId.get());
netconfMessage.getDocument().appendChild(comment);
}
- byte[] bytes = (this.framing == FramingMechanism.EOM) ? this.putEOM(netconfMessage) : this
- .putChunked(netconfMessage);
+ final ByteBuffer msgBytes = Charsets.UTF_8.encode(xmlToString(netconfMessage.getDocument()));
String content = xmlToString(netconfMessage.getDocument());
logger.trace("Putting message \n{}", content);
- return bytes;
- }
-
- private byte[] putEOM(NetconfMessage msg) {
- // create byte buffer from the String XML
- // all Netconf messages are encoded using UTF-8
- final ByteBuffer msgBytes = Charsets.UTF_8.encode(xmlToString(msg.getDocument()));
- final ByteBuffer result = ByteBuffer.allocate(msgBytes.limit() + endOfMessage.length);
- result.put(msgBytes);
- // put end of message
- result.put(endOfMessage);
- return result.array();
- }
-
- private byte[] putChunked(NetconfMessage msg) {
- final ByteBuffer msgBytes = Charsets.UTF_8.encode(xmlToString(msg.getDocument()));
- final NetconfMessageHeader h = new NetconfMessageHeader();
- if (msgBytes.limit() > MAX_CHUNK_SIZE)
- logger.warn("Netconf message too long, should be split.");
- h.setLength(msgBytes.limit());
- final byte[] headerBytes = h.toBytes();
- final ByteBuffer result = ByteBuffer.allocate(headerBytes.length + msgBytes.limit() + endOfChunk.length);
- result.put(headerBytes);
- result.put(msgBytes);
- result.put(endOfChunk);
- return result.array();
+ byte[] b = new byte[msgBytes.limit()];
+ msgBytes.get(b);
+ return b;
}
private String xmlToString(Document doc) {
return XmlUtil.toString(doc, false);
}
-
- /**
- * For Hello message the framing is always EOM, but the framing mechanism
- * may change.
- *
- * @param fm
- * new framing mechanism
- */
- public void setFramingMechanism(final FramingMechanism fm) {
- logger.debug("Framing mechanism changed to {}", fm);
- this.framing = fm;
- }
}
Code Review / controller.git / commitdiff