opendaylight/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.ExecutorService;
  19 import org.opendaylight.controller.config.util.capability.Capability;
  20 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  21 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  22 import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
  23 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  24 import org.opendaylight.controller.md.sal.dom.broker.impl.SerializedDOMDataBroker;
  25 import org.opendaylight.controller.md.sal.dom.store.impl.InMemoryDOMDataStoreFactory;
  26 import org.opendaylight.controller.sal.core.api.model.SchemaService;
  27 import org.opendaylight.controller.sal.core.spi.data.DOMStore;
  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.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.schema.ContainerNode;
  51 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  52 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  53 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  54 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  55 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  56 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  57 import org.opendaylight.yangtools.yang.model.api.Module;
  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 SchemaSourceProvider<YangTextSchemaSource> sourceProvider;
  73
  74     public MdsalOperationProvider(final SessionIdProvider idProvider,
  75                                   final Set<Capability> caps,
  76                                   final SchemaContext schemaContext, final SchemaSourceProvider<YangTextSchemaSource> sourceProvider) {
  77         this.caps = caps;
  78         this.schemaContext = schemaContext;
  79         this.sourceProvider = sourceProvider;
  80     }
  81
  82     @Override
  83     public Set<Capability> getCapabilities() {
  84         return caps;
  85     }
  86
  87     @Override
  88     public AutoCloseable registerCapabilityListener(
  89             CapabilityListener listener) {
  90         listener.onCapabilitiesChanged(caps, Collections.<Capability>emptySet());
  91         return new AutoCloseable() {
  92             @Override
  93             public void close() throws Exception {
  94             }
  95         };
  96     }
  97
  98     @Override
  99     public NetconfOperationService createService(String netconfSessionIdForReporting) {
 100         return new MdsalOperationService(Long.parseLong(netconfSessionIdForReporting), schemaContext, caps, sourceProvider);
 101     }
 102
 103     static class MdsalOperationService implements NetconfOperationService {
 104         private final long currentSessionId;
 105         private final SchemaContext schemaContext;
 106         private final Set<Capability> caps;
 107         private final SchemaService schemaService;
 108         private final DOMDataBroker dataBroker;
 109         private SchemaSourceProvider<YangTextSchemaSource> sourceProvider;
 110
 111         public MdsalOperationService(final long currentSessionId,
 112                                      final SchemaContext schemaContext,
 113                                      final Set<Capability> caps, 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);
 121
 122         }
 123
 124         @Override
 125         public Set<NetconfOperation> getNetconfOperations() {
 126             TransactionProvider transactionProvider = new TransactionProvider(dataBroker, String.valueOf(currentSessionId));
 127             CurrentSchemaContext currentSchemaContext = new CurrentSchemaContext(schemaService, sourceProvider);
 128
 129             ContainerNode netconf = createNetconfState();
 130
 131             YangInstanceIdentifier yangInstanceIdentifier = YangInstanceIdentifier.builder().node(NetconfState.QNAME)
 132                     .build();
 133
 134             final DOMDataWriteTransaction tx = dataBroker.newWriteOnlyTransaction();
 135             tx.put(LogicalDatastoreType.OPERATIONAL, yangInstanceIdentifier, netconf);
 136
 137             try {
 138                 tx.submit().checkedGet();
 139                 LOG.debug("Netconf state updated successfully");
 140             } catch (TransactionCommitFailedException e) {
 141                 LOG.warn("Unable to update netconf state", e);
 142             }
 143
 144             final Get get = new Get(String.valueOf(currentSessionId), currentSchemaContext, transactionProvider);
 145             final EditConfig editConfig = new EditConfig(String.valueOf(currentSessionId), currentSchemaContext,
 146                     transactionProvider);
 147             final GetConfig getConfig = new GetConfig(String.valueOf(currentSessionId), currentSchemaContext,
 148                     transactionProvider);
 149             final Commit commit = new Commit(String.valueOf(currentSessionId), transactionProvider);
 150             final Lock lock = new Lock(String.valueOf(currentSessionId));
 151             final Unlock unLock = new Unlock(String.valueOf(currentSessionId));
 152             final DiscardChanges discardChanges = new DiscardChanges(String.valueOf(currentSessionId), transactionProvider);
 153
 154             return Sets.<NetconfOperation>newHashSet(get, getConfig,
 155                     editConfig, commit, lock, unLock, discardChanges);
 156         }
 157
 158         @Override
 159         public void close() {
 160         }
 161
 162         private ContainerNode createNetconfState() {
 163             DummyMonitoringService monitor = new DummyMonitoringService(
 164                     caps);
 165
 166             final QName identifier = QName.create(Schema.QNAME, "identifier");
 167             final QName version = QName.create(Schema.QNAME, "version");
 168             final QName format = QName.create(Schema.QNAME, "format");
 169             final QName location = QName.create(Schema.QNAME, "location");
 170             final QName namespace = QName.create(Schema.QNAME, "namespace");
 171
 172             CollectionNodeBuilder<MapEntryNode, MapNode> schemaMapEntryNodeMapNodeCollectionNodeBuilder = Builders
 173                     .mapBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(Schema.QNAME));
 174             LeafSetEntryNode locationLeafSetEntryNode = Builders.leafSetEntryBuilder().withNodeIdentifier(
 175                             new YangInstanceIdentifier.NodeWithValue(location, "NETCONF")).withValue("NETCONF").build();
 176
 177             Map<QName, Object> keyValues = Maps.newHashMap();
 178             for (final Schema schema : monitor.getSchemas().getSchema()) {
 179                 keyValues.put(identifier, schema.getIdentifier());
 180                 keyValues.put(version, schema.getVersion());
 181                 keyValues.put(format, Yang.QNAME);
 182
 183                 MapEntryNode schemaMapEntryNode = Builders.mapEntryBuilder().withNodeIdentifier(
 184                                 new YangInstanceIdentifier.NodeIdentifierWithPredicates(Schema.QNAME, keyValues))
 185                         .withChild(Builders.leafBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(
 186                                 identifier)).withValue(schema.getIdentifier()).build())
 187                         .withChild(Builders.leafBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(
 188                                                 version)).withValue(schema.getVersion()).build())
 189                         .withChild(Builders.leafBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(
 190                                                 format)).withValue(Yang.QNAME).build())
 191                         .withChild(Builders.leafBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(
 192                                                 namespace)).withValue(schema.getNamespace().getValue()).build())
 193                         .withChild((DataContainerChild<?, ?>) Builders.leafSetBuilder().withNodeIdentifier(
 194                                         new YangInstanceIdentifier.NodeIdentifier(location))
 195                                 .withChild(locationLeafSetEntryNode).build())
 196                         .build();
 197
 198                 schemaMapEntryNodeMapNodeCollectionNodeBuilder.withChild(schemaMapEntryNode);
 199             }
 200
 201             DataContainerChild<?, ?> schemaList = schemaMapEntryNodeMapNodeCollectionNodeBuilder.build();
 202
 203             ContainerNode schemasContainer = Builders.containerBuilder().withNodeIdentifier(
 204                     new YangInstanceIdentifier.NodeIdentifier(Schemas.QNAME)).withChild(schemaList).build();
 205             return (ContainerNode) Builders.containerBuilder().withNodeIdentifier(
 206                     new YangInstanceIdentifier.NodeIdentifier(NetconfState.QNAME)).withChild(schemasContainer).build();
 207         }
 208
 209         private DOMDataBroker createDataStore(SchemaService schemaService) {
 210             final DOMStore operStore = InMemoryDOMDataStoreFactory
 211                     .create("DOM-OPER", schemaService);
 212             final DOMStore configStore = InMemoryDOMDataStoreFactory
 213                     .create("DOM-CFG", schemaService);
 214
 215             ExecutorService listenableFutureExecutor = SpecialExecutors.newBlockingBoundedCachedThreadPool(
 216                     16, 16, "CommitFutures");
 217
 218             final EnumMap<LogicalDatastoreType, DOMStore> datastores = new EnumMap<>(LogicalDatastoreType.class);
 219             datastores.put(LogicalDatastoreType.CONFIGURATION, configStore);
 220             datastores.put(LogicalDatastoreType.OPERATIONAL, operStore);
 221
 222             return new SerializedDOMDataBroker(datastores, MoreExecutors.listeningDecorator(listenableFutureExecutor));
 223         }
 224
 225         private SchemaService createSchemaService() {
 226             return new SchemaService() {
 227
 228                 @Override
 229                 public void addModule(Module module) {
 230                 }
 231
 232                 @Override
 233                 public void removeModule(Module module) {
 234
 235                 }
 236
 237                 @Override
 238                 public SchemaContext getSessionContext() {
 239                     return schemaContext;
 240                 }
 241
 242                 @Override
 243                 public SchemaContext getGlobalContext() {
 244                     return schemaContext;
 245                 }
 246
 247                 @Override
 248                 public ListenerRegistration<SchemaContextListener> registerSchemaContextListener(
 249                         final SchemaContextListener listener) {
 250                     listener.onGlobalContextUpdated(getGlobalContext());
 251                     return new ListenerRegistration<SchemaContextListener>() {
 252                         @Override
 253                         public void close() {
 254
 255                         }
 256
 257                         @Override
 258                         public SchemaContextListener getInstance() {
 259                             return listener;
 260                         }
 261                     };
 262                 }
 263             };
 264         }
 265     }
 266
 267 }