policy-agent/src/test/java/org/oransc/policyagent/tasks/RicSupervisionTest.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2020 Nordix Foundation
   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.oransc.policyagent.tasks;
  22
  23 import static org.assertj.core.api.Assertions.assertThat;
  24 import static org.mockito.ArgumentMatchers.any;
  25 import static org.mockito.Mockito.doReturn;
  26 import static org.mockito.Mockito.spy;
  27 import static org.mockito.Mockito.verify;
  28 import static org.mockito.Mockito.verifyNoMoreInteractions;
  29 import static org.mockito.Mockito.when;
  30
  31 import java.util.ArrayList;
  32 import java.util.Arrays;
  33 import java.util.Collections;
  34 import java.util.List;
  35 import java.util.Vector;
  36
  37 import org.junit.jupiter.api.AfterEach;
  38 import org.junit.jupiter.api.BeforeEach;
  39 import org.junit.jupiter.api.Test;
  40 import org.junit.jupiter.api.extension.ExtendWith;
  41 import org.mockito.Mock;
  42 import org.mockito.junit.jupiter.MockitoExtension;
  43 import org.oransc.policyagent.clients.A1Client;
  44 import org.oransc.policyagent.clients.A1ClientFactory;
  45 import org.oransc.policyagent.configuration.ImmutableRicConfig;
  46 import org.oransc.policyagent.repository.ImmutablePolicy;
  47 import org.oransc.policyagent.repository.ImmutablePolicyType;
  48 import org.oransc.policyagent.repository.Lock.LockType;
  49 import org.oransc.policyagent.repository.Policies;
  50 import org.oransc.policyagent.repository.Policy;
  51 import org.oransc.policyagent.repository.PolicyType;
  52 import org.oransc.policyagent.repository.PolicyTypes;
  53 import org.oransc.policyagent.repository.Ric;
  54 import org.oransc.policyagent.repository.Ric.RicState;
  55 import org.oransc.policyagent.repository.Rics;
  56 import reactor.core.publisher.Mono;
  57
  58 @ExtendWith(MockitoExtension.class)
  59 public class RicSupervisionTest {
  60     private static final String POLICY_TYPE_1_NAME = "type1";
  61     private static final PolicyType POLICY_TYPE_1 = ImmutablePolicyType.builder() //
  62         .name(POLICY_TYPE_1_NAME) //
  63         .schema("") //
  64         .build();
  65
  66     private static final Ric RIC_1 = new Ric(ImmutableRicConfig.builder() //
  67         .name("RIC_1") //
  68         .baseUrl("baseUrl1") //
  69         .managedElementIds(new Vector<String>(Arrays.asList("kista_1", "kista_2"))) //
  70         .controllerName("controllerName") //
  71         .build());
  72
  73     private static final String POLICY_1_ID = "policyId1";
  74     private static final Policy POLICY_1 = ImmutablePolicy.builder() //
  75         .id(POLICY_1_ID) //
  76         .json("") //
  77         .ownerServiceName("service") //
  78         .ric(RIC_1) //
  79         .type(POLICY_TYPE_1) //
  80         .lastModified("now") //
  81         .build();
  82
  83     private static final Policy POLICY_2 = ImmutablePolicy.builder() //
  84         .id("policyId2") //
  85         .json("") //
  86         .ownerServiceName("service") //
  87         .ric(RIC_1) //
  88         .type(POLICY_TYPE_1) //
  89         .lastModified("now") //
  90         .build();
  91
  92     @Mock
  93     private A1Client a1ClientMock;
  94
  95     @Mock
  96     private A1ClientFactory a1ClientFactory;
  97
  98     @Mock
  99     private RicSynchronizationTask synchronizationTaskMock;
 100
 101     private final PolicyTypes types = new PolicyTypes();
 102     private Policies policies = new Policies();
 103     private Rics rics = new Rics();
 104
 105     @BeforeEach
 106     public void init() {
 107         doReturn(Mono.just(a1ClientMock)).when(a1ClientFactory).createA1Client(any(Ric.class));
 108         types.clear();
 109         policies.clear();
 110         rics.clear();
 111         RIC_1.setState(RicState.UNDEFINED);
 112         RIC_1.clearSupportedPolicyTypes();
 113     }
 114
 115     @AfterEach
 116     public void verifyNoRicLocks() {
 117         for (Ric ric : this.rics.getRics()) {
 118             ric.getLock().lockBlocking(LockType.EXCLUSIVE);
 119             ric.getLock().unlockBlocking();
 120             assertThat(ric.getLock().getLockCounter()).isEqualTo(0);
 121         }
 122     }
 123
 124     @Test
 125     public void whenRicIdleAndNoChangedPoliciesOrPolicyTypes_thenNoSynchronization() {
 126         RIC_1.setState(RicState.IDLE);
 127         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
 128         rics.put(RIC_1);
 129
 130         types.put(POLICY_TYPE_1);
 131
 132         policies.put(POLICY_1);
 133
 134         setUpGetPolicyIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_1_ID)));
 135         setUpGetPolicyTypeIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_TYPE_1_NAME)));
 136
 137         RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
 138
 139         supervisorUnderTest.checkAllRics();
 140
 141         verify(supervisorUnderTest).checkAllRics();
 142         verifyNoMoreInteractions(supervisorUnderTest);
 143     }
 144
 145     @Test
 146     public void whenRicUndefined_thenSynchronization() {
 147         RIC_1.setState(RicState.UNDEFINED);
 148         rics.put(RIC_1);
 149
 150         RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
 151
 152         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
 153
 154         supervisorUnderTest.checkAllRics();
 155
 156         verify(supervisorUnderTest).checkAllRics();
 157         verify(supervisorUnderTest).createSynchronizationTask();
 158         verify(synchronizationTaskMock).run(RIC_1);
 159         verifyNoMoreInteractions(supervisorUnderTest);
 160     }
 161
 162     @Test
 163     public void whenRicSynchronizing_thenNoSynchronization() {
 164         RIC_1.setState(RicState.SYNCHRONIZING);
 165         rics.put(RIC_1);
 166
 167         RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
 168
 169         supervisorUnderTest.checkAllRics();
 170
 171         verify(supervisorUnderTest).checkAllRics();
 172         verifyNoMoreInteractions(supervisorUnderTest);
 173     }
 174
 175     @Test
 176     public void whenRicIdleAndErrorGettingPolicyIdentities_thenNoSynchronization() {
 177         RIC_1.setState(RicState.IDLE);
 178         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
 179         rics.put(RIC_1);
 180
 181         setUpGetPolicyIdentitiesToReturn(new Exception("Failed"));
 182
 183         RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
 184         supervisorUnderTest.checkAllRics();
 185
 186         verify(supervisorUnderTest).checkAllRics();
 187         verifyNoMoreInteractions(supervisorUnderTest);
 188     }
 189
 190     @Test
 191     public void whenRicIdleAndNotSameAmountOfPolicies_thenSynchronization() {
 192         RIC_1.setState(RicState.IDLE);
 193         rics.put(RIC_1);
 194
 195         policies.put(POLICY_1);
 196         policies.put(POLICY_2);
 197
 198         setUpGetPolicyIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_1_ID)));
 199
 200         RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
 201
 202         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
 203
 204         supervisorUnderTest.checkAllRics();
 205
 206         verify(supervisorUnderTest).checkAllRics();
 207         verify(supervisorUnderTest).createSynchronizationTask();
 208         verify(synchronizationTaskMock).run(RIC_1);
 209         verifyNoMoreInteractions(supervisorUnderTest);
 210     }
 211
 212     @Test
 213     public void whenRicIdleAndSameAmountOfPoliciesButNotSamePolicies_thenSynchronization() {
 214         RIC_1.setState(RicState.IDLE);
 215         rics.put(RIC_1);
 216
 217         policies.put(POLICY_1);
 218         policies.put(POLICY_2);
 219
 220         setUpGetPolicyIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_1_ID, "Another_policy")));
 221
 222         RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
 223
 224         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
 225
 226         supervisorUnderTest.checkAllRics();
 227
 228         verify(supervisorUnderTest).checkAllRics();
 229         verify(supervisorUnderTest).createSynchronizationTask();
 230         verify(synchronizationTaskMock).run(RIC_1);
 231         verifyNoMoreInteractions(supervisorUnderTest);
 232     }
 233
 234     @Test
 235     public void whenRicIdleAndErrorGettingPolicyTypes_thenNoSynchronization() {
 236         RIC_1.setState(RicState.IDLE);
 237         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
 238         rics.put(RIC_1);
 239
 240         setUpGetPolicyIdentitiesToReturn(Collections.emptyList());
 241         setUpGetPolicyTypeIdentitiesToReturn(new Exception("Failed"));
 242
 243         RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
 244         supervisorUnderTest.checkAllRics();
 245
 246         verify(supervisorUnderTest).checkAllRics();
 247         verifyNoMoreInteractions(supervisorUnderTest);
 248     }
 249
 250     @Test
 251     public void whenRicIdleAndNotSameAmountOfPolicyTypes_thenSynchronization() {
 252         RIC_1.setState(RicState.IDLE);
 253         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
 254         rics.put(RIC_1);
 255
 256         types.put(POLICY_TYPE_1);
 257
 258         setUpGetPolicyIdentitiesToReturn(Collections.emptyList());
 259         setUpGetPolicyTypeIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_TYPE_1_NAME, "another_policy_type")));
 260
 261         RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
 262
 263         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
 264
 265         supervisorUnderTest.checkAllRics();
 266
 267         verify(supervisorUnderTest).checkAllRics();
 268         verify(supervisorUnderTest).createSynchronizationTask();
 269         verify(synchronizationTaskMock).run(RIC_1);
 270         verifyNoMoreInteractions(supervisorUnderTest);
 271     }
 272
 273     @Test
 274     public void whenRicIdleAndSameAmountOfPolicyTypesButNotSameTypes_thenSynchronization() {
 275         PolicyType policyType2 = ImmutablePolicyType.builder() //
 276             .name("policyType2") //
 277             .schema("") //
 278             .build();
 279
 280         RIC_1.setState(RicState.IDLE);
 281         RIC_1.addSupportedPolicyType(POLICY_TYPE_1);
 282         RIC_1.addSupportedPolicyType(policyType2);
 283         rics.put(RIC_1);
 284
 285         setUpGetPolicyIdentitiesToReturn(Collections.emptyList());
 286         setUpGetPolicyTypeIdentitiesToReturn(new ArrayList<>(Arrays.asList(POLICY_TYPE_1_NAME, "another_policy_type")));
 287
 288         RicSupervision supervisorUnderTest = spy(new RicSupervision(rics, policies, a1ClientFactory, types, null));
 289
 290         doReturn(synchronizationTaskMock).when(supervisorUnderTest).createSynchronizationTask();
 291
 292         supervisorUnderTest.checkAllRics();
 293
 294         verify(supervisorUnderTest).checkAllRics();
 295         verify(supervisorUnderTest).createSynchronizationTask();
 296         verify(synchronizationTaskMock).run(RIC_1);
 297         verifyNoMoreInteractions(supervisorUnderTest);
 298     }
 299
 300     @SuppressWarnings("unchecked")
 301     private void setUpGetPolicyIdentitiesToReturn(Object returnValue) {
 302         if (returnValue instanceof List<?>) {
 303             when(a1ClientMock.getPolicyIdentities()).thenReturn(Mono.just((List<String>) returnValue));
 304         } else if (returnValue instanceof Exception) {
 305             when(a1ClientMock.getPolicyIdentities()).thenReturn(Mono.error((Exception) returnValue));
 306         }
 307     }
 308
 309     @SuppressWarnings("unchecked")
 310     private void setUpGetPolicyTypeIdentitiesToReturn(Object returnValue) {
 311         if (returnValue instanceof List<?>) {
 312             when(a1ClientMock.getPolicyTypeIdentities()).thenReturn(Mono.just((List<String>) returnValue));
 313         } else if (returnValue instanceof Exception) {
 314             when(a1ClientMock.getPolicyTypeIdentities()).thenReturn(Mono.error((Exception) returnValue));
 315         }
 316     }
 317 }