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