gerrit.onap Code Review - dcaegen2/collectors/datafile.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2019 Nordix Foundation.
   4  * Copyright (C) 2020 Nokia. All rights reserved.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.dcaegen2.collectors.datafile.tasks;
  23
  24 import static org.awaitility.Awaitility.await;
  25 import static org.junit.jupiter.api.Assertions.assertEquals;
  26 import static org.junit.jupiter.api.Assertions.assertFalse;
  27 import static org.junit.jupiter.api.Assertions.assertTrue;
  28 import static org.mockito.ArgumentMatchers.any;
  29 import static org.mockito.ArgumentMatchers.anyLong;
  30 import static org.mockito.ArgumentMatchers.anyString;
  31 import static org.mockito.ArgumentMatchers.notNull;
  32 import static org.mockito.Mockito.doReturn;
  33 import static org.mockito.Mockito.mock;
  34 import static org.mockito.Mockito.spy;
  35 import static org.mockito.Mockito.times;
  36 import static org.mockito.Mockito.verify;
  37 import static org.mockito.Mockito.verifyNoMoreInteractions;
  38
  39 import ch.qos.logback.classic.spi.ILoggingEvent;
  40 import ch.qos.logback.core.read.ListAppender;
  41
  42 import java.nio.file.Paths;
  43 import java.time.Duration;
  44 import java.time.Instant;
  45 import java.util.HashMap;
  46 import java.util.LinkedList;
  47 import java.util.List;
  48 import java.util.Map;
  49
  50 import org.apache.commons.lang3.StringUtils;
  51 import org.junit.jupiter.api.BeforeEach;
  52 import org.junit.jupiter.api.Test;
  53 import org.onap.dcaegen2.collectors.datafile.configuration.AppConfig;
  54 import org.onap.dcaegen2.collectors.datafile.configuration.ConsumerConfiguration;
  55 import org.onap.dcaegen2.collectors.datafile.configuration.ImmutablePublisherConfiguration;
  56 import org.onap.dcaegen2.collectors.datafile.configuration.PublisherConfiguration;
  57 import org.onap.dcaegen2.collectors.datafile.exceptions.DatafileTaskException;
  58 import org.onap.dcaegen2.collectors.datafile.ftp.Scheme;
  59 import org.onap.dcaegen2.collectors.datafile.model.FileData;
  60 import org.onap.dcaegen2.collectors.datafile.model.FilePublishInformation;
  61 import org.onap.dcaegen2.collectors.datafile.model.FileReadyMessage;
  62 import org.onap.dcaegen2.collectors.datafile.model.ImmutableFileData;
  63 import org.onap.dcaegen2.collectors.datafile.model.ImmutableFilePublishInformation;
  64 import org.onap.dcaegen2.collectors.datafile.model.ImmutableFileReadyMessage;
  65 import org.onap.dcaegen2.collectors.datafile.model.ImmutableMessageMetaData;
  66 import org.onap.dcaegen2.collectors.datafile.model.MessageMetaData;
  67 import org.onap.dcaegen2.collectors.datafile.utils.LoggingUtils;
  68 import org.onap.dcaegen2.services.sdk.rest.services.dmaap.client.api.MessageRouterSubscriber;
  69 import org.onap.dcaegen2.services.sdk.rest.services.dmaap.client.model.MessageRouterSubscribeRequest;
  70 import org.onap.dcaegen2.services.sdk.rest.services.dmaap.client.model.config.MessageRouterSubscriberConfig;
  71 import org.onap.dcaegen2.services.sdk.rest.services.model.logging.MdcVariables;
  72 import org.slf4j.MDC;
  73
  74 import reactor.core.publisher.Flux;
  75 import reactor.core.publisher.Mono;
  76 import reactor.test.StepVerifier;
  77 import reactor.test.scheduler.VirtualTimeScheduler;
  78
  79 public class ScheduledTasksTest {
  80
  81     private static final String PM_FILE_NAME = "A20161224.1030-1045.bin.gz";
  82     private static final String CHANGE_IDENTIFIER = "PM_MEAS_FILES";
  83
  84     private AppConfig appConfig = mock(AppConfig.class);
  85     private ScheduledTasks testedObject;
  86
  87     private int uniqueValue = 0;
  88     private DMaaPMessageConsumer consumerMock;
  89     private PublishedChecker publishedCheckerMock;
  90     private FileCollector fileCollectorMock;
  91     private DataRouterPublisher dataRouterMock;
  92     private Map<String, String> contextMap = new HashMap<String, String>();
  93
  94     private final String publishUrl = "https://54.45.33.2:1234/unauthenticated.VES_NOTIFICATION_OUTPUT";
  95
  96     @BeforeEach
  97     private void setUp() throws DatafileTaskException {
  98         testedObject = spy(new ScheduledTasks(appConfig));
  99
 100         consumerMock = mock(DMaaPMessageConsumer.class);
 101         publishedCheckerMock = mock(PublishedChecker.class);
 102         fileCollectorMock = mock(FileCollector.class);
 103         dataRouterMock = mock(DataRouterPublisher.class);
 104
 105         doReturn(consumerMock).when(testedObject).createConsumerTask();
 106         doReturn(publishedCheckerMock).when(testedObject).createPublishedChecker();
 107         doReturn(fileCollectorMock).when(testedObject).createFileCollector();
 108         doReturn(dataRouterMock).when(testedObject).createDataRouterPublisher();
 109     }
 110
 111     private void setUpConfiguration() throws DatafileTaskException {
 112         final PublisherConfiguration dmaapPublisherConfiguration = ImmutablePublisherConfiguration.builder() //
 113             .publishUrl(publishUrl) //
 114             .logUrl("") //
 115             .userName("userName") //
 116             .password("passWord") //
 117             .trustStorePath("trustStorePath") //
 118             .trustStorePasswordPath("trustStorePasswordPath") //
 119             .keyStorePath("keyStorePath") //
 120             .keyStorePasswordPath("keyStorePasswordPath") //
 121             .enableDmaapCertAuth(true) //
 122             .changeIdentifier(CHANGE_IDENTIFIER) //
 123             .build(); //
 124         final ConsumerConfiguration dmaapConsumerConfiguration =
 125             new ConsumerConfiguration(mock(MessageRouterSubscriberConfig.class), mock(MessageRouterSubscriber.class),
 126                 mock(MessageRouterSubscribeRequest.class));
 127
 128
 129         doReturn(dmaapPublisherConfiguration).when(appConfig).getPublisherConfiguration(CHANGE_IDENTIFIER);
 130         doReturn(dmaapConsumerConfiguration).when(appConfig).getDmaapConsumerConfiguration();
 131         doReturn(true).when(appConfig).isFeedConfigured(CHANGE_IDENTIFIER);
 132     }
 133
 134     private MessageMetaData messageMetaData() {
 135         return ImmutableMessageMetaData.builder() //
 136             .productName("productName") //
 137             .vendorName("") //
 138             .lastEpochMicrosec("") //
 139             .sourceName("") //
 140             .startEpochMicrosec("") //
 141             .timeZoneOffset("") //
 142             .changeIdentifier(CHANGE_IDENTIFIER) //
 143             .changeType("") //
 144             .build();
 145     }
 146
 147     private FileData fileData(int instanceNumber) {
 148         return ImmutableFileData.builder() //
 149             .name(PM_FILE_NAME + instanceNumber) //
 150             .fileFormatType("") //
 151             .fileFormatVersion("") //
 152             .location("ftpes://192.168.0.101/ftp/rop/" + PM_FILE_NAME + instanceNumber) //
 153             .scheme(Scheme.FTPES) //
 154             .compression("") //
 155             .messageMetaData(messageMetaData()) //
 156             .build();
 157     }
 158
 159     private List<FileData> files(int size, boolean uniqueNames) {
 160         List<FileData> list = new LinkedList<FileData>();
 161         for (int i = 0; i < size; ++i) {
 162             if (uniqueNames) {
 163                 ++uniqueValue;
 164             }
 165             list.add(fileData(uniqueValue));
 166         }
 167         return list;
 168     }
 169
 170     private FileReadyMessage createFileReadyMessage(int numberOfFiles, boolean uniqueNames) {
 171         return ImmutableFileReadyMessage.builder().files(files(numberOfFiles, uniqueNames)).build();
 172     }
 173
 174     private Flux<FileReadyMessage> fileReadyMessageFlux(int numberOfEvents, int filesPerEvent, boolean uniqueNames) {
 175         List<FileReadyMessage> list = new LinkedList<FileReadyMessage>();
 176         for (int i = 0; i < numberOfEvents; ++i) {
 177             list.add(createFileReadyMessage(filesPerEvent, uniqueNames));
 178         }
 179         return Flux.fromIterable(list);
 180     }
 181
 182     private FilePublishInformation filePublishInformation() {
 183         return ImmutableFilePublishInformation //
 184             .builder() //
 185             .productName("") //
 186             .vendorName("") //
 187             .lastEpochMicrosec("") //
 188             .sourceName("") //
 189             .startEpochMicrosec("") //
 190             .timeZoneOffset("") //
 191             .name("") //
 192             .location("") //
 193             .internalLocation(Paths.get("internalLocation")) //
 194             .compression("") //
 195             .fileFormatType("") //
 196             .fileFormatVersion("") //
 197             .changeIdentifier(CHANGE_IDENTIFIER) //
 198             .context(new HashMap<String, String>()).build();
 199     }
 200
 201     @Test
 202     public void purgeFileCache() {
 203         testedObject.publishedFilesCache.put(Paths.get("file.xml"));
 204
 205         testedObject.purgeCachedInformation(Instant.MAX);
 206
 207         assertEquals(0, testedObject.publishedFilesCacheSize());
 208     }
 209
 210     @Test
 211     public void nothingToConsume() throws DatafileTaskException {
 212         setUpConfiguration();
 213
 214         doReturn(consumerMock).when(testedObject).createConsumerTask();
 215         doReturn(Flux.empty()).when(consumerMock).getMessageRouterResponse();
 216
 217         testedObject.executeDatafileMainTask();
 218
 219         assertEquals(0, testedObject.getCurrentNumberOfTasks());
 220         verify(consumerMock, times(1)).getMessageRouterResponse();
 221         verifyNoMoreInteractions(consumerMock);
 222     }
 223
 224     @Test
 225     public void skippingConsumeDueToCurrentNumberOfTasksGreaterThan50() {
 226         doReturn(51).when(testedObject).getCurrentNumberOfTasks();
 227
 228         testedObject.executeDatafileMainTask();
 229
 230         verifyNoMoreInteractions(consumerMock);
 231     }
 232
 233     @Test
 234     public void executeDatafileMainTask_successfulCase() throws DatafileTaskException {
 235         setUpConfiguration();
 236
 237         final int noOfEvents = 1;
 238         final int noOfFilesPerEvent = 1;
 239
 240         Flux<FileReadyMessage> fileReadyMessages = fileReadyMessageFlux(noOfEvents, noOfFilesPerEvent, true);
 241         doReturn(fileReadyMessages).when(consumerMock).getMessageRouterResponse();
 242
 243         doReturn(false).when(publishedCheckerMock).isFilePublished(anyString(), any(), any());
 244
 245         Mono<FilePublishInformation> collectedFile = Mono.just(filePublishInformation());
 246         doReturn(collectedFile).when(fileCollectorMock).collectFile(notNull(), anyLong(), notNull(), notNull());
 247         doReturn(collectedFile).when(dataRouterMock).publishFile(notNull(), anyLong(), notNull());
 248
 249         testedObject.executeDatafileMainTask();
 250
 251         await().untilAsserted(() -> assertEquals(0,
 252             testedObject.getCurrentNumberOfSubscriptions()));
 253
 254         assertFalse(StringUtils.isBlank(MDC.get(MdcVariables.REQUEST_ID)));
 255
 256         verify(appConfig).getDmaapConsumerConfiguration();
 257         verify(appConfig).isFeedConfigured(CHANGE_IDENTIFIER);
 258         verifyNoMoreInteractions(appConfig);
 259
 260         assertEquals(1, testedObject.getCounters().getTotalReceivedEvents(),"totalReceivedEvents should have been 1");
 261     }
 262
 263     @Test
 264     public void executeDatafileMainTask_unconfiguredChangeIdentifier() throws DatafileTaskException {
 265         final PublisherConfiguration dmaapPublisherConfiguration = ImmutablePublisherConfiguration.builder() //
 266             .publishUrl(publishUrl) //
 267             .logUrl("") //
 268             .userName("userName") //
 269             .password("passWord") //
 270             .trustStorePath("trustStorePath") //
 271             .trustStorePasswordPath("trustStorePasswordPath") //
 272             .keyStorePath("keyStorePath") //
 273             .keyStorePasswordPath("keyStorePasswordPath") //
 274             .enableDmaapCertAuth(true) //
 275             .changeIdentifier("Different changeIdentifier") //
 276             .build(); //
 277         final ConsumerConfiguration dmaapConsumerConfiguration =
 278             new ConsumerConfiguration(mock(MessageRouterSubscriberConfig.class), mock(MessageRouterSubscriber.class),
 279                 mock(MessageRouterSubscribeRequest.class));
 280
 281         doReturn(dmaapPublisherConfiguration).when(appConfig).getPublisherConfiguration(CHANGE_IDENTIFIER);
 282         doReturn(dmaapConsumerConfiguration).when(appConfig).getDmaapConsumerConfiguration();
 283         doReturn(false).when(appConfig).isFeedConfigured(CHANGE_IDENTIFIER);
 284         final int noOfEvents = 1;
 285         final int noOfFilesPerEvent = 1;
 286
 287         Flux<FileReadyMessage> fileReadyMessages = fileReadyMessageFlux(noOfEvents, noOfFilesPerEvent, true);
 288         doReturn(fileReadyMessages).when(consumerMock).getMessageRouterResponse();
 289
 290         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(ScheduledTasks.class);
 291         testedObject.executeDatafileMainTask();
 292
 293         await().untilAsserted(() -> assertEquals(0, testedObject.getCurrentNumberOfSubscriptions(),"currentNumberOfSubscriptions should have been 0"));
 294
 295         assertTrue(logAppender.list.toString().contains(
 296             "[INFO] No feed is configured for: " + CHANGE_IDENTIFIER + ", file ignored: " + PM_FILE_NAME + "1"),"Error missing in log");
 297     }
 298
 299     @Test
 300     public void createMainTask_consumeFail() {
 301         MDC.setContextMap(contextMap);
 302         doReturn(Flux.error(new Exception("Failed"))).when(consumerMock).getMessageRouterResponse();
 303
 304         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(ScheduledTasks.class);
 305         StepVerifier //
 306             .create(testedObject.createMainTask(contextMap)) //
 307             .expectSubscription() //
 308             .expectNextCount(0) //
 309             .expectComplete() //
 310             .verify(); //
 311
 312         assertTrue(logAppender.list.toString()
 313             .contains("[ERROR] Polling for file ready message failed, " + "exception: java.lang.Exception: Failed"),"Error missing in log");
 314     }
 315
 316     @Test
 317     public void consume_successfulCase() throws DatafileTaskException {
 318         setUpConfiguration();
 319
 320         final int noOfEvents = 200;
 321         final int noOfFilesPerEvent = 200;
 322         final int noOfFiles = noOfEvents * noOfFilesPerEvent;
 323
 324         Flux<FileReadyMessage> fileReadyMessages = fileReadyMessageFlux(noOfEvents, noOfFilesPerEvent, true);
 325         doReturn(fileReadyMessages).when(consumerMock).getMessageRouterResponse();
 326
 327         doReturn(false).when(publishedCheckerMock).isFilePublished(anyString(), anyString(), any());
 328
 329         Mono<FilePublishInformation> collectedFile = Mono.just(filePublishInformation());
 330         doReturn(collectedFile).when(fileCollectorMock).collectFile(notNull(), anyLong(), notNull(), notNull());
 331         doReturn(collectedFile).when(dataRouterMock).publishFile(notNull(), anyLong(), notNull());
 332
 333         StepVerifier //
 334             .create(testedObject.createMainTask(contextMap)) //
 335             .expectSubscription() //
 336             .expectNextCount(noOfFiles) //
 337             .expectComplete() //
 338             .verify(); //
 339
 340         assertEquals(0, testedObject.getCurrentNumberOfTasks());
 341         assertEquals(0, testedObject.getThreadPoolQueueSize());
 342
 343         verify(consumerMock, times(1)).getMessageRouterResponse();
 344         verifyNoMoreInteractions(consumerMock);
 345
 346         verify(fileCollectorMock, times(noOfFiles)).collectFile(notNull(), anyLong(), notNull(), notNull());
 347         verifyNoMoreInteractions(fileCollectorMock);
 348
 349         verify(dataRouterMock, times(noOfFiles)).publishFile(notNull(), anyLong(), notNull());
 350         verifyNoMoreInteractions(dataRouterMock);
 351
 352         assertEquals(200,
 353             testedObject.getCounters().getTotalReceivedEvents(),"totalReceivedEvents should have been 200");
 354     }
 355
 356     @Test
 357     public void consume_fetchFailedOnce() throws DatafileTaskException {
 358         setUpConfiguration();
 359
 360         Flux<FileReadyMessage> fileReadyMessages = fileReadyMessageFlux(2, 2, true); // 4 files
 361         doReturn(fileReadyMessages).when(consumerMock).getMessageRouterResponse();
 362
 363         doReturn(false).when(publishedCheckerMock).isFilePublished(anyString(), anyString(), any());
 364
 365         Mono<FilePublishInformation> collectedFile = Mono.just(filePublishInformation());
 366         Mono<Object> error = Mono.error(new Exception("problem"));
 367
 368         // First file collect will fail, 3 will succeed
 369         doReturn(error, collectedFile, collectedFile, collectedFile) //
 370             .when(fileCollectorMock) //
 371             .collectFile(any(FileData.class), anyLong(), any(Duration.class), notNull());
 372
 373         doReturn(collectedFile).when(dataRouterMock).publishFile(notNull(), anyLong(), notNull());
 374         doReturn(collectedFile).when(dataRouterMock).publishFile(notNull(), anyLong(), notNull());
 375
 376         StepVerifier //
 377             .create(testedObject.createMainTask(contextMap)) //
 378             .expectSubscription() //
 379             .expectNextCount(3) //
 380             .expectComplete() //
 381             .verify(); //
 382
 383         assertEquals(0, testedObject.getCurrentNumberOfTasks());
 384
 385         verify(consumerMock, times(1)).getMessageRouterResponse();
 386         verifyNoMoreInteractions(consumerMock);
 387
 388         verify(fileCollectorMock, times(4)).collectFile(notNull(), anyLong(), notNull(), notNull());
 389         verifyNoMoreInteractions(fileCollectorMock);
 390
 391         verify(dataRouterMock, times(3)).publishFile(notNull(), anyLong(), notNull());
 392         verifyNoMoreInteractions(dataRouterMock);
 393
 394         assertEquals(2, testedObject.getCounters().getTotalReceivedEvents(),"totalReceivedEvents should have been 2");
 395         assertEquals(1, testedObject.getCounters().getNoOfFailedFtp(),"failedFtp should have been 1");
 396     }
 397
 398     @Test
 399     public void consume_publishFailedOnce() throws DatafileTaskException {
 400         setUpConfiguration();
 401
 402         Flux<FileReadyMessage> fileReadyMessages = fileReadyMessageFlux(2, 2, true); // 4 files
 403         doReturn(fileReadyMessages).when(consumerMock).getMessageRouterResponse();
 404
 405         doReturn(false).when(publishedCheckerMock).isFilePublished(anyString(), anyString(), any());
 406
 407         Mono<FilePublishInformation> collectedFile = Mono.just(filePublishInformation());
 408         doReturn(collectedFile).when(fileCollectorMock).collectFile(notNull(), anyLong(), notNull(), notNull());
 409
 410         Mono<Object> error = Mono.error(new Exception("problem"));
 411         // One publish will fail, the rest will succeed
 412         doReturn(collectedFile, error, collectedFile, collectedFile) //
 413             .when(dataRouterMock) //
 414             .publishFile(notNull(), anyLong(), notNull());
 415
 416         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(ScheduledTasks.class);
 417         StepVerifier //
 418             .create(testedObject.createMainTask(contextMap)) //
 419             .expectSubscription() //
 420             .expectNextCount(3) // 3 completed files
 421             .expectComplete() //
 422             .verify(); //
 423
 424         assertTrue(logAppender.list.toString().contains("[ERROR] File publishing failed: "));
 425
 426         assertEquals(0, testedObject.getCurrentNumberOfTasks());
 427
 428         verify(consumerMock, times(1)).getMessageRouterResponse();
 429         verifyNoMoreInteractions(consumerMock);
 430
 431         verify(fileCollectorMock, times(4)).collectFile(notNull(), anyLong(), notNull(), notNull());
 432         verifyNoMoreInteractions(fileCollectorMock);
 433
 434         verify(dataRouterMock, times(4)).publishFile(notNull(), anyLong(), notNull());
 435         verifyNoMoreInteractions(dataRouterMock);
 436
 437         assertEquals(2, testedObject.getCounters().getTotalReceivedEvents(),"totalReceivedEvents should have been 2");
 438         assertEquals(1, testedObject.getCounters().getNoOfFailedPublish(),"noOfFailedPublish should have been 1");
 439     }
 440
 441     @Test
 442     public void consume_successfulCase_sameFileNames() throws DatafileTaskException {
 443         setUpConfiguration();
 444
 445         final int noOfEvents = 1;
 446         final int noOfFilesPerEvent = 100;
 447
 448         // 100 files with the same name
 449         Flux<FileReadyMessage> fileReadyMessages = fileReadyMessageFlux(noOfEvents, noOfFilesPerEvent, false);
 450         doReturn(fileReadyMessages).when(consumerMock).getMessageRouterResponse();
 451
 452         doReturn(false).when(publishedCheckerMock).isFilePublished(anyString(), anyString(), any());
 453
 454         Mono<FilePublishInformation> collectedFile = Mono.just(filePublishInformation());
 455         doReturn(collectedFile).when(fileCollectorMock).collectFile(notNull(), anyLong(), notNull(), notNull());
 456         doReturn(collectedFile).when(dataRouterMock).publishFile(notNull(), anyLong(), notNull());
 457
 458         StepVerifier //
 459             .create(testedObject.createMainTask(contextMap)).expectSubscription() //
 460             .expectNextCount(1) // 99 is skipped
 461             .expectComplete() //
 462             .verify(); //
 463
 464         assertEquals(0, testedObject.getCurrentNumberOfTasks());
 465
 466         verify(consumerMock, times(1)).getMessageRouterResponse();
 467         verifyNoMoreInteractions(consumerMock);
 468
 469         verify(fileCollectorMock, times(1)).collectFile(notNull(), anyLong(), notNull(), notNull());
 470         verifyNoMoreInteractions(fileCollectorMock);
 471
 472         verify(dataRouterMock, times(1)).publishFile(notNull(), anyLong(), notNull());
 473         verifyNoMoreInteractions(dataRouterMock);
 474
 475         verify(publishedCheckerMock, times(1)).isFilePublished(notNull(), anyString(), notNull());
 476         verifyNoMoreInteractions(publishedCheckerMock);
 477
 478         assertEquals(1, testedObject.getCounters().getTotalReceivedEvents(),"totalReceivedEvents should have been 1");
 479     }
 480 }