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