gerrit.onap Code Review - ccsdk/oran.git/blob

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * ONAP : ccsdk oran
   4  * ======================================================================
   5  * Copyright (C) 2020-2023 Nordix Foundation. All rights reserved.
   6  * ======================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ========================LICENSE_END===================================
  19  */
  20
  21 package org.onap.ccsdk.oran.a1policymanagementservice.clients;
  22
  23 import static org.junit.jupiter.api.Assertions.assertEquals;
  24 import static org.junit.jupiter.api.Assertions.assertTrue;
  25 import static org.mockito.ArgumentMatchers.any;
  26 import static org.mockito.Mockito.doReturn;
  27 import static org.mockito.Mockito.spy;
  28 import static org.mockito.Mockito.when;
  29
  30 import org.junit.jupiter.api.Assertions;
  31 import org.junit.jupiter.api.BeforeEach;
  32 import org.junit.jupiter.api.DisplayName;
  33 import org.junit.jupiter.api.Test;
  34 import org.junit.jupiter.api.extension.ExtendWith;
  35 import org.mockito.Mock;
  36 import org.mockito.junit.jupiter.MockitoExtension;
  37 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1Client.A1ProtocolType;
  38 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
  39 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ControllerConfig;
  40 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.RicConfig;
  41 import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException;
  42 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
  43
  44 import reactor.core.publisher.Mono;
  45 import reactor.test.StepVerifier;
  46
  47 @ExtendWith(MockitoExtension.class)
  48 class A1ClientFactoryTest {
  49     private static final String RIC_NAME = "Name";
  50     private static final String EXCEPTION_MESSAGE = "Error";
  51
  52     @Mock
  53     private ApplicationConfig applicationConfigMock;
  54
  55     @Mock
  56     A1Client clientMock1;
  57
  58     @Mock
  59     A1Client clientMock2;
  60
  61     @Mock
  62     A1Client clientMock3;
  63
  64     @Mock
  65     A1Client clientMock4;
  66
  67     private Ric ric;
  68     private A1ClientFactory factoryUnderTest;
  69
  70     private static RicConfig ricConfig(String controllerName, String customAdapter) {
  71         ControllerConfig controllerConfig = null;
  72         if (!controllerName.isEmpty()) {
  73             controllerConfig = ControllerConfig.builder().baseUrl("baseUrl").name(controllerName).build();
  74         }
  75         return RicConfig.builder() //
  76                 .ricId(RIC_NAME) //
  77                 .baseUrl("baseUrl") //
  78                 .controllerConfig(controllerConfig) //
  79                 .customAdapterClass(customAdapter) //
  80                 .build();
  81     }
  82
  83     private static RicConfig ricConfig(String controllerName) {
  84         return ricConfig(controllerName, "");
  85     }
  86
  87     @BeforeEach
  88     void createFactoryUnderTest() {
  89         SecurityContext sec = new SecurityContext("");
  90         factoryUnderTest = spy(new A1ClientFactory(applicationConfigMock, sec));
  91         this.ric = new Ric(ricConfig(""));
  92     }
  93
  94     @Test
  95     @DisplayName("test get Protocol Version ok")
  96     void getProtocolVersion_ok() throws ServiceException {
  97         whenGetProtocolVersionThrowException(clientMock1);
  98         whenGetProtocolVersionReturn(clientMock2, A1ProtocolType.STD_V1_1);
  99         doReturn(clientMock1, clientMock2).when(factoryUnderTest).createClient(any(), any());
 100
 101         A1Client client = factoryUnderTest.createA1Client(ric).block();
 102
 103         assertEquals(clientMock2, client, "Not correct client returned");
 104         assertEquals(A1ProtocolType.STD_V1_1, ric.getProtocolVersion(), "Not correct protocol");
 105     }
 106
 107     @Test
 108     @DisplayName("test get Protocol Version ok Last")
 109     void getProtocolVersion_ok_Last() throws ServiceException {
 110         whenGetProtocolVersionThrowException(clientMock1, clientMock2, clientMock3);
 111         whenGetProtocolVersionReturn(clientMock4, A1ProtocolType.STD_V1_1);
 112         doReturn(clientMock1, clientMock2, clientMock3, clientMock4).when(factoryUnderTest).createClient(any(), any());
 113
 114         A1Client client = factoryUnderTest.createA1Client(ric).block();
 115
 116         assertEquals(clientMock4, client, "Not correct client returned");
 117         assertEquals(A1ProtocolType.STD_V1_1, ric.getProtocolVersion(), "Not correct protocol");
 118     }
 119
 120     public static class CustomA1AdapterFactory implements A1Client.Factory {
 121         @Override
 122         public A1Client create(RicConfig ricConfig, AsyncRestClientFactory restClientFactory) {
 123             return new StdA1ClientVersion2(ricConfig, restClientFactory);
 124         }
 125     }
 126
 127     @Test
 128     @DisplayName("test Custom Adapter Creation")
 129     void testCustomAdapterCreation() {
 130
 131         Ric ric = new Ric(ricConfig("", CustomA1AdapterFactory.class.getName()));
 132         A1Client client = factoryUnderTest.createA1Client(ric).block();
 133
 134         assertEquals(client.getClass(), StdA1ClientVersion2.class);
 135
 136         ric = new Ric(ricConfig("", "org.onap.ccsdk.oran.a1policymanagementservice.clients.StdA1ClientVersion2"));
 137         client = factoryUnderTest.createA1Client(ric).block();
 138
 139         assertEquals(client.getClass(), StdA1ClientVersion2.class);
 140
 141         ric = new Ric(
 142                 ricConfig("", "org.onap.ccsdk.oran.a1policymanagementservice.clients.StdA1ClientVersion2$Factory"));
 143         client = factoryUnderTest.createA1Client(ric).block();
 144
 145         assertEquals(client.getClass(), StdA1ClientVersion2.class);
 146
 147         Exception e = Assertions.assertThrows(Exception.class, () -> {
 148             factoryUnderTest.createClient(new Ric(ricConfig("", "junk")), A1ProtocolType.CUSTOM_PROTOCOL);
 149         });
 150         assertEquals("Could not find class: junk", e.getMessage());
 151     }
 152
 153     @Test
 154     @DisplayName("test get Protocol Version error")
 155     void getProtocolVersion_error() throws ServiceException {
 156         whenGetProtocolVersionThrowException(clientMock1, clientMock2, clientMock3, clientMock4);
 157         doReturn(clientMock1, clientMock2, clientMock3, clientMock4).when(factoryUnderTest).createClient(any(), any());
 158
 159         StepVerifier.create(factoryUnderTest.createA1Client(ric)) //
 160                 .expectSubscription() //
 161                 .expectError() //
 162                 .verify();
 163
 164         assertEquals(A1ProtocolType.UNKNOWN, ric.getProtocolVersion(), "Protocol negotiation failed for " + ric.id());
 165     }
 166
 167     private A1Client createClient(A1ProtocolType version) throws ServiceException {
 168         return factoryUnderTest.createClient(ric, version);
 169     }
 170
 171     @Test
 172     @DisplayName("tes create check types")
 173     void create_check_types() throws ServiceException {
 174         assertTrue(createClient(A1ProtocolType.STD_V1_1) instanceof StdA1ClientVersion1);
 175         assertTrue(createClient(A1ProtocolType.OSC_V1) instanceof OscA1Client);
 176     }
 177
 178     @Test
 179     @DisplayName("test create check types controllers")
 180     void create_check_types_controllers() throws ServiceException {
 181         this.ric = new Ric(ricConfig("anythingButEmpty"));
 182
 183         assertTrue(createClient(A1ProtocolType.CCSDK_A1_ADAPTER_STD_V1_1) instanceof CcsdkA1AdapterClient);
 184
 185         assertTrue(createClient(A1ProtocolType.CCSDK_A1_ADAPTER_OSC_V1) instanceof CcsdkA1AdapterClient);
 186     }
 187
 188     private void whenGetProtocolVersionThrowException(A1Client... clientMocks) {
 189         for (A1Client clientMock : clientMocks) {
 190             when(clientMock.getProtocolVersion()).thenReturn(Mono.error(new Exception(EXCEPTION_MESSAGE)));
 191         }
 192     }
 193
 194     private void whenGetProtocolVersionReturn(A1Client clientMock, A1ProtocolType protocol) {
 195         when(clientMock.getProtocolVersion()).thenReturn(Mono.just(protocol));
 196     }
 197
 198 }