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