BUG-6647 Increase code coverage and clean up IV
[bgpcep.git] / bgp / rib-impl / src / main / java / org / opendaylight / protocol / bgp / rib / impl / ApplicationPeer.java
index 9584abba542ef972ca48e0e892a1086dd45a46b1..d31c5c46e2829bbf840777b1417c9058b707270c 100644 (file)
@@ -12,22 +12,30 @@ import com.google.common.base.Verify;
 import com.google.common.net.InetAddresses;
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Collections;
+import java.util.Optional;
 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
-import org.opendaylight.controller.md.sal.dom.api.DOMDataTreeChangeListener;
+import org.opendaylight.controller.md.sal.dom.api.ClusteredDOMDataTreeChangeListener;
 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
 import org.opendaylight.controller.md.sal.dom.api.DOMTransactionChain;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
+import org.opendaylight.protocol.bgp.openconfig.spi.BGPConfigModuleTracker;
+import org.opendaylight.protocol.bgp.rib.impl.spi.RIB;
+import org.opendaylight.protocol.bgp.rib.spi.IdentifierUtils;
+import org.opendaylight.protocol.bgp.rib.spi.RouterIds;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.ApplicationRibId;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.PeerRole;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.SimpleRoutingPolicy;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.Peer;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.bgp.rib.rib.peer.AdjRibIn;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.rib.Tables;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidateNode;
 import org.slf4j.Logger;
@@ -46,30 +54,51 @@ import org.slf4j.LoggerFactory;
  * For purposed of import policies such as Best Path Selection, application
  * peer needs to have a BGP-ID that is configurable.
  */
-public class ApplicationPeer implements AutoCloseable, org.opendaylight.protocol.bgp.rib.spi.Peer, DOMDataTreeChangeListener, TransactionChainListener {
+public class ApplicationPeer implements AutoCloseable, org.opendaylight.protocol.bgp.rib.spi.Peer, ClusteredDOMDataTreeChangeListener, TransactionChainListener {
 
     private static final Logger LOG = LoggerFactory.getLogger(ApplicationPeer.class);
 
     private final byte[] rawIdentifier;
-    private final RIBImpl targetRib;
     private final String name;
     private final YangInstanceIdentifier adjRibsInId;
-    private final DOMTransactionChain chain;
-    private final DOMTransactionChain writerChain;
-
+    private final Ipv4Address ipAddress;
+    private final BGPConfigModuleTracker moduleTracker;
+    private final RIB rib;
+    private final YangInstanceIdentifier peerIId;
+    private DOMTransactionChain chain;
+    private DOMTransactionChain writerChain;
+    private EffectiveRibInWriter effectiveRibInWriter;
     private AdjRibInWriter writer;
 
-    public ApplicationPeer(final ApplicationRibId applicationRibId, final Ipv4Address ipAddress, final RIBImpl targetRib) {
-        this.name = applicationRibId.getValue().toString();
-        this.targetRib = Preconditions.checkNotNull(targetRib);
+    public ApplicationPeer(final ApplicationRibId applicationRibId, final Ipv4Address ipAddress, final RIB rib,
+        final BGPConfigModuleTracker moduleTracker) {
+        this.name = applicationRibId.getValue();
+        final RIB targetRib = Preconditions.checkNotNull(rib);
         this.rawIdentifier = InetAddresses.forString(ipAddress.getValue()).getAddress();
         final NodeIdentifierWithPredicates peerId = IdentifierUtils.domPeerId(RouterIds.createPeerId(ipAddress));
-        this.adjRibsInId = this.targetRib.getYangRibId().node(Peer.QNAME).node(peerId).node(AdjRibIn.QNAME).node(Tables.QNAME);
-        this.chain = this.targetRib.createPeerChain(this);
-        this.writerChain = this.targetRib.createPeerChain(this);
-        this.writer = AdjRibInWriter.create(this.targetRib.getYangRibId(), PeerRole.Internal, this.writerChain);
-        // FIXME: set to true, once it's fixed how to skip advertising routes back to AppPeer
-        this.writer = this.writer.transform(RouterIds.createPeerId(ipAddress), this.targetRib.getRibSupportContext(), this.targetRib.getLocalTablesKeys(), false);
+        this.peerIId = targetRib.getYangRibId().node(Peer.QNAME).node(peerId);
+        this.adjRibsInId = this.peerIId.node(AdjRibIn.QNAME).node(Tables.QNAME);
+        this.rib = targetRib;
+        this.ipAddress = ipAddress;
+        this.moduleTracker = moduleTracker;
+    }
+
+    public ApplicationPeer(final ApplicationRibId applicationRibId, final Ipv4Address bgpPeerId, final RIB targetRibDependency) {
+        this(applicationRibId, bgpPeerId, targetRibDependency, null);
+    }
+
+    public void instantiateServiceInstance() {
+        this.chain = this.rib.createPeerChain(this);
+        this.writerChain = this.rib.createPeerChain(this);
+        this.writer = AdjRibInWriter.create(this.rib.getYangRibId(), PeerRole.Internal, Optional.of(SimpleRoutingPolicy.AnnounceNone), this.writerChain);
+        this.writer = this.writer.transform(RouterIds.createPeerId(this.ipAddress), this.rib.getRibSupportContext(), this.rib.getLocalTablesKeys(),
+            Collections.emptyList());
+        //TODO need to create effective rib in writer with route counter here
+        this.effectiveRibInWriter = EffectiveRibInWriter.create(this.rib.getService(), this.rib.createPeerChain(this), this.peerIId,
+            this.rib.getImportPolicyPeerTracker(), this.rib.getRibSupportContext(), PeerRole.Internal);
+        if (moduleTracker != null) {
+            moduleTracker.onInstanceCreate();
+        }
     }
 
     /**
@@ -89,17 +118,77 @@ public class ApplicationPeer implements AutoCloseable, org.opendaylight.protocol
             Verify.verify(lastArg instanceof NodeIdentifierWithPredicates, "Unexpected type %s in path %s", lastArg.getClass(), path);
             final NodeIdentifierWithPredicates tableKey = (NodeIdentifierWithPredicates) lastArg;
             for (final DataTreeCandidateNode child : tc.getRootNode().getChildNodes()) {
-                final YangInstanceIdentifier tableId = this.adjRibsInId.node(tableKey).node(child.getIdentifier());
-                if (child.getDataAfter().isPresent()) {
-                    LOG.trace("App peer -> AdjRibsIn path : {}", tableId);
-                    LOG.trace("App peer -> AdjRibsIn data : {}", child.getDataAfter().get());
-                    tx.put(LogicalDatastoreType.OPERATIONAL, tableId, child.getDataAfter().get());
+                final PathArgument childIdentifier = child.getIdentifier();
+                final YangInstanceIdentifier tableId = this.adjRibsInId.node(tableKey).node(childIdentifier);
+                switch (child.getModificationType()) {
+                case DELETE:
+                    LOG.trace("App peer -> AdjRibsIn path delete: {}", childIdentifier);
+                    tx.delete(LogicalDatastoreType.OPERATIONAL, tableId);
+                    break;
+                case UNMODIFIED:
+                    // No-op
+                    break;
+                case SUBTREE_MODIFIED:
+                    if (EffectiveRibInWriter.TABLE_ROUTES.equals(childIdentifier)) {
+                        processRoutesTable(child, tableId, tx, tableId);
+                        break;
+                    }
+                case WRITE:
+                    if (child.getDataAfter().isPresent()) {
+                        final NormalizedNode<?,?> dataAfter = child.getDataAfter().get();
+                        LOG.trace("App peer -> AdjRibsIn path : {}", tableId);
+                        LOG.trace("App peer -> AdjRibsIn data : {}", dataAfter);
+                        tx.put(LogicalDatastoreType.OPERATIONAL, tableId, dataAfter);
+                    }
+                    break;
+                default:
+                    break;
                 }
             }
         }
         tx.submit();
     }
 
+    /**
+     * Applies modification under table routes based on modification type instead of only put. BUG 4438
+     * @param node
+     * @param identifier
+     * @param tx
+     * @param routeTableIdentifier
+     */
+    private void processRoutesTable(final DataTreeCandidateNode node, final YangInstanceIdentifier identifier,
+            final DOMDataWriteTransaction tx, final YangInstanceIdentifier routeTableIdentifier) {
+        for (final DataTreeCandidateNode child : node.getChildNodes()) {
+            final YangInstanceIdentifier childIdentifier = identifier.node(child.getIdentifier());
+            switch (child.getModificationType()) {
+            case DELETE:
+                LOG.trace("App peer -> AdjRibsIn path delete: {}", childIdentifier);
+                tx.delete(LogicalDatastoreType.OPERATIONAL, childIdentifier);
+                break;
+            case UNMODIFIED:
+                // No-op
+                break;
+            case SUBTREE_MODIFIED:
+                //For be ables to use DELETE when we remove specific routes as we do when we remove the whole routes,
+                // we need to go deeper three levels
+                if (!routeTableIdentifier.equals(childIdentifier.getParent().getParent().getParent())) {
+                    processRoutesTable(child, childIdentifier, tx, routeTableIdentifier);
+                    break;
+                }
+            case WRITE:
+                if (child.getDataAfter().isPresent()) {
+                    final NormalizedNode<?,?> dataAfter = child.getDataAfter().get();
+                    LOG.trace("App peer -> AdjRibsIn path : {}", childIdentifier);
+                    LOG.trace("App peer -> AdjRibsIn data : {}", dataAfter);
+                    tx.put(LogicalDatastoreType.OPERATIONAL, childIdentifier, dataAfter);
+                }
+                break;
+            default:
+                break;
+            }
+        }
+    }
+
     @Override
     public String getName() {
         return this.name;
@@ -107,9 +196,21 @@ public class ApplicationPeer implements AutoCloseable, org.opendaylight.protocol
 
     @Override
     public void close() {
-        this.writer.cleanTables(this.targetRib.getLocalTablesKeys());
-        this.chain.close();
-        this.writerChain.close();
+        if(this.effectiveRibInWriter != null) {
+            this.effectiveRibInWriter.close();
+        }
+        if(this.writer != null) {
+            this.writer.removePeer();
+        }
+        if(this.chain != null) {
+            this.chain.close();
+        }
+        if(this.writerChain != null) {
+            this.writerChain.close();
+        }
+        if (this.moduleTracker != null) {
+            this.moduleTracker.onInstanceClose();
+        }
     }
 
     @Override
@@ -119,7 +220,7 @@ public class ApplicationPeer implements AutoCloseable, org.opendaylight.protocol
 
     @Override
     public void onTransactionChainFailed(final TransactionChain<?, ?> chain, final AsyncTransaction<?, ?> transaction,
-        final Throwable cause) {
+            final Throwable cause) {
         LOG.error("Transaction chain failed.", cause);
     }