BUG-635: implement MD5 auth option for BGP peers
[bgpcep.git] / integration-tests / src / test / java / org / opendaylight / protocol / integration / bgp / ParserToSalTest.java
1 /*
2  * Copyright (c) 2013 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 package org.opendaylight.protocol.integration.bgp;
9
10 import io.netty.util.concurrent.GlobalEventExecutor;
11
12 import java.net.InetSocketAddress;
13 import java.util.Collection;
14 import java.util.HashMap;
15 import java.util.List;
16 import java.util.concurrent.ExecutionException;
17 import java.util.concurrent.Future;
18 import java.util.concurrent.TimeUnit;
19 import java.util.concurrent.TimeoutException;
20
21 import javax.annotation.Nullable;
22
23 import org.junit.After;
24 import org.junit.Before;
25 import org.junit.Test;
26 import org.mockito.Matchers;
27 import org.mockito.Mock;
28 import org.mockito.Mockito;
29 import org.mockito.MockitoAnnotations;
30 import org.mockito.invocation.InvocationOnMock;
31 import org.mockito.stubbing.Answer;
32 import org.opendaylight.bgpcep.tcpmd5.KeyMapping;
33 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
34 import org.opendaylight.controller.sal.binding.api.data.DataModificationTransaction;
35 import org.opendaylight.controller.sal.binding.api.data.DataProviderService;
36 import org.opendaylight.protocol.bgp.parser.BGPSessionListener;
37 import org.opendaylight.protocol.bgp.parser.BgpTableTypeImpl;
38 import org.opendaylight.protocol.bgp.parser.spi.pojo.ServiceLoaderBGPExtensionProviderContext;
39 import org.opendaylight.protocol.bgp.rib.impl.BGPPeer;
40 import org.opendaylight.protocol.bgp.rib.impl.RIBActivator;
41 import org.opendaylight.protocol.bgp.rib.impl.RIBImpl;
42 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPDispatcher;
43 import org.opendaylight.protocol.bgp.rib.impl.spi.BGPSessionPreferences;
44 import org.opendaylight.protocol.bgp.rib.mock.BGPMock;
45 import org.opendaylight.protocol.bgp.rib.spi.AbstractRIBExtensionProviderActivator;
46 import org.opendaylight.protocol.bgp.rib.spi.RIBExtensionProviderContext;
47 import org.opendaylight.protocol.bgp.rib.spi.SimpleRIBExtensionProviderContext;
48 import org.opendaylight.protocol.bgp.util.HexDumpBGPFileParser;
49 import org.opendaylight.protocol.framework.ReconnectStrategyFactory;
50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.AsNumber;
51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev131125.LinkstateAddressFamily;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev131125.LinkstateSubsequentAddressFamily;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev130919.BgpTableType;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev130925.RibId;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.Ipv4AddressFamily;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev130919.UnicastSubsequentAddressFamily;
58 import org.opendaylight.yangtools.concepts.ListenerRegistration;
59 import org.opendaylight.yangtools.yang.binding.DataObject;
60 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
61 import org.opendaylight.yangtools.yang.common.RpcResult;
62 import org.slf4j.Logger;
63 import org.slf4j.LoggerFactory;
64
65 import com.google.common.base.Function;
66 import com.google.common.collect.Collections2;
67 import com.google.common.collect.ImmutableList;
68 import com.google.common.collect.Lists;
69 import com.google.common.eventbus.EventBus;
70
71 public class ParserToSalTest {
72
73         private static final Logger LOG = LoggerFactory.getLogger(ParserToSalTest.class);
74
75         private final String hex_messages = "/bgp_hex.txt";
76
77         private BGPMock mock;
78         private AbstractRIBExtensionProviderActivator baseact, lsact;
79         private RIBExtensionProviderContext ext;
80
81         @Mock
82         DataModificationTransaction mockedTransaction;
83
84         @Mock
85         DataProviderService providerService;
86
87         @Mock
88         BGPDispatcher dispatcher;
89
90         @Mock
91         ReconnectStrategyFactory tcpStrategyFactory;
92
93         @Mock
94         ReconnectStrategyFactory sessionStrategy;
95
96         @Before
97         public void setUp() throws Exception {
98                 MockitoAnnotations.initMocks(this);
99                 final List<byte[]> bgpMessages = HexDumpBGPFileParser.parseMessages(ParserToSalTest.class.getResourceAsStream(this.hex_messages));
100                 this.mock = new BGPMock(new EventBus("test"), ServiceLoaderBGPExtensionProviderContext.getSingletonInstance().getMessageRegistry(), Lists.newArrayList(fixMessages(bgpMessages)));
101
102                 Mockito.doReturn(this.mockedTransaction).when(this.providerService).beginTransaction();
103
104                 Mockito.doReturn(new Future<RpcResult<TransactionStatus>>() {
105                         int i = 0;
106
107                         @Override
108                         public boolean cancel(final boolean mayInterruptIfRunning) {
109                                 LOG.debug("Cancel.");
110                                 return false;
111                         }
112
113                         @Override
114                         public boolean isCancelled() {
115                                 return false;
116                         }
117
118                         @Override
119                         public boolean isDone() {
120                                 this.i++;
121                                 LOG.debug("Done. {}", this.i);
122                                 return true;
123                         }
124
125                         @Override
126                         public RpcResult<TransactionStatus> get() throws InterruptedException, ExecutionException {
127                                 return null;
128                         }
129
130                         @Override
131                         public RpcResult<TransactionStatus> get(final long timeout, final TimeUnit unit) throws InterruptedException,
132                         ExecutionException, TimeoutException {
133                                 return null;
134                         }
135                 }).when(this.mockedTransaction).commit();
136
137                 final HashMap<Object, Object> data = new HashMap<>();
138
139                 Mockito.doAnswer(new Answer<String>() {
140                         @Override
141                         public String answer(final InvocationOnMock invocation) throws Throwable {
142                                 final Object[] args = invocation.getArguments();
143                                 LOG.debug("Put key {} value {}", args[0]);
144                                 LOG.debug("Put value {}", args[1]);
145                                 data.put(args[0], args[1]);
146                                 return null;
147                         }
148
149                 }).when(this.mockedTransaction).putOperationalData(Matchers.any(InstanceIdentifier.class), Matchers.any(DataObject.class));
150
151                 Mockito.doAnswer(new Answer<Object>() {
152                         @Override
153                         public Object answer(final InvocationOnMock invocation) throws Throwable {
154                                 final Object[] args = invocation.getArguments();
155                                 LOG.debug("Get key {}", args[0]);
156                                 return data.get(args[0]);
157                         }
158
159                 }).when(this.mockedTransaction).readOperationalData(Matchers.any(InstanceIdentifier.class));
160
161                 Mockito.doReturn(GlobalEventExecutor.INSTANCE.newSucceededFuture(null)).when(this.dispatcher).
162                 createReconnectingClient(Mockito.any(InetSocketAddress.class), Mockito.any(BGPSessionPreferences.class), Mockito.any(AsNumber.class),
163                                 Mockito.any(BGPSessionListener.class), Mockito.eq(this.tcpStrategyFactory), Mockito.eq(this.sessionStrategy), Mockito.any(KeyMapping.class));
164
165                 this.ext = new SimpleRIBExtensionProviderContext();
166                 this.baseact = new RIBActivator();
167                 this.lsact = new org.opendaylight.protocol.bgp.linkstate.RIBActivator();
168
169                 this.baseact.startRIBExtensionProvider(this.ext);
170                 this.lsact.startRIBExtensionProvider(this.ext);
171         }
172
173         @After
174         public void tearDown() {
175                 this.lsact.close();
176                 this.baseact.close();
177         }
178
179         private void runTestWithTables(final List<BgpTableType> tables) {
180                 final RIBImpl rib = new RIBImpl(new RibId("testRib"), new AsNumber(72L), new Ipv4Address("127.0.0.1"), this.ext,
181                                 this.dispatcher, this.tcpStrategyFactory, this.sessionStrategy, this.providerService, tables);
182                 final BGPPeer peer = new BGPPeer("peer-" + this.mock.toString(), null, null, null, rib.getLocalAs(), rib);
183
184                 ListenerRegistration<?> reg = this.mock.registerUpdateListener(peer);
185                 reg.close();
186
187                 Mockito.verify(this.mockedTransaction, Mockito.times(31)).commit();
188         }
189
190         @Test
191         public void testWithLinkstate() {
192                 runTestWithTables(ImmutableList.of(
193                                 (BgpTableType) new BgpTableTypeImpl(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class),
194                                 new BgpTableTypeImpl(LinkstateAddressFamily.class, LinkstateSubsequentAddressFamily.class)));
195
196                 Mockito.verify(this.mockedTransaction, Mockito.times(81)).putOperationalData(Matchers.any(InstanceIdentifier.class),
197                                 Matchers.any(DataObject.class));
198         }
199
200         @Test
201         public void testWithoutLinkstate() {
202                 runTestWithTables(ImmutableList.of(
203                                 (BgpTableType) new BgpTableTypeImpl(Ipv4AddressFamily.class, UnicastSubsequentAddressFamily.class)));
204
205                 Mockito.verify(this.mockedTransaction, Mockito.times(27)).putOperationalData(Matchers.any(InstanceIdentifier.class),
206                                 Matchers.any(DataObject.class));
207         }
208
209         private Collection<byte[]> fixMessages(final Collection<byte[]> bgpMessages) {
210                 return Collections2.transform(bgpMessages, new Function<byte[], byte[]>() {
211
212                         @Nullable
213                         @Override
214                         public byte[] apply(@Nullable final byte[] input) {
215                                 final byte[] ret = new byte[input.length + 1];
216                                 // ff
217                                 ret[0] = -1;
218                                 for (int i = 0; i < input.length; i++) {
219                                         ret[i + 1] = input[i];
220                                 }
221                                 return ret;
222                         }
223                 });
224         }
225 }