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