apps/netconf-topology/src/test/java/org/opendaylight/netconf/topology/spi/NetconfClientConfigurationBuilderFactoryImplTest.java

   1 /*
   2  * Copyright (c) 2023 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.topology.spi;
   9
  10 import static org.junit.jupiter.api.Assertions.assertEquals;
  11 import static org.junit.jupiter.api.Assertions.assertNotNull;
  12 import static org.junit.jupiter.api.Assertions.assertSame;
  13 import static org.junit.jupiter.api.Assertions.assertThrows;
  14
  15 import java.util.NoSuchElementException;
  16 import org.junit.jupiter.api.BeforeEach;
  17 import org.junit.jupiter.api.Test;
  18 import org.junit.jupiter.api.extension.ExtendWith;
  19 import org.mockito.Mock;
  20 import org.mockito.junit.jupiter.MockitoExtension;
  21 import org.opendaylight.aaa.encrypt.AAAEncryptionService;
  22 import org.opendaylight.netconf.client.NetconfClientSessionListener;
  23 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
  24 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration.NetconfClientProtocol;
  25 import org.opendaylight.netconf.client.mdsal.api.CredentialProvider;
  26 import org.opendaylight.netconf.client.mdsal.api.SslHandlerFactoryProvider;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev240120.connection.parameters.Protocol.Name;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev240120.connection.parameters.ProtocolBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev240120.credentials.credentials.LoginPwUnencryptedBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev240120.credentials.credentials.login.pw.unencrypted.LoginPasswordUnencryptedBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev231121.NetconfNode;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev231121.NetconfNodeBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  38 import org.opendaylight.yangtools.yang.common.Decimal64;
  39 import org.opendaylight.yangtools.yang.common.Uint16;
  40 import org.opendaylight.yangtools.yang.common.Uint32;
  41
  42 @ExtendWith(MockitoExtension.class)
  43 class NetconfClientConfigurationBuilderFactoryImplTest {
  44     private static final NodeId NODE_ID = new NodeId("testing-node");
  45     private static final Host HOST = new Host(new IpAddress(new Ipv4Address("127.0.0.1")));
  46     private static final PortNumber PORT = new PortNumber(Uint16.valueOf(9999));
  47
  48     @Mock
  49     private NetconfClientSessionListener sessionListener;
  50     @Mock
  51     private AAAEncryptionService encryptionService;
  52     @Mock
  53     private CredentialProvider credentialProvider;
  54     @Mock
  55     private SslHandlerFactoryProvider sslHandlerFactoryProvider;
  56
  57     private NetconfNodeBuilder nodeBuilder;
  58     private NetconfClientConfigurationBuilderFactoryImpl factory;
  59
  60     @BeforeEach
  61     void beforeEach() {
  62         nodeBuilder = new NetconfNodeBuilder()
  63             .setHost(HOST).setPort(PORT)
  64             .setReconnectOnChangedSchema(true)
  65             .setDefaultRequestTimeoutMillis(Uint32.valueOf(1000))
  66             .setMinBackoffMillis(Uint16.valueOf(100))
  67             .setKeepaliveDelay(Uint32.valueOf(1000))
  68             .setCredentials(new LoginPwUnencryptedBuilder()
  69                 .setLoginPasswordUnencrypted(new LoginPasswordUnencryptedBuilder()
  70                     .setUsername("test-user")
  71                     .setPassword("test-password")
  72                     .build())
  73                 .build())
  74             .setMaxConnectionAttempts(Uint32.ZERO)
  75             .setBackoffMultiplier(Decimal64.valueOf("1.5"))
  76             .setConnectionTimeoutMillis(Uint32.valueOf(20000));
  77         factory = new NetconfClientConfigurationBuilderFactoryImpl(encryptionService, credentialProvider,
  78             sslHandlerFactoryProvider);
  79     }
  80
  81     private void assertConfig(NetconfClientConfiguration config) {
  82         assertNotNull(config);
  83         assertNotNull(config.getTcpParameters());
  84         assertEquals(HOST, config.getTcpParameters().getRemoteAddress());
  85         assertEquals(PORT, config.getTcpParameters().getRemotePort());
  86         assertSame(sessionListener, config.getSessionListener());
  87     }
  88
  89     @Test
  90     void testDefault() {
  91         final var config = createConfig(nodeBuilder.setTcpOnly(false).build());
  92         assertConfig(config);
  93         assertEquals(NetconfClientProtocol.SSH, config.getProtocol());
  94         assertNotNull(config.getSshParameters());
  95     }
  96
  97     @Test
  98     void testSsh() {
  99         final var config = createConfig(
 100             nodeBuilder.setTcpOnly(false).setProtocol(new ProtocolBuilder().setName(Name.SSH).build()).build());
 101         assertConfig(config);
 102         assertEquals(NetconfClientProtocol.SSH, config.getProtocol());
 103         assertNotNull(config.getSshParameters());
 104     }
 105
 106     @Test
 107     void testTcp() {
 108         final var config = createConfig(nodeBuilder.setTcpOnly(true).build());
 109         assertConfig(config);
 110         assertEquals(NetconfClientProtocol.TCP, config.getProtocol());
 111     }
 112
 113     @Test
 114     void testTls() {
 115         final var config = createConfig(
 116             nodeBuilder.setTcpOnly(false).setProtocol(new ProtocolBuilder().setName(Name.TLS).build()).build());
 117         assertConfig(config);
 118         assertEquals(NetconfClientProtocol.TLS, config.getProtocol());
 119         assertNotNull(config.getSslHandlerFactory());
 120     }
 121
 122     @Test
 123     void noPort() {
 124         assertThrows(NoSuchElementException.class, () -> createConfig(nodeBuilder.setPort(null).build()));
 125     }
 126
 127     @Test
 128     void noHost() {
 129         assertThrows(NoSuchElementException.class, () -> createConfig(nodeBuilder.setHost(null).build()));
 130     }
 131
 132     private NetconfClientConfiguration createConfig(final NetconfNode netconfNode) {
 133         return factory.createClientConfigurationBuilder(NODE_ID, netconfNode)
 134             .withSessionListener(sessionListener)
 135             .build();
 136     }
 137 }