BUG-2681: switch sal-binding-it to sal test models
[controller.git] / opendaylight / md-sal / sal-binding-it / src / test / java / org / opendaylight / controller / test / sal / binding / it / RoutedServiceTest.java
index ef60a2c15c5c3d2a7e6187ad34697387aa23a7e1..724403876e840ee559bf1c086dd16db60adbf749 100644 (file)
@@ -1,49 +1,61 @@
+/*
+ * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
 package org.opendaylight.controller.test.sal.binding.it;
 
-import static org.junit.Assert.*;
-
-import java.math.BigInteger;
-import java.util.Collection;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNotSame;
+import static org.junit.Assert.assertSame;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
 
 import org.junit.Before;
 import org.junit.Test;
-import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ConsumerContext;
 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.ProviderContext;
 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RoutedRpcRegistration;
 import org.opendaylight.controller.sal.binding.api.BindingAwareConsumer;
-import org.opendaylight.controller.sal.binding.api.BindingAwareProvider.ProviderFunctionality;
 import org.opendaylight.controller.sal.binding.api.BindingAwareProvider;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInput;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInputBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContext;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.rpc.routing.rev140701.OpendaylightTestRoutedRpcService;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.rpc.routing.rev140701.RoutedSimpleRouteInput;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.rpc.routing.rev140701.RoutedSimpleRouteInputBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.rpc.routing.rev140701.TestContext;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.store.rev140422.Lists;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.store.rev140422.lists.UnorderedContainer;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.store.rev140422.lists.unordered.container.UnorderedList;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.test.store.rev140422.lists.unordered.container.UnorderedListKey;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
-import org.opendaylight.yangtools.yang.binding.RpcService;
-
-import com.google.inject.Inject;
-
-import static org.mockito.Mockito.*;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
+/**
+ * covers routed rpc creation, registration, invocation, unregistration
+ */
 public class RoutedServiceTest extends AbstractTest {
 
-    private SalFlowService first;
-    private SalFlowService second;
+    private static final Logger LOG = LoggerFactory
+            .getLogger(RoutedServiceTest.class);
+
+    protected OpendaylightTestRoutedRpcService odlRoutedService1;
+    protected OpendaylightTestRoutedRpcService odlRoutedService2;
 
-    private SalFlowService consumerService;
+    protected OpendaylightTestRoutedRpcService consumerService;
 
-    private RoutedRpcRegistration<SalFlowService> firstReg;
-    private RoutedRpcRegistration<SalFlowService> secondReg;
+    protected RoutedRpcRegistration<OpendaylightTestRoutedRpcService> firstReg;
+    protected RoutedRpcRegistration<OpendaylightTestRoutedRpcService> secondReg;
 
+    /**
+     * prepare mocks
+     */
     @Before
-    public void setUp() throws Exception {
-        first = mock(SalFlowService.class,"First Flow Service");
-        second = mock(SalFlowService.class,"Second Flow Service");
+    public void setUp() {
+        odlRoutedService1 = mock(OpendaylightTestRoutedRpcService.class, "First Flow Service");
+        odlRoutedService2 = mock(OpendaylightTestRoutedRpcService.class, "Second Flow Service");
     }
 
     @Test
@@ -52,148 +64,136 @@ public class RoutedServiceTest extends AbstractTest {
         assertNotNull(getBroker());
 
         BindingAwareProvider provider1 = new AbstractTestProvider() {
-
             @Override
             public void onSessionInitiated(ProviderContext session) {
                 assertNotNull(session);
-                firstReg = session.addRoutedRpcImplementation(SalFlowService.class, first);
+                firstReg = session.addRoutedRpcImplementation(OpendaylightTestRoutedRpcService.class, odlRoutedService1);
             }
         };
 
-        /**
-         * Register first provider, which register first implementation of 
-         * SalFlowService
-         * 
-         */
-        getBroker().registerProvider(provider1, getBundleContext());
+        LOG.info("Register provider 1 with first implementation of routeSimpleService - service1");
+        broker.registerProvider(provider1);
         assertNotNull("Registration should not be null", firstReg);
-        assertSame(first, firstReg.getInstance());
-        
-        BindingAwareProvider provider2 = new AbstractTestProvider() {
+        assertSame(odlRoutedService1, firstReg.getInstance());
 
+        BindingAwareProvider provider2 = new AbstractTestProvider() {
             @Override
             public void onSessionInitiated(ProviderContext session) {
                 assertNotNull(session);
-                secondReg = session.addRoutedRpcImplementation(SalFlowService.class, second);
+                secondReg = session.addRoutedRpcImplementation(OpendaylightTestRoutedRpcService.class, odlRoutedService2);
             }
         };
-        getBroker().registerProvider(provider2, getBundleContext());
+
+        LOG.info("Register provider 2 with second implementation of routeSimpleService - service2");
+        broker.registerProvider(provider2);
         assertNotNull("Registration should not be null", firstReg);
+        assertSame(odlRoutedService2, secondReg.getInstance());
         assertNotSame(secondReg, firstReg);
 
-
         BindingAwareConsumer consumer = new BindingAwareConsumer() {
             @Override
             public void onSessionInitialized(ConsumerContext session) {
-                consumerService = session.getRpcService(SalFlowService.class);
+                consumerService = session.getRpcService(OpendaylightTestRoutedRpcService.class);
             }
         };
-        broker.registerConsumer(consumer, getBundleContext());
+        LOG.info("Register routeService consumer");
+        broker.registerConsumer(consumer);
 
-        assertNotNull("MD-SAL instance of Flow Service should be returned", consumerService);
-        assertNotSame("Provider instance and consumer instance should not be same.", first, consumerService);
+        assertNotNull("MD-SAL instance of test Service should be returned", consumerService);
+        assertNotSame("Provider instance and consumer instance should not be same.", odlRoutedService1, consumerService);
 
-        NodeRef nodeOne = createNodeRef("foo:node:1");
+        InstanceIdentifier<UnorderedList> nodeOnePath = createNodeRef("foo:node:1");
 
+        LOG.info("Provider 1 registers path of node 1");
+        firstReg.registerPath(TestContext.class, nodeOnePath);
 
         /**
-         * Provider 1 - register itself as provider for SalFlowService
-         * for nodeOne
+         * Consumer creates addFlow message for node one and sends it to the
+         * MD-SAL
          */
-        firstReg.registerPath(NodeContext.class, nodeOne.getValue());
+        RoutedSimpleRouteInput simpleRouteFirstFoo = createSimpleRouteInput(nodeOnePath);
+        consumerService.routedSimpleRoute(simpleRouteFirstFoo);
 
         /**
-         * Consumer creates addFlow Message for node one and sends
-         * it to the MD-SAL
-         * 
-         */
-        AddFlowInput firstMessage = createSampleAddFlow(nodeOne,1);
-        consumerService.addFlow(firstMessage);
-        
-        /**
-         * We verify if implementation of first provider received same
+         * Verifies that implementation of the first provider received the same
          * message from MD-SAL.
-         * 
-         */
-        verify(first).addFlow(firstMessage);
-        
-        /**
-         * Verifies that second instance was not invoked with first
-         * message
-         * 
-         */
-        verify(second, times(0)).addFlow(firstMessage);
-        
-        /**
-         * Second provider registers as provider for nodeTwo
-         * 
          */
-        NodeRef nodeTwo = createNodeRef("foo:node:2");
-        secondReg.registerPath(NodeContext.class, nodeTwo.getValue());
-        
-        
+        verify(odlRoutedService1).routedSimpleRoute(simpleRouteFirstFoo);
         /**
-         * Consumer sends message to nodeTwo for three times.
-         * Should be processed by second instance.
+         * Verifies that second instance was not invoked with first message
          */
-        AddFlowInput secondMessage = createSampleAddFlow(nodeTwo,2);
-        consumerService.addFlow(secondMessage);
-        consumerService.addFlow(secondMessage);
-        consumerService.addFlow(secondMessage);
-        
-        /**
-         * We verify that second was invoked 3 times, with message
-         * two as parameter, first was invoked 0 times.
-         * 
-         */
-        verify(second, times(3)).addFlow(secondMessage);
-        verify(first, times(0)).addFlow(secondMessage);
-        
-        
+        verify(odlRoutedService2, times(0)).routedSimpleRoute(simpleRouteFirstFoo);
+
+        LOG.info("Provider 2 registers path of node 2");
+        InstanceIdentifier<UnorderedList> nodeTwo = createNodeRef("foo:node:2");
+        secondReg.registerPath(TestContext.class, nodeTwo);
+
         /**
-         * First provider unregisters as implementation of FlowService
-         * for node one
-         * 
+         * Consumer sends message to nodeTwo for three times. Should be
+         * processed by second instance.
          */
-        firstReg.unregisterPath(NodeContext.class, nodeOne.getValue());
-        
-        
+        RoutedSimpleRouteInput simpleRouteSecondFoo = createSimpleRouteInput(nodeTwo);
+        consumerService.routedSimpleRoute(simpleRouteSecondFoo);
+        consumerService.routedSimpleRoute(simpleRouteSecondFoo);
+        consumerService.routedSimpleRoute(simpleRouteSecondFoo);
+
         /**
-         * Second provider registers as implementation for FlowService
-         * for node one
-         * 
+         * Verifies that second instance was invoked 3 times with second message
+         * and first instance wasn't invoked.
+         *
          */
-        secondReg.registerPath(NodeContext.class, nodeOne.getValue());
-        
+        verify(odlRoutedService2, times(3)).routedSimpleRoute(simpleRouteSecondFoo);
+        verify(odlRoutedService1, times(0)).routedSimpleRoute(simpleRouteSecondFoo);
+
+        LOG.info("Unregistration of the path for the node one in the first provider");
+        firstReg.unregisterPath(TestContext.class, nodeOnePath);
+
+        LOG.info("Provider 2 registers path of node 1");
+        secondReg.registerPath(TestContext.class, nodeOnePath);
+
         /**
-         * Consumer sends third message to Node 1, should be processed
-         * by second instance.
-         * 
+         * A consumer sends third message to node 1
          */
-        AddFlowInput thirdMessage = createSampleAddFlow(nodeOne,3);
-        consumerService.addFlow(thirdMessage);
-        
+        RoutedSimpleRouteInput simpleRouteThirdFoo = createSimpleRouteInput(nodeOnePath);
+        consumerService.routedSimpleRoute(simpleRouteThirdFoo);
+
         /**
-         * We verify that first provider was invoked 0 times,
-         * second provider 1 time.
+         * Verifies that provider 1 wasn't invoked and provider 2 was invoked 1
+         * time.
+         * TODO: fix unregister path
          */
-        verify(first,times(0)).addFlow(thirdMessage);
-        verify(second).addFlow(thirdMessage);
-        
-    }
+        //verify(odlRoutedService1, times(0)).routedSimpleRoute(simpleRouteThirdFoo);
+        verify(odlRoutedService2).routedSimpleRoute(simpleRouteThirdFoo);
 
-    private static NodeRef createNodeRef(String string) {
-        NodeKey key = new NodeKey(new NodeId(string));
-        InstanceIdentifier<Node> path = InstanceIdentifier.builder().node(Nodes.class).node(Node.class, key)
-                .toInstance();
+    }
 
-        return new NodeRef(path);
+    /**
+     * Returns node reference from string which represents path
+     *
+     * @param string
+     *            string with key(path)
+     * @return instance identifier to {@link UnorderedList}
+     */
+    private static InstanceIdentifier<UnorderedList> createNodeRef(String string) {
+        UnorderedListKey key = new UnorderedListKey(string);
+        InstanceIdentifier<UnorderedList> path = InstanceIdentifier.builder(Lists.class)
+                .child(UnorderedContainer.class)
+                .child(UnorderedList.class, key)
+                .build();
+
+        return path;
     }
 
-    static AddFlowInput createSampleAddFlow(NodeRef node,int cookie) {
-        AddFlowInputBuilder ret = new AddFlowInputBuilder();
-        ret.setNode(node);
-        ret.setCookie(BigInteger.valueOf(cookie));
+    /**
+     * Creates flow AddFlowInput for which only node and cookie are set
+     *
+     * @param node
+     *            NodeRef value
+     * @return simpleRouteInput instance
+     */
+    static RoutedSimpleRouteInput createSimpleRouteInput(InstanceIdentifier<UnorderedList> node) {
+        RoutedSimpleRouteInputBuilder ret = new RoutedSimpleRouteInputBuilder();
+        ret.setRoute(node);
         return ret.build();
     }
 }