2 * Copyright (c) 2023 PANTHEON.tech, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.netconf.topology.spi;
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;
17 import java.util.NoSuchElementException;
18 import org.junit.jupiter.api.BeforeEach;
19 import org.junit.jupiter.api.Test;
20 import org.junit.jupiter.api.extension.ExtendWith;
21 import org.mockito.Mock;
22 import org.mockito.junit.jupiter.MockitoExtension;
23 import org.opendaylight.aaa.encrypt.AAAEncryptionService;
24 import org.opendaylight.netconf.client.NetconfClientSessionListener;
25 import org.opendaylight.netconf.client.SslHandlerFactory;
26 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration;
27 import org.opendaylight.netconf.client.conf.NetconfClientConfiguration.NetconfClientProtocol;
28 import org.opendaylight.netconf.client.mdsal.api.CredentialProvider;
29 import org.opendaylight.netconf.client.mdsal.api.SslHandlerFactoryProvider;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Host;
31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev240120.connection.parameters.Protocol.Name;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev240120.connection.parameters.ProtocolBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev240120.credentials.credentials.LoginPwUnencryptedBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev240120.credentials.credentials.login.pw.unencrypted.LoginPasswordUnencryptedBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev231121.NetconfNode;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev231121.NetconfNodeBuilder;
40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
41 import org.opendaylight.yangtools.yang.common.Decimal64;
42 import org.opendaylight.yangtools.yang.common.Uint16;
43 import org.opendaylight.yangtools.yang.common.Uint32;
45 @ExtendWith(MockitoExtension.class)
46 class NetconfClientConfigurationBuilderFactoryImplTest {
47 private static final NodeId NODE_ID = new NodeId("testing-node");
48 private static final Host HOST = new Host(new IpAddress(new Ipv4Address("127.0.0.1")));
49 private static final PortNumber PORT = new PortNumber(Uint16.valueOf(9999));
52 private NetconfClientSessionListener sessionListener;
54 private AAAEncryptionService encryptionService;
56 private CredentialProvider credentialProvider;
58 private SslHandlerFactoryProvider sslHandlerFactoryProvider;
60 private SslHandlerFactory sslHandlerFactory;
62 private NetconfNodeBuilder nodeBuilder;
63 private NetconfClientConfigurationBuilderFactoryImpl factory;
67 nodeBuilder = new NetconfNodeBuilder()
68 .setHost(HOST).setPort(PORT)
69 .setReconnectOnChangedSchema(true)
70 .setDefaultRequestTimeoutMillis(Uint32.valueOf(1000))
71 .setMinBackoffMillis(Uint16.valueOf(100))
72 .setKeepaliveDelay(Uint32.valueOf(1000))
73 .setCredentials(new LoginPwUnencryptedBuilder()
74 .setLoginPasswordUnencrypted(new LoginPasswordUnencryptedBuilder()
75 .setUsername("test-user")
76 .setPassword("test-password")
79 .setMaxConnectionAttempts(Uint32.ZERO)
80 .setBackoffMultiplier(Decimal64.valueOf("1.5"))
81 .setConnectionTimeoutMillis(Uint32.valueOf(20000));
82 factory = new NetconfClientConfigurationBuilderFactoryImpl(encryptionService, credentialProvider,
83 sslHandlerFactoryProvider);
86 private void assertConfig(final NetconfClientConfiguration config) {
87 assertNotNull(config);
88 assertNotNull(config.getTcpParameters());
89 assertEquals(HOST, config.getTcpParameters().getRemoteAddress());
90 assertEquals(PORT, config.getTcpParameters().getRemotePort());
91 assertSame(sessionListener, config.getSessionListener());
96 final var config = createConfig(nodeBuilder.setTcpOnly(false).build());
98 assertEquals(NetconfClientProtocol.SSH, config.getProtocol());
99 assertNotNull(config.getSshParameters());
104 final var config = createConfig(
105 nodeBuilder.setTcpOnly(false).setProtocol(new ProtocolBuilder().setName(Name.SSH).build()).build());
106 assertConfig(config);
107 assertEquals(NetconfClientProtocol.SSH, config.getProtocol());
108 assertNotNull(config.getSshParameters());
113 final var config = createConfig(nodeBuilder.setTcpOnly(true).build());
114 assertConfig(config);
115 assertEquals(NetconfClientProtocol.TCP, config.getProtocol());
120 doReturn(sslHandlerFactory).when(sslHandlerFactoryProvider).getSslHandlerFactory(any());
121 final var config = createConfig(
122 nodeBuilder.setTcpOnly(false).setProtocol(new ProtocolBuilder().setName(Name.TLS).build()).build());
123 assertConfig(config);
124 assertEquals(NetconfClientProtocol.TLS, config.getProtocol());
125 assertNotNull(config.getSslHandlerFactory());
130 assertThrows(NoSuchElementException.class, () -> createConfig(nodeBuilder.setPort(null).build()));
135 assertThrows(NoSuchElementException.class, () -> createConfig(nodeBuilder.setHost(null).build()));
138 private NetconfClientConfiguration createConfig(final NetconfNode netconfNode) {
139 return factory.createClientConfigurationBuilder(NODE_ID, netconfNode)
140 .withSessionListener(sessionListener)