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

   1 /*-
   2  * ============LICENSE_START======================================================================
   3  * Copyright (C) 2018-2019 Nordix Foundation. All rights reserved.
   4  * ===============================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
   6  * in compliance with the License. You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software distributed under the License
  11  * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
  12  * or implied. See the License for the specific language governing permissions and limitations under
  13  * the License.
  14  * ============LICENSE_END========================================================================
  15  */
  16
  17 package org.onap.dcaegen2.collectors.datafile.tasks;
  18
  19 import static org.mockito.ArgumentMatchers.any;
  20 import static org.mockito.Mockito.doReturn;
  21 import static org.mockito.Mockito.doThrow;
  22 import static org.mockito.Mockito.mock;
  23 import static org.mockito.Mockito.spy;
  24 import static org.mockito.Mockito.times;
  25 import static org.mockito.Mockito.verify;
  26 import static org.mockito.Mockito.verifyNoMoreInteractions;
  27 import static org.mockito.Mockito.when;
  28
  29 import java.nio.file.Path;
  30 import java.nio.file.Paths;
  31 import java.time.Duration;
  32 import java.util.HashMap;
  33 import java.util.Map;
  34
  35 import org.junit.jupiter.api.BeforeAll;
  36 import org.junit.jupiter.api.Test;
  37 import org.onap.dcaegen2.collectors.datafile.configuration.AppConfig;
  38 import org.onap.dcaegen2.collectors.datafile.configuration.FtpesConfig;
  39 import org.onap.dcaegen2.collectors.datafile.exceptions.DatafileTaskException;
  40 import org.onap.dcaegen2.collectors.datafile.ftp.FtpsClient;
  41 import org.onap.dcaegen2.collectors.datafile.ftp.Scheme;
  42 import org.onap.dcaegen2.collectors.datafile.ftp.SftpClient;
  43 import org.onap.dcaegen2.collectors.datafile.model.FileData;
  44 import org.onap.dcaegen2.collectors.datafile.model.FilePublishInformation;
  45 import org.onap.dcaegen2.collectors.datafile.model.ImmutableFileData;
  46 import org.onap.dcaegen2.collectors.datafile.model.ImmutableFilePublishInformation;
  47 import org.onap.dcaegen2.collectors.datafile.model.ImmutableMessageMetaData;
  48 import org.onap.dcaegen2.collectors.datafile.model.MessageMetaData;
  49
  50 import reactor.test.StepVerifier;
  51
  52 public class FileCollectorTest {
  53     private static final String PRODUCT_NAME = "NrRadio";
  54     private static final String VENDOR_NAME = "Ericsson";
  55     private static final String LAST_EPOCH_MICROSEC = "8745745764578";
  56     private static final String SOURCE_NAME = "oteNB5309";
  57     private static final String START_EPOCH_MICROSEC = "8745745764578";
  58     private static final String TIME_ZONE_OFFSET = "UTC+05:00";
  59     private static final String PM_MEAS_CHANGE_IDENTIFIER = "PM_MEAS_FILES";
  60     private static final String FILE_READY_CHANGE_TYPE = "FileReady";
  61     private static final String FTPES_SCHEME = "ftpes://";
  62     private static final String SFTP_SCHEME = "sftp://";
  63     private static final String SERVER_ADDRESS = "192.168.0.101";
  64     private static final int PORT_22 = 22;
  65     private static final String PM_FILE_NAME = "A20161224.1030-1045.bin.gz";
  66     private static final Path LOCAL_FILE_LOCATION = Paths.get(FileData.DATAFILE_TMPDIR, PM_FILE_NAME);
  67     private static final String REMOTE_FILE_LOCATION = "/ftp/rop/" + PM_FILE_NAME;
  68     private static final String USER = "usr";
  69     private static final String PWD = "pwd";
  70     private static final String FTPES_LOCATION =
  71             FTPES_SCHEME + USER + ":" + PWD + "@" + SERVER_ADDRESS + ":" + PORT_22 + REMOTE_FILE_LOCATION;
  72
  73     private static final String FTPES_LOCATION_NO_PORT =
  74             FTPES_SCHEME + USER + ":" + PWD + "@" + SERVER_ADDRESS + REMOTE_FILE_LOCATION;
  75     private static final String SFTP_LOCATION = SFTP_SCHEME + SERVER_ADDRESS + ":" + PORT_22 + REMOTE_FILE_LOCATION;
  76     private static final String SFTP_LOCATION_NO_PORT = SFTP_SCHEME + SERVER_ADDRESS + REMOTE_FILE_LOCATION;
  77
  78     private static final String GZIP_COMPRESSION = "gzip";
  79     private static final String MEAS_COLLECT_FILE_FORMAT_TYPE = "org.3GPP.32.435#measCollec";
  80     private static final String FILE_FORMAT_VERSION = "V10";
  81
  82     private static final String FTP_KEY_PATH = "ftpKeyPath";
  83     private static final String FTP_KEY_PASSWORD = "ftpKeyPassword";
  84     private static final String TRUSTED_CA_PATH = "trustedCAPath";
  85     private static final String TRUSTED_CA_PASSWORD = "trustedCAPassword";
  86     private static final String CHANGE_IDENTIFIER = "PM_MEAS_FILES";
  87
  88     private static AppConfig appConfigMock = mock(AppConfig.class);
  89     private static FtpesConfig ftpesConfigMock = mock(FtpesConfig.class);
  90
  91     private FtpsClient ftpsClientMock = mock(FtpsClient.class);
  92
  93     private SftpClient sftpClientMock = mock(SftpClient.class);
  94     private final Map<String, String> contextMap = new HashMap<>();
  95
  96
  97     private MessageMetaData createMessageMetaData() {
  98         return ImmutableMessageMetaData.builder() //
  99                 .productName(PRODUCT_NAME) //
 100                 .vendorName(VENDOR_NAME) //
 101                 .lastEpochMicrosec(LAST_EPOCH_MICROSEC) //
 102                 .sourceName(SOURCE_NAME) //
 103                 .startEpochMicrosec(START_EPOCH_MICROSEC) //
 104                 .timeZoneOffset(TIME_ZONE_OFFSET) //
 105                 .changeIdentifier(PM_MEAS_CHANGE_IDENTIFIER) //
 106                 .changeType(FILE_READY_CHANGE_TYPE) //
 107                 .build();
 108     }
 109
 110     private FileData createFileData(String location, Scheme scheme) {
 111         return ImmutableFileData.builder() //
 112                 .name(PM_FILE_NAME) //
 113                 .location(location) //
 114                 .compression(GZIP_COMPRESSION) //
 115                 .fileFormatType(MEAS_COLLECT_FILE_FORMAT_TYPE) //
 116                 .fileFormatVersion(FILE_FORMAT_VERSION) //
 117                 .scheme(scheme) //
 118                 .messageMetaData(createMessageMetaData()) //
 119                 .build();
 120     }
 121
 122     private FilePublishInformation createExpectedFilePublishInformation(String location) {
 123         return ImmutableFilePublishInformation.builder() //
 124                 .productName(PRODUCT_NAME) //
 125                 .vendorName(VENDOR_NAME) //
 126                 .lastEpochMicrosec(LAST_EPOCH_MICROSEC) //
 127                 .sourceName(SOURCE_NAME) //
 128                 .startEpochMicrosec(START_EPOCH_MICROSEC) //
 129                 .timeZoneOffset(TIME_ZONE_OFFSET) //
 130                 .name(PM_FILE_NAME) //
 131                 .location(location) //
 132                 .internalLocation(LOCAL_FILE_LOCATION) //
 133                 .compression(GZIP_COMPRESSION) //
 134                 .fileFormatType(MEAS_COLLECT_FILE_FORMAT_TYPE) //
 135                 .fileFormatVersion(FILE_FORMAT_VERSION) //
 136                 .context(new HashMap<String,String>()) //
 137                 .changeIdentifier(CHANGE_IDENTIFIER) //
 138                 .build();
 139     }
 140
 141     /**
 142      * Sets up the configuration.
 143      */
 144     @BeforeAll
 145     public static void setUpConfiguration() {
 146         when(appConfigMock.getFtpesConfiguration()).thenReturn(ftpesConfigMock);
 147         when(ftpesConfigMock.keyCert()).thenReturn(FTP_KEY_PATH);
 148         when(ftpesConfigMock.keyPassword()).thenReturn(FTP_KEY_PASSWORD);
 149         when(ftpesConfigMock.trustedCa()).thenReturn(TRUSTED_CA_PATH);
 150         when(ftpesConfigMock.trustedCaPassword()).thenReturn(TRUSTED_CA_PASSWORD);
 151     }
 152
 153     @Test
 154     public void whenFtpesFile_returnCorrectResponse() throws Exception {
 155         FileCollector collectorUndetTest = spy(new FileCollector(appConfigMock));
 156         doReturn(ftpsClientMock).when(collectorUndetTest).createFtpsClient(any());
 157
 158         FileData fileData = createFileData(FTPES_LOCATION_NO_PORT, Scheme.FTPS);
 159
 160         FilePublishInformation expectedfilePublishInformation =
 161                 createExpectedFilePublishInformation(FTPES_LOCATION_NO_PORT);
 162
 163         StepVerifier.create(collectorUndetTest.collectFile(fileData, 3, Duration.ofSeconds(0), contextMap))
 164                 .expectNext(expectedfilePublishInformation) //
 165                 .verifyComplete();
 166
 167         verify(ftpsClientMock, times(1)).open();
 168         verify(ftpsClientMock, times(1)).collectFile(REMOTE_FILE_LOCATION, LOCAL_FILE_LOCATION);
 169         verify(ftpsClientMock, times(1)).close();
 170
 171         verifyNoMoreInteractions(ftpsClientMock);
 172     }
 173
 174     @Test
 175     public void whenSftpFile_returnCorrectResponse() throws Exception {
 176         FileCollector collectorUndetTest = spy(new FileCollector(appConfigMock));
 177         doReturn(sftpClientMock).when(collectorUndetTest).createSftpClient(any());
 178
 179
 180         FileData fileData = createFileData(SFTP_LOCATION_NO_PORT, Scheme.SFTP);
 181         FilePublishInformation expectedfilePublishInformation =
 182                 createExpectedFilePublishInformation(SFTP_LOCATION_NO_PORT);
 183
 184         StepVerifier.create(collectorUndetTest.collectFile(fileData, 3, Duration.ofSeconds(0), contextMap))
 185                 .expectNext(expectedfilePublishInformation) //
 186                 .verifyComplete();
 187
 188         // The same again, but with port
 189         fileData = createFileData(SFTP_LOCATION, Scheme.SFTP);
 190         expectedfilePublishInformation = createExpectedFilePublishInformation(SFTP_LOCATION);
 191
 192         StepVerifier.create(collectorUndetTest.collectFile(fileData, 3, Duration.ofSeconds(0), contextMap))
 193                 .expectNext(expectedfilePublishInformation) //
 194                 .verifyComplete();
 195
 196         verify(sftpClientMock, times(2)).open();
 197         verify(sftpClientMock, times(2)).collectFile(REMOTE_FILE_LOCATION, LOCAL_FILE_LOCATION);
 198         verify(sftpClientMock, times(2)).close();
 199         verifyNoMoreInteractions(sftpClientMock);
 200     }
 201
 202     @Test
 203     public void whenFtpesFileAlwaysFail_retryAndFail() throws Exception {
 204         FileCollector collectorUndetTest = spy(new FileCollector(appConfigMock));
 205         doReturn(ftpsClientMock).when(collectorUndetTest).createFtpsClient(any());
 206
 207         FileData fileData = createFileData(FTPES_LOCATION, Scheme.FTPS);
 208         doThrow(new DatafileTaskException("Unable to collect file.")).when(ftpsClientMock)
 209                 .collectFile(REMOTE_FILE_LOCATION, LOCAL_FILE_LOCATION);
 210
 211         StepVerifier.create(collectorUndetTest.collectFile(fileData, 3, Duration.ofSeconds(0), contextMap))
 212                 .expectErrorMessage("Retries exhausted: 3/3") //
 213                 .verify();
 214
 215         verify(ftpsClientMock, times(4)).collectFile(REMOTE_FILE_LOCATION, LOCAL_FILE_LOCATION);
 216     }
 217
 218     @Test
 219     public void whenFtpesFileAlwaysFail_failWithoutRetry() throws Exception {
 220         FileCollector collectorUndetTest = spy(new FileCollector(appConfigMock));
 221         doReturn(ftpsClientMock).when(collectorUndetTest).createFtpsClient(any());
 222
 223         final boolean retry = false;
 224         FileData fileData = createFileData(FTPES_LOCATION, Scheme.FTPS);
 225         doThrow(new DatafileTaskException("Unable to collect file.", retry)).when(ftpsClientMock)
 226                 .collectFile(REMOTE_FILE_LOCATION, LOCAL_FILE_LOCATION);
 227
 228         StepVerifier.create(collectorUndetTest.collectFile(fileData, 3, Duration.ofSeconds(0), contextMap))
 229                 .expectErrorMessage("Non retryable file transfer failure") //
 230                 .verify();
 231
 232         verify(ftpsClientMock, times(1)).collectFile(REMOTE_FILE_LOCATION, LOCAL_FILE_LOCATION);
 233     }
 234
 235     @Test
 236     public void whenFtpesFileFailOnce_retryAndReturnCorrectResponse() throws Exception {
 237         FileCollector collectorUndetTest = spy(new FileCollector(appConfigMock));
 238         doReturn(ftpsClientMock).when(collectorUndetTest).createFtpsClient(any());
 239         doThrow(new DatafileTaskException("Unable to collect file.")).doNothing().when(ftpsClientMock)
 240                 .collectFile(REMOTE_FILE_LOCATION, LOCAL_FILE_LOCATION);
 241
 242         FilePublishInformation expectedfilePublishInformation =
 243                 createExpectedFilePublishInformation(FTPES_LOCATION_NO_PORT);
 244
 245         FileData fileData = createFileData(FTPES_LOCATION_NO_PORT, Scheme.FTPS);
 246
 247         StepVerifier.create(collectorUndetTest.collectFile(fileData, 3, Duration.ofSeconds(0), contextMap))
 248                 .expectNext(expectedfilePublishInformation) //
 249                 .verifyComplete();
 250
 251         verify(ftpsClientMock, times(2)).collectFile(REMOTE_FILE_LOCATION, LOCAL_FILE_LOCATION);
 252     }
 253 }