netconf/tools/netconf-testtool/src/main/java/org/opendaylight/netconf/test/tool/MdsalOperationProvider.java

   1 /*
   2  * Copyright (c) 2014 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.netconf.test.tool;
   9
  10 import com.google.common.collect.ClassToInstanceMap;
  11 import com.google.common.collect.ImmutableClassToInstanceMap;
  12 import com.google.common.collect.Sets;
  13 import com.google.common.util.concurrent.MoreExecutors;
  14 import java.util.Collections;
  15 import java.util.EnumMap;
  16 import java.util.HashMap;
  17 import java.util.Map;
  18 import java.util.Set;
  19 import java.util.concurrent.ExecutionException;
  20 import java.util.concurrent.ExecutorService;
  21 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  22 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  23 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
  24 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  25 import org.opendaylight.mdsal.dom.api.DOMSchemaServiceExtension;
  26 import org.opendaylight.mdsal.dom.broker.SerializedDOMDataBroker;
  27 import org.opendaylight.mdsal.dom.spi.store.DOMStore;
  28 import org.opendaylight.mdsal.dom.store.inmemory.InMemoryDOMDataStoreFactory;
  29 import org.opendaylight.netconf.api.capability.Capability;
  30 import org.opendaylight.netconf.api.monitoring.CapabilityListener;
  31 import org.opendaylight.netconf.impl.SessionIdProvider;
  32 import org.opendaylight.netconf.mapping.api.NetconfOperation;
  33 import org.opendaylight.netconf.mapping.api.NetconfOperationService;
  34 import org.opendaylight.netconf.mapping.api.NetconfOperationServiceFactory;
  35 import org.opendaylight.netconf.mdsal.connector.CurrentSchemaContext;
  36 import org.opendaylight.netconf.mdsal.connector.TransactionProvider;
  37 import org.opendaylight.netconf.mdsal.connector.ops.Commit;
  38 import org.opendaylight.netconf.mdsal.connector.ops.DiscardChanges;
  39 import org.opendaylight.netconf.mdsal.connector.ops.EditConfig;
  40 import org.opendaylight.netconf.mdsal.connector.ops.Lock;
  41 import org.opendaylight.netconf.mdsal.connector.ops.Unlock;
  42 import org.opendaylight.netconf.mdsal.connector.ops.get.Get;
  43 import org.opendaylight.netconf.mdsal.connector.ops.get.GetConfig;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Yang;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema;
  48 import org.opendaylight.yangtools.concepts.AbstractListenerRegistration;
  49 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  50 import org.opendaylight.yangtools.util.concurrent.SpecialExecutors;
  51 import org.opendaylight.yangtools.yang.common.QName;
  52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  53 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  54 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  55 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  56 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  57 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  58 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  59 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  60 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  61 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  62 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  63 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  64 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
  65 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  66 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
  67 import org.slf4j.Logger;
  68 import org.slf4j.LoggerFactory;
  69
  70 class MdsalOperationProvider implements NetconfOperationServiceFactory {
  71
  72     private static final Logger LOG = LoggerFactory
  73             .getLogger(MdsalOperationProvider.class);
  74
  75     private final Set<Capability> caps;
  76     private final SchemaContext schemaContext;
  77     private final SchemaSourceProvider<YangTextSchemaSource> sourceProvider;
  78
  79     MdsalOperationProvider(final SessionIdProvider idProvider,
  80                            final Set<Capability> caps,
  81                            final SchemaContext schemaContext,
  82                            final SchemaSourceProvider<YangTextSchemaSource> sourceProvider) {
  83         this.caps = caps;
  84         this.schemaContext = schemaContext;
  85         this.sourceProvider = sourceProvider;
  86     }
  87
  88     @Override
  89     public Set<Capability> getCapabilities() {
  90         return caps;
  91     }
  92
  93     @Override
  94     public AutoCloseable registerCapabilityListener(
  95             final CapabilityListener listener) {
  96         listener.onCapabilitiesChanged(caps, Collections.emptySet());
  97         return () -> {
  98         };
  99     }
 100
 101     @Override
 102     public NetconfOperationService createService(final String netconfSessionIdForReporting) {
 103         return new MdsalOperationService(Long.parseLong(netconfSessionIdForReporting), schemaContext,
 104             caps, sourceProvider);
 105     }
 106
 107     static class MdsalOperationService implements NetconfOperationService {
 108         private final long currentSessionId;
 109         private final SchemaContext schemaContext;
 110         private final Set<Capability> caps;
 111         private final DOMSchemaService schemaService;
 112         private final DOMDataBroker dataBroker;
 113         private final SchemaSourceProvider<YangTextSchemaSource> sourceProvider;
 114
 115         MdsalOperationService(final long currentSessionId,
 116                               final SchemaContext schemaContext,
 117                               final Set<Capability> caps,
 118                               final SchemaSourceProvider<YangTextSchemaSource> sourceProvider) {
 119             this.currentSessionId = currentSessionId;
 120             this.schemaContext = schemaContext;
 121             this.caps = caps;
 122             this.sourceProvider = sourceProvider;
 123             this.schemaService = createSchemaService();
 124
 125             this.dataBroker = createDataStore(schemaService, currentSessionId);
 126
 127         }
 128
 129         @Override
 130         public Set<NetconfOperation> getNetconfOperations() {
 131             TransactionProvider transactionProvider = new TransactionProvider(
 132                 dataBroker, String.valueOf(currentSessionId));
 133             CurrentSchemaContext currentSchemaContext = new CurrentSchemaContext(schemaService, sourceProvider);
 134
 135             ContainerNode netconf = createNetconfState();
 136
 137             YangInstanceIdentifier yangInstanceIdentifier = YangInstanceIdentifier.builder().node(NetconfState.QNAME)
 138                     .build();
 139
 140             final DOMDataTreeWriteTransaction tx = dataBroker.newWriteOnlyTransaction();
 141             tx.put(LogicalDatastoreType.OPERATIONAL, yangInstanceIdentifier, netconf);
 142
 143             try {
 144                 tx.commit().get();
 145                 LOG.debug("Netconf state updated successfully");
 146             } catch (InterruptedException | ExecutionException e) {
 147                 LOG.warn("Unable to update netconf state", e);
 148             }
 149
 150             final Get get = new Get(String.valueOf(currentSessionId), currentSchemaContext, transactionProvider);
 151             final EditConfig editConfig = new EditConfig(String.valueOf(currentSessionId), currentSchemaContext,
 152                     transactionProvider);
 153             final GetConfig getConfig = new GetConfig(String.valueOf(currentSessionId), currentSchemaContext,
 154                     transactionProvider);
 155             final Commit commit = new Commit(String.valueOf(currentSessionId), transactionProvider);
 156             final Lock lock = new Lock(String.valueOf(currentSessionId));
 157             final Unlock unLock = new Unlock(String.valueOf(currentSessionId));
 158             final DiscardChanges discardChanges = new DiscardChanges(
 159                 String.valueOf(currentSessionId), transactionProvider);
 160
 161             return Sets.newHashSet(get, getConfig,
 162                     editConfig, commit, lock, unLock, discardChanges);
 163         }
 164
 165         @Override
 166         public void close() {
 167         }
 168
 169         private ContainerNode createNetconfState() {
 170             DummyMonitoringService monitor = new DummyMonitoringService(
 171                     caps);
 172
 173             final QName identifier = QName.create(Schema.QNAME, "identifier");
 174             final QName version = QName.create(Schema.QNAME, "version");
 175             final QName format = QName.create(Schema.QNAME, "format");
 176             final QName location = QName.create(Schema.QNAME, "location");
 177             final QName namespace = QName.create(Schema.QNAME, "namespace");
 178
 179             CollectionNodeBuilder<MapEntryNode, MapNode> schemaMapEntryNodeMapNodeCollectionNodeBuilder = Builders
 180                     .mapBuilder().withNodeIdentifier(new NodeIdentifier(Schema.QNAME));
 181             LeafSetEntryNode locationLeafSetEntryNode = Builders.leafSetEntryBuilder().withNodeIdentifier(
 182                             new NodeWithValue<>(location, "NETCONF")).withValue("NETCONF").build();
 183
 184             Map<QName, Object> keyValues = new HashMap<>();
 185             for (final Schema schema : monitor.getSchemas().getSchema()) {
 186                 keyValues.put(identifier, schema.getIdentifier());
 187                 keyValues.put(version, schema.getVersion());
 188                 keyValues.put(format, Yang.QNAME);
 189
 190                 MapEntryNode schemaMapEntryNode = Builders.mapEntryBuilder()
 191                         .withNodeIdentifier(NodeIdentifierWithPredicates.of(Schema.QNAME, keyValues))
 192                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(identifier))
 193                             .withValue(schema.getIdentifier()).build())
 194                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(version))
 195                             .withValue(schema.getVersion()).build())
 196                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(format))
 197                             .withValue(Yang.QNAME).build())
 198                         .withChild(Builders.leafBuilder().withNodeIdentifier(new NodeIdentifier(namespace))
 199                             .withValue(schema.getNamespace().getValue()).build())
 200                         .withChild((DataContainerChild<?, ?>) Builders.leafSetBuilder().withNodeIdentifier(
 201                                         new NodeIdentifier(location))
 202                                 .withChild(locationLeafSetEntryNode).build())
 203                         .build();
 204
 205                 schemaMapEntryNodeMapNodeCollectionNodeBuilder.withChild(schemaMapEntryNode);
 206             }
 207
 208             DataContainerChild<?, ?> schemaList = schemaMapEntryNodeMapNodeCollectionNodeBuilder.build();
 209
 210             ContainerNode schemasContainer = Builders.containerBuilder().withNodeIdentifier(
 211                     new NodeIdentifier(Schemas.QNAME)).withChild(schemaList).build();
 212             return Builders.containerBuilder().withNodeIdentifier(
 213                     new NodeIdentifier(NetconfState.QNAME)).withChild(schemasContainer).build();
 214         }
 215
 216         private static DOMDataBroker createDataStore(final DOMSchemaService schemaService, final long sessionId) {
 217             LOG.debug("Session {}: Creating data stores for simulated device", sessionId);
 218             final DOMStore operStore = InMemoryDOMDataStoreFactory.create("DOM-OPER", schemaService);
 219             final DOMStore configStore = InMemoryDOMDataStoreFactory.create("DOM-CFG", schemaService);
 220
 221             ExecutorService listenableFutureExecutor = SpecialExecutors.newBlockingBoundedCachedThreadPool(
 222                     16, 16, "CommitFutures", MdsalOperationProvider.class);
 223
 224             final EnumMap<LogicalDatastoreType, DOMStore> datastores = new EnumMap<>(LogicalDatastoreType.class);
 225             datastores.put(LogicalDatastoreType.CONFIGURATION, configStore);
 226             datastores.put(LogicalDatastoreType.OPERATIONAL, operStore);
 227
 228             return new SerializedDOMDataBroker(datastores, MoreExecutors.listeningDecorator(listenableFutureExecutor));
 229         }
 230
 231         private DOMSchemaService createSchemaService() {
 232             return new DOMSchemaService() {
 233
 234                 @Override
 235                 public SchemaContext getSessionContext() {
 236                     return schemaContext;
 237                 }
 238
 239                 @Override
 240                 public SchemaContext getGlobalContext() {
 241                     return schemaContext;
 242                 }
 243
 244                 @Override
 245                 public ListenerRegistration<SchemaContextListener> registerSchemaContextListener(
 246                         final SchemaContextListener listener) {
 247                     listener.onGlobalContextUpdated(getGlobalContext());
 248                     return new AbstractListenerRegistration<SchemaContextListener>(listener) {
 249
 250                         @Override
 251                         protected void removeRegistration() {
 252                             // No-op
 253                         }
 254                     };
 255                 }
 256
 257                 @Override
 258                 public ClassToInstanceMap<DOMSchemaServiceExtension> getExtensions() {
 259                     return ImmutableClassToInstanceMap.of();
 260                 }
 261             };
 262         }
 263     }
 264
 265 }