policy-agent/src/test/java/org/oransc/policyagent/ApplicationTest.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2019 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;
  22
  23 import static org.assertj.core.api.Assertions.assertThat;
  24 import static org.junit.Assert.assertEquals;
  25 import static org.junit.jupiter.api.Assertions.assertFalse;
  26
  27 import com.google.gson.Gson;
  28 import com.google.gson.GsonBuilder;
  29 import com.google.gson.reflect.TypeToken;
  30
  31 import java.net.URL;
  32 import java.util.List;
  33 import java.util.Vector;
  34
  35 import org.junit.jupiter.api.Test;
  36 import org.junit.jupiter.api.extension.ExtendWith;
  37 import org.oransc.policyagent.clients.A1Client;
  38 import org.oransc.policyagent.configuration.ApplicationConfig;
  39 import org.oransc.policyagent.configuration.ImmutableRicConfig;
  40 import org.oransc.policyagent.configuration.RicConfig;
  41 import org.oransc.policyagent.controllers.ImmutableServiceRegistrationInfo;
  42 import org.oransc.policyagent.controllers.ImmutableServiceStatus;
  43 import org.oransc.policyagent.controllers.ServiceRegistrationInfo;
  44 import org.oransc.policyagent.controllers.ServiceStatus;
  45 import org.oransc.policyagent.exceptions.ServiceException;
  46 import org.oransc.policyagent.repository.ImmutablePolicy;
  47 import org.oransc.policyagent.repository.ImmutablePolicyType;
  48 import org.oransc.policyagent.repository.Policies;
  49 import org.oransc.policyagent.repository.Policy;
  50 import org.oransc.policyagent.repository.PolicyType;
  51 import org.oransc.policyagent.repository.PolicyTypes;
  52 import org.oransc.policyagent.repository.Ric;
  53 import org.oransc.policyagent.repository.Rics;
  54 import org.oransc.policyagent.tasks.RepositorySupervision;
  55 import org.oransc.policyagent.utils.MockA1Client;
  56 import org.springframework.beans.factory.annotation.Autowired;
  57 import org.springframework.boot.test.context.SpringBootTest;
  58 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
  59 import org.springframework.boot.test.context.TestConfiguration;
  60 import org.springframework.boot.web.server.LocalServerPort;
  61 import org.springframework.context.ApplicationContext;
  62 import org.springframework.context.annotation.Bean;
  63 import org.springframework.http.HttpStatus;
  64 import org.springframework.http.ResponseEntity;
  65 import org.springframework.test.context.junit.jupiter.SpringExtension;
  66 import org.springframework.web.client.RestTemplate;
  67
  68 @ExtendWith(SpringExtension.class)
  69 @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
  70 public class ApplicationTest {
  71     @Autowired
  72     ApplicationContext context;
  73
  74     @Autowired
  75     private Rics rics;
  76
  77     @Autowired
  78     private Policies policies;
  79
  80     @Autowired
  81     private PolicyTypes policyTypes;
  82
  83     @Autowired
  84     MockA1Client a1Client;
  85
  86     @Autowired
  87     RepositorySupervision supervision;
  88
  89     private static Gson gson = new GsonBuilder() //
  90         .serializeNulls() //
  91         .create(); //
  92
  93     public static class MockApplicationConfig extends ApplicationConfig {
  94         @Override
  95         public String getLocalConfigurationFilePath() {
  96             URL url = MockApplicationConfig.class.getClassLoader().getResource("test_application_configuration.json");
  97             return url.getFile();
  98         }
  99     }
 100
 101     /**
 102      * Overrides the BeanFactory.
 103      */
 104     @TestConfiguration
 105     static class TestBeanFactory {
 106         private final PolicyTypes policyTypes = new PolicyTypes();
 107
 108         @Bean
 109         public ApplicationConfig getApplicationConfig() {
 110             return new MockApplicationConfig();
 111         }
 112
 113         @Bean
 114         A1Client getA1Client() {
 115             return new MockA1Client(this.policyTypes);
 116         }
 117
 118         @Bean
 119         public Policies getPolicies() {
 120             return new Policies();
 121         }
 122
 123         @Bean
 124         public PolicyTypes getPolicyTypes() {
 125             return this.policyTypes;
 126         }
 127
 128         @Bean
 129         public Rics getRics() {
 130             return new Rics();
 131         }
 132     }
 133
 134     @LocalServerPort
 135     private int port;
 136
 137     private final RestTemplate restTemplate = new RestTemplate();
 138
 139     private void reset() {
 140         rics.clear();
 141         policies.clear();
 142         policyTypes.clear();
 143         assertThat(policies.size()).isEqualTo(0);
 144     }
 145
 146     @Test
 147     public void testGetRics() throws Exception {
 148         reset();
 149         addRic("kista_1");
 150         String url = baseUrl() + "/rics";
 151         String rsp = this.restTemplate.getForObject(url, String.class);
 152         System.out.println(rsp);
 153         assertThat(rsp).contains("kista_1");
 154
 155         url = baseUrl() + "/rics?policyType=ANR";
 156         rsp = this.restTemplate.getForObject(url, String.class);
 157         assertThat(rsp).isEqualTo("[]");
 158     }
 159
 160     @Test
 161     public void testRecovery() throws Exception {
 162         reset();
 163         Policy policy = addPolicy("policyId", "typeName", "service", "ric"); // This should be created in the RIC
 164
 165         Policy policy2 = addPolicy("policyId2", "typeName", "service", "ric");
 166         a1Client.putPolicy("ric", policy2); // put it in the RIC
 167         policies.remove(policy2); // Remove it from the repo -> should be deleted in the RIC
 168
 169         supervision.checkAllRics(); // The created policy should be put in the RIC
 170         Policies ricPolicies = a1Client.getPolicies("ric");
 171         assertThat(ricPolicies.size()).isEqualTo(1);
 172         Policy ricPolicy = ricPolicies.get("policyId");
 173         assertThat(ricPolicy.json()).isEqualTo(policy.json());
 174     }
 175
 176     @Test
 177     public void testGetRic() throws Exception {
 178         reset();
 179         String url = baseUrl() + "/ric?managedElementId=kista_1";
 180         String rsp = this.restTemplate.getForObject(url, String.class);
 181         System.out.println(rsp);
 182         assertThat(rsp).isEqualTo("ric1");
 183     }
 184
 185     @Test
 186     public void testPutPolicy() throws Exception {
 187         putService("service1");
 188
 189         String url = baseUrl() + "/policy?type=type1&instance=instance1&ric=ric1&service=service1";
 190         String json = "{}";
 191         addPolicyType("type1", "ric1");
 192         this.rics.getRic("ric1").setState(Ric.RicState.IDLE);
 193
 194         this.restTemplate.put(url, json);
 195
 196         Policy policy = policies.getPolicy("instance1");
 197
 198         assertThat(policy).isNotNull();
 199         assertThat(policy.id()).isEqualTo("instance1");
 200         assertThat(policy.ownerServiceName()).isEqualTo("service1");
 201
 202         url = baseUrl() + "/policies";
 203         String rsp = this.restTemplate.getForObject(url, String.class);
 204         System.out.println(rsp);
 205     }
 206
 207     private PolicyType addPolicyType(String policyTypeName, String ricName) {
 208         PolicyType type = ImmutablePolicyType.builder() //
 209             .name(policyTypeName) //
 210             .schema("{\"title\":\"" + policyTypeName + "\"}") //
 211             .build();
 212
 213         policyTypes.put(type);
 214         addRic(ricName).addSupportedPolicyType(type);
 215         return type;
 216     }
 217
 218     private Ric addRic(String ricName) {
 219         if (rics.get(ricName) != null) {
 220             return rics.get(ricName);
 221         }
 222         Vector<String> mes = new Vector<>();
 223         RicConfig conf = ImmutableRicConfig.builder() //
 224             .name(ricName) //
 225             .baseUrl(ricName) //
 226             .managedElementIds(mes) //
 227             .build();
 228         Ric ric = new Ric(conf);
 229         this.rics.put(ric);
 230         return ric;
 231     }
 232
 233     private Policy addPolicy(String id, String typeName, String service, String ric) throws ServiceException {
 234         addRic(ric);
 235         Policy p = ImmutablePolicy.builder().id(id) //
 236             .json("{}") //
 237             .ownerServiceName(service) //
 238             .ric(rics.getRic(ric)) //
 239             .type(addPolicyType(typeName, ric)) //
 240             .lastModified("lastModified").build();
 241         policies.put(p);
 242         return p;
 243     }
 244
 245     private Policy addPolicy(String id, String typeName, String service) throws ServiceException {
 246         return addPolicy(id, typeName, service, "ric");
 247     }
 248
 249     private String baseUrl() {
 250         return "http://localhost:" + port;
 251     }
 252
 253     @Test
 254     public void testGetPolicy() throws Exception {
 255         String url = baseUrl() + "/policy?instance=id";
 256         Policy policy = addPolicy("id", "typeName", "service1", "ric1");
 257         {
 258             String rsp = this.restTemplate.getForObject(url, String.class);
 259             assertThat(rsp).isEqualTo(policy.json());
 260         }
 261         {
 262             policies.remove(policy);
 263             ResponseEntity<String> rsp = this.restTemplate.getForEntity(url, String.class);
 264             assertThat(rsp.getStatusCodeValue()).isEqualTo(HttpStatus.NO_CONTENT.value());
 265         }
 266     }
 267
 268     @Test
 269     public void testDeletePolicy() throws Exception {
 270         reset();
 271         String url = baseUrl() + "/policy?instance=id";
 272         Policy policy = addPolicy("id", "typeName", "service1", "ric1");
 273         policy.ric().setState(Ric.RicState.IDLE);
 274         assertThat(policies.size()).isEqualTo(1);
 275
 276         this.restTemplate.delete(url);
 277
 278         assertThat(policies.size()).isEqualTo(0);
 279     }
 280
 281     private static <T> List<T> parseList(String json, Class<T> clazz) {
 282         if (null == json) {
 283             return null;
 284         }
 285         return gson.fromJson(json, new TypeToken<T>() {}.getType());
 286
 287     }
 288
 289     @Test
 290     public void testGetPolicySchemas() throws Exception {
 291         reset();
 292         addPolicyType("type1", "ric1");
 293         addPolicyType("type2", "ric2");
 294
 295         String url = baseUrl() + "/policy_schemas";
 296         String rsp = this.restTemplate.getForObject(url, String.class);
 297         System.out.println("*** " + rsp);
 298         assertThat(rsp).contains("type1");
 299         assertThat(rsp).contains("type2");
 300         assertThat(rsp).contains("title");
 301
 302         List<String> info = parseList(rsp, String.class);
 303         assertEquals(2, info.size());
 304
 305         url = baseUrl() + "/policy_schemas?ric=ric1";
 306         rsp = this.restTemplate.getForObject(url, String.class);
 307         assertThat(rsp).contains("type1");
 308         info = parseList(rsp, String.class);
 309         assertEquals(1, info.size());
 310     }
 311
 312     @Test
 313     public void testGetPolicySchema() throws Exception {
 314         reset();
 315         addPolicyType("type1", "ric1");
 316         addPolicyType("type2", "ric2");
 317
 318         String url = baseUrl() + "/policy_schema?id=type1";
 319         String rsp = this.restTemplate.getForObject(url, String.class);
 320         System.out.println(rsp);
 321         assertThat(rsp).contains("type1");
 322         assertThat(rsp).contains("title");
 323     }
 324
 325     @Test
 326     public void testGetPolicyTypes() throws Exception {
 327         reset();
 328         addPolicyType("type1", "ric1");
 329         addPolicyType("type2", "ric2");
 330
 331         String url = baseUrl() + "/policy_types";
 332         String rsp = this.restTemplate.getForObject(url, String.class);
 333         assertThat(rsp).isEqualTo("[\"type2\",\"type1\"]");
 334
 335         url = baseUrl() + "/policy_types?ric=ric1";
 336         rsp = this.restTemplate.getForObject(url, String.class);
 337         assertThat(rsp).isEqualTo("[\"type1\"]");
 338     }
 339
 340     @Test
 341     public void testGetPolicies() throws Exception {
 342         String url = baseUrl() + "/policies";
 343         addPolicy("id1", "type1", "service1");
 344         addPolicy("id2", "type2", "service2");
 345
 346         String rsp = this.restTemplate.getForObject(url, String.class);
 347         System.out.println(rsp);
 348         assertThat(rsp).contains("id1");
 349         assertThat(rsp).contains("id2");
 350     }
 351
 352     @Test
 353     public void testGetPoliciesFilter() throws Exception {
 354         addPolicy("id1", "type1", "service1");
 355         addPolicy("id2", "type1", "service2");
 356         addPolicy("id3", "type2", "service1");
 357
 358         String url = baseUrl() + "/policies?type=type1";
 359         String rsp = this.restTemplate.getForObject(url, String.class);
 360         System.out.println(rsp);
 361         assertThat(rsp).contains("id1");
 362         assertThat(rsp).contains("id2");
 363         assertFalse(rsp.contains("id3"));
 364
 365         url = baseUrl() + "/policies?type=type1&service=service2";
 366         rsp = this.restTemplate.getForObject(url, String.class);
 367         System.out.println(rsp);
 368         assertFalse(rsp.contains("id1"));
 369         assertThat(rsp).contains("id2");
 370         assertFalse(rsp.contains("id3"));
 371     }
 372
 373     private String createServiceJson(String name) {
 374         ServiceRegistrationInfo service = ImmutableServiceRegistrationInfo.builder() //
 375             .keepAliveInterval(1) //
 376             .name(name) //
 377             .callbackUrl("callbackUrl") //
 378             .build();
 379         String json = gson.toJson(service);
 380         return json;
 381     }
 382
 383     private void putService(String name) {
 384         String url = baseUrl() + "/service";
 385         this.restTemplate.put(url, createServiceJson(name));
 386     }
 387
 388     @Test
 389     public void testPutAndGetService() throws Exception {
 390         putService("name");
 391
 392         String url = baseUrl() + "/service?name=name";
 393         String rsp = this.restTemplate.getForObject(url, String.class);
 394         ServiceStatus status = gson.fromJson(rsp, ImmutableServiceStatus.class);
 395         assertThat(status.keepAliveInterval() == 1);
 396         assertThat(status.name().equals("name"));
 397
 398         url = baseUrl() + "/services";
 399         rsp = this.restTemplate.getForObject(url, String.class);
 400         assertThat(rsp.contains("name"));
 401         System.out.println(rsp);
 402
 403         url = baseUrl() + "/service/ping";
 404         this.restTemplate.put(url, "name");
 405     }
 406
 407 }