lisp/lisp2vpp/src/test/java/io/fd/honeycomb/lisp/util/EidMappingContextHelper.java

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package io.fd.honeycomb.lisp.util;
  18
  19
  20 import static org.mockito.Mockito.doReturn;
  21
  22 import com.google.common.base.Optional;
  23 import com.google.common.collect.Lists;
  24 import io.fd.honeycomb.translate.MappingContext;
  25 import java.util.List;
  26 import javax.annotation.Nonnull;
  27 import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.eid.mapping.context.rev160801.Contexts;
  28 import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.eid.mapping.context.rev160801.contexts.EidMappingContext;
  29 import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.eid.mapping.context.rev160801.contexts.EidMappingContextKey;
  30 import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.eid.mapping.context.rev160801.contexts.eid.mapping.context.Mappings;
  31 import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.eid.mapping.context.rev160801.contexts.eid.mapping.context.MappingsBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.eid.mapping.context.rev160801.contexts.eid.mapping.context.mappings.Mapping;
  33 import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.eid.mapping.context.rev160801.contexts.eid.mapping.context.mappings.MappingBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.eid.mapping.context.rev160801.contexts.eid.mapping.context.mappings.MappingKey;
  35 import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.eid.mapping.context.rev160801.contexts.eid.mapping.context.mappings.mapping.Eid;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.lisp.rev160520.MappingId;
  37 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  38 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  39
  40 /**
  41  * Utility class to stub {@link EidMappingContext}
  42  *
  43  * TODO - HONEYCOMB-237 - generalize logic for naming context and eid mapping context helper utils if possible
  44  */
  45 public interface EidMappingContextHelper {
  46
  47     /**
  48      * Creates {@link Mapping} for given data.
  49      *
  50      * @param eid to be mapped
  51      * @param id  to be mapped  @return eid to id mapping
  52      */
  53     default Optional<Mapping> mapping(@Nonnull final Eid eid, final MappingId id) {
  54         return Optional.of(new MappingBuilder().setEid(eid).setId(id).build());
  55     }
  56
  57     /**
  58      * Creates {@link KeyedInstanceIdentifier} for {@link Mapping} in {@link EidMappingContext}.
  59      *
  60      * @param id                 identificator of the mapping
  61      * @param mappingContextName identificator of the mapping context
  62      * @return identifier for the mapping
  63      */
  64     default KeyedInstanceIdentifier<Mapping, MappingKey> mappingIid(@Nonnull final MappingId id,
  65                                                                     @Nonnull final String mappingContextName) {
  66         return InstanceIdentifier.create(Contexts.class).child(EidMappingContext.class,
  67                 new EidMappingContextKey(mappingContextName)).child(Mappings.class)
  68                 .child(Mapping.class, new MappingKey(id));
  69     }
  70
  71     /**
  72      * Stubs {@link MappingContext#read} to include given mapping in {@link EidMappingContext}.
  73      *
  74      * @param mappingContext    mock instance of {@link MappingContext}
  75      * @param eid               name of the mapping
  76      * @param mappingName       index to be mapped
  77      * @param namingContextName name of the naming context
  78      */
  79     default void defineMapping(@Nonnull final MappingContext mappingContext, @Nonnull final Eid eid,
  80                                final MappingId mappingName, @Nonnull final String namingContextName) {
  81         final KeyedInstanceIdentifier<Mapping, MappingKey> mappingIid = mappingIid(mappingName, namingContextName);
  82         final InstanceIdentifier<Mappings> mappingsIid = mappingIid.firstIdentifierOf(Mappings.class);
  83
  84         final Optional<Mapping> singleMapping = mapping(eid, mappingName);
  85         final List<Mapping> list = Common.getMappingList(mappingContext, mappingsIid);
  86         list.add(singleMapping.get());
  87
  88         doReturn(Optional.of(new MappingsBuilder().setMapping(list).build())).when(mappingContext).read(mappingsIid);
  89         doReturn(singleMapping).when(mappingContext).read(mappingIid);
  90     }
  91
  92     final class Common {
  93         private static List<Mapping> getMappingList(@Nonnull final MappingContext mappingContext,
  94                                                     @Nonnull final InstanceIdentifier<Mappings> mappingsIid) {
  95             final Optional<Mappings> previousMappings = mappingContext.read(mappingsIid);
  96             final MappingsBuilder mappingsBuilder;
  97             if (previousMappings != null && previousMappings.isPresent()) {
  98                 mappingsBuilder = new MappingsBuilder(previousMappings.get());
  99             } else {
 100                 mappingsBuilder = new MappingsBuilder();
 101                 mappingsBuilder.setMapping(Lists.newArrayList());
 102             }
 103             return mappingsBuilder.getMapping();
 104         }
 105     }
 106 }