aboutsummaryrefslogtreecommitdiffstats
path: root/datafile-app-server/src/test/java/org/onap/dcaegen2/collectors/datafile/http/DfcHttpsClientTest.java
blob: 168bb08c4912dc07e061d9db11688ec1e8babab7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/*-
 * ============LICENSE_START======================================================================
 * Copyright (C) 2021 Nokia. All rights reserved.
 * ===============================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 * ============LICENSE_END========================================================================
 */
package org.onap.dcaegen2.collectors.datafile.http;


import org.apache.hc.core5.net.URIBuilder;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.conn.ConnectTimeoutException;
import org.apache.http.impl.conn.PoolingHttpClientConnectionManager;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.onap.dcaegen2.collectors.datafile.commons.FileServerData;
import org.onap.dcaegen2.collectors.datafile.commons.ImmutableFileServerData;
import org.onap.dcaegen2.collectors.datafile.exceptions.DatafileTaskException;
import org.onap.dcaegen2.collectors.datafile.exceptions.NonRetryableDatafileTaskException;

import java.io.IOException;
import java.io.InputStream;
import java.net.URISyntaxException;
import java.nio.file.Path;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;

@ExtendWith(MockitoExtension.class)
class DfcHttpsClientTest {

    private static final String USERNAME = "bob";
    private static final String PASSWORD = "123";
    private static final String XNF_ADDRESS = "127.0.0.1";
    private static final int PORT = 443;
    private static final String JWT_PASSWORD = "thisIsThePassword";
    private static String ACCESS_TOKEN = "access_token";
    private static String remoteFile = "remoteFile";

    @Mock
    private PoolingHttpClientConnectionManager connectionManager;
    @Mock
    private Path localFile;

    DfcHttpsClient dfcHttpsClientSpy;

    @BeforeEach
    public void setup() {
        dfcHttpsClientSpy = spy(new DfcHttpsClient(createFileServerData(), connectionManager));
    }

    @Test
    void fileServerData_properLocationBasicAuth() throws Exception {
        boolean result  = dfcHttpsClientSpy.basicAuthValidNotPresentOrThrow();
        assertEquals(true, result);
    }

    @Test
    void fileServerData_properLocationNoBasicAuth() throws Exception {
        dfcHttpsClientSpy = spy(new DfcHttpsClient(emptyUserInFileServerData(), connectionManager));

        boolean result  = dfcHttpsClientSpy.basicAuthValidNotPresentOrThrow();
        assertEquals(false, result);
    }

    @Test
    void fileServerData_improperAuthDataExceptionOccurred() throws Exception {
        dfcHttpsClientSpy = spy(new DfcHttpsClient(invalidUserInFileServerData(), connectionManager));

        assertThrows(DatafileTaskException.class, () -> dfcHttpsClientSpy.basicAuthValidNotPresentOrThrow());
    }

    @Test
    void dfcHttpsClient_flow_successfulCallAndResponseProcessing() throws Exception {
        doReturn(HttpClientResponseHelper.APACHE_RESPONSE_OK).when(dfcHttpsClientSpy)
            .executeHttpClient(any(HttpGet.class));
        doReturn((long)3).when(dfcHttpsClientSpy).writeFile(eq(localFile), any(InputStream.class));

        dfcHttpsClientSpy.open();
        dfcHttpsClientSpy.collectFile(remoteFile, localFile);
        dfcHttpsClientSpy.close();

        verify(dfcHttpsClientSpy, times(1)).makeCall(any(HttpGet.class));
        verify(dfcHttpsClientSpy, times(1))
            .executeHttpClient(any(HttpGet.class));
        verify(dfcHttpsClientSpy, times(1))
            .processResponse(HttpClientResponseHelper.APACHE_RESPONSE_OK, localFile);
        verify(dfcHttpsClientSpy, times(1))
            .writeFile(eq(localFile), any(InputStream.class));
    }

    @Test
    void dfcHttpsClient_flow_successfulCallWithJWTAndResponseProcessing() throws Exception {
        FileServerData serverData = jWTTokenInFileServerData();
        dfcHttpsClientSpy = spy(new DfcHttpsClient(serverData, connectionManager));

        doReturn(HttpClientResponseHelper.APACHE_RESPONSE_OK).when(dfcHttpsClientSpy)
                .executeHttpClient(any(HttpGet.class));
        doReturn((long)3).when(dfcHttpsClientSpy).writeFile(eq(localFile), any(InputStream.class));

        dfcHttpsClientSpy.open();
        dfcHttpsClientSpy.collectFile(remoteFile, localFile);
        dfcHttpsClientSpy.close();

        verify(dfcHttpsClientSpy, times(1)).makeCall(any(HttpGet.class));
        verify(dfcHttpsClientSpy, times(1))
                .executeHttpClient(any(HttpGet.class));
        verify(dfcHttpsClientSpy, times(1))
                .processResponse(HttpClientResponseHelper.APACHE_RESPONSE_OK, localFile);
        verify(dfcHttpsClientSpy, times(1))
                .writeFile(eq(localFile), any(InputStream.class));
        assertFalse(serverData.toString().contains(JWT_PASSWORD));
    }

    @Test
    void dfcHttpsClient_flow_failedCallUnexpectedResponseCode() throws Exception {
        doReturn(HttpClientResponseHelper.APACHE_RESPONSE_OK).when(dfcHttpsClientSpy)
            .executeHttpClient(any(HttpGet.class));
        doReturn(false).when(dfcHttpsClientSpy).isResponseOk(any(HttpResponse.class));

        dfcHttpsClientSpy.open();

        assertThrows(DatafileTaskException.class,
                () -> dfcHttpsClientSpy.collectFile(remoteFile, localFile));
    }

    @Test
    void dfcHttpsClient_flow_failedCallConnectionTimeout() throws Exception {
        doThrow(ConnectTimeoutException.class).when(dfcHttpsClientSpy)
            .executeHttpClient(any(HttpGet.class));

        dfcHttpsClientSpy.open();

        assertThrows(NonRetryableDatafileTaskException.class,
                () -> dfcHttpsClientSpy.collectFile(remoteFile, localFile));
    }

    @Test
    void dfcHttpsClient_flow_failedCallIOExceptionForExecuteHttpClient() throws Exception {
        doThrow(IOException.class).when(dfcHttpsClientSpy)
            .executeHttpClient(any(HttpGet.class));

        dfcHttpsClientSpy.open();

        assertThrows(DatafileTaskException.class,
                () -> dfcHttpsClientSpy.collectFile(remoteFile, localFile));
    }

    private ImmutableFileServerData createFileServerData() {
        return ImmutableFileServerData.builder()
                .serverAddress(XNF_ADDRESS)
                .userId(USERNAME).password(PASSWORD)
                .port(PORT)
                .build();
    }

    private ImmutableFileServerData emptyUserInFileServerData() {
        return ImmutableFileServerData.builder()
                .serverAddress(XNF_ADDRESS)
                .userId("").password("")
                .port(PORT)
                .build();
    }

    private ImmutableFileServerData invalidUserInFileServerData() {
        return ImmutableFileServerData.builder()
                .serverAddress(XNF_ADDRESS)
                .userId(USERNAME).password("")
                .port(PORT)
                .build();
    }

    private ImmutableFileServerData jWTTokenInFileServerData() throws URISyntaxException {
        String query = "?" + ACCESS_TOKEN + "=" + JWT_PASSWORD;

        return ImmutableFileServerData.builder()
                .serverAddress(XNF_ADDRESS)
                .userId("").password("")
                .port(PORT)
                .queryParameters(new URIBuilder(query).getQueryParams())
                .build();
    }
}