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