2 * ========================LICENSE_START=================================
5 * Copyright (C) 2023 Nordix Foundation
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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===================================
21 package org.oran.pmproducer;
23 import static org.assertj.core.api.Assertions.assertThat;
24 import static org.awaitility.Awaitility.await;
25 import static org.junit.jupiter.api.Assertions.assertTrue;
26 import static org.mockito.ArgumentMatchers.any;
27 import static org.mockito.Mockito.doReturn;
28 import static org.mockito.Mockito.spy;
29 import static org.mockito.Mockito.times;
30 import static org.mockito.Mockito.verify;
31 import static org.mockito.Mockito.when;
33 import com.google.gson.JsonParser;
35 import java.io.FileOutputStream;
36 import java.io.IOException;
37 import java.io.PrintStream;
38 import java.lang.invoke.MethodHandles;
39 import java.nio.file.Files;
40 import java.nio.file.Path;
41 import java.nio.file.Paths;
42 import java.time.Duration;
43 import java.time.OffsetDateTime;
44 import java.util.List;
46 import org.apache.kafka.clients.consumer.ConsumerRecord;
47 import org.json.JSONObject;
48 import org.junit.jupiter.api.AfterEach;
49 import org.junit.jupiter.api.BeforeEach;
50 import org.junit.jupiter.api.MethodOrderer;
51 import org.junit.jupiter.api.Test;
52 import org.junit.jupiter.api.TestMethodOrder;
53 import org.mockito.ArgumentCaptor;
54 import org.oran.pmproducer.clients.AsyncRestClient;
55 import org.oran.pmproducer.clients.AsyncRestClientFactory;
56 import org.oran.pmproducer.clients.SecurityContext;
57 import org.oran.pmproducer.configuration.ApplicationConfig;
58 import org.oran.pmproducer.configuration.WebClientConfig;
59 import org.oran.pmproducer.configuration.WebClientConfig.HttpProxyConfig;
60 import org.oran.pmproducer.controllers.ProducerCallbacksController;
61 import org.oran.pmproducer.datastore.DataStore;
62 import org.oran.pmproducer.datastore.DataStore.Bucket;
63 import org.oran.pmproducer.filter.FilteredData;
64 import org.oran.pmproducer.filter.PmReport;
65 import org.oran.pmproducer.filter.PmReportFilter;
66 import org.oran.pmproducer.filter.PmReportFilter.FilterData;
67 import org.oran.pmproducer.r1.ConsumerJobInfo;
68 import org.oran.pmproducer.r1.ProducerJobInfo;
69 import org.oran.pmproducer.repository.InfoType;
70 import org.oran.pmproducer.repository.InfoTypes;
71 import org.oran.pmproducer.repository.Job;
72 import org.oran.pmproducer.repository.Job.Parameters;
73 import org.oran.pmproducer.repository.Job.Parameters.KafkaDeliveryInfo;
74 import org.oran.pmproducer.repository.Jobs;
75 import org.oran.pmproducer.repository.Jobs.JobGroup;
76 import org.oran.pmproducer.tasks.JobDataDistributor;
77 import org.oran.pmproducer.tasks.NewFileEvent;
78 import org.oran.pmproducer.tasks.ProducerRegstrationTask;
79 import org.oran.pmproducer.tasks.TopicListener;
80 import org.oran.pmproducer.tasks.TopicListeners;
81 import org.slf4j.Logger;
82 import org.slf4j.LoggerFactory;
83 import org.springframework.beans.factory.annotation.Autowired;
84 import org.springframework.boot.test.context.SpringBootTest;
85 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
86 import org.springframework.boot.test.context.TestConfiguration;
87 import org.springframework.boot.test.web.server.LocalServerPort;
88 import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
89 import org.springframework.boot.web.servlet.server.ServletWebServerFactory;
90 import org.springframework.context.annotation.Bean;
91 import org.springframework.http.HttpStatus;
92 import org.springframework.http.MediaType;
93 import org.springframework.http.ResponseEntity;
94 import org.springframework.test.context.TestPropertySource;
95 import org.springframework.web.reactive.function.client.WebClientRequestException;
96 import org.springframework.web.reactive.function.client.WebClientResponseException;
98 import reactor.core.publisher.Flux;
99 import reactor.core.publisher.Mono;
100 import reactor.test.StepVerifier;
102 @TestMethodOrder(MethodOrderer.MethodName.class)
103 @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
104 @TestPropertySource(properties = { //
105 "server.ssl.key-store=./config/keystore.jks", //
106 "app.webclient.trust-store=./config/truststore.jks", //
107 "app.webclient.trust-store-used=true", //
108 "app.configuration-filepath=./src/test/resources/test_application_configuration.json", //
109 "app.pm-files-path=/tmp/dmaapadaptor", //
110 "app.s3.endpointOverride=" //
112 class ApplicationTest {
115 private ApplicationConfig applicationConfig;
121 private InfoTypes types;
124 private IcsSimulatorController icsSimulatorController;
127 TopicListeners topicListeners;
130 ProducerRegstrationTask producerRegistrationTask;
133 private SecurityContext securityContext;
135 private com.google.gson.Gson gson = new com.google.gson.GsonBuilder().disableHtmlEscaping().create();
138 int localServerHttpPort;
140 private final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
142 static class TestApplicationConfig extends ApplicationConfig {
145 public String getIcsBaseUrl() {
146 return thisProcessUrl();
150 public String getSelfUrl() {
151 return thisProcessUrl();
154 private String thisProcessUrl() {
155 final String url = "https://localhost:" + getLocalServerHttpPort();
161 * Overrides the BeanFactory.
164 static class TestBeanFactory extends BeanFactory {
168 public ServletWebServerFactory servletContainer() {
169 return new TomcatServletWebServerFactory();
174 public ApplicationConfig getApplicationConfig() {
175 TestApplicationConfig cfg = new TestApplicationConfig();
182 this.applicationConfig.setLocalServerHttpPort(this.localServerHttpPort);
183 assertThat(this.jobs.size()).isZero();
185 DataStore fileStore = this.dataStore();
186 fileStore.create(DataStore.Bucket.FILES).block();
187 fileStore.create(DataStore.Bucket.LOCKS).block();
190 private DataStore dataStore() {
191 return DataStore.create(this.applicationConfig);
197 for (Job job : this.jobs.getAll()) {
198 this.icsSimulatorController.deleteJob(job.getId(), restClient());
200 await().untilAsserted(() -> assertThat(this.jobs.size()).isZero());
202 this.icsSimulatorController.testResults.reset();
204 DataStore fileStore = DataStore.create(applicationConfig);
205 fileStore.deleteBucket(Bucket.FILES);
206 fileStore.deleteBucket(Bucket.LOCKS);
210 private AsyncRestClient restClient(boolean useTrustValidation) {
211 WebClientConfig config = this.applicationConfig.getWebClientConfig();
212 HttpProxyConfig httpProxyConfig = HttpProxyConfig.builder() //
213 .httpProxyHost("") //
216 config = WebClientConfig.builder() //
217 .keyStoreType(config.getKeyStoreType()) //
218 .keyStorePassword(config.getKeyStorePassword()) //
219 .keyStore(config.getKeyStore()) //
220 .keyPassword(config.getKeyPassword()) //
221 .isTrustStoreUsed(useTrustValidation) //
222 .trustStore(config.getTrustStore()) //
223 .trustStorePassword(config.getTrustStorePassword()) //
224 .httpProxyConfig(httpProxyConfig).build();
226 AsyncRestClientFactory restClientFactory = new AsyncRestClientFactory(config, securityContext);
227 return restClientFactory.createRestClientNoHttpProxy(baseUrl());
230 private AsyncRestClient restClient() {
231 return restClient(false);
234 private String baseUrl() {
235 return "https://localhost:" + this.applicationConfig.getLocalServerHttpPort();
238 private String quote(String str) {
239 final String q = "\"";
240 return q + str.replace(q, "\\\"") + q;
243 private Object toJson(String json) {
245 return JsonParser.parseString(json).getAsJsonObject();
246 } catch (Exception e) {
247 throw new NullPointerException(e.toString());
251 private ConsumerJobInfo consumerJobInfo(String typeId, String infoJobId, Object filter) {
253 return new ConsumerJobInfo(typeId, filter, "owner", "");
254 } catch (Exception e) {
259 private void waitForRegistration() {
260 // Register producer, Register types
261 await().untilAsserted(() -> assertThat(icsSimulatorController.testResults.registrationInfo).isNotNull());
262 producerRegistrationTask.supervisionTask().block();
264 assertThat(icsSimulatorController.testResults.registrationInfo.supportedTypeIds).hasSize(this.types.size());
265 assertThat(producerRegistrationTask.isRegisteredInIcs()).isTrue();
266 assertThat(icsSimulatorController.testResults.types).hasSize(this.types.size());
270 void generateApiDoc() throws IOException {
271 String url = "https://localhost:" + applicationConfig.getLocalServerHttpPort() + "/v3/api-docs";
272 ResponseEntity<String> resp = restClient().getForEntity(url).block();
273 assertThat(resp.getStatusCode()).isEqualTo(HttpStatus.OK);
274 JSONObject jsonObj = new JSONObject(resp.getBody());
275 assertThat(jsonObj.remove("servers")).isNotNull();
277 String indented = (jsonObj).toString(4);
278 String docDir = "api/";
279 Files.createDirectories(Paths.get(docDir));
280 try (PrintStream out = new PrintStream(new FileOutputStream(docDir + "api.json"))) {
286 void testTrustValidation() throws IOException {
287 String url = "https://localhost:" + applicationConfig.getLocalServerHttpPort() + "/v3/api-docs";
288 ResponseEntity<String> resp = restClient(true).getForEntity(url).block();
289 assertThat(resp.getStatusCode()).isEqualTo(HttpStatus.OK);
293 void testResponseCodes() throws Exception {
294 String supervisionUrl = baseUrl() + ProducerCallbacksController.SUPERVISION_URL;
295 ResponseEntity<String> resp = restClient().getForEntity(supervisionUrl).block();
296 assertThat(resp.getStatusCode()).isEqualTo(HttpStatus.OK);
298 String jobUrl = baseUrl() + ProducerCallbacksController.JOB_URL;
299 resp = restClient().deleteForEntity(jobUrl + "/junk").block();
300 assertThat(resp.getStatusCode()).isEqualTo(HttpStatus.OK);
302 ProducerJobInfo info = new ProducerJobInfo(null, "id", "typeId", "owner", "lastUpdated");
303 String body = gson.toJson(info);
304 testErrorCode(restClient().post(jobUrl, body, MediaType.APPLICATION_JSON), HttpStatus.NOT_FOUND,
305 "Could not find type");
309 void testFiltering() {
310 String path = "./src/test/resources/pm_report.json.gz";
311 DataStore fs = DataStore.create(this.applicationConfig);
312 fs.copyFileTo(Path.of(path), "pm_report.json.gz");
314 InfoType infoType = this.types.getAll().iterator().next();
315 TopicListener listener = spy(new TopicListener(this.applicationConfig, infoType));
316 NewFileEvent event = NewFileEvent.builder().filename("pm_report.json.gz").build();
317 ConsumerRecord<byte[], byte[]> cr = new ConsumerRecord<>("", 0, 0, new byte[0], gson.toJson(event).getBytes());
318 when(listener.receiveFromKafka(any())).thenReturn(Flux.just(cr));
320 KafkaDeliveryInfo deliveryInfo = KafkaDeliveryInfo.builder().topic("topic").bootStrapServers("").build();
321 JobGroup jobGroup = new JobGroup(infoType, deliveryInfo);
322 jobGroup.add(new Job("id", infoType, "owner", "lastUpdated",
323 Parameters.builder().filter(new FilterData()).build(), this.applicationConfig));
324 JobDataDistributor distributor = spy(new JobDataDistributor(jobGroup, this.applicationConfig));
326 doReturn(Mono.just("")).when(distributor).sendToClient(any());
328 distributor.start(listener.getFlux());
331 ArgumentCaptor<FilteredData> captor = ArgumentCaptor.forClass(FilteredData.class);
332 verify(distributor).sendToClient(captor.capture());
333 FilteredData data = captor.getValue();
334 PmReport report = PmReportFilter.parse(new String(data.value));
335 assertThat(report.event.getCommonEventHeader().getSourceName()).isEqualTo("O-DU-1122");
340 void testFilteringHistoricalData() {
341 DataStore fileStore = DataStore.create(this.applicationConfig);
342 fileStore.copyFileTo(Path.of("./src/test/resources/pm_report.json"),
343 "O-DU-1122/A20000626.2315+0200-2330+0200_HTTPS-6-73.json").block();
345 InfoType infoType = this.types.getAll().iterator().next();
346 TopicListener listener = spy(new TopicListener(this.applicationConfig, infoType));
347 Flux<ConsumerRecord<byte[], byte[]>> flux = Flux.just("") //
348 .delayElements(Duration.ofSeconds(10)).flatMap(s -> Flux.empty());
349 when(listener.receiveFromKafka(any())).thenReturn(flux);
351 PmReportFilter.FilterData filterData = new PmReportFilter.FilterData();
352 filterData.getSourceNames().add("O-DU-1122");
353 filterData.setPmRopStartTime("1999-12-27T10:50:44.000-08:00");
354 filterData.setPmRopEndTime(OffsetDateTime.now().toString());
355 KafkaDeliveryInfo deliveryInfo = KafkaDeliveryInfo.builder().topic("topic").bootStrapServers("").build();
356 JobGroup jobGroup = new JobGroup(infoType, deliveryInfo);
357 Parameters params = Parameters.builder().filter(filterData).build();
358 Job job = new Job("id", infoType, "owner", "lastUpdated", params, this.applicationConfig);
360 JobDataDistributor distributor = spy(new JobDataDistributor(jobGroup, this.applicationConfig));
362 doReturn(Mono.just("")).when(distributor).sendToClient(any());
364 distributor.start(listener.getFlux());
367 ArgumentCaptor<FilteredData> captor = ArgumentCaptor.forClass(FilteredData.class);
368 verify(distributor, times(2)).sendToClient(captor.capture());
369 List<FilteredData> data = captor.getAllValues();
370 assertThat(data).hasSize(2);
371 PmReport report = PmReportFilter.parse(new String(data.get(0).value));
372 assertThat(report.event.getCommonEventHeader().getSourceName()).isEqualTo("O-DU-1122");
373 assertThat(new String(data.get(1).value)).isEqualTo("{}");
378 void testCreateJob() throws Exception {
380 final String JOB_ID = "ID";
382 // Register producer, Register types
383 waitForRegistration();
385 assertThat(this.topicListeners.getTopicListeners()).hasSize(1);
387 // Create a job with a PM filter
388 PmReportFilter.FilterData filterData = new PmReportFilter.FilterData();
390 filterData.addMeasTypes("UtranCell", "succImmediateAssignProcs");
391 filterData.getMeasObjInstIds().add("UtranCell=Gbg-997");
392 filterData.getSourceNames().add("O-DU-1122");
393 filterData.getMeasuredEntityDns().add("ManagedElement=RNC-Gbg-1");
394 Job.Parameters param = Job.Parameters.builder() //
395 .filter(filterData).deliveryInfo(KafkaDeliveryInfo.builder().bootStrapServers("").topic("").build()) //
398 String paramJson = gson.toJson(param);
399 System.out.println(paramJson);
400 ConsumerJobInfo jobInfo = consumerJobInfo("PmDataOverKafka", "EI_PM_JOB_ID", toJson(paramJson));
402 this.icsSimulatorController.addJob(jobInfo, JOB_ID, restClient());
403 await().untilAsserted(() -> assertThat(this.jobs.size()).isEqualTo(1));
405 assertThat(this.topicListeners.getDataDistributors().keySet()).hasSize(1);
409 void testPmFilteringKafka() throws Exception {
410 // Test that the schema for kafka and pm filtering is OK.
413 final String JOB_ID = "ID";
415 // Register producer, Register types
416 waitForRegistration();
418 // Create a job with a PM filter
419 PmReportFilter.FilterData filterData = new PmReportFilter.FilterData();
420 filterData.addMeasTypes("ManagedElement", "succImmediateAssignProcs");
421 Job.Parameters param = Job.Parameters.builder() //
422 .filter(filterData).deliveryInfo(KafkaDeliveryInfo.builder().bootStrapServers("").topic("").build()) //
425 String paramJson = gson.toJson(param);
427 ConsumerJobInfo jobInfo = consumerJobInfo("PmDataOverKafka", "EI_PM_JOB_ID", toJson(paramJson));
428 this.icsSimulatorController.addJob(jobInfo, JOB_ID, restClient());
429 await().untilAsserted(() -> assertThat(this.jobs.size()).isEqualTo(1));
433 void testReRegister() throws Exception {
434 // Wait foir register types and producer
435 waitForRegistration();
437 // Clear the registration, should trigger a re-register
438 icsSimulatorController.testResults.reset();
439 producerRegistrationTask.supervisionTask().block();
440 await().untilAsserted(() -> assertThat(icsSimulatorController.testResults.registrationInfo).isNotNull());
441 assertThat(icsSimulatorController.testResults.registrationInfo.supportedTypeIds).hasSize(this.types.size());
443 // Just clear the registerred types, should trigger a re-register
444 icsSimulatorController.testResults.types.clear();
445 await().untilAsserted(() -> assertThat(icsSimulatorController.testResults.registrationInfo.supportedTypeIds)
446 .hasSize(this.types.size()));
450 @SuppressWarnings("squid:S2925") // "Thread.sleep" should not be used in tests.
451 void testZZActuator() throws Exception {
452 // The test must be run last, hence the "ZZ" in the name. All succeeding tests
454 AsyncRestClient client = restClient();
455 client.post("/actuator/loggers/org.oran.pmproducer", "{\"configuredLevel\":\"trace\"}").block();
456 String resp = client.get("/actuator/loggers/org.oran.pmproducer").block();
457 assertThat(resp).contains("TRACE");
458 client.post("/actuator/loggers/org.springframework.boot.actuate", "{\"configuredLevel\":\"trace\"}").block();
459 // This will stop the web server and all coming tests will fail.
460 client.post("/actuator/shutdown", "").block();
463 String url = "https://localhost:" + applicationConfig.getLocalServerHttpPort() + "/v3/api-docs";
464 StepVerifier.create(restClient().get(url)) // Any call
465 .expectSubscription() //
466 .expectErrorMatches(t -> t instanceof WebClientRequestException) //
470 public static void testErrorCode(Mono<?> request, HttpStatus expStatus, String responseContains) {
471 testErrorCode(request, expStatus, responseContains, true);
474 public static void testErrorCode(Mono<?> request, HttpStatus expStatus, String responseContains,
475 boolean expectApplicationProblemJsonMediaType) {
476 StepVerifier.create(request) //
477 .expectSubscription() //
479 t -> checkWebClientError(t, expStatus, responseContains, expectApplicationProblemJsonMediaType)) //
483 private static boolean checkWebClientError(Throwable throwable, HttpStatus expStatus, String responseContains,
484 boolean expectApplicationProblemJsonMediaType) {
485 assertTrue(throwable instanceof WebClientResponseException);
486 WebClientResponseException responseException = (WebClientResponseException) throwable;
487 assertThat(responseException.getStatusCode()).isEqualTo(expStatus);
488 assertThat(responseException.getResponseBodyAsString()).contains(responseContains);
489 if (expectApplicationProblemJsonMediaType) {
490 assertThat(responseException.getHeaders().getContentType()).isEqualTo(MediaType.APPLICATION_PROBLEM_JSON);