BUG-9079 Make PCEP session recoverable from exception
[bgpcep.git] / pcep / topology-provider / src / test / java / org / opendaylight / bgpcep / pcep / topology / provider / StateSynchronizationAvoidanceProcedureTest.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8
9 package org.opendaylight.bgpcep.pcep.topology.provider;
10
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertFalse;
13 import static org.junit.Assert.assertTrue;
14 import static org.opendaylight.protocol.pcep.pcc.mock.spi.MsgBuilderUtil.createLsp;
15 import static org.opendaylight.protocol.pcep.pcc.mock.spi.MsgBuilderUtil.createPath;
16 import static org.opendaylight.protocol.util.CheckUtil.readDataOperational;
17
18 import com.google.common.base.Optional;
19 import java.math.BigInteger;
20 import java.util.Collections;
21 import org.junit.Before;
22 import org.junit.Test;
23 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
24 import org.opendaylight.protocol.pcep.PCEPSession;
25 import org.opendaylight.protocol.pcep.pcc.mock.spi.MsgBuilderUtil;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev150714.PathComputationClient1;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev150714.Tlvs3;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev150714.Tlvs3Builder;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev150714.lsp.db.version.tlv.LspDbVersion;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev150714.lsp.db.version.tlv.LspDbVersionBuilder;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.Stateful1;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.crabbe.initiated.rev131126.Stateful1Builder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.OperationalStatus;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Pcrpt;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.PlspId;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.SymbolicPathName;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Tlvs1;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.Tlvs1Builder;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.identifiers.tlv.LspIdentifiersBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.LspBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.stateful.capability.tlv.StatefulBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.symbolic.path.name.tlv.SymbolicPathNameBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.open.object.Open;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.open.object.OpenBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.open.object.open.TlvsBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.LspId;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev131024.PccSyncState;
48
49 public class StateSynchronizationAvoidanceProcedureTest extends
50     AbstractPCEPSessionTest<Stateful07TopologySessionListenerFactory> {
51
52     private Stateful07TopologySessionListener listener;
53
54     @Override
55     @Before
56     public void setUp() throws Exception {
57         super.setUp();
58         this.listener = (Stateful07TopologySessionListener) getSessionListener();
59     }
60
61     @Test
62     public void testNodePersisted() throws ReadFailedException {
63         final PCEPSession session = getPCEPSession(getOpen(null), getOpen(null));
64         this.listener.onSessionUp(session);
65         //report LSP + LSP-DB version number
66         final Pcrpt pcRpt = MsgBuilderUtil.createPcRtpMessage(new LspBuilder().setTlvs(
67                 new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.object.lsp.TlvsBuilder()
68                     .addAugmentation(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev150714.Tlvs1.class,
69                             new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev150714.Tlvs1Builder().setLspDbVersion(new LspDbVersionBuilder().setLspDbVersionValue(BigInteger.ONE).build()).build()).build()).setPlspId(new PlspId(1L)).setSync(false).setRemove(false).setOperational(OperationalStatus.Active).build(), Optional.of(MsgBuilderUtil.createSrp(1L)), null);
70         this.listener.onMessage(session, pcRpt);
71         //check topology
72         readDataOperational(getDataBroker(), this.pathComputationClientIId.builder().augmentation(PathComputationClient1.class)
73             .child(LspDbVersion.class).build(), dbVersion -> {
74             assertEquals(1L, dbVersion.getLspDbVersionValue().longValue());
75             return dbVersion;
76         });
77
78         //drop session
79         this.listener.onSessionDown(session, new IllegalStateException());
80         readDataOperational(getDataBroker(), TOPO_IID, topology -> {
81             assertFalse(topology.getNode().isEmpty());
82             return topology;
83         });
84         //check topology - node is persisted
85     }
86
87     @Test
88     public void testStateSynchronizationSkipped() throws Exception {
89         //session up - sync skipped (LSP-DBs match)
90         final LspDbVersion lspDbVersion = new LspDbVersionBuilder().setLspDbVersionValue(BigInteger.ONE).build();
91         final PCEPSession session = getPCEPSession(getOpen(lspDbVersion), getOpen(lspDbVersion));
92         this.listener.onSessionUp(session);
93         //check node - synchronized
94         readDataOperational(getDataBroker(), this.pathComputationClientIId, pcc -> {
95             assertEquals(PccSyncState.Synchronized, pcc.getStateSync());
96             return pcc;
97         });
98   }
99
100     @Test
101     public void testStateSynchronizationPerformed() throws Exception {
102         PCEPSession session = getPCEPSession(getOpen(null), getOpen(null));
103         this.listener.onSessionUp(session);
104         //report LSP + LSP-DB version number
105         final Pcrpt pcRpt = MsgBuilderUtil.createPcRtpMessage(new LspBuilder().setPlspId(new PlspId(1L)).setTlvs(
106                 new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222.lsp.
107                     object.lsp.TlvsBuilder().setLspIdentifiers(new LspIdentifiersBuilder()
108                     .setLspId(new LspId(1L)).build()).setSymbolicPathName(new SymbolicPathNameBuilder()
109                     .setPathName(new SymbolicPathName("test".getBytes())).build()).addAugmentation(org.opendaylight.
110                         yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.optimizations.rev150714
111                         .Tlvs1.class, new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller
112                     .pcep.sync.optimizations.rev150714.Tlvs1Builder().setLspDbVersion(new LspDbVersionBuilder()
113                     .setLspDbVersionValue(BigInteger.ONE).build()).build()).build())
114             .setPlspId(new PlspId(1L)).setSync(true).setRemove(false).setOperational(OperationalStatus.Active)
115             .build(), Optional.absent(), createPath(Collections.emptyList()));
116         this.listener.onMessage(session, pcRpt);
117         readDataOperational(getDataBroker(), this.pathComputationClientIId, pcc -> {
118             assertFalse(pcc.getReportedLsp().isEmpty());
119             return pcc;
120         });
121
122         this.listener.onSessionDown(session, new IllegalArgumentException());
123         this.listener = (Stateful07TopologySessionListener) getSessionListener();
124
125         //session up - expect sync (LSP-DBs do not match)
126         final LspDbVersion localDbVersion = new LspDbVersionBuilder()
127             .setLspDbVersionValue(BigInteger.valueOf(2L)).build();
128         session = getPCEPSession(getOpen(localDbVersion), getOpen(null));
129         this.listener.onSessionUp(session);
130
131         readDataOperational(getDataBroker(), this.pathComputationClientIId, pcc -> {
132             //check node - not synchronized
133             assertEquals(PccSyncState.InitialResync, pcc.getStateSync());
134             //check reported LSP - persisted from previous session
135             assertFalse(pcc.getReportedLsp().isEmpty());
136             return pcc;
137         });
138
139         //sync rpt + LSP-DB
140         final Pcrpt syncMsg = MsgBuilderUtil.createPcRtpMessage(createLsp(0, false, Optional.of(
141             new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev131222
142                 .lsp.object.lsp.TlvsBuilder().addAugmentation(org.opendaylight.yang.gen.v1.urn.opendaylight.
143                     params.xml.ns.yang.controller.pcep.sync.optimizations.rev150714.Tlvs1.class,
144                 new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync
145                     .optimizations.rev150714.Tlvs1Builder().setLspDbVersion(new LspDbVersionBuilder()
146                     .setLspDbVersionValue(BigInteger.valueOf(2L)).build()).build()).build()),
147             true, false), Optional.absent(),
148                 createPath(Collections.emptyList()));
149         this.listener.onMessage(session, syncMsg);
150         readDataOperational(getDataBroker(), this.pathComputationClientIId, pcc -> {
151             //check node - synchronized
152             assertEquals(PccSyncState.Synchronized, pcc.getStateSync());
153             //check reported LSP is empty, LSP state from previous session was purged
154             assertTrue(pcc.getReportedLsp().isEmpty());
155             return pcc;
156         });
157     }
158
159     private Open getOpen(final LspDbVersion dbVersion) {
160         return new OpenBuilder(super.getLocalPref()).setTlvs(new TlvsBuilder().addAugmentation(Tlvs1.class,
161             new Tlvs1Builder().setStateful(new StatefulBuilder()
162             .addAugmentation(Stateful1.class, new Stateful1Builder().setInitiation(Boolean.TRUE).build())
163             .addAugmentation(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.sync.
164                 optimizations.rev150714.Stateful1.class, new org.opendaylight.yang.gen.v1.urn.opendaylight.params.
165                 xml.ns.yang.controller.pcep.sync.optimizations.rev150714.Stateful1Builder()
166                 .setIncludeDbVersion(Boolean.TRUE).build()).build()).build()).addAugmentation(Tlvs3.class,
167             new Tlvs3Builder().setLspDbVersion(dbVersion).build()).build()).build();
168     }
169
170 }