/*
* Copyright (c) 2017 Cisco and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.fd.hc2vpp.l3.read.ipv4;
import static org.hamcrest.Matchers.empty;
import static org.hamcrest.Matchers.hasItem;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.is;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.when;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import io.fd.hc2vpp.common.test.read.ListReaderCustomizerTest;
import io.fd.hc2vpp.common.translate.util.Ipv4Translator;
import io.fd.hc2vpp.common.translate.util.NamingContext;
import io.fd.hc2vpp.l3.read.InterfaceChildNodeTest;
import io.fd.hc2vpp.l3.utils.ip.read.IfaceDumpFilter;
import io.fd.honeycomb.translate.read.ReadFailedException;
import io.fd.honeycomb.translate.spi.read.ReaderCustomizer;
import io.fd.honeycomb.translate.util.read.cache.CacheKeyFactory;
import io.fd.honeycomb.translate.util.read.cache.TypeAwareIdentifierCacheKeyFactory;
import io.fd.vpp.jvpp.core.dto.IpAddressDetails;
import io.fd.vpp.jvpp.core.dto.IpAddressDetailsReplyDump;
import io.fd.vpp.jvpp.core.dto.IpAddressDump;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.stream.Collectors;
import org.junit.Test;
import org.mockito.Mockito;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.Interface2;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.Ipv4;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.Ipv4Builder;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.Address;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.AddressBuilder;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.AddressKey;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ip.rev140616.interfaces.state._interface.ipv4.address.subnet.PrefixLength;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
public class Ipv4AddressCustomizerTest extends ListReaderCustomizerTest
implements
Ipv4Translator,InterfaceChildNodeTest {
private static final String IFC_CTX_NAME = "ifc-test-instance";
private NamingContext interfacesContext;
private InstanceIdentifier ifaceOneAddressOneIdentifier;
private InstanceIdentifier ifaceTwoAddressOneIdentifier;
private CacheKeyFactory cacheKeyFactory;
public Ipv4AddressCustomizerTest() {
super(Address.class, Ipv4Builder.class);
}
private static InstanceIdentifier getId(final String address, final String ifaceName) {
return InstanceIdentifier.builder(InterfacesState.class)
.child(Interface.class, new InterfaceKey(ifaceName))
.augmentation(Interface2.class)
.child(Ipv4.class)
.child(Address.class, new AddressKey(new Ipv4AddressNoZone(new Ipv4Address(address))))
.build();
}
@Override
public void setUp() {
interfacesContext = new NamingContext("generatedIfaceName", IFC_CTX_NAME);
defineMapping(mappingContext, IFACE_NAME, IFACE_ID, IFC_CTX_NAME);
defineMapping(mappingContext, IFACE_2_NAME, IFACE_2_ID, IFC_CTX_NAME);
ifaceOneAddressOneIdentifier =
InstanceIdentifier.create(InterfacesState.class)
.child(Interface.class, new InterfaceKey(IFACE_NAME))
.augmentation(Interface2.class)
.child(Ipv4.class)
.child(Address.class, new AddressKey(new Ipv4AddressNoZone("192.168.2.1")));
ifaceTwoAddressOneIdentifier =
InstanceIdentifier.create(InterfacesState.class)
.child(Interface.class, new InterfaceKey(IFACE_2_NAME))
.augmentation(Interface2.class)
.child(Ipv4.class)
.child(Address.class, new AddressKey(new Ipv4AddressNoZone("192.168.2.1")));
// to simulate complex key
cacheKeyFactory = new TypeAwareIdentifierCacheKeyFactory(IpAddressDetailsReplyDump.class,
ImmutableSet.of(Interface.class));
}
@Override
protected ReaderCustomizer initCustomizer() {
return new Ipv4AddressCustomizer(api, interfacesContext);
}
@Test
public void testReadCurrentAttributesFor2Ifcs() throws ReadFailedException {
//changed to mock to not store first dumped data(otherwise that double thenReturn on line 118 is not gonna work)
IpAddressDetails detail1 = new IpAddressDetails();
IpAddressDetails detail2 = new IpAddressDetails();
detail1.ip = ipv4AddressNoZoneToArray(new Ipv4AddressNoZone(new Ipv4Address("192.168.2.1")));
detail2.ip = ipv4AddressNoZoneToArray(new Ipv4AddressNoZone(new Ipv4Address("192.168.2.2")));
IpAddressDetailsReplyDump reply = new IpAddressDetailsReplyDump();
reply.ipAddressDetails = ImmutableList.of(detail1);
IpAddressDetailsReplyDump reply2 = new IpAddressDetailsReplyDump();
reply2.ipAddressDetails = ImmutableList.of(detail2);
CompletableFuture future = new CompletableFuture<>();
future.complete(reply);
CompletableFuture future2 = new CompletableFuture<>();
future2.complete(reply2);
when(api.ipAddressDump(Mockito.any(IpAddressDump.class))).thenReturn(future).thenReturn(future2)
.thenReturn(future).thenReturn(future2);
when(api.ipAddressDump(Mockito.any(IpAddressDump.class))).thenReturn(future(reply)).thenReturn(future(reply2))
.thenReturn(future(reply)).thenReturn(future(reply2));
when(ctx.getModificationCache()).thenReturn(cache);
final InstanceIdentifier id = getId("192.168.2.1", IFACE_NAME);
final InstanceIdentifier id2 = getId("192.168.2.2", IFACE_2_NAME);
final List ifc1Ids = getCustomizer().getAllIds(id, ctx);
assertThat(ifc1Ids.size(), is(1));
assertThat(ifc1Ids, hasItem(new AddressKey(new Ipv4AddressNoZone("192.168.2.1"))));
final List ifc2Ids = getCustomizer().getAllIds(id2, ctx);
assertThat(ifc2Ids.size(), is(1));
assertThat(ifc2Ids, hasItem(new AddressKey(new Ipv4AddressNoZone("192.168.2.2"))));
AddressBuilder builder = new AddressBuilder();
getCustomizer().readCurrentAttributes(id, builder, ctx);
assertEquals(builder.getIp().getValue(), "192.168.2.1");
builder = new AddressBuilder();
getCustomizer().readCurrentAttributes(id2, builder, ctx);
assertEquals(builder.getIp().getValue(), "192.168.2.2");
}
@Test
public void testReadCurrentAttributesSuccessfull() throws ReadFailedException {
IpAddressDetails detail1 = new IpAddressDetails();
IpAddressDetails detail2 = new IpAddressDetails();
IpAddressDetails detail3 = new IpAddressDetails();
detail1.ip = ipv4AddressNoZoneToArray(new Ipv4AddressNoZone(new Ipv4Address("192.168.2.1")));
detail2.ip = ipv4AddressNoZoneToArray(new Ipv4AddressNoZone(new Ipv4Address("192.168.2.2")));
detail3.ip = ipv4AddressNoZoneToArray(new Ipv4AddressNoZone(new Ipv4Address("192.168.2.3")));
IpAddressDetailsReplyDump reply = new IpAddressDetailsReplyDump();
reply.ipAddressDetails = ImmutableList.of(detail1, detail2, detail3);
when(api.ipAddressDump(Mockito.any(IpAddressDump.class))).thenReturn(future(reply));
when(ctx.getModificationCache()).thenReturn(cache);
final AddressBuilder builder = new AddressBuilder();
final InstanceIdentifier id = getId("192.168.2.1", IFACE_NAME);
getCustomizer().readCurrentAttributes(id, builder, ctx);
assertEquals("192.168.2.1", builder.getIp().getValue());
}
@Test
public void testGetAllIdsFromSuccessfull() throws ReadFailedException {
IpAddressDetails detail1 = new IpAddressDetails();
IpAddressDetails detail2 = new IpAddressDetails();
IpAddressDetails detail3 = new IpAddressDetails();
detail1.ip = ipv4AddressNoZoneToArray(new Ipv4AddressNoZone(new Ipv4Address("192.168.2.1")));
detail2.ip = ipv4AddressNoZoneToArray(new Ipv4AddressNoZone(new Ipv4Address("192.168.2.2")));
detail3.ip = ipv4AddressNoZoneToArray(new Ipv4AddressNoZone(new Ipv4Address("192.168.2.3")));
IpAddressDetailsReplyDump reply = new IpAddressDetailsReplyDump();
reply.ipAddressDetails = ImmutableList.of(detail1, detail2, detail3);
when(api.ipAddressDump(Mockito.any(IpAddressDump.class))).thenReturn(future(reply));
when(ctx.getModificationCache()).thenReturn(cache);
final InstanceIdentifier id = getId("192.168.2.1", IFACE_NAME);
List ids = getCustomizer().getAllIds(id, ctx).stream()
.map(key -> key.getIp())
.collect(Collectors.toList());
assertEquals(3, ids.size());
assertEquals(true, "192.168.2.1".equals(ids.get(0).getValue()));
assertEquals(true, "192.168.2.2".equals(ids.get(1).getValue()));
assertEquals(true, "192.168.2.3".equals(ids.get(2).getValue()));
}
@Test
public void testCachingScopeSpecificRequest() throws ReadFailedException {
fillCacheForTwoIfaces();
final AddressBuilder ifaceOneAddressBuilder = new AddressBuilder();
final AddressBuilder ifaceTwoAddressBuilder = new AddressBuilder();
getCustomizer().readCurrentAttributes(ifaceOneAddressOneIdentifier, ifaceOneAddressBuilder, ctx);
getCustomizer().readCurrentAttributes(ifaceTwoAddressOneIdentifier, ifaceTwoAddressBuilder, ctx);
// addresses have caching scope of parent interface, so returned address should have respective prefix lengths
assertEquals("192.168.2.1", ifaceOneAddressBuilder.getIp().getValue());
assertTrue(ifaceOneAddressBuilder.getSubnet() instanceof PrefixLength);
assertEquals(22, PrefixLength.class.cast(ifaceOneAddressBuilder.getSubnet()).getPrefixLength().intValue());
assertEquals("192.168.2.1", ifaceTwoAddressBuilder.getIp().getValue());
assertTrue(ifaceTwoAddressBuilder.getSubnet() instanceof PrefixLength);
assertEquals(23, PrefixLength.class.cast(ifaceTwoAddressBuilder.getSubnet()).getPrefixLength().intValue());
}
@Test
public void testCachingScopeGetAll() throws ReadFailedException {
fillCacheForFirstIfaceSecondEmpty();
final List keysForIfaceOne = getCustomizer().getAllIds(ifaceOneAddressOneIdentifier, ctx);
assertThat(keysForIfaceOne, hasSize(1));
final AddressKey keyIfaceOne = keysForIfaceOne.get(0);
assertEquals("192.168.2.1", keyIfaceOne.getIp().getValue());
final List keysForIfaceTwo = getCustomizer().getAllIds(ifaceTwoAddressOneIdentifier, ctx);
assertThat(keysForIfaceTwo, is(empty()));
}
private void fillCacheForTwoIfaces() {
IpAddressDetails detailIfaceOneAddressOne = new IpAddressDetails();
IpAddressDetails detailIfaceTwoAddressOne = new IpAddressDetails();
IpAddressDetailsReplyDump replyIfaceOne = new IpAddressDetailsReplyDump();
IpAddressDetailsReplyDump replyIfaceTwo = new IpAddressDetailsReplyDump();
replyIfaceOne.ipAddressDetails = Arrays.asList(detailIfaceOneAddressOne);
replyIfaceTwo.ipAddressDetails = Arrays.asList(detailIfaceTwoAddressOne);
detailIfaceOneAddressOne.ip = ipv4AddressNoZoneToArray(new Ipv4AddressNoZone(new Ipv4Address("192.168.2.1")));
detailIfaceOneAddressOne.prefixLength = 22;
detailIfaceTwoAddressOne.ip = ipv4AddressNoZoneToArray(new Ipv4AddressNoZone(new Ipv4Address("192.168.2.1")));
detailIfaceTwoAddressOne.prefixLength = 23;
cache.put(cacheKeyFactory.createKey(ifaceOneAddressOneIdentifier, new IfaceDumpFilter(IFACE_ID, false)),
replyIfaceOne);
cache.put(cacheKeyFactory.createKey(ifaceTwoAddressOneIdentifier, new IfaceDumpFilter(IFACE_2_ID, false)),
replyIfaceTwo);
}
private void fillCacheForFirstIfaceSecondEmpty() {
IpAddressDetails detailIfaceOneAddressOne = new IpAddressDetails();
IpAddressDetailsReplyDump replyIfaceOne = new IpAddressDetailsReplyDump();
replyIfaceOne.ipAddressDetails = Arrays.asList(detailIfaceOneAddressOne);
detailIfaceOneAddressOne.ip = ipv4AddressNoZoneToArray(new Ipv4AddressNoZone(new Ipv4Address("192.168.2.1")));
detailIfaceOneAddressOne.prefixLength = 22;
cache.put(cacheKeyFactory.createKey(ifaceOneAddressOneIdentifier, new IfaceDumpFilter(IFACE_ID, false)),
replyIfaceOne);
cache.put(cacheKeyFactory.createKey(ifaceTwoAddressOneIdentifier, new IfaceDumpFilter(IFACE_2_ID, false)),
new IpAddressDetailsReplyDump());
}
}