netconf/yanglib/src/test/java/org/opendaylight/yanglib/impl/YangLibProviderTest.java

   1 /*
   2  * Copyright (c) 2016 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.yanglib.impl;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.mockito.ArgumentMatchers.any;
  12 import static org.mockito.ArgumentMatchers.eq;
  13 import static org.mockito.Mockito.doNothing;
  14 import static org.mockito.Mockito.doReturn;
  15 import static org.mockito.Mockito.times;
  16 import static org.mockito.Mockito.verify;
  17 import static org.mockito.Mockito.verifyZeroInteractions;
  18 import static org.mockito.Mockito.when;
  19 import static org.opendaylight.mdsal.common.api.CommitInfo.emptyFluentFuture;
  20
  21 import java.io.File;
  22 import java.io.IOException;
  23 import java.util.ArrayList;
  24 import java.util.Collections;
  25 import java.util.List;
  26 import org.apache.commons.io.FileUtils;
  27 import org.junit.AfterClass;
  28 import org.junit.Before;
  29 import org.junit.BeforeClass;
  30 import org.junit.Test;
  31 import org.mockito.ArgumentCaptor;
  32 import org.mockito.Mock;
  33 import org.mockito.MockitoAnnotations;
  34 import org.opendaylight.mdsal.binding.api.DataBroker;
  35 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  36 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.ModulesState;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.ModulesStateBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.RevisionIdentifier;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.RevisionUtils;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.module.list.CommonLeafs.Revision;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.module.list.Module;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.module.list.ModuleBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.module.list.ModuleKey;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.YangIdentifier;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.yanglib.impl.rev141210.YanglibConfig;
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.yanglib.impl.rev141210.YanglibConfigBuilder;
  49 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  50 import org.opendaylight.yangtools.yang.common.Uint32;
  51 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
  52 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  53 import org.opendaylight.yangtools.yang.model.repo.api.YinSchemaSourceRepresentation;
  54 import org.opendaylight.yangtools.yang.model.repo.spi.PotentialSchemaSource;
  55 import org.opendaylight.yangtools.yang.parser.repo.SharedSchemaRepository;
  56 import org.opendaylight.yangtools.yang.parser.rfc7950.repo.ASTSchemaSource;
  57
  58 public class YangLibProviderTest {
  59     private static final File CACHE_DIR = new File("target/yanglib");
  60
  61     @Mock
  62     private DataBroker dataBroker;
  63
  64     @Mock
  65     private WriteTransaction writeTransaction;
  66
  67     private YangLibProvider yangLibProvider;
  68
  69     @BeforeClass
  70     public static void staticSetup() {
  71         if (!CACHE_DIR.exists() && !CACHE_DIR.mkdirs()) {
  72             throw new RuntimeException("Failed to create " + CACHE_DIR);
  73         }
  74     }
  75
  76     @AfterClass
  77     public static void staticCleanup() {
  78         FileUtils.deleteQuietly(CACHE_DIR);
  79     }
  80
  81     @Before
  82     public void setUp() {
  83         MockitoAnnotations.initMocks(this);
  84
  85         try {
  86             if (CACHE_DIR.exists()) {
  87                 FileUtils.cleanDirectory(CACHE_DIR);
  88             }
  89         } catch (IOException e) {
  90             // Ignore
  91         }
  92
  93         final YanglibConfig yanglibConfig = new YanglibConfigBuilder().setBindingAddr("www.fake.com")
  94                 .setBindingPort(Uint32.valueOf(300)).setCacheFolder(CACHE_DIR.getAbsolutePath()).build();
  95         yangLibProvider = new YangLibProvider(yanglibConfig, dataBroker, new SharedSchemaRepository("yang-library"));
  96     }
  97
  98     @Test
  99     public void testSchemaSourceRegistered() {
 100         yangLibProvider.init();
 101         when(dataBroker.newWriteOnlyTransaction()).thenReturn(writeTransaction);
 102         doNothing().when(writeTransaction)
 103                 .merge(eq(LogicalDatastoreType.OPERATIONAL), eq(InstanceIdentifier.create(ModulesState.class)), any());
 104
 105         List<PotentialSchemaSource<?>> list = new ArrayList<>();
 106         list.add(
 107                 PotentialSchemaSource.create(
 108                         RevisionSourceIdentifier.create("no-revision"),
 109                         YangTextSchemaSource.class, PotentialSchemaSource.Costs.IMMEDIATE.getValue()));
 110
 111         list.add(
 112                 PotentialSchemaSource.create(
 113                         RevisionSourceIdentifier.create("with-revision",
 114                             org.opendaylight.yangtools.yang.common.Revision.of("2016-04-28")),
 115                         YangTextSchemaSource.class, PotentialSchemaSource.Costs.IMMEDIATE.getValue()));
 116
 117         doReturn(emptyFluentFuture()).when(writeTransaction).commit();
 118         yangLibProvider.schemaSourceRegistered(list);
 119
 120         List<Module> newModulesList = new ArrayList<>();
 121
 122         Module newModule = new ModuleBuilder()
 123                 .setName(new YangIdentifier("no-revision"))
 124                 .setRevision(RevisionUtils.emptyRevision())
 125                 .setSchema(new Uri("http://www.fake.com:300/yanglib/schemas/no-revision/"))
 126                 .build();
 127
 128         newModulesList.add(newModule);
 129
 130         newModule = new ModuleBuilder()
 131                 .setName(new YangIdentifier("with-revision"))
 132                 .setRevision(new Revision(new RevisionIdentifier("2016-04-28")))
 133                 .setSchema(new Uri("http://www.fake.com:300/yanglib/schemas/with-revision/2016-04-28"))
 134                 .build();
 135
 136         newModulesList.add(newModule);
 137
 138         verify(dataBroker).newWriteOnlyTransaction();
 139         verify(writeTransaction).merge(eq(LogicalDatastoreType.OPERATIONAL),
 140                 eq(InstanceIdentifier.create(ModulesState.class)),
 141                 eq(new ModulesStateBuilder().setModule(newModulesList).build()));
 142         verify(writeTransaction).commit();
 143     }
 144
 145     @Test
 146     public void testFilteringNonYangSchemaSourceRegistered() {
 147         yangLibProvider.init();
 148
 149         // test empty list of schema sources registered
 150         List<PotentialSchemaSource<?>> potentialSources = Collections.emptyList();
 151         yangLibProvider.schemaSourceRegistered(potentialSources);
 152
 153         verifyZeroInteractions(dataBroker, writeTransaction);
 154
 155         // test list of non yang schema sources registered
 156         // expected behavior is to do nothing
 157         potentialSources = new ArrayList<>();
 158         potentialSources.add(
 159                 PotentialSchemaSource.create(
 160                         RevisionSourceIdentifier.create("yin-source-representation"),
 161                         YinSchemaSourceRepresentation.class, PotentialSchemaSource.Costs.IMMEDIATE.getValue()));
 162
 163         potentialSources.add(
 164                 PotentialSchemaSource.create(
 165                         RevisionSourceIdentifier.create("asts-schema-source"),
 166                         ASTSchemaSource.class, PotentialSchemaSource.Costs.IMMEDIATE.getValue()));
 167
 168         yangLibProvider.schemaSourceRegistered(potentialSources);
 169         verifyZeroInteractions(dataBroker, writeTransaction);
 170
 171         // add yang schema source to list
 172         potentialSources.add(
 173                 PotentialSchemaSource.create(
 174                         RevisionSourceIdentifier.create("yang-schema-source"),
 175                         YangTextSchemaSource.class, PotentialSchemaSource.Costs.IMMEDIATE.getValue()));
 176
 177         when(dataBroker.newWriteOnlyTransaction()).thenReturn(writeTransaction);
 178         doReturn(emptyFluentFuture()).when(writeTransaction).commit();
 179         yangLibProvider.schemaSourceRegistered(potentialSources);
 180         verify(dataBroker).newWriteOnlyTransaction();
 181
 182         ArgumentCaptor<ModulesState> modulesStateCaptor = ArgumentCaptor.forClass(ModulesState.class);
 183         verify(writeTransaction).merge(eq(LogicalDatastoreType.OPERATIONAL),
 184                 eq(InstanceIdentifier.create(ModulesState.class)), modulesStateCaptor.capture());
 185         assertEquals(modulesStateCaptor.getValue().getModule().size(), 1);
 186         verify(writeTransaction).commit();
 187     }
 188
 189     @Test
 190     public void testNonYangSchemaSourceUnregistered() {
 191         yangLibProvider.init();
 192
 193         final PotentialSchemaSource<YinSchemaSourceRepresentation> nonYangSource =
 194                 PotentialSchemaSource.create(
 195                         RevisionSourceIdentifier.create("yin-source-representation"),
 196                 YinSchemaSourceRepresentation.class, PotentialSchemaSource.Costs.IMMEDIATE.getValue());
 197
 198         yangLibProvider.schemaSourceUnregistered(nonYangSource);
 199
 200         // expected behaviour is to do nothing if non yang based source is unregistered
 201         verifyZeroInteractions(dataBroker, writeTransaction);
 202     }
 203
 204     @Test
 205     public void testSchemaSourceUnregistered() {
 206         yangLibProvider.init();
 207
 208         when(dataBroker.newWriteOnlyTransaction()).thenReturn(writeTransaction);
 209         doNothing().when(writeTransaction)
 210                 .delete(eq(LogicalDatastoreType.OPERATIONAL), any(InstanceIdentifier.class));
 211
 212         doReturn(emptyFluentFuture()).when(writeTransaction).commit();
 213
 214         PotentialSchemaSource<YangTextSchemaSource> yangUnregistererSource =
 215                 PotentialSchemaSource.create(
 216                         RevisionSourceIdentifier.create("unregistered-yang-schema-without-revision"),
 217                         YangTextSchemaSource.class, PotentialSchemaSource.Costs.LOCAL_IO.getValue());
 218
 219         yangLibProvider.schemaSourceUnregistered(yangUnregistererSource);
 220
 221         verify(dataBroker).newWriteOnlyTransaction();
 222         verify(writeTransaction).delete(eq(LogicalDatastoreType.OPERATIONAL),
 223                 eq(InstanceIdentifier.create(ModulesState.class)
 224                         .child(Module.class,
 225                                 new ModuleKey(new YangIdentifier("unregistered-yang-schema-without-revision"),
 226                                         RevisionUtils.emptyRevision()))));
 227
 228         verify(writeTransaction).commit();
 229
 230         yangUnregistererSource =
 231                 PotentialSchemaSource.create(
 232                         RevisionSourceIdentifier.create("unregistered-yang-with-revision",
 233                             org.opendaylight.yangtools.yang.common.Revision.of("2016-04-28")),
 234                         YangTextSchemaSource.class, PotentialSchemaSource.Costs.LOCAL_IO.getValue());
 235
 236         yangLibProvider.schemaSourceUnregistered(yangUnregistererSource);
 237
 238         verify(dataBroker, times(2)).newWriteOnlyTransaction();
 239         verify(writeTransaction).delete(eq(LogicalDatastoreType.OPERATIONAL),
 240                 eq(InstanceIdentifier.create(ModulesState.class)
 241                         .child(Module.class,
 242                                 new ModuleKey(new YangIdentifier("unregistered-yang-with-revision"),
 243                                         new Revision(new RevisionIdentifier("2016-04-28"))))));
 244
 245         verify(writeTransaction, times(2)).commit();
 246     }
 247 }