netconf/tools/netconf-testtool/src/main/java/org/opendaylight/netconf/test/tool/PayloadCreator.java

   1 /*
   2  * Copyright (c) 2021 PANTHEON.tech, s.r.o. 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.gson.stream.JsonWriter;
  11 import java.io.IOException;
  12 import java.io.StringWriter;
  13 import java.util.List;
  14 import org.opendaylight.mdsal.binding.runtime.spi.BindingRuntimeHelpers;
  15 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev221225.credentials.Credentials;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.$YangModuleInfoImpl;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev221225.NetconfNodeFields;
  18 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  19 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  20 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  21 import org.opendaylight.yangtools.yang.common.QName;
  22 import org.opendaylight.yangtools.yang.common.Uint16;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  25 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  29 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  30 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactory;
  31 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactorySupplier;
  32 import org.opendaylight.yangtools.yang.data.codec.gson.JSONNormalizedNodeStreamWriter;
  33 import org.opendaylight.yangtools.yang.data.codec.gson.JsonWriterFactory;
  34 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  35 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  36 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 final class PayloadCreator {
  41     private static final Logger LOG = LoggerFactory.getLogger(PayloadCreator.class);
  42     private static final EffectiveModelContext NETWORK_TOPOLOGY_SCHEMA_CONTEXT =
  43         BindingRuntimeHelpers.createEffectiveModel(List.of($YangModuleInfoImpl.getInstance()));
  44     private static final JSONCodecFactory NETWORK_TOPOLOGY_JSON_CODEC_FACTORY =
  45         JSONCodecFactorySupplier.RFC7951.getShared(NETWORK_TOPOLOGY_SCHEMA_CONTEXT);
  46
  47     private static final QName TOPOLOGY_ID_QNAME = QName.create(Topology.QNAME, "topology-id").intern();
  48     private static final QName NODE_ID_QNAME = QName.create(Node.QNAME, "node-id").intern();
  49
  50     private static final NodeIdentifier PORT_NODE_IDENTIFIER = NodeIdentifier
  51             .create(QName.create(NetconfNodeFields.QNAME, "port"));
  52     private static final NodeIdentifier HOST_NODE_IDENTIFIER = NodeIdentifier
  53             .create(QName.create(NetconfNodeFields.QNAME,"host"));
  54     private static final NodeIdentifier USERNAME_NODE_IDENTIFIER = NodeIdentifier
  55             .create(QName.create(NetconfNodeFields.QNAME,"username"));
  56     private static final NodeIdentifier PASSWORD_NODE_IDENTIFIER = NodeIdentifier
  57             .create(QName.create(NetconfNodeFields.QNAME, "password"));
  58     private static final NodeIdentifier CREDENTIALS_NODE_IDENTIFIER = NodeIdentifier.create(Credentials.QNAME);
  59     private static final NodeIdentifier TCP_ONLY_NODE_IDENTIFIER = NodeIdentifier
  60             .create(QName.create(NetconfNodeFields.QNAME, "tcp-only"));
  61     private static final NodeIdentifier KEEPALIVE_DELAY_NODE_IDENTIFIER = NodeIdentifier
  62             .create(QName.create(NetconfNodeFields.QNAME, "keepalive-delay"));
  63     private static final NodeIdentifier SCHEMALESS_NODE_IDENTIFIER = NodeIdentifier
  64             .create(QName.create(NetconfNodeFields.QNAME, "schemaless"));
  65     private static final String DEFAULT_TOPOLOGY_ID = "topology-netconf";
  66     private static final String DEFAULT_NODE_PASSWORD = "admin";
  67     private static final String DEFAULT_NODE_USERNAME = "admin";
  68
  69     private static final boolean DEFAULT_NODE_SCHEMALESS = false;
  70     private static final int DEFAULT_NODE_KEEPALIVE_DELAY = 0;
  71     private static final int DEFAULT_REQUEST_PAYLOAD_INDENTATION = 2;
  72
  73     private PayloadCreator() {
  74         // hidden on purpose
  75     }
  76
  77     static String createStringPayload(final List<Integer> devices, final TesttoolParameters parameters) {
  78         return normalizedNodeToString(createNormalizedNodePayload(devices, parameters));
  79     }
  80
  81     private static String normalizedNodeToString(final NormalizedNode node) {
  82         final StringWriter writer = new StringWriter();
  83         final JsonWriter jsonWriter = JsonWriterFactory.createJsonWriter(writer, DEFAULT_REQUEST_PAYLOAD_INDENTATION);
  84         final NormalizedNodeStreamWriter jsonStream = JSONNormalizedNodeStreamWriter.createExclusiveWriter(
  85                 NETWORK_TOPOLOGY_JSON_CODEC_FACTORY, Absolute.of(NetworkTopology.QNAME), null, jsonWriter);
  86         try (NormalizedNodeWriter nodeWriter = NormalizedNodeWriter.forStreamWriter(jsonStream)) {
  87             nodeWriter.write(node);
  88         } catch (final IOException e) {
  89             LOG.error("Failed to serialize node: {} to JSON", node, e);
  90             throw new IllegalStateException("Failed to serialize node to JSON", e);
  91         }
  92         return writer.toString();
  93     }
  94
  95     private static NormalizedNode createNormalizedNodePayload(final List<Integer> devices,
  96             final TesttoolParameters parameters) {
  97         final var nodeBuilder = Builders.mapBuilder().withNodeIdentifier(NodeIdentifier.create(Node.QNAME));
  98         for (final Integer device : devices) {
  99             nodeBuilder.withChild(Builders.mapEntryBuilder()
 100                     .withNodeIdentifier(NodeIdentifierWithPredicates.of(Node.QNAME, NODE_ID_QNAME,
 101                             createNodeID(device)))
 102                     .withChild(leafPort(device))
 103                     .withChild(leafHost(parameters.generateConfigsAddress))
 104                     .withChild(containerCredentials(DEFAULT_NODE_USERNAME, DEFAULT_NODE_PASSWORD))
 105                     .withChild(leafTcpOnly(!parameters.ssh))
 106                     .withChild(leafKeepaliveDelay(DEFAULT_NODE_KEEPALIVE_DELAY))
 107                     .withChild(leafSchemaless(DEFAULT_NODE_SCHEMALESS))
 108                     .build());
 109         }
 110
 111         return Builders.mapBuilder()
 112                 .withNodeIdentifier(NodeIdentifier.create(Topology.QNAME))
 113                 .withChild(Builders.mapEntryBuilder().withNodeIdentifier(NodeIdentifierWithPredicates
 114                         .of(Topology.QNAME, TOPOLOGY_ID_QNAME, DEFAULT_TOPOLOGY_ID))
 115                         .withChild(nodeBuilder.build())
 116                         .build())
 117                 .build();
 118     }
 119
 120     private static String createNodeID(final Integer port) {
 121         return String.format("%d-sim-device", port);
 122     }
 123
 124     private static LeafNode<Uint16> leafPort(final int port) {
 125         return Builders.<Uint16>leafBuilder()
 126                 .withNodeIdentifier(PORT_NODE_IDENTIFIER)
 127                 .withValue(Uint16.valueOf(port))
 128                 .build();
 129     }
 130
 131     private static LeafNode<String> leafHost(final String host) {
 132         return Builders.<String>leafBuilder()
 133                 .withNodeIdentifier(HOST_NODE_IDENTIFIER)
 134                 .withValue(host)
 135                 .build();
 136     }
 137
 138     private static ChoiceNode containerCredentials(final String username, final String password) {
 139         return Builders.choiceBuilder().withNodeIdentifier(CREDENTIALS_NODE_IDENTIFIER)
 140                 .withChild(Builders.<String>leafBuilder()
 141                         .withNodeIdentifier(USERNAME_NODE_IDENTIFIER)
 142                         .withValue(username)
 143                         .build())
 144                 .withChild(Builders.<String>leafBuilder()
 145                         .withNodeIdentifier(PASSWORD_NODE_IDENTIFIER)
 146                         .withValue(password)
 147                         .build())
 148                 .build();
 149     }
 150
 151     private static LeafNode<Boolean> leafTcpOnly(final Boolean tcpOnly) {
 152         return Builders.<Boolean>leafBuilder()
 153                 .withNodeIdentifier(TCP_ONLY_NODE_IDENTIFIER)
 154                 .withValue(tcpOnly)
 155                 .build();
 156     }
 157
 158     private static LeafNode<Integer> leafKeepaliveDelay(final Integer keepaliveDelay) {
 159         return Builders.<Integer>leafBuilder()
 160                 .withNodeIdentifier(KEEPALIVE_DELAY_NODE_IDENTIFIER)
 161                 .withValue(keepaliveDelay)
 162                 .build();
 163     }
 164
 165     private static LeafNode<Boolean> leafSchemaless(final Boolean schemaless) {
 166         return Builders.<Boolean>leafBuilder()
 167                 .withNodeIdentifier(SCHEMALESS_NODE_IDENTIFIER)
 168                 .withValue(schemaless)
 169                 .build();
 170     }
 171 }