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

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