BUG-4447: BGP-LS SR extention
[bgpcep.git] / bgp / linkstate / src / test / java / org / opendaylight / protocol / bgp / linkstate / SrAttributeParserTest.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 package org.opendaylight.protocol.bgp.linkstate;
9
10 import static org.junit.Assert.assertArrayEquals;
11 import static org.junit.Assert.assertEquals;
12 import com.google.common.collect.Lists;
13 import com.google.common.primitives.Bytes;
14 import io.netty.buffer.ByteBuf;
15 import io.netty.buffer.Unpooled;
16 import java.lang.reflect.Constructor;
17 import java.lang.reflect.InvocationTargetException;
18 import java.util.ArrayList;
19 import java.util.Collections;
20 import java.util.List;
21 import org.junit.Test;
22 import org.opendaylight.protocol.bgp.linkstate.attribute.sr.RangeTlvParser;
23 import org.opendaylight.protocol.bgp.linkstate.attribute.sr.SrLinkAttributesParser;
24 import org.opendaylight.protocol.bgp.linkstate.attribute.sr.SrNodeAttributesParser;
25 import org.opendaylight.protocol.bgp.linkstate.attribute.sr.SrPrefixAttributesParser;
26 import org.opendaylight.protocol.util.ByteArray;
27 import org.opendaylight.protocol.util.Ipv6Util;
28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv4Address;
29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Ipv6Address;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.link.state.SrAdjId;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.link.state.SrAdjIdBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.link.state.SrLanAdjId;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.link.state.SrLanAdjIdBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.state.SrAlgorithm;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.state.SrAlgorithmBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.state.SrCapabilities;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.node.state.SrCapabilitiesBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.prefix.state.SrPrefix;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.prefix.state.SrPrefixBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.prefix.state.SrRange;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev150210.prefix.state.SrRangeBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.Algorithm;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.Weight;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.binding.sid.tlv.BindingSubTlvs;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.binding.sid.tlv.BindingSubTlvsBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.binding.sub.tlvs.binding.sub.tlv.EroMetricCaseBuilder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.binding.sub.tlvs.binding.sub.tlv.Ipv4EroBackupCaseBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.binding.sub.tlvs.binding.sub.tlv.Ipv4EroCaseBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.binding.sub.tlvs.binding.sub.tlv.Ipv6EroBackupCaseBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.binding.sub.tlvs.binding.sub.tlv.Ipv6EroCaseBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.binding.sub.tlvs.binding.sub.tlv.PrefixSidCaseBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.binding.sub.tlvs.binding.sub.tlv.SidLabelCaseBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.binding.sub.tlvs.binding.sub.tlv.UnnumberedInterfaceIdBackupEroCaseBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.binding.sub.tlvs.binding.sub.tlv.UnnumberedInterfaceIdEroCaseBuilder;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.range.sub.tlvs.range.sub.tlv.BindingSidTlvCaseBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.range.sub.tlvs.range.sub.tlv.PrefixSidTlvCaseBuilder;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.range.sub.tlvs.range.sub.tlv.SidLabelTlvCaseBuilder;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.range.tlv.SubTlvs;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.range.tlv.SubTlvsBuilder;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.sid.label.index.sid.label.index.Ipv6AddressCaseBuilder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.sid.label.index.sid.label.index.LocalLabelCaseBuilder;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev151014.sid.label.index.sid.label.index.SidCaseBuilder;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.IsoSystemIdentifier;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.MplsLabel;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.TeMetric;
66
67 public class SrAttributeParserTest {
68
69     private static final byte[] IPV6_A_BYTES = { 0x20, 1, 0x0d, (byte) 0xb8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1 };
70     private static final Ipv6Address IPV6_A = new Ipv6Address("2001:db8::1");
71     private static final byte[] IPV6_B_BYTES = { 0x20, 1, 0x0d, (byte) 0xb8, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2 };
72     private static final Ipv6Address IPV6_B = new Ipv6Address("2001:db8::2");
73
74     @Test
75     public void testSrAlgorithm() {
76         final byte[] bytes = { 0 };
77         final SrAlgorithm alg = new SrAlgorithmBuilder().setAlgorithms(Lists.newArrayList(Algorithm.ShortestPathFirst)).build();
78         final SrAlgorithm empty = new SrAlgorithmBuilder().setAlgorithms(Collections.<Algorithm>emptyList()).build();
79         assertEquals(alg, SrNodeAttributesParser.parseSrAlgorithms(Unpooled.wrappedBuffer(bytes)));
80         final ByteBuf b = Unpooled.buffer();
81         assertEquals(empty, SrNodeAttributesParser.parseSrAlgorithms(b));
82         SrNodeAttributesParser.serializeSrAlgorithms(alg, b);
83         assertArrayEquals(bytes, ByteArray.readAllBytes(b));
84
85         SrNodeAttributesParser.serializeSrAlgorithms(empty, b);
86         assertEquals(0, b.readableBytes());
87     }
88
89     // tools.ietf.org/html/draft-gredler-idr-bgp-ls-segment-routing-ext-00#section-2.1.1
90     @Test
91     public void testSrCapabilities() {
92         final byte[] bytes = { (byte)0xC0, 0, 0, 0, 10, 4, (byte)0x89, 0, 4, 1, 2, 3, 4 };
93         final SrCapabilities caps = new SrCapabilitiesBuilder().setMplsIpv4(Boolean.TRUE).setMplsIpv6(Boolean.TRUE).setSrIpv6(Boolean.FALSE).setSidLabelIndex(new SidCaseBuilder().setSid(16909060L).build()).setRangeSize((long) 10).build();
94         assertEquals(caps, SrNodeAttributesParser.parseSrCapabilities(Unpooled.wrappedBuffer(bytes)));
95         final ByteBuf b = Unpooled.buffer();
96         SrNodeAttributesParser.serializeSrCapabilities(caps, b);
97         assertArrayEquals(bytes, ByteArray.readAllBytes(b));
98     }
99
100     // tools.ietf.org/html/draft-gredler-idr-bgp-ls-segment-routing-ext-00#section-2.3.1
101     @Test
102     public void testSrPrefix() {
103         final byte[] bytes = { (byte)0xFC, 0, 0, 0, 1, 2, 3, 4 };
104         final SrPrefix prefix = new SrPrefixBuilder()
105             .setFlags(new byte[] {(byte)0xfc})
106             .setAlgorithm(Algorithm.ShortestPathFirst).setSidLabelIndex(new SidCaseBuilder().setSid(16909060L).build()).build();
107         assertEquals(prefix, SrPrefixAttributesParser.parseSrPrefix(Unpooled.wrappedBuffer(bytes)));
108         final ByteBuf serializedPrefix = Unpooled.buffer();
109         SrPrefixAttributesParser.serializeSrPrefix(prefix, serializedPrefix);
110         assertArrayEquals(bytes, ByteArray.readAllBytes(serializedPrefix));
111     }
112
113     // tools.ietf.org/html/draft-gredler-idr-bgp-ls-segment-routing-ext-00#section-2.3.2
114     @Test
115     public void testRangeTlv() {
116         final byte[] tested = {
117             0, 0, 0, 5,
118             4, (byte)0x89, 0, 4, 1, 2, 3, 4, // sid
119             4, (byte)0x86, 0, 7, 0, 1, 0, 0, 1, 2, 0, // prefix
120             4, (byte)0x88, 0, 0x58, 5, 0, 0, 0, // binding sid
121             // binding sub-tlvs
122             4, (byte)0x86, 0, 8, 0, 1, 0, 0, 1, 2, 3, 4, // prefix
123             4, (byte)0x89, 0, 4, 1, 2, 3, 4, // sid
124             4, (byte)0x8a, 0, 4, 0, 0, 0, 6, // ero metric
125             4, (byte)0x8b, 0, 8, 0, 0, 0, 0, 9, 8, 7, 6,  // IPv4 ERO
126             4, (byte)0x8d, 0, 0x0c, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, // Unnumbered Interface ID ERO Sub-TLV
127             4, (byte)0x8e, 0, 8, 0, 0, 0, 0, 3, 4, 5, 6, // IPv4 ERO backup
128             4, (byte)0x90, 0, 0x0c, 0, 0, 0, 0, 3, 3, 3, 3, 4, 4, 4, 4, // Unnumbered Interface ID ERO Sub-TLV Backup
129         };
130         final SrRange parsedRange = RangeTlvParser.parseSrRange(Unpooled.wrappedBuffer(tested));
131
132         final List<SubTlvs> rangeSubTlvs = new ArrayList<SubTlvs>();
133         addSubTlvs(rangeSubTlvs);
134         final SrRange expected = new SrRangeBuilder().setInterArea(Boolean.FALSE).setRangeSize(5).setSubTlvs(rangeSubTlvs).build();
135
136         assertEquals(expected, parsedRange);
137
138         final ByteBuf serializedRange = Unpooled.buffer();
139         RangeTlvParser.serializeSrRange(parsedRange, serializedRange);
140         assertArrayEquals(tested, ByteArray.getAllBytes(serializedRange));
141     }
142
143     private void addSubTlvs(final List<SubTlvs> rangeSubTlvs) {
144         rangeSubTlvs.add(new SubTlvsBuilder().setRangeSubTlv(
145             new SidLabelTlvCaseBuilder()
146                 .setSidLabelIndex(new SidCaseBuilder().setSid(16909060L).build()).build()).build());
147         rangeSubTlvs.add(new SubTlvsBuilder().setRangeSubTlv(
148             new PrefixSidTlvCaseBuilder()
149                 .setFlags(new byte[] {0})
150                 .setAlgorithm(Algorithm.StrictShortestPathFirst)
151                 .setSidLabelIndex(new LocalLabelCaseBuilder().setLocalLabel(new MplsLabel(4128L)).build()).build()).build());
152         final List<BindingSubTlvs> bindingSubTlvs = new ArrayList<BindingSubTlvs>();
153         addBindingSubTlvs(bindingSubTlvs);
154         rangeSubTlvs.add(new SubTlvsBuilder().setRangeSubTlv(
155             new BindingSidTlvCaseBuilder()
156                 .setWeight(new Weight((short) 5))
157                 .setFlags(new byte[] {0})
158                 .setBindingSubTlvs(bindingSubTlvs).build()).build());
159     }
160
161     private void addBindingSubTlvs(final List<BindingSubTlvs> bindingSubTlvs) {
162         bindingSubTlvs.add(new BindingSubTlvsBuilder().setBindingSubTlv(
163             new PrefixSidCaseBuilder()
164                 .setFlags(new byte[] {0})
165                 .setAlgorithm(Algorithm.StrictShortestPathFirst)
166                 .setSidLabelIndex(new SidCaseBuilder().setSid(16909060L).build())
167                 .build()).build());
168         bindingSubTlvs.add(new BindingSubTlvsBuilder().setBindingSubTlv(
169             new SidLabelCaseBuilder().setSidLabelIndex(new SidCaseBuilder().setSid(16909060L).build()).build()).build());
170         bindingSubTlvs.add(new BindingSubTlvsBuilder().setBindingSubTlv(
171             new EroMetricCaseBuilder().setEroMetric(new TeMetric(6L)).build()).build());
172         bindingSubTlvs.add(new BindingSubTlvsBuilder().setBindingSubTlv(
173             new Ipv4EroCaseBuilder().setLoose(Boolean.FALSE).setAddress(new Ipv4Address("9.8.7.6")).build()).build());
174         bindingSubTlvs.add(new BindingSubTlvsBuilder().setBindingSubTlv(
175             new UnnumberedInterfaceIdEroCaseBuilder().setLoose(Boolean.FALSE).setRouterId(16843009L).setInterfaceId(33686018L).build()).build());
176         bindingSubTlvs.add(new BindingSubTlvsBuilder().setBindingSubTlv(
177             new Ipv4EroBackupCaseBuilder().setLoose(Boolean.FALSE).setAddress(new Ipv4Address("3.4.5.6")).build()).build());
178         bindingSubTlvs.add(new BindingSubTlvsBuilder().setBindingSubTlv(
179             new UnnumberedInterfaceIdBackupEroCaseBuilder().setLoose(Boolean.FALSE).setRouterId(50529027L).setInterfaceId(67372036L).build()).build());
180     }
181
182     @Test
183     public void testRangeTlvIpv6() {
184         final byte[] tested = Bytes.concat(
185             new byte[] {
186                 0, 0, 0, 5,
187                 4, (byte)0x88, 0, 0x34, 5, 0, 0, 0, // binding sid
188                 // binding sub-tlvs
189                 4, (byte)0x8c, 0, 0x14, 0, 0, 0, 0 }, IPV6_A_BYTES, // IPv6 ERO
190                     new byte[] { 4, (byte)0x8f, 0, 0x14, 0, 0, 0, 0 }, IPV6_B_BYTES // IPv6 ERO backup
191             );
192         final SrRange parsedRange = RangeTlvParser.parseSrRange(Unpooled.wrappedBuffer(tested));
193
194         final List<SubTlvs> rangeSubTlvs = new ArrayList<SubTlvs>();
195         final List<BindingSubTlvs> bindingSubTlvs = new ArrayList<BindingSubTlvs>();
196         bindingSubTlvs.add(new BindingSubTlvsBuilder().setBindingSubTlv(
197             new Ipv6EroCaseBuilder().setLoose(Boolean.FALSE).setAddress(new Ipv6Address(IPV6_A)).build()).build());
198         bindingSubTlvs.add(new BindingSubTlvsBuilder().setBindingSubTlv(
199             new Ipv6EroBackupCaseBuilder().setLoose(Boolean.FALSE).setAddress(new Ipv6Address(IPV6_B)).build()).build());
200         rangeSubTlvs.add(new SubTlvsBuilder().setRangeSubTlv(
201             new BindingSidTlvCaseBuilder()
202                 .setWeight(new Weight((short) 5))
203                 .setFlags(new byte[] {0})
204                 .setBindingSubTlvs(bindingSubTlvs).build()).build());
205         final SrRange expected = new SrRangeBuilder().setInterArea(Boolean.FALSE).setRangeSize(5).setSubTlvs(rangeSubTlvs).build();
206
207         assertEquals(expected, parsedRange);
208
209         final ByteBuf serializedRange = Unpooled.buffer();
210         RangeTlvParser.serializeSrRange(parsedRange, serializedRange);
211         assertArrayEquals(tested, ByteArray.getAllBytes(serializedRange));
212     }
213
214     // tools.ietf.org/html/draft-gredler-idr-bgp-ls-segment-routing-ext-00#section-2.2.1
215     @Test
216     public void testSrAdjId() {
217         final byte[] tested = { (byte)-80, 10, 0, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 };
218         final byte[] sidLabel = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 };
219         final SrAdjId srAdjId = new SrAdjIdBuilder()
220             .setFlags(new byte[] { (byte)-80 })
221             .setWeight(new Weight((short) 10))
222             .setSidLabelIndex(new Ipv6AddressCaseBuilder().setIpv6Address(Ipv6Util.addressForByteBuf(Unpooled.copiedBuffer(sidLabel))).build()).build();
223         final ByteBuf serializedData = SrLinkAttributesParser.serializeAdjacencySegmentIdentifier(srAdjId);
224         assertEquals(srAdjId, new SrAdjIdBuilder(SrLinkAttributesParser.parseAdjacencySegmentIdentifier(Unpooled.wrappedBuffer(tested))).build());
225         assertArrayEquals(tested, ByteArray.readAllBytes(serializedData));
226     }
227
228     @Test
229     public void testSrLanAdjId() {
230         final byte[] tested = { (byte)-80, 10, 0, 0, 1, 2, 3, 4, 5, 6, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 };
231         final byte[] sidLabel = { 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16};
232         final byte[] systemId = { 1, 2, 3, 4, 5, 6 };
233         final SrLanAdjId srLanAdjId = new SrLanAdjIdBuilder()
234             .setFlags(new byte[] { (byte) -80 })
235             .setWeight(new Weight((short)10))
236             .setIsoSystemId(new IsoSystemIdentifier(systemId))
237             .setSidLabelIndex(new Ipv6AddressCaseBuilder().setIpv6Address(Ipv6Util.addressForByteBuf(Unpooled.copiedBuffer(sidLabel))).build()).build();
238         final ByteBuf serializedData = SrLinkAttributesParser.serializeLanAdjacencySegmentIdentifier(srLanAdjId);
239         assertEquals(srLanAdjId, SrLinkAttributesParser.parseLanAdjacencySegmentIdentifier(Unpooled.wrappedBuffer(tested)));
240         assertArrayEquals(tested, ByteArray.readAllBytes(serializedData));
241     }
242
243     @Test(expected=UnsupportedOperationException.class)
244     public void testSrLinkAttributesPrivateConstructor() throws Throwable {
245         final Constructor<SrLinkAttributesParser> c = SrLinkAttributesParser.class.getDeclaredConstructor();
246         c.setAccessible(true);
247         try {
248             c.newInstance();
249         } catch (final InvocationTargetException e) {
250             throw e.getCause();
251         }
252     }
253
254     @Test(expected=UnsupportedOperationException.class)
255     public void testSrNodeAttributesPrivateConstructor() throws Throwable {
256         final Constructor<SrNodeAttributesParser> c = SrNodeAttributesParser.class.getDeclaredConstructor();
257         c.setAccessible(true);
258         try {
259             c.newInstance();
260         } catch (final InvocationTargetException e) {
261             throw e.getCause();
262         }
263     }
264
265     @Test(expected=UnsupportedOperationException.class)
266     public void testSrPrefixAttributesPrivateConstructor() throws Throwable {
267         final Constructor<SrPrefixAttributesParser> c = SrPrefixAttributesParser.class.getDeclaredConstructor();
268         c.setAccessible(true);
269         try {
270             c.newInstance();
271         } catch (final InvocationTargetException e) {
272             throw e.getCause();
273         }
274     }
275 }