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 static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.util.concurrent.MoreExecutors;
  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.server.api.SessionIdProvider;
  27 import org.opendaylight.netconf.server.api.monitoring.Capability;
  28 import org.opendaylight.netconf.server.api.monitoring.CapabilityListener;
  29 import org.opendaylight.netconf.server.api.operations.NetconfOperation;
  30 import org.opendaylight.netconf.server.api.operations.NetconfOperationService;
  31 import org.opendaylight.netconf.server.api.operations.NetconfOperationServiceFactory;
  32 import org.opendaylight.netconf.server.mdsal.CurrentSchemaContext;
  33 import org.opendaylight.netconf.server.mdsal.TransactionProvider;
  34 import org.opendaylight.netconf.server.mdsal.operations.Commit;
  35 import org.opendaylight.netconf.server.mdsal.operations.DiscardChanges;
  36 import org.opendaylight.netconf.server.mdsal.operations.EditConfig;
  37 import org.opendaylight.netconf.server.mdsal.operations.Get;
  38 import org.opendaylight.netconf.server.mdsal.operations.GetConfig;
  39 import org.opendaylight.netconf.server.mdsal.operations.Lock;
  40 import org.opendaylight.netconf.server.mdsal.operations.Unlock;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdType;
  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.concepts.Registration;
  49 import org.opendaylight.yangtools.util.concurrent.SpecialExecutors;
  50 import org.opendaylight.yangtools.yang.common.QName;
  51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  53 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  54 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  55 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  56 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  57 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  58 import org.opendaylight.yangtools.yang.data.api.schema.SystemMapNode;
  59 import org.opendaylight.yangtools.yang.data.api.schema.builder.CollectionNodeBuilder;
  60 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  61 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  62 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  63 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextListener;
  64 import org.opendaylight.yangtools.yang.model.repo.api.YangTextSchemaSource;
  65 import org.opendaylight.yangtools.yang.model.repo.spi.SchemaSourceProvider;
  66 import org.slf4j.Logger;
  67 import org.slf4j.LoggerFactory;
  68
  69 class MdsalOperationProvider implements NetconfOperationServiceFactory {
  70     private static final Logger LOG = LoggerFactory.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 Registration registerCapabilityListener(final CapabilityListener listener) {
  92         listener.onCapabilitiesChanged(caps, Set.of());
  93         return () -> { };
  94     }
  95
  96     @Override
  97     public NetconfOperationService createService(final SessionIdType sessionId) {
  98         return new MdsalOperationService(sessionId, schemaContext, caps, sourceProvider);
  99     }
 100
 101     static class MdsalOperationService implements NetconfOperationService {
 102         private final SessionIdType currentSessionId;
 103         private final EffectiveModelContext schemaContext;
 104         private final Set<Capability> caps;
 105         private final DOMSchemaService schemaService;
 106         private final DOMDataBroker dataBroker;
 107         private final SchemaSourceProvider<YangTextSchemaSource> sourceProvider;
 108
 109         MdsalOperationService(final SessionIdType currentSessionId, final EffectiveModelContext schemaContext,
 110                               final Set<Capability> caps,
 111                               final SchemaSourceProvider<YangTextSchemaSource> sourceProvider) {
 112             this.currentSessionId = requireNonNull(currentSessionId);
 113             this.schemaContext = schemaContext;
 114             this.caps = caps;
 115             this.sourceProvider = sourceProvider;
 116             schemaService = createSchemaService();
 117
 118             dataBroker = createDataStore(schemaService, currentSessionId);
 119
 120         }
 121
 122         @Override
 123         public Set<NetconfOperation> getNetconfOperations() {
 124             ContainerNode netconf = createNetconfState();
 125
 126             final DOMDataTreeWriteTransaction tx = dataBroker.newWriteOnlyTransaction();
 127             tx.put(LogicalDatastoreType.OPERATIONAL, YangInstanceIdentifier.of(NetconfState.QNAME), netconf);
 128
 129             try {
 130                 tx.commit().get();
 131                 LOG.debug("Netconf state updated successfully");
 132             } catch (InterruptedException | ExecutionException e) {
 133                 LOG.warn("Unable to update netconf state", e);
 134             }
 135
 136             TransactionProvider transactionProvider = new TransactionProvider(dataBroker, currentSessionId);
 137             CurrentSchemaContext currentSchemaContext = CurrentSchemaContext.create(schemaService, sourceProvider);
 138
 139             final Get get = new Get(currentSessionId, currentSchemaContext, transactionProvider);
 140             final EditConfig editConfig = new EditConfig(currentSessionId, currentSchemaContext, transactionProvider);
 141             final GetConfig getConfig = new GetConfig(currentSessionId, currentSchemaContext, transactionProvider);
 142             final Commit commit = new Commit(currentSessionId, transactionProvider);
 143             final Lock lock = new Lock(currentSessionId);
 144             final Unlock unLock = new Unlock(currentSessionId);
 145             final DiscardChanges discardChanges = new DiscardChanges(currentSessionId, transactionProvider);
 146
 147             return Set.of(get, getConfig, editConfig, commit, lock, unLock, discardChanges);
 148         }
 149
 150         @Override
 151         public void close() {
 152             // No-op
 153         }
 154
 155         private ContainerNode createNetconfState() {
 156             final DummyMonitoringService monitor = new DummyMonitoringService(caps);
 157             final QName identifier = QName.create(Schema.QNAME, "identifier");
 158             final QName version = QName.create(Schema.QNAME, "version");
 159             final QName format = QName.create(Schema.QNAME, "format");
 160             final QName location = QName.create(Schema.QNAME, "location");
 161             final QName namespace = QName.create(Schema.QNAME, "namespace");
 162
 163             CollectionNodeBuilder<MapEntryNode, SystemMapNode> schemaMapEntryNodeMapNodeCollectionNodeBuilder =
 164                 Builders.mapBuilder().withNodeIdentifier(new NodeIdentifier(Schema.QNAME));
 165             LeafSetNode<String> locationLeafSet = Builders.<String>leafSetBuilder()
 166                 .withNodeIdentifier(new NodeIdentifier(location))
 167                 .withChild(Builders.<String>leafSetEntryBuilder()
 168                     .withNodeIdentifier(new NodeWithValue<>(location, "NETCONF"))
 169                     .withValue("NETCONF")
 170                     .build())
 171                 .build();
 172
 173             Map<QName, Object> keyValues = new HashMap<>();
 174             for (final Schema schema : monitor.getSchemas().nonnullSchema().values()) {
 175                 keyValues.put(identifier, schema.getIdentifier());
 176                 keyValues.put(version, schema.getVersion());
 177                 keyValues.put(format, Yang.QNAME);
 178
 179                 schemaMapEntryNodeMapNodeCollectionNodeBuilder.withChild(Builders.mapEntryBuilder()
 180                     .withNodeIdentifier(NodeIdentifierWithPredicates.of(Schema.QNAME, keyValues))
 181                     .withChild(ImmutableNodes.leafNode(identifier, schema.getIdentifier()))
 182                     .withChild(ImmutableNodes.leafNode(version, schema.getVersion()))
 183                     .withChild(ImmutableNodes.leafNode(format, Yang.QNAME))
 184                     .withChild(ImmutableNodes.leafNode(namespace, schema.getNamespace().getValue()))
 185                     .withChild(locationLeafSet)
 186                     .build());
 187             }
 188
 189             return Builders.containerBuilder()
 190                 .withNodeIdentifier(new NodeIdentifier(NetconfState.QNAME))
 191                 .withChild(Builders.containerBuilder()
 192                     .withNodeIdentifier(new NodeIdentifier(Schemas.QNAME))
 193                     .withChild(schemaMapEntryNodeMapNodeCollectionNodeBuilder.build())
 194                     .build())
 195                 .build();
 196         }
 197
 198         private static DOMDataBroker createDataStore(final DOMSchemaService schemaService,
 199                 final SessionIdType sessionId) {
 200             LOG.debug("Session {}: Creating data stores for simulated device", sessionId.getValue());
 201             final DOMStore operStore = InMemoryDOMDataStoreFactory.create("DOM-OPER", schemaService);
 202             final DOMStore configStore = InMemoryDOMDataStoreFactory.create("DOM-CFG", schemaService);
 203
 204             ExecutorService listenableFutureExecutor = SpecialExecutors.newBlockingBoundedCachedThreadPool(16, 16,
 205                 "CommitFutures", MdsalOperationProvider.class);
 206
 207             final var datastores = new EnumMap<LogicalDatastoreType, DOMStore>(LogicalDatastoreType.class);
 208             datastores.put(LogicalDatastoreType.CONFIGURATION, configStore);
 209             datastores.put(LogicalDatastoreType.OPERATIONAL, operStore);
 210
 211             return new SerializedDOMDataBroker(datastores, MoreExecutors.listeningDecorator(listenableFutureExecutor));
 212         }
 213
 214         private DOMSchemaService createSchemaService() {
 215             return new DOMSchemaService() {
 216                 @Override
 217                 public EffectiveModelContext getGlobalContext() {
 218                     return schemaContext;
 219                 }
 220
 221                 @Override
 222                 public ListenerRegistration<EffectiveModelContextListener> registerSchemaContextListener(
 223                         final EffectiveModelContextListener listener) {
 224                     listener.onModelContextUpdated(getGlobalContext());
 225                     return new AbstractListenerRegistration<>(listener) {
 226                         @Override
 227                         protected void removeRegistration() {
 228                             // No-op
 229                         }
 230                     };
 231                 }
 232             };
 233         }
 234     }
 235 }