OFMessageDamperMockSwitch.java

/**
 *    Copyright 2013, Big Switch Networks, Inc.
 *
 *    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 net.floodlightcontroller.util;

import static org.junit.Assert.*;
import java.io.IOException;
import java.net.SocketAddress;

import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Future;
import net.floodlightcontroller.core.FloodlightContext;
import net.floodlightcontroller.core.IOFMessageListener;
import net.floodlightcontroller.core.IOFSwitch;
import net.floodlightcontroller.core.IFloodlightProviderService.Role;
import net.floodlightcontroller.core.ImmutablePort;
import net.floodlightcontroller.core.internal.Controller;
import net.floodlightcontroller.debugcounter.IDebugCounterService;
import net.floodlightcontroller.threadpool.IThreadPoolService;

import org.jboss.netty.channel.Channel;
import org.openflow.protocol.OFFeaturesReply;
import org.openflow.protocol.OFMessage;
import org.openflow.protocol.OFPortStatus;
import org.openflow.protocol.OFStatisticsReply;
import org.openflow.protocol.OFStatisticsRequest;
import org.openflow.protocol.statistics.OFDescriptionStatistics;
import org.openflow.protocol.statistics.OFStatistics;


/**
 * A mock implementation of IFOSwitch we use for {@link OFMessageDamper}
 *
 * We need to mock equals() and hashCode() but alas, EasyMock doesn't support
 * this. Sigh. And of course this happens to be the interface with the most
 * methods.
 * @author gregor
 *
 */
public class OFMessageDamperMockSwitch implements IOFSwitch {
    OFMessage writtenMessage;
    FloodlightContext writtenContext;

    public OFMessageDamperMockSwitch() {
        reset();
    }

    /* reset this mock. I.e., clear the stored message previously written */
    public void reset() {
        writtenMessage = null;
        writtenContext = null;
    }

    /* assert that a message was written to this switch and that the
     * written message and context matches the expected values
     * @param expected
     * @param expectedContext
     */
    public void assertMessageWasWritten(OFMessage expected,
                                        FloodlightContext expectedContext) {
        assertNotNull("No OFMessage was written", writtenMessage);
        assertEquals(expected, writtenMessage);
        assertEquals(expectedContext, writtenContext);
    }

    /*
     * assert that no message was written
     */
    public void assertNoMessageWritten() {
        assertNull("OFMessage was written but didn't expect one",
                      writtenMessage);
        assertNull("There was a context but didn't expect one",
                      writtenContext);
    }

    /*
     * use hashCode() and equals() from Object
     */


    //-------------------------------------------------------
    // IOFSwitch: mocked methods
    @Override
    public void write(OFMessage m, FloodlightContext bc) throws IOException {
        assertNull("write() called but already have message", writtenMessage);
        assertNull("write() called but already have context", writtenContext);
        writtenContext = bc;
        writtenMessage = m;
    }

    @Override
    public void writeThrottled(OFMessage msg, FloodlightContext cntx)
            throws IOException {
        write(msg, cntx);
    }

    //-------------------------------------------------------
    // IOFSwitch: not-implemented methods

    @Override
    public void writeThrottled(List<OFMessage> msglist, FloodlightContext bc)
            throws IOException {
        assertTrue("Unexpected method call", false);
    }

    @Override
    public void write(List<OFMessage> msglist, FloodlightContext bc)
            throws IOException {
        assertTrue("Unexpected method call", false);
    }

    @Override
    public void disconnectOutputStream() {
        assertTrue("Unexpected method call", false);
    }

    @Override
    public void setFeaturesReply(OFFeaturesReply featuresReply) {
        assertTrue("Unexpected method call", false);
    }

    @Override
    public void setSwitchProperties(OFDescriptionStatistics description) {
        assertTrue("Unexpected method call", false);
        // TODO Auto-generated method stub
    }

    @Override
    public Collection<ImmutablePort> getEnabledPorts() {
        assertTrue("Unexpected method call", false);
        return null;
    }

    @Override
    public Collection<Short> getEnabledPortNumbers() {
        assertTrue("Unexpected method call", false);
        return null;
    }

    @Override
    public ImmutablePort getPort(short portNumber) {
        assertTrue("Unexpected method call", false);
        return null;
    }

    @Override
    public ImmutablePort getPort(String portName) {
        assertTrue("Unexpected method call", false);
        return null;
    }

    @Override
    public Collection<ImmutablePort> getPorts() {
        assertTrue("Unexpected method call", false);
        return null;
    }

    @Override
    public boolean portEnabled(short portName) {
        assertTrue("Unexpected method call", false);
        return false;
    }

    @Override
    public boolean portEnabled(String portName) {
        assertTrue("Unexpected method call", false);
        return false;
    }

    @Override
    public long getId() {
        assertTrue("Unexpected method call", false);
        return 0;
    }

    @Override
    public String getStringId() {
        assertTrue("Unexpected method call", false);
        return null;
    }

    @Override
    public SocketAddress getInetAddress() {
        assertTrue("Unexpected method call", false);
        return null;
    }

    @Override
    public Map<Object, Object> getAttributes() {
        assertTrue("Unexpected method call", false);
        return null;
    }

    @Override
    public Date getConnectedSince() {
        assertTrue("Unexpected method call", false);
        return null;
    }

    @Override
    public int getNextTransactionId() {
        assertTrue("Unexpected method call", false);
        return 0;
    }

    @Override
    public Future<List<OFStatistics>>
            queryStatistics(OFStatisticsRequest request) throws IOException {
        assertTrue("Unexpected method call", false);
        return null;
    }

    @Override
    public boolean isConnected() {
        assertTrue("Unexpected method call", false);
        return false;
    }

    @Override
    public void setConnected(boolean connected) {
        assertTrue("Unexpected method call", false);
    }

    @Override
    public Role getHARole() {
        assertTrue("Unexpected method call", false);
        return null;
    }

    @Override
    public void deliverStatisticsReply(OFStatisticsReply reply) {
        assertTrue("Unexpected method call", false);
    }

    @Override
    public void cancelStatisticsReply(int transactionId) {
        assertTrue("Unexpected method call", false);
    }

    @Override
    public void cancelAllStatisticsReplies() {
        assertTrue("Unexpected method call", false);
    }

    @Override
    public boolean hasAttribute(String name) {
        assertTrue("Unexpected method call", false);
        return false;
    }

    @Override
    public Object getAttribute(String name) {
        assertTrue("Unexpected method call", false);
        return null;
    }

    @Override
    public void setAttribute(String name, Object value) {
        assertTrue("Unexpected method call", false);
    }

    @Override
    public Object removeAttribute(String name) {
        assertTrue("Unexpected method call", false);
        return null;
    }

    @Override
    public void clearAllFlowMods() {
        assertTrue("Unexpected method call", false);
    }

    @Override
    public boolean updateBroadcastCache(Long entry, Short port) {
        assertTrue("Unexpected method call", false);
        return false;
    }

    @Override
    public Map<Short, Long> getPortBroadcastHits() {
        assertTrue("Unexpected method call", false);
        return null;
    }

    @Override
    public void sendStatsQuery(OFStatisticsRequest request, int xid,
                               IOFMessageListener caller)
                                                         throws IOException {
        assertTrue("Unexpected method call", false);
    }

    @Override
    public void flush() {
        assertTrue("Unexpected method call", false);
    }

    @Override
    public Future<OFFeaturesReply> querySwitchFeaturesReply()
            throws IOException {
        fail("Unexpected method call");
        return null;
    }

    @Override
    public void deliverOFFeaturesReply(OFMessage reply) {
        fail("Unexpected method call");
    }

    @Override
    public void cancelFeaturesReply(int transactionId) {
        fail("Unexpected method call");
    }

    @Override
    public int getBuffers() {
        fail("Unexpected method call");
        return 0;
    }

    @Override
    public int getActions() {
        fail("Unexpected method call");
        return 0;
    }

    @Override
    public int getCapabilities() {
        fail("Unexpected method call");
        return 0;
    }

    @Override
    public byte getTables() {
        fail("Unexpected method call");
        return 0;
    }

    @Override
    public void setChannel(Channel channel) {
        fail("Unexpected method call");
    }

    @Override
    public void setFloodlightProvider(Controller controller) {
        fail("Unexpected method call");
        // TODO Auto-generated method stub

    }

    @Override
    public void setThreadPoolService(IThreadPoolService threadPool) {
        fail("Unexpected method call");
    }

    @Override
    public void setHARole(Role role) {
        fail("Unexpected method call");
    }

    @Override
    public OFPortType getPortType(short port_num) {
        fail("Unexpected method call");
        return null;
    }

    @Override
    public boolean isFastPort(short port_num) {
        fail("Unexpected method call");
        return false;
    }

    @Override
    public boolean attributeEquals(String name, Object other) {
        fail("Unexpected method call");
        return false;
    }

    @Override
    public OFDescriptionStatistics getDescriptionStatistics() {
        fail("Unexpected method call");
        return null;
    }

    @Override
    public boolean isActive() {
        fail("Unexpected method call");
        return false; // never reached
    }

    @Override
    public boolean inputThrottled(OFMessage ofm) {
        fail("Unexpected method call");
        return false;
    }

    @Override
    public boolean isOverloaded() {
        fail("Unexpected method call");
        return false;
    }

    @Override
    public boolean isWriteThrottleEnabled() {
        fail("Unexpected method call");
        return false;
    }

    @Override
    public void setDebugCounterService(IDebugCounterService debugCounters) {
        fail("Unexpected method call");
    }

    @Override
    public OrderedCollection<PortChangeEvent>
            processOFPortStatus(OFPortStatus ps) {
        fail("Unexpected method call");
        return null;
    }

    @Override
    public OrderedCollection<PortChangeEvent>
            comparePorts(Collection<ImmutablePort> ports) {
        fail("Unexpected method call");
        return null;
    }

    @Override
    public OrderedCollection<PortChangeEvent>
            setPorts(Collection<ImmutablePort> ports) {
        fail("Unexpected method call");
        return null;
    }

    @Override
    public void setTableFull(boolean isFull) {
        fail("Unexpected method call");
        // TODO Auto-generated method stub
    }

    @Override
    public void setAccessFlowPriority(short prio) {
        fail("Unexpected method call");
    }

    @Override
    public void setCoreFlowPriority(short prio) {
        fail("Unexpected method call");
    }

    @Override
    public short getAccessFlowPriority() {
        fail("Unexpected method call");
        return 0;
    }

    @Override
    public short getCoreFlowPriority() {
        fail("Unexpected method call");
        return 0;
    }

    @Override
    public void startDriverHandshake() {
        fail("Unexpected method call");
    }

    @Override
    public boolean isDriverHandshakeComplete() {
        fail("Unexpected method call");
        return false;
    }

    @Override
    public void processDriverHandshakeMessage(OFMessage m) {
        fail("Unexpected method call");
    }
}