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