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