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.Assert.assertEquals;
  26 import static org.junit.Assert.assertFalse;
  27 import static org.junit.Assert.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
  78 public class ScheduledTasksTest {
  79
  80     private static final String PM_FILE_NAME = "A20161224.1030-1045.bin.gz";
  81     private static final String CHANGE_IDENTIFIER = "PM_MEAS_FILES";
  82
  83     private AppConfig appConfig = mock(AppConfig.class);
  84     private ScheduledTasks testedObject;
  85
  86     private int uniqueValue = 0;
  87     private DMaaPMessageConsumer consumerMock;
  88     private PublishedChecker publishedCheckerMock;
  89     private FileCollector fileCollectorMock;
  90     private DataRouterPublisher dataRouterMock;
  91     private Map<String, String> contextMap = new HashMap<String, String>();
  92
  93     private final String publishUrl = "https://54.45.33.2:1234/unauthenticated.VES_NOTIFICATION_OUTPUT";
  94
  95     @BeforeEach
  96     private void setUp() throws DatafileTaskException {
  97         testedObject = spy(new ScheduledTasks(appConfig));
  98
  99         consumerMock = mock(DMaaPMessageConsumer.class);
 100         publishedCheckerMock = mock(PublishedChecker.class);
 101         fileCollectorMock = mock(FileCollector.class);
 102         dataRouterMock = mock(DataRouterPublisher.class);
 103
 104         doReturn(consumerMock).when(testedObject).createConsumerTask();
 105         doReturn(publishedCheckerMock).when(testedObject).createPublishedChecker();
 106         doReturn(fileCollectorMock).when(testedObject).createFileCollector();
 107         doReturn(dataRouterMock).when(testedObject).createDataRouterPublisher();
 108     }
 109
 110     private void setUpConfiguration() throws DatafileTaskException {
 111         final PublisherConfiguration dmaapPublisherConfiguration = ImmutablePublisherConfiguration.builder() //
 112             .publishUrl(publishUrl) //
 113             .logUrl("") //
 114             .userName("userName") //
 115             .password("passWord") //
 116             .trustStorePath("trustStorePath") //
 117             .trustStorePasswordPath("trustStorePasswordPath") //
 118             .keyStorePath("keyStorePath") //
 119             .keyStorePasswordPath("keyStorePasswordPath") //
 120             .enableDmaapCertAuth(true) //
 121             .changeIdentifier(CHANGE_IDENTIFIER) //
 122             .build(); //
 123         final ConsumerConfiguration dmaapConsumerConfiguration =
 124             new ConsumerConfiguration(mock(MessageRouterSubscriberConfig.class), mock(MessageRouterSubscriber.class),
 125                 mock(MessageRouterSubscribeRequest.class));
 126
 127
 128         doReturn(dmaapPublisherConfiguration).when(appConfig).getPublisherConfiguration(CHANGE_IDENTIFIER);
 129         doReturn(dmaapConsumerConfiguration).when(appConfig).getDmaapConsumerConfiguration();
 130         doReturn(true).when(appConfig).isFeedConfigured(CHANGE_IDENTIFIER);
 131     }
 132
 133     private MessageMetaData messageMetaData() {
 134         return ImmutableMessageMetaData.builder() //
 135             .productName("productName") //
 136             .vendorName("") //
 137             .lastEpochMicrosec("") //
 138             .sourceName("") //
 139             .startEpochMicrosec("") //
 140             .timeZoneOffset("") //
 141             .changeIdentifier(CHANGE_IDENTIFIER) //
 142             .changeType("") //
 143             .build();
 144     }
 145
 146     private FileData fileData(int instanceNumber) {
 147         return ImmutableFileData.builder() //
 148             .name(PM_FILE_NAME + instanceNumber) //
 149             .fileFormatType("") //
 150             .fileFormatVersion("") //
 151             .location("ftpes://192.168.0.101/ftp/rop/" + PM_FILE_NAME + instanceNumber) //
 152             .scheme(Scheme.FTPES) //
 153             .compression("") //
 154             .messageMetaData(messageMetaData()) //
 155             .build();
 156     }
 157
 158     private List<FileData> files(int size, boolean uniqueNames) {
 159         List<FileData> list = new LinkedList<FileData>();
 160         for (int i = 0; i < size; ++i) {
 161             if (uniqueNames) {
 162                 ++uniqueValue;
 163             }
 164             list.add(fileData(uniqueValue));
 165         }
 166         return list;
 167     }
 168
 169     private FileReadyMessage createFileReadyMessage(int numberOfFiles, boolean uniqueNames) {
 170         return ImmutableFileReadyMessage.builder().files(files(numberOfFiles, uniqueNames)).build();
 171     }
 172
 173     private Flux<FileReadyMessage> fileReadyMessageFlux(int numberOfEvents, int filesPerEvent, boolean uniqueNames) {
 174         List<FileReadyMessage> list = new LinkedList<FileReadyMessage>();
 175         for (int i = 0; i < numberOfEvents; ++i) {
 176             list.add(createFileReadyMessage(filesPerEvent, uniqueNames));
 177         }
 178         return Flux.fromIterable(list);
 179     }
 180
 181     private FilePublishInformation filePublishInformation() {
 182         return ImmutableFilePublishInformation //
 183             .builder() //
 184             .productName("") //
 185             .vendorName("") //
 186             .lastEpochMicrosec("") //
 187             .sourceName("") //
 188             .startEpochMicrosec("") //
 189             .timeZoneOffset("") //
 190             .name("") //
 191             .location("") //
 192             .internalLocation(Paths.get("internalLocation")) //
 193             .compression("") //
 194             .fileFormatType("") //
 195             .fileFormatVersion("") //
 196             .changeIdentifier(CHANGE_IDENTIFIER) //
 197             .context(new HashMap<String, String>()).build();
 198     }
 199
 200     @Test
 201     public void purgeFileCache() {
 202         testedObject.publishedFilesCache.put(Paths.get("file.xml"));
 203
 204         testedObject.purgeCachedInformation(Instant.MAX);
 205
 206         assertEquals(0, testedObject.publishedFilesCacheSize());
 207     }
 208
 209     @Test
 210     public void nothingToConsume() throws DatafileTaskException {
 211         setUpConfiguration();
 212
 213         doReturn(consumerMock).when(testedObject).createConsumerTask();
 214         doReturn(Flux.empty()).when(consumerMock).getMessageRouterResponse();
 215
 216         testedObject.executeDatafileMainTask();
 217
 218         assertEquals(0, testedObject.getCurrentNumberOfTasks());
 219         verify(consumerMock, times(1)).getMessageRouterResponse();
 220         verifyNoMoreInteractions(consumerMock);
 221     }
 222
 223     @Test
 224     public void skippingConsumeDueToCurrentNumberOfTasksGreaterThan50() {
 225         doReturn(51).when(testedObject).getCurrentNumberOfTasks();
 226
 227         testedObject.executeDatafileMainTask();
 228
 229         verifyNoMoreInteractions(consumerMock);
 230     }
 231
 232     @Test
 233     public void executeDatafileMainTask_successfulCase() throws DatafileTaskException {
 234         setUpConfiguration();
 235
 236         final int noOfEvents = 1;
 237         final int noOfFilesPerEvent = 1;
 238
 239         Flux<FileReadyMessage> fileReadyMessages = fileReadyMessageFlux(noOfEvents, noOfFilesPerEvent, true);
 240         doReturn(fileReadyMessages).when(consumerMock).getMessageRouterResponse();
 241
 242         doReturn(false).when(publishedCheckerMock).isFilePublished(anyString(), any(), any());
 243
 244         Mono<FilePublishInformation> collectedFile = Mono.just(filePublishInformation());
 245         doReturn(collectedFile).when(fileCollectorMock).collectFile(notNull(), anyLong(), notNull(), notNull());
 246         doReturn(collectedFile).when(dataRouterMock).publishFile(notNull(), anyLong(), notNull());
 247
 248         testedObject.executeDatafileMainTask();
 249
 250         await().untilAsserted(() -> assertEquals("currentNumberOfSubscriptions should have been 0", 0,
 251             testedObject.getCurrentNumberOfSubscriptions()));
 252
 253         assertFalse(StringUtils.isBlank(MDC.get(MdcVariables.REQUEST_ID)));
 254
 255         verify(appConfig).getDmaapConsumerConfiguration();
 256         verify(appConfig).isFeedConfigured(CHANGE_IDENTIFIER);
 257         verifyNoMoreInteractions(appConfig);
 258
 259         assertEquals("totalReceivedEvents should have been 1", 1, testedObject.getCounters().getTotalReceivedEvents());
 260     }
 261
 262     @Test
 263     public void executeDatafileMainTask_unconfiguredChangeIdentifier() throws DatafileTaskException {
 264         final PublisherConfiguration dmaapPublisherConfiguration = ImmutablePublisherConfiguration.builder() //
 265             .publishUrl(publishUrl) //
 266             .logUrl("") //
 267             .userName("userName") //
 268             .password("passWord") //
 269             .trustStorePath("trustStorePath") //
 270             .trustStorePasswordPath("trustStorePasswordPath") //
 271             .keyStorePath("keyStorePath") //
 272             .keyStorePasswordPath("keyStorePasswordPath") //
 273             .enableDmaapCertAuth(true) //
 274             .changeIdentifier("Different changeIdentifier") //
 275             .build(); //
 276         final ConsumerConfiguration dmaapConsumerConfiguration =
 277             new ConsumerConfiguration(mock(MessageRouterSubscriberConfig.class), mock(MessageRouterSubscriber.class),
 278                 mock(MessageRouterSubscribeRequest.class));
 279
 280         doReturn(dmaapPublisherConfiguration).when(appConfig).getPublisherConfiguration(CHANGE_IDENTIFIER);
 281         doReturn(dmaapConsumerConfiguration).when(appConfig).getDmaapConsumerConfiguration();
 282         doReturn(false).when(appConfig).isFeedConfigured(CHANGE_IDENTIFIER);
 283         final int noOfEvents = 1;
 284         final int noOfFilesPerEvent = 1;
 285
 286         Flux<FileReadyMessage> fileReadyMessages = fileReadyMessageFlux(noOfEvents, noOfFilesPerEvent, true);
 287         doReturn(fileReadyMessages).when(consumerMock).getMessageRouterResponse();
 288
 289         final ListAppender<ILoggingEvent> logAppender = LoggingUtils.getLogListAppender(ScheduledTasks.class);
 290         testedObject.executeDatafileMainTask();
 291
 292         await().untilAsserted(() -> assertEquals("currentNumberOfSubscriptions should have been 0", 0,
 293             testedObject.getCurrentNumberOfSubscriptions()));
 294
 295         assertTrue("Error missing in log", logAppender.list.toString().contains(
 296             "[INFO] No feed is configured for: " + CHANGE_IDENTIFIER + ", file ignored: " + PM_FILE_NAME + "1"));
 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("Error missing in log", logAppender.list.toString()
 313             .contains("[ERROR] Polling for file ready message failed, " + "exception: java.lang.Exception: Failed"));
 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("totalReceivedEvents should have been 200", 200,
 353             testedObject.getCounters().getTotalReceivedEvents());
 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("totalReceivedEvents should have been 2", 2, testedObject.getCounters().getTotalReceivedEvents());
 395         assertEquals("failedFtp should have been 1", 1, testedObject.getCounters().getNoOfFailedFtp());
 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("Error missing in log", 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("totalReceivedEvents should have been 2", 2, testedObject.getCounters().getTotalReceivedEvents());
 438         assertEquals("noOfFailedPublish should have been 1", 1, testedObject.getCounters().getNoOfFailedPublish());
 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("totalReceivedEvents should have been 1", 1, testedObject.getCounters().getTotalReceivedEvents());
 479     }
 480 }