BasicFactoryTest.java

/**
*    Copyright (c) 2008 The Board of Trustees of The Leland Stanford Junior
*    University
*
*    Licensed 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.openflow.protocol;

import static org.junit.Assert.assertArrayEquals;

import java.util.List;

import junit.framework.TestCase;

import org.jboss.netty.buffer.ChannelBuffer;
import org.jboss.netty.buffer.ChannelBuffers;
import org.openflow.protocol.action.MockVendorAction;
import org.openflow.protocol.action.MockVendorActionFactory;
import org.openflow.protocol.action.OFAction;
import org.openflow.protocol.action.OFActionVendorGeneric;
import org.openflow.protocol.factory.BasicFactory;
import org.openflow.protocol.factory.MessageParseException;
import org.openflow.protocol.factory.OFVendorActionRegistry;
import org.openflow.util.U16;

public class BasicFactoryTest extends TestCase {

    public void testCreateAndParse() throws MessageParseException {
        BasicFactory factory = BasicFactory.getInstance();
        OFMessage m = factory.getMessage(OFType.HELLO);
        m.setVersion((byte) 1);
        m.setType(OFType.ECHO_REQUEST);
        m.setLength(U16.t(8));
        m.setXid(0xdeadbeef);
        ChannelBuffer bb = ChannelBuffers.dynamicBuffer();
        ChannelBuffer bb2 = ChannelBuffers.dynamicBuffer();
        m.writeTo(bb);
        bb2.writeBytes(bb, bb.readableBytes()-1);
        TestCase.assertNull(factory.parseMessage(bb2));
        bb2.writeByte(bb.readByte());
        List<OFMessage> message = factory.parseMessage(bb2);
        TestCase.assertNotNull(message);
        TestCase.assertEquals(message.size(), 1);
        TestCase.assertTrue(message.get(0).getType() == OFType.ECHO_REQUEST);
    }

    public void testInvalidMsgParse() throws MessageParseException {
        BasicFactory factory = BasicFactory.getInstance();
        OFMessage m = factory.getMessage(OFType.HELLO);
        m.setVersion((byte) 1);
        m.setType(OFType.ECHO_REQUEST);
        m.setLength(U16.t(16));
        m.setXid(0xdeadbeef);
        ChannelBuffer bb = ChannelBuffers.dynamicBuffer();
        m.writeTo(bb);
        List<OFMessage> message = factory.parseMessage(bb);
        TestCase.assertNull(message);
    }

    public void testCurrouptedMsgParse() throws MessageParseException {
        BasicFactory factory = BasicFactory.getInstance();
        OFMessage m = factory.getMessage(OFType.HELLO);
        m.setVersion((byte) 1);
        m.setType(OFType.ERROR);
        m.setLength(U16.t(8));
        m.setXid(0xdeadbeef);
        ChannelBuffer bb = ChannelBuffers.dynamicBuffer();
        m.writeTo(bb);
        try {
                factory.parseMessage(bb);
        }
        catch(Exception e) {
            TestCase.assertEquals(MessageParseException.class, e.getClass());
        }
    }

    public void testCustomVendorAction() throws MessageParseException {
        BasicFactory factory = BasicFactory.getInstance();
        OFVendorActionRegistry.getInstance().register(
                MockVendorAction.VENDOR_ID, new MockVendorActionFactory());


        byte[] deadBeefMessage = {
            (byte) 0xff, (byte) 0xff,          // action vendor
            0x00, 0x10,                        // length
            (byte) 0xde, (byte) 0xad, (byte) 0xbe, (byte)0xef,            // deadbeaf
            0x01, 0x02, 0x03, 0x04,
            0x05, 0x06, 0x07, 0x08               // pad
        };

        ChannelBuffer buf = ChannelBuffers.copiedBuffer(deadBeefMessage);

        List<OFAction> actions = factory.parseActions(buf,deadBeefMessage.length);
        assertEquals(1, actions.size());
        OFAction ofAction = actions.get(0);
        assertTrue("Action should be MockVendorAction, but is "+ofAction.getClass(), ofAction instanceof MockVendorAction);
        assertArrayEquals( new byte[]  { 1,2,3,4,5,6,7,8}, ((MockVendorAction)ofAction).getMockData());


    }

    public void testGenericVendorAction() throws MessageParseException {
        byte[] nonDeadBeefMessage = {
                (byte) 0xff, (byte) 0xff,          // action vendor
                0x00, 0x10,                        // length
                (byte) 0x7e, (byte) 0xe7, (byte) 0xbe, (byte)0xef,            // deadbeaf
                0x01, 0x02, 0x03, 0x04,
                0x05, 0x06, 0x07, 0x08               // pad
            };

        BasicFactory factory = BasicFactory.getInstance();
        OFVendorActionRegistry.getInstance().register(
                MockVendorAction.VENDOR_ID, new MockVendorActionFactory());

        ChannelBuffer buf = ChannelBuffers.copiedBuffer(nonDeadBeefMessage);

        List<OFAction> actions = factory.parseActions(buf,nonDeadBeefMessage.length);
        assertEquals(1, actions.size());
        OFAction ofAction = actions.get(0);
        assertTrue("Action should be OFActionVendorGeneric, but is "+ofAction.getClass(), ofAction instanceof OFActionVendorGeneric);
    }

}