fb49c8601aec3970dbfbb9278dda548308ee7f97
[dcaegen2/collectors/datafile.git] /
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.time.Duration;
31 import java.util.HashMap;
32 import java.util.Map;
33
34 import org.junit.jupiter.api.BeforeAll;
35 import org.junit.jupiter.api.Test;
36 import org.onap.dcaegen2.collectors.datafile.configuration.AppConfig;
37 import org.onap.dcaegen2.collectors.datafile.configuration.FtpesConfig;
38 import org.onap.dcaegen2.collectors.datafile.exceptions.DatafileTaskException;
39 import org.onap.dcaegen2.collectors.datafile.ftp.FtpsClient;
40 import org.onap.dcaegen2.collectors.datafile.ftp.Scheme;
41 import org.onap.dcaegen2.collectors.datafile.ftp.SftpClient;
42 import org.onap.dcaegen2.collectors.datafile.model.ConsumerDmaapModel;
43 import org.onap.dcaegen2.collectors.datafile.model.FileData;
44 import org.onap.dcaegen2.collectors.datafile.model.ImmutableConsumerDmaapModel;
45 import org.onap.dcaegen2.collectors.datafile.model.ImmutableFileData;
46 import org.onap.dcaegen2.collectors.datafile.model.ImmutableMessageMetaData;
47 import org.onap.dcaegen2.collectors.datafile.model.MessageMetaData;
48
49 import reactor.test.StepVerifier;
50
51 /**
52  * @author <a href="mailto:henrik.b.andersson@est.tech">Henrik Andersson</a>
53  *
54  */
55 public class FileCollectorTest {
56     private static final String PRODUCT_NAME = "NrRadio";
57     private static final String VENDOR_NAME = "Ericsson";
58     private static final String LAST_EPOCH_MICROSEC = "8745745764578";
59     private static final String SOURCE_NAME = "oteNB5309";
60     private static final String START_EPOCH_MICROSEC = "8745745764578";
61     private static final String TIME_ZONE_OFFSET = "UTC+05:00";
62     private static final String PM_MEAS_CHANGE_IDENTIFIER = "PM_MEAS_FILES";
63     private static final String FILE_READY_CHANGE_TYPE = "FileReady";
64     private static final String FTPES_SCHEME = "ftpes://";
65     private static final String SFTP_SCHEME = "sftp://";
66     private static final String SERVER_ADDRESS = "192.168.0.101";
67     private static final int PORT_22 = 22;
68     private static final String PM_FILE_NAME = "A20161224.1030-1045.bin.gz";
69     private static final String REMOTE_FILE_LOCATION = "/ftp/rop/" + PM_FILE_NAME;
70     private static final Path LOCAL_FILE_LOCATION = FileData.createLocalFileName(SERVER_ADDRESS, PM_FILE_NAME);
71     private static final String USER = "usr";
72     private static final String PWD = "pwd";
73     private static final String FTPES_LOCATION =
74             FTPES_SCHEME + USER + ":" + PWD + "@" + SERVER_ADDRESS + ":" + PORT_22 + REMOTE_FILE_LOCATION;
75
76     private static final String FTPES_LOCATION_NO_PORT =
77             FTPES_SCHEME + USER + ":" + PWD + "@" + SERVER_ADDRESS + REMOTE_FILE_LOCATION;
78     private static final String SFTP_LOCATION = SFTP_SCHEME + SERVER_ADDRESS + ":" + PORT_22 + REMOTE_FILE_LOCATION;
79     private static final String SFTP_LOCATION_NO_PORT = SFTP_SCHEME + SERVER_ADDRESS + REMOTE_FILE_LOCATION;
80
81     private static final String GZIP_COMPRESSION = "gzip";
82     private static final String MEAS_COLLECT_FILE_FORMAT_TYPE = "org.3GPP.32.435#measCollec";
83     private static final String FILE_FORMAT_VERSION = "V10";
84
85     private static final String FTP_KEY_PATH = "ftpKeyPath";
86     private static final String FTP_KEY_PASSWORD = "ftpKeyPassword";
87     private static final String TRUSTED_CA_PATH = "trustedCAPath";
88     private static final String TRUSTED_CA_PASSWORD = "trustedCAPassword";
89
90     private static AppConfig appConfigMock = mock(AppConfig.class);
91     private static FtpesConfig ftpesConfigMock = mock(FtpesConfig.class);
92
93     private FtpsClient ftpsClientMock = mock(FtpsClient.class);
94
95     private SftpClient sftpClientMock = mock(SftpClient.class);
96
97
98     private MessageMetaData createMessageMetaData() {
99         // @formatter:off
100         return ImmutableMessageMetaData.builder()
101                 .productName(PRODUCT_NAME)
102                 .vendorName(VENDOR_NAME)
103                 .lastEpochMicrosec(LAST_EPOCH_MICROSEC)
104                 .sourceName(SOURCE_NAME)
105                 .startEpochMicrosec(START_EPOCH_MICROSEC)
106                 .timeZoneOffset(TIME_ZONE_OFFSET)
107                 .changeIdentifier(PM_MEAS_CHANGE_IDENTIFIER)
108                 .changeType(FILE_READY_CHANGE_TYPE)
109                 .build();
110         // @formatter:on
111     }
112
113     private FileData createFileData(String location, Scheme scheme) {
114         // @formatter:off
115         return  ImmutableFileData.builder()
116             .name(PM_FILE_NAME)
117             .location(location)
118             .compression(GZIP_COMPRESSION)
119             .fileFormatType(MEAS_COLLECT_FILE_FORMAT_TYPE)
120             .fileFormatVersion(FILE_FORMAT_VERSION)
121             .scheme(scheme)
122             .build();
123         // @formatter:on
124     }
125
126     private ConsumerDmaapModel createExpectedConsumerDmaapModel(String location) {
127         // @formatter:off
128         return ImmutableConsumerDmaapModel.builder()
129             .productName(PRODUCT_NAME)
130             .vendorName(VENDOR_NAME)
131             .lastEpochMicrosec(LAST_EPOCH_MICROSEC)
132             .sourceName(SOURCE_NAME)
133             .startEpochMicrosec(START_EPOCH_MICROSEC)
134             .timeZoneOffset(TIME_ZONE_OFFSET)
135             .name(PM_FILE_NAME)
136             .location(location)
137             .internalLocation(LOCAL_FILE_LOCATION)
138             .compression(GZIP_COMPRESSION)
139             .fileFormatType(MEAS_COLLECT_FILE_FORMAT_TYPE)
140             .fileFormatVersion(FILE_FORMAT_VERSION)
141             .build();
142       // @formatter:on
143     }
144
145     @BeforeAll
146     public static void setUpConfiguration() {
147         when(appConfigMock.getFtpesConfiguration()).thenReturn(ftpesConfigMock);
148         when(ftpesConfigMock.keyCert()).thenReturn(FTP_KEY_PATH);
149         when(ftpesConfigMock.keyPassword()).thenReturn(FTP_KEY_PASSWORD);
150         when(ftpesConfigMock.trustedCA()).thenReturn(TRUSTED_CA_PATH);
151         when(ftpesConfigMock.trustedCAPassword()).thenReturn(TRUSTED_CA_PASSWORD);
152     }
153
154     @Test
155     public void whenFtpesFile_returnCorrectResponse() throws Exception {
156         FileCollector collectorUndetTest = spy(new FileCollector(appConfigMock));
157         doReturn(ftpsClientMock).when(collectorUndetTest).createFtpsClient(any());
158
159         FileData fileData = createFileData(FTPES_LOCATION_NO_PORT, Scheme.FTPS);
160
161         ConsumerDmaapModel expectedConsumerDmaapModel = createExpectedConsumerDmaapModel(FTPES_LOCATION_NO_PORT);
162
163         Map<String, String> contextMap = new HashMap<>();
164         StepVerifier.create(
165                 collectorUndetTest.execute(fileData, createMessageMetaData(), 3, Duration.ofSeconds(0), contextMap))
166                 .expectNext(expectedConsumerDmaapModel).verifyComplete();
167
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         FileData fileData = createFileData(SFTP_LOCATION_NO_PORT, Scheme.SFTP);
180         ConsumerDmaapModel expectedConsumerDmaapModel = createExpectedConsumerDmaapModel(SFTP_LOCATION_NO_PORT);
181
182         Map<String, String> contextMap = new HashMap<>();
183         StepVerifier
184                 .create(collectorUndetTest.execute(fileData, createMessageMetaData(), 3, Duration.ofSeconds(0),
185                         contextMap))
186                 .expectNext(expectedConsumerDmaapModel) //
187                 .verifyComplete();
188
189         // The same again, but with port
190         fileData = createFileData(SFTP_LOCATION, Scheme.SFTP);
191         expectedConsumerDmaapModel = createExpectedConsumerDmaapModel(SFTP_LOCATION);
192
193         StepVerifier
194                 .create(collectorUndetTest.execute(fileData, createMessageMetaData(), 3, Duration.ofSeconds(0),
195                         contextMap))
196                 .expectNext(expectedConsumerDmaapModel) //
197                 .verifyComplete();
198
199         verify(sftpClientMock, times(2)).collectFile(REMOTE_FILE_LOCATION, LOCAL_FILE_LOCATION);
200         verify(sftpClientMock, times(2)).close();
201         verifyNoMoreInteractions(sftpClientMock);
202     }
203
204     @Test
205     public void whenFtpesFileAlwaysFail_retryAndFail() throws Exception {
206         FileCollector collectorUndetTest = spy(new FileCollector(appConfigMock));
207         doReturn(ftpsClientMock).when(collectorUndetTest).createFtpsClient(any());
208
209         FileData fileData = createFileData(FTPES_LOCATION, Scheme.FTPS);
210         doThrow(new DatafileTaskException("Unable to collect file.")).when(ftpsClientMock)
211                 .collectFile(REMOTE_FILE_LOCATION, LOCAL_FILE_LOCATION);
212
213         Map<String, String> contextMap = new HashMap<>();
214         StepVerifier.create(
215                 collectorUndetTest.execute(fileData, createMessageMetaData(), 3, Duration.ofSeconds(0), contextMap))
216                 .expectErrorMessage("Retries exhausted: 3/3").verify();
217
218         verify(ftpsClientMock, times(4)).collectFile(REMOTE_FILE_LOCATION, LOCAL_FILE_LOCATION);
219     }
220
221     @Test
222     public void whenFtpesFileFailOnce_retryAndReturnCorrectResponse() throws Exception {
223         FileCollector collectorUndetTest = spy(new FileCollector(appConfigMock));
224         doReturn(ftpsClientMock).when(collectorUndetTest).createFtpsClient(any());
225         doThrow(new DatafileTaskException("Unable to collect file.")).doNothing().when(ftpsClientMock)
226                 .collectFile(REMOTE_FILE_LOCATION, LOCAL_FILE_LOCATION);
227
228         ConsumerDmaapModel expectedConsumerDmaapModel = createExpectedConsumerDmaapModel(FTPES_LOCATION_NO_PORT);
229
230         FileData fileData = createFileData(FTPES_LOCATION_NO_PORT, Scheme.FTPS);
231         Map<String, String> contextMap = new HashMap<>();
232         StepVerifier.create(
233                 collectorUndetTest.execute(fileData, createMessageMetaData(), 3, Duration.ofSeconds(0), contextMap))
234                 .expectNext(expectedConsumerDmaapModel).verifyComplete();
235
236         verify(ftpsClientMock, times(2)).collectFile(REMOTE_FILE_LOCATION, LOCAL_FILE_LOCATION);
237     }
238 }