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